import {z} from 'zod' export type LogicalOperators = 'or' | 'and'; export type GetApiApiV1PipelineDeploymentsArgs = {hydrate?: boolean | undefined, sort_by?: string | undefined, logical_operator?: LogicalOperators | undefined, page?: number | undefined, size?: number | undefined, id?: (string | string | null) | undefined, created?: (string | string | null) | undefined, updated?: (string | string | null) | undefined, scope_workspace?: (string | null) | undefined, workspace_id?: (string | string | null) | undefined, user_id?: (string | string | null) | undefined, pipeline_id?: (string | string | null) | undefined, stack_id?: (string | string | null) | undefined, build_id?: (string | string | null) | undefined, schedule_id?: (string | string | null) | undefined, template_id?: (string | string | null) | undefined}; export type GetApiApiV1PipelineDeploymentsOptions = {baseUrl: string, CookieOAuth2TokenBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const userResponseBody = z.object({created: z.string(), updated: z.string(), active: z.boolean().optional(), activation_token: z.string().max(255).nullable().optional(), full_name: z.string().max(255).optional(), email_opted_in: z.boolean().nullable().optional(), is_service_account: z.boolean(), is_admin: z.boolean()}); export const userResponseMetadata = z.object({email: z.string().max(255).nullable().optional(), external_user_id: z.string().nullable().optional(), user_metadata: z.object({}).optional()}); export const userResponseResources = z.record(z.string(), z.unknown()); export const userResponse = z.object({body: userResponseBody.nullable().optional(), metadata: userResponseMetadata.nullable().optional(), resources: userResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const pipelineDeploymentResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional()}); export const workspaceResponseBody = z.object({created: z.string(), updated: z.string()}); export const workspaceResponseMetadata = z.object({description: z.string().max(255).optional()}); export const workspaceResponseResources = z.record(z.string(), z.unknown()); export const workspaceResponse = z.object({body: workspaceResponseBody.nullable().optional(), metadata: workspaceResponseMetadata.nullable().optional(), resources: workspaceResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const baseSettings = z.record(z.string(), z.unknown()); export const sourceType = z.enum(["user", "builtin", "internal", "distribution_package", "code_repository", "notebook", "unknown"]); export const source = z.object({module: z.string(), attribute: z.string().nullable().optional(), type: sourceType}).and(z.record(z.string(), z.unknown())); export const modelStages = z.enum(["none", "staging", "production", "archived", "latest"]); export const model = z.object({name: z.string(), license: z.string().nullable().optional(), description: z.string().nullable().optional(), audience: z.string().nullable().optional(), use_cases: z.string().nullable().optional(), limitations: z.string().nullable().optional(), trade_offs: z.string().nullable().optional(), ethics: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), version: z.union([modelStages, z.number().int(), z.string()]).nullable().optional(), save_models_to_registry: z.boolean().optional(), model_version_id: z.string().nullable().optional(), suppress_class_validation_warnings: z.boolean().optional(), was_created_in_this_run: z.boolean().optional()}); export const stepRetryConfig = z.object({max_retries: z.number().int().optional(), delay: z.number().int().optional(), backoff: z.number().int().optional()}); export const pipelineConfigurationOutput = z.object({enable_cache: z.boolean().nullable().optional(), enable_artifact_metadata: z.boolean().nullable().optional(), enable_artifact_visualization: z.boolean().nullable().optional(), enable_step_logs: z.boolean().nullable().optional(), settings: z.record(z.string(), baseSettings).optional(), extra: z.object({}).optional(), failure_hook_source: source.nullable().optional(), success_hook_source: source.nullable().optional(), model: model.nullable().optional(), parameters: z.object({}).nullable().optional(), retry: stepRetryConfig.nullable().optional(), name: z.string()}); export const inputSpec = z.object({step_name: z.string(), output_name: z.string()}); export const stepSpecOutput = z.object({source: source, upstream_steps: z.array(z.string()), inputs: z.record(z.string(), inputSpec).optional(), pipeline_parameter_name: z.string().optional()}); export const artifactConfigurationOutput = z.object({materializer_source: z.array(source), default_materializer_source: source.nullable().optional()}); export const externalArtifactConfigurationOutput = z.object({id: z.string().nullable().optional(), name: z.string().nullable().optional(), version: z.string().nullable().optional(), model: model.nullable().optional()}); export const modelVersionDataLazyLoaderOutput = z.object({model: model, artifact_name: z.string().nullable().optional(), artifact_version: z.string().nullable().optional(), metadata_name: z.string().nullable().optional()}); export const callStep = z.object({attribute_name: z.string().nullable().optional(), is_call: z.boolean().nullable().optional(), call_args: z.array(z.unknown()).nullable().optional(), call_kwargs: z.object({}).nullable().optional(), selector: z.unknown()}); export const clientLazyLoader = z.object({method_name: z.string(), call_chain: z.array(callStep).optional(), exclude_next_call: z.boolean().optional()}); export const stepConfigurationOutput = z.object({name: z.string(), enable_cache: z.boolean().nullable().optional(), enable_artifact_metadata: z.boolean().nullable().optional(), enable_artifact_visualization: z.boolean().nullable().optional(), enable_step_logs: z.boolean().nullable().optional(), step_operator: z.string().nullable().optional(), experiment_tracker: z.string().nullable().optional(), parameters: z.object({}).optional(), settings: z.record(z.string(), baseSettings).optional(), extra: z.object({}).optional(), failure_hook_source: source.nullable().optional(), success_hook_source: source.nullable().optional(), model: model.nullable().optional(), retry: stepRetryConfig.nullable().optional(), outputs: z.record(z.string(), artifactConfigurationOutput).optional(), caching_parameters: z.object({}).optional(), external_input_artifacts: z.record(z.string(), externalArtifactConfigurationOutput).optional(), model_artifacts_or_metadata: z.record(z.string(), modelVersionDataLazyLoaderOutput).optional(), client_lazy_loaders: z.record(z.string(), clientLazyLoader).optional()}); export const stepOutput = z.object({spec: stepSpecOutput, config: stepConfigurationOutput}); export const pipelineSpecOutput = z.object({version: z.string().optional(), source: source.nullable().optional(), parameters: z.object({}).optional(), steps: z.array(stepSpecOutput)}); export const executionStatus = z.enum(["initializing", "failed", "completed", "running", "cached"]); export const pipelineResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), latest_run_id: z.string().nullable().optional(), latest_run_status: executionStatus.nullable().optional()}); export const pipelineResponseMetadata = z.object({workspace: workspaceResponse, description: z.string().nullable().optional()}); export const colorVariants = z.enum(["grey", "purple", "red", "green", "yellow", "orange", "lime", "teal", "turquoise", "magenta", "blue"]); export const tagResponseBody = z.object({created: z.string(), updated: z.string(), color: colorVariants.optional(), tagged_count: z.number().int()}); export const baseResponseMetadata = z.object({}); export const tagResponseResources = z.record(z.string(), z.unknown()); export const tagResponse = z.object({body: tagResponseBody.nullable().optional(), metadata: baseResponseMetadata.nullable().optional(), resources: tagResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const pipelineResponseResources = z.object({tags: z.array(tagResponse)}).and(z.record(z.string(), z.unknown())); export const pipelineResponse = z.object({body: pipelineResponseBody.nullable().optional(), metadata: pipelineResponseMetadata.nullable().optional(), resources: pipelineResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const stackResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional()}); export const stackComponentType = z.enum(["alerter", "annotator", "artifact_store", "container_registry", "data_validator", "experiment_tracker", "feature_store", "image_builder", "model_deployer", "orchestrator", "step_operator", "model_registry"]); export const componentResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), type: stackComponentType, flavor: z.string().max(255), integration: z.string().max(255).nullable().optional(), logo_url: z.string().nullable().optional()}); export const resourceTypeModel = z.object({name: z.string(), resource_type: z.string(), description: z.string().optional(), auth_methods: z.array(z.string()), supports_instances: z.boolean().optional(), logo_url: z.string().nullable().optional(), emoji: z.string().nullable().optional()}); export const authenticationMethodModel = z.object({name: z.string(), auth_method: z.string().max(255), description: z.string().optional(), config_schema: z.object({}).optional(), min_expiration_seconds: z.number().int().nullable().optional(), max_expiration_seconds: z.number().int().nullable().optional(), default_expiration_seconds: z.number().int().nullable().optional()}); export const serviceConnectorTypeModel = z.object({name: z.string(), connector_type: z.string().max(255), description: z.string().optional(), resource_types: z.array(resourceTypeModel), auth_methods: z.array(authenticationMethodModel), supports_auto_configuration: z.boolean().optional(), logo_url: z.string().nullable().optional(), emoji: z.string().nullable().optional(), docs_url: z.string().nullable().optional(), sdk_docs_url: z.string().nullable().optional(), local: z.boolean().optional(), remote: z.boolean().optional()}); export const serviceConnectorResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), description: z.string().optional(), connector_type: z.union([z.string(), serviceConnectorTypeModel]), auth_method: z.string().max(255), resource_types: z.array(z.string()).optional(), resource_id: z.string().max(255).nullable().optional(), supports_instances: z.boolean().optional(), expires_at: z.string().nullable().optional(), expires_skew_tolerance: z.number().int().nullable().optional()}); export const serviceConnectorResponseMetadata = z.object({workspace: workspaceResponse, configuration: z.object({}).optional(), secret_id: z.string().nullable().optional(), expiration_seconds: z.number().int().nullable().optional(), secrets: z.record(z.string(), z.string().nullable()).optional(), labels: z.record(z.string(), z.string()).optional()}); export const serviceConnectorResponseResources = z.record(z.string(), z.unknown()); export const serviceConnectorResponse = z.object({body: serviceConnectorResponseBody.nullable().optional(), metadata: serviceConnectorResponseMetadata.nullable().optional(), resources: serviceConnectorResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const componentResponseMetadata = z.object({workspace: workspaceResponse, configuration: z.object({}), labels: z.object({}).nullable().optional(), component_spec_path: z.string().nullable().optional(), connector_resource_id: z.string().nullable().optional(), connector: serviceConnectorResponse.nullable().optional()}); export const componentResponseResources = z.record(z.string(), z.unknown()); export const componentResponse = z.object({body: componentResponseBody.nullable().optional(), metadata: componentResponseMetadata.nullable().optional(), resources: componentResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const stackResponseMetadata = z.object({workspace: workspaceResponse, components: z.record(z.string(), z.array(componentResponse)), description: z.string().max(255).nullable().optional(), stack_spec_path: z.string().nullable().optional(), labels: z.object({}).nullable().optional()}); export const stackResponseResources = z.record(z.string(), z.unknown()); export const stackResponse = z.object({body: stackResponseBody.nullable().optional(), metadata: stackResponseMetadata.nullable().optional(), resources: stackResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const pipelineBuildResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional()}); export const buildItem = z.object({image: z.string(), dockerfile: z.string().nullable().optional(), requirements: z.string().nullable().optional(), settings_checksum: z.string().nullable().optional(), contains_code: z.boolean().optional(), requires_code_download: z.boolean().optional()}); export const pipelineBuildResponseMetadata = z.object({workspace: workspaceResponse, pipeline: pipelineResponse.nullable().optional(), stack: stackResponse.nullable().optional(), images: z.record(z.string(), buildItem).optional(), zenml_version: z.string().nullable().optional(), python_version: z.string().nullable().optional(), checksum: z.string().nullable().optional(), stack_checksum: z.string().nullable().optional(), is_local: z.boolean(), contains_code: z.boolean()}); export const pipelineBuildResponseResources = z.record(z.string(), z.unknown()); export const pipelineBuildResponse = z.object({body: pipelineBuildResponseBody.nullable().optional(), metadata: pipelineBuildResponseMetadata.nullable().optional(), resources: pipelineBuildResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional()}); export const scheduleResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), active: z.boolean(), cron_expression: z.string().nullable().optional(), start_time: z.string().nullable().optional(), end_time: z.string().nullable().optional(), interval_second: z.string().nullable().optional(), catchup: z.boolean().optional(), run_once_start_time: z.string().nullable().optional()}); export const scheduleResponseMetadata = z.object({workspace: workspaceResponse, orchestrator_id: z.string().nullable(), pipeline_id: z.string().nullable()}); export const scheduleResponseResources = z.record(z.string(), z.unknown()); export const scheduleResponse = z.object({body: scheduleResponseBody.nullable().optional(), metadata: scheduleResponseMetadata.nullable().optional(), resources: scheduleResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const codeRepositoryResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), source: source, logo_url: z.string().nullable().optional()}); export const codeRepositoryResponseMetadata = z.object({workspace: workspaceResponse, config: z.object({}), description: z.string().max(65535).nullable().optional()}); export const codeRepositoryResponseResources = z.record(z.string(), z.unknown()); export const codeRepositoryResponse = z.object({body: codeRepositoryResponseBody.nullable().optional(), metadata: codeRepositoryResponseMetadata.nullable().optional(), resources: codeRepositoryResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const codeReferenceResponseBody = z.object({created: z.string(), updated: z.string(), commit: z.string(), subdirectory: z.string(), code_repository: codeRepositoryResponse}); export const codeReferenceResponseMetadata = z.object({}); export const codeReferenceResponseResources = z.record(z.string(), z.unknown()); export const codeReferenceResponse = z.object({body: codeReferenceResponseBody.nullable().optional(), metadata: codeReferenceResponseMetadata.nullable().optional(), resources: codeReferenceResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional()}); export const pipelineDeploymentResponseMetadata = z.object({workspace: workspaceResponse, run_name_template: z.string(), pipeline_configuration: pipelineConfigurationOutput, step_configurations: z.record(z.string(), stepOutput).optional(), client_environment: z.record(z.string(), z.string()).optional(), client_version: z.string().nullable(), server_version: z.string().nullable(), pipeline_version_hash: z.string().nullable().optional(), pipeline_spec: pipelineSpecOutput.nullable().optional(), code_path: z.string().nullable().optional(), pipeline: pipelineResponse.nullable().optional(), stack: stackResponse.nullable().optional(), build: pipelineBuildResponse.nullable().optional(), schedule: scheduleResponse.nullable().optional(), code_reference: codeReferenceResponse.nullable().optional(), template_id: z.string().nullable().optional()}); export const triggerResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), action_flavor: z.string().max(255), action_subtype: z.string(), event_source_flavor: z.string().max(255).nullable().optional(), event_source_subtype: z.string().max(255).nullable().optional(), is_active: z.boolean()}); export const schedule = z.object({name: z.string().nullable().optional(), cron_expression: z.string().nullable().optional(), start_time: z.string().nullable().optional(), end_time: z.string().nullable().optional(), interval_second: z.string().nullable().optional(), catchup: z.boolean().optional(), run_once_start_time: z.string().nullable().optional()}); export const triggerResponseMetadata = z.object({workspace: workspaceResponse, description: z.string().max(255).optional(), event_filter: z.object({}).nullable().optional(), schedule: schedule.nullable().optional()}); export const actionResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), flavor: z.string().max(255), plugin_subtype: z.enum(["webhook", "pipeline_run"]).max(255)}); export const actionResponseMetadata = z.object({workspace: workspaceResponse, description: z.string().max(255).optional(), configuration: z.object({}), auth_window: z.number().int()}); export const actionResponseResources = z.object({service_account: userResponse}).and(z.record(z.string(), z.unknown())); export const actionResponse = z.object({body: actionResponseBody.nullable().optional(), metadata: actionResponseMetadata.nullable().optional(), resources: actionResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const zenmlEnumsPluginSubType2 = z.enum(["webhook", "pipeline_run"]); export const eventSourceResponseBody = z.object({created: z.string(), updated: z.string(), user: userResponse.nullable().optional(), flavor: z.string().max(255), plugin_subtype: zenmlEnumsPluginSubType2, is_active: z.boolean()}); export const eventSourceResponseMetadata = z.object({workspace: workspaceResponse, description: z.string().max(255).optional(), configuration: z.object({})}); export const eventSourceResponseResources = z.object({triggers: z.lazy(() => pageTriggerResponse)}).and(z.record(z.string(), z.unknown())); export const eventSourceResponse = z.object({body: eventSourceResponseBody.nullable().optional(), metadata: eventSourceResponseMetadata.nullable().optional(), resources: eventSourceResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const triggerExecutionResponseBody = z.object({created: z.string(), updated: z.string()}); export const triggerExecutionResponseMetadata = z.object({event_metadata: z.object({}).optional()}); export const triggerExecutionResponseResources = z.object({trigger: z.lazy(() => triggerResponse)}).and(z.record(z.string(), z.unknown())); export const triggerExecutionResponse = z.object({body: triggerExecutionResponseBody.nullable().optional(), metadata: triggerExecutionResponseMetadata.nullable().optional(), resources: triggerExecutionResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional()}); export const pageTriggerExecutionResponse = z.object({index: z.number().int().gt(0), max_size: z.number().int().gt(0), total_pages: z.number().int().gte(0), total: z.number().int().gte(0), items: z.array(triggerExecutionResponse)}); export const triggerResponseResources = z.object({action: actionResponse, event_source: eventSourceResponse.nullable().optional(), executions: pageTriggerExecutionResponse}).and(z.record(z.string(), z.unknown())); export const triggerResponse: z.ZodType = z.object({body: triggerResponseBody.nullable().optional(), metadata: triggerResponseMetadata.nullable().optional(), resources: triggerResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional(), name: z.string().max(255)}); export const pageTriggerResponse: z.ZodType = z.object({index: z.number().int().gt(0), max_size: z.number().int().gt(0), total_pages: z.number().int().gte(0), total: z.number().int().gte(0), items: z.array(triggerResponse)}); export const pipelineDeploymentResponseResources = z.object({triggers: pageTriggerResponse}).and(z.record(z.string(), z.unknown())); export const pipelineDeploymentResponse = z.object({body: pipelineDeploymentResponseBody.nullable().optional(), metadata: pipelineDeploymentResponseMetadata.nullable().optional(), resources: pipelineDeploymentResponseResources.nullable().optional(), id: z.string(), permission_denied: z.boolean().optional()}); export const pagePipelineDeploymentResponse = z.object({index: z.number().int().gt(0), max_size: z.number().int().gt(0), total_pages: z.number().int().gte(0), total: z.number().int().gte(0), items: z.array(pipelineDeploymentResponse)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List Deployments * * GET /api/v1/pipeline_deployments */ export const getApiApiV1PipelineDeployments = async (args: GetApiApiV1PipelineDeploymentsArgs, options: GetApiApiV1PipelineDeploymentsOptions) => { const {baseUrl, fetch: fetchFn = fetch, CookieOAuth2TokenBearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.hydrate != null) query.append("hydrate", String(args.hydrate)) if (args.sort_by != null) query.append("sort_by", String(args.sort_by)) if (args.logical_operator != null) query.append("logical_operator", String(args.logical_operator)) if (args.page != null) query.append("page", String(args.page)) if (args.size != null) query.append("size", String(args.size)) if (args.id != null) query.append("id", String(args.id)) if (args.created != null) query.append("created", String(args.created)) if (args.updated != null) query.append("updated", String(args.updated)) if (args.scope_workspace != null) query.append("scope_workspace", String(args.scope_workspace)) if (args.workspace_id != null) query.append("workspace_id", String(args.workspace_id)) if (args.user_id != null) query.append("user_id", String(args.user_id)) if (args.pipeline_id != null) query.append("pipeline_id", String(args.pipeline_id)) if (args.stack_id != null) query.append("stack_id", String(args.stack_id)) if (args.build_id != null) query.append("build_id", String(args.build_id)) if (args.schedule_id != null) query.append("schedule_id", String(args.schedule_id)) if (args.template_id != null) query.append("template_id", String(args.template_id)) if (CookieOAuth2TokenBearer !== undefined) headers.set('authorization', `Bearer ${CookieOAuth2TokenBearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/pipeline_deployments${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(pagePipelineDeploymentResponse, await res.json()) };