import { APIResource } from "../resource.js"; import * as Core from "../core.js"; import * as VariablesAPI from "./variables.js"; import * as Shared from "./shared.js"; export declare class Variables extends APIResource { /** * Create Variable */ create(params: VariableCreateParams, options?: Core.RequestOptions): Core.APIPromise; /** * Read Variable */ retrieve(id: string, params?: VariableRetrieveParams, options?: Core.RequestOptions): Core.APIPromise; retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise; /** * Update Variable */ update(id: string, params: VariableUpdateParams, options?: Core.RequestOptions): Core.APIPromise; /** * Delete Variable */ delete(id: string, params?: VariableDeleteParams, options?: Core.RequestOptions): Core.APIPromise; delete(id: string, options?: Core.RequestOptions): Core.APIPromise; /** * Count Variables */ count(params?: VariableCountParams, options?: Core.RequestOptions): Core.APIPromise; count(options?: Core.RequestOptions): Core.APIPromise; /** * Read Variables */ filter(params?: VariableFilterParams, options?: Core.RequestOptions): Core.APIPromise; filter(options?: Core.RequestOptions): Core.APIPromise; /** * Update Variable By Name */ updateName(params: VariableUpdateNameParams, options?: Core.RequestOptions): Core.APIPromise; } export type VariableCountResponse = number; export type VariableFilterResponse = Array; export interface VariableCreateParams { /** * Body param: The name of the variable */ name: string; /** * Body param: The value of the variable */ value: string | boolean | number | unknown | Array | null; /** * Body param: A list of variable tags */ tags?: Array; /** * Header param: */ 'x-prefect-api-version'?: string; } export interface VariableRetrieveParams { 'x-prefect-api-version'?: string; } export interface VariableUpdateParams { /** * Body param: The name of the variable */ name?: string | null; /** * Body param: A list of variable tags */ tags?: Array | null; /** * Body param: The value of the variable */ value?: string | boolean | number | unknown | Array | null; /** * Header param: */ 'x-prefect-api-version'?: string; } export interface VariableDeleteParams { 'x-prefect-api-version'?: string; } export interface VariableCountParams { /** * Body param: Filter variables. Only variables matching all criteria will be * returned */ variables?: VariableCountParams.Variables | null; /** * Header param: */ 'x-prefect-api-version'?: string; } export declare namespace VariableCountParams { /** * Filter variables. Only variables matching all criteria will be returned */ interface Variables { /** * Filter by `Variable.id`. */ id?: Variables.ID | null; /** * Filter by `Variable.name`. */ name?: Variables.Name | null; /** * Operator for combining filter criteria. Defaults to 'and\_'. */ operator?: 'and_' | 'or_'; /** * Filter by `Variable.tags`. */ tags?: Variables.Tags | null; } namespace Variables { /** * Filter by `Variable.id`. */ interface ID { /** * A list of variable ids to include */ any_?: Array | null; } /** * Filter by `Variable.name`. */ interface Name { /** * A list of variables names to include */ any_?: Array | null; /** * A string to match variable names against. This can include SQL wildcard * characters like `%` and `_`. */ like_?: string | null; } /** * Filter by `Variable.tags`. */ interface Tags { /** * A list of tags. Variables will be returned only if their tags are a superset of * the list */ all_?: Array | null; /** * If true, only include Variables without tags */ is_null_?: boolean | null; /** * Operator for combining filter criteria. Defaults to 'and\_'. */ operator?: 'and_' | 'or_'; } } } export interface VariableFilterParams { /** * Body param: Defaults to PREFECT_API_DEFAULT_LIMIT if not provided. */ limit?: number; /** * Body param: */ offset?: number; /** * Body param: Defines variables sorting options. */ sort?: 'CREATED_DESC' | 'UPDATED_DESC' | 'NAME_DESC' | 'NAME_ASC'; /** * Body param: Filter variables. Only variables matching all criteria will be * returned */ variables?: VariableFilterParams.Variables | null; /** * Header param: */ 'x-prefect-api-version'?: string; } export declare namespace VariableFilterParams { /** * Filter variables. Only variables matching all criteria will be returned */ interface Variables { /** * Filter by `Variable.id`. */ id?: Variables.ID | null; /** * Filter by `Variable.name`. */ name?: Variables.Name | null; /** * Operator for combining filter criteria. Defaults to 'and\_'. */ operator?: 'and_' | 'or_'; /** * Filter by `Variable.tags`. */ tags?: Variables.Tags | null; } namespace Variables { /** * Filter by `Variable.id`. */ interface ID { /** * A list of variable ids to include */ any_?: Array | null; } /** * Filter by `Variable.name`. */ interface Name { /** * A list of variables names to include */ any_?: Array | null; /** * A string to match variable names against. This can include SQL wildcard * characters like `%` and `_`. */ like_?: string | null; } /** * Filter by `Variable.tags`. */ interface Tags { /** * A list of tags. Variables will be returned only if their tags are a superset of * the list */ all_?: Array | null; /** * If true, only include Variables without tags */ is_null_?: boolean | null; /** * Operator for combining filter criteria. Defaults to 'and\_'. */ operator?: 'and_' | 'or_'; } } } export interface VariableUpdateNameParams { /** * Path param: */ path_name: string; /** * Body param: The name of the variable */ body_name?: string | null; /** * Body param: A list of variable tags */ tags?: Array | null; /** * Body param: The value of the variable */ value?: string | boolean | number | unknown | Array | null; /** * Header param: */ 'x-prefect-api-version'?: string; } export declare namespace Variables { export import VariableCountResponse = VariablesAPI.VariableCountResponse; export import VariableFilterResponse = VariablesAPI.VariableFilterResponse; export import VariableCreateParams = VariablesAPI.VariableCreateParams; export import VariableRetrieveParams = VariablesAPI.VariableRetrieveParams; export import VariableUpdateParams = VariablesAPI.VariableUpdateParams; export import VariableDeleteParams = VariablesAPI.VariableDeleteParams; export import VariableCountParams = VariablesAPI.VariableCountParams; export import VariableFilterParams = VariablesAPI.VariableFilterParams; export import VariableUpdateNameParams = VariablesAPI.VariableUpdateNameParams; } //# sourceMappingURL=variables.d.ts.map