/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments"; import * as core from "../../../../core"; import * as Vellum from "../../../index"; export declare namespace WorkflowDeployments { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; apiKey: core.Supplier; /** Override the X-API-Version header */ apiVersion?: core.Supplier; } interface RequestOptions { /** The maximum time to wait for a response in seconds. */ timeoutInSeconds?: number; /** The number of times to retry the request. Defaults to 2. */ maxRetries?: number; /** A hook to abort the request. */ abortSignal?: AbortSignal; /** Override the X-API-Version header */ apiVersion?: Vellum.ApiVersionEnum | undefined; /** Additional headers to include in the request. */ headers?: Record; } } export declare class WorkflowDeployments { protected readonly _options: WorkflowDeployments.Options; constructor(_options: WorkflowDeployments.Options); /** * Used to list all Workflow Deployments. * * @param {Vellum.WorkflowDeploymentsListRequest} request * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.list() */ list(request?: Vellum.WorkflowDeploymentsListRequest, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __list; /** * Used to retrieve a workflow deployment given its ID or name. * * @param {string} id - Either the Workflow Deployment's ID or its unique name * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.retrieve("id") */ retrieve(id: string, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __retrieve; /** * Executes a deployed Workflow and streams back its results. */ executeStream(id: string, request?: Vellum.ExecuteWorkflowDeploymentStreamRequest, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise>; private __executeStream; /** * @param {string} id * @param {Vellum.ListWorkflowDeploymentEventExecutionsRequest} request * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.listWorkflowDeploymentEventExecutions("id") */ listWorkflowDeploymentEventExecutions(id: string, request?: Vellum.ListWorkflowDeploymentEventExecutionsRequest, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __listWorkflowDeploymentEventExecutions; /** * @param {string} executionId * @param {string} id * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Vellum.BadRequestError} * @throws {@link Vellum.NotFoundError} * @throws {@link Vellum.MisdirectedRequestError} * * @example * await client.workflowDeployments.workflowDeploymentEventExecution("execution_id", "id") */ workflowDeploymentEventExecution(executionId: string, id: string, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __workflowDeploymentEventExecution; /** * DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the * `retrieve_workflow_deployment_release` endpoint instead. * * @param {string} historyIdOrReleaseTag - Either the UUID of Workflow Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment History Item you'd like to retrieve. * @param {string} id - Either the Workflow Deployment's ID or its unique name * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.workflowDeploymentHistoryItemRetrieve("history_id_or_release_tag", "id") */ workflowDeploymentHistoryItemRetrieve(historyIdOrReleaseTag: string, id: string, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __workflowDeploymentHistoryItemRetrieve; /** * List Release Tags associated with the specified Workflow Deployment * * @param {string} id - Either the Workflow Deployment's ID or its unique name * @param {Vellum.ListWorkflowReleaseTagsRequest} request * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.listWorkflowReleaseTags("id") */ listWorkflowReleaseTags(id: string, request?: Vellum.ListWorkflowReleaseTagsRequest, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __listWorkflowReleaseTags; /** * Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment. * * @param {string} id - Either the Workflow Deployment's ID or its unique name * @param {string} name - The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve. * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.retrieveWorkflowReleaseTag("id", "name") */ retrieveWorkflowReleaseTag(id: string, name: string, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __retrieveWorkflowReleaseTag; /** * Updates an existing Release Tag associated with the specified Workflow Deployment. * * @param {string} id - Either the Workflow Deployment's ID or its unique name * @param {string} name - The name of the Release Tag associated with this Workflow Deployment that you'd like to update. * @param {Vellum.PatchedWorkflowReleaseTagUpdateRequest} request * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.updateWorkflowReleaseTag("id", "name") */ updateWorkflowReleaseTag(id: string, name: string, request?: Vellum.PatchedWorkflowReleaseTagUpdateRequest, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __updateWorkflowReleaseTag; /** * List the Releases of the specified Workflow Deployment for the current Environment. * * @param {string} id - Either the Workflow Deployment's ID or its unique name * @param {Vellum.ListWorkflowDeploymentReleasesRequest} request * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.listWorkflowDeploymentReleases("id") */ listWorkflowDeploymentReleases(id: string, request?: Vellum.ListWorkflowDeploymentReleasesRequest, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __listWorkflowDeploymentReleases; /** * Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it. * * @param {string} id - Either the Workflow Deployment's ID or its unique name * @param {string} releaseIdOrReleaseTag - Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve. * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.workflowDeployments.retrieveWorkflowDeploymentRelease("id", "release_id_or_release_tag") */ retrieveWorkflowDeploymentRelease(id: string, releaseIdOrReleaseTag: string, requestOptions?: WorkflowDeployments.RequestOptions): core.HttpResponsePromise; private __retrieveWorkflowDeploymentRelease; protected _getCustomAuthorizationHeaders(): Promise<{ "X-API-KEY": string; }>; }