import type { RawAxiosRequestHeaders } from 'axios'; import type { GetWorkflowDefinitionParams, GetSpaceEnvironmentParams, CollectionProp } from '../../common-types'; import type { OptionalDefaults } from '../wrappers/wrap'; import type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, DeleteWorkflowDefinitionParams, UpdateWorkflowDefinitionParams, UpdateWorkflowDefinitionProps, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions } from '../../entities/workflow-definition'; export type WorkflowDefinitionPlainClientAPI = { /** * Fetch a Workflow Definition * @param params entity IDs to identify the Workflow Definition * @returns the Workflow Definition * @throws if the request fails, or the Space/Environment is not found * @example * ```javascript * const workflowDefinition = await client.workflowDefinition.get({ * spaceId: '', * environmentId: '', * workflowDefinitionId: '', * }); * ``` */ get(params: OptionalDefaults, headers?: RawAxiosRequestHeaders): Promise; /** * Query Workflow Definitions with certain filters * @param params entity IDs to identify the Space/Environment, optional query parameters to filter returned Workflow Definitions * @returns an object containing the list of Workflow Definitions * @throws if the request fails, or the Space/Environment is not found * @example * ```javascript * const workflowDefinitions = await client.workflowDefinition.getMany({ * spaceId: '', * environmentId: '', * query: { * limit: 10, * } * }); * ``` * */ getMany(params: OptionalDefaults, headers?: RawAxiosRequestHeaders): Promise>; /** * Create a new Workflow Definition * @param params entity IDs to identify the Space/Environment to create the Workflow Definition in * @param rawData the new Workflow Definition * @throws if the request fails, or the Space/Environment is not found * @example * ```javascript * const workflowDefinition = await client.workflowDefinition.create({ * spaceId: '', * environmentId: '', * }, workflowDefinitionProps); * ``` */ create(params: OptionalDefaults, rawData: CreateWorkflowDefinitionProps, headers?: RawAxiosRequestHeaders): Promise; /** * Update a Workflow Definition * @param params entity IDs to identify the Space/Environment and Workflow Definition * @param rawData the updated Workflow Definition * @throws if the request fails, or the Space/Environment is not found * @example * ```javascript * const updatedWorkflowDefinition = await client.workflowDefinition.update({ * spaceId: '', * environmentId: '', * workflowDefinitionId: '', * }, { * ...workflowDefinition, * steps: [ * ...workflowDefinition.steps, * newStep, * ] * }); * ``` */ update(params: OptionalDefaults, rawData: UpdateWorkflowDefinitionProps, headers?: RawAxiosRequestHeaders): Promise; /** * Delete a Workflow Definition * @param params entity IDs to identify the Space/Environment and Workflow Definition version * @throws if the request fails, or the Space/Environment is not found * @example * ```javascript * await client.workflowDefinition.delete({ * spaceId: '', * environmentId: '', * workflowDefinitionId: '', * version: 1 * }); * ``` */ delete(params: OptionalDefaults, headers?: RawAxiosRequestHeaders): Promise; };