/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AutoLayoutWorkflowResponse, ConnectWorkflowStepResponse, CreateWorkflowStepResponse, DisconnectWorkflowStepResponse, GetWorkflowStepResponse, ListWorkflowStepsResponse, ResolveStepCollisionsResponse, UpdateWorkflowStepResponse, ValidateWorkflowResponse, WorkflowStepsServiceConnectStepBody, WorkflowStepsServiceCreateBody, WorkflowStepsServiceUpdateBody } from '../models/index'; export interface WorkflowStepsServiceAutoLayoutWorkflowRequest { linkId: string; body: object; } export interface WorkflowStepsServiceConnectStepRequest { linkId: string; stepId: string; branchId: string; workflowStepsServiceConnectStepBody: WorkflowStepsServiceConnectStepBody; } export interface WorkflowStepsServiceCreateRequest { linkId: string; workflowStepsServiceCreateBody: WorkflowStepsServiceCreateBody; } export interface WorkflowStepsServiceDeleteRequest { linkId: string; id: string; } export interface WorkflowStepsServiceDisconnectStepRequest { linkId: string; stepId: string; branchId: string; } export interface WorkflowStepsServiceGetRequest { linkId: string; id: string; } export interface WorkflowStepsServiceListRequest { linkId: string; pageSize?: number; pageToken?: string; } export interface WorkflowStepsServiceResolveStepCollisionsRequest { linkId: string; stepId: string; body: object; } export interface WorkflowStepsServiceUpdateRequest { linkId: string; id: string; workflowStepsServiceUpdateBody: WorkflowStepsServiceUpdateBody; } export interface WorkflowStepsServiceValidateWorkflowRequest { linkId: string; } /** * WorkflowStepsApi - interface * * @export * @interface WorkflowStepsApiInterface */ export interface WorkflowStepsApiInterface { /** * Creates request options for workflowStepsServiceAutoLayoutWorkflow without sending the request * @param {string} linkId * @param {object} body * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceAutoLayoutWorkflowRequestOpts(requestParameters: WorkflowStepsServiceAutoLayoutWorkflowRequest): Promise; /** * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch. * @summary Auto-layout workflow * @param {string} linkId * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceAutoLayoutWorkflowRaw(requestParameters: WorkflowStepsServiceAutoLayoutWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch. * Auto-layout workflow */ workflowStepsServiceAutoLayoutWorkflow(requestParameters: WorkflowStepsServiceAutoLayoutWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceConnectStep without sending the request * @param {string} linkId The ID of the link (UUID) * @param {string} stepId The ID of the step the connection leaves from (UUID) * @param {string} branchId Which exit of that step to connect. \"next\" for atomic steps, or a button id, option id, range id, country code, or \"else\" for composite steps. * @param {WorkflowStepsServiceConnectStepBody} workflowStepsServiceConnectStepBody * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceConnectStepRequestOpts(requestParameters: WorkflowStepsServiceConnectStepRequest): Promise; /** * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to. Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all. Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op. * @summary Connect one exit of a workflow step to another step * @param {string} linkId The ID of the link (UUID) * @param {string} stepId The ID of the step the connection leaves from (UUID) * @param {string} branchId Which exit of that step to connect. \"next\" for atomic steps, or a button id, option id, range id, country code, or \"else\" for composite steps. * @param {WorkflowStepsServiceConnectStepBody} workflowStepsServiceConnectStepBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceConnectStepRaw(requestParameters: WorkflowStepsServiceConnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to. Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all. Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op. * Connect one exit of a workflow step to another step */ workflowStepsServiceConnectStep(requestParameters: WorkflowStepsServiceConnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceCreate without sending the request * @param {string} linkId The ID of the link to create the workflow step for (UUID) * @param {WorkflowStepsServiceCreateBody} workflowStepsServiceCreateBody * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceCreateRequestOpts(requestParameters: WorkflowStepsServiceCreateRequest): Promise; /** * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations. * @summary Create a new workflow step * @param {string} linkId The ID of the link to create the workflow step for (UUID) * @param {WorkflowStepsServiceCreateBody} workflowStepsServiceCreateBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceCreateRaw(requestParameters: WorkflowStepsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations. * Create a new workflow step */ workflowStepsServiceCreate(requestParameters: WorkflowStepsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceDelete without sending the request * @param {string} linkId The ID of the link (UUID) * @param {string} id The ID of the workflow step to delete (UUID) * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceDeleteRequestOpts(requestParameters: WorkflowStepsServiceDeleteRequest): Promise; /** * Removes a workflow step from the link. This operation cannot be undone. * @summary Delete a workflow step * @param {string} linkId The ID of the link (UUID) * @param {string} id The ID of the workflow step to delete (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceDeleteRaw(requestParameters: WorkflowStepsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes a workflow step from the link. This operation cannot be undone. * Delete a workflow step */ workflowStepsServiceDelete(requestParameters: WorkflowStepsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceDisconnectStep without sending the request * @param {string} linkId The ID of the link (UUID) * @param {string} stepId The ID of the step the connection leaves from (UUID) * @param {string} branchId Which exit of that step to clear. See ConnectWorkflowStepRequest.branch_id. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceDisconnectStepRequestOpts(requestParameters: WorkflowStepsServiceDisconnectStepRequest): Promise; /** * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is. * @summary Clear one exit of a workflow step * @param {string} linkId The ID of the link (UUID) * @param {string} stepId The ID of the step the connection leaves from (UUID) * @param {string} branchId Which exit of that step to clear. See ConnectWorkflowStepRequest.branch_id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceDisconnectStepRaw(requestParameters: WorkflowStepsServiceDisconnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is. * Clear one exit of a workflow step */ workflowStepsServiceDisconnectStep(requestParameters: WorkflowStepsServiceDisconnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceGet without sending the request * @param {string} linkId The ID of the link (UUID) * @param {string} id The ID of the workflow step to retrieve (UUID) * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceGetRequestOpts(requestParameters: WorkflowStepsServiceGetRequest): Promise; /** * Retrieves information about a specific workflow step. * @summary Get workflow step details * @param {string} linkId The ID of the link (UUID) * @param {string} id The ID of the workflow step to retrieve (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceGetRaw(requestParameters: WorkflowStepsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves information about a specific workflow step. * Get workflow step details */ workflowStepsServiceGet(requestParameters: WorkflowStepsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceList without sending the request * @param {string} linkId The ID of the link to list workflow steps for (UUID) * @param {number} [pageSize] The maximum number of workflow steps to return (optional) * @param {string} [pageToken] The token for retrieving the next page of results (optional) * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceListRequestOpts(requestParameters: WorkflowStepsServiceListRequest): Promise; /** * Retrieves all workflow steps for a specific link * @summary List workflow steps for a link * @param {string} linkId The ID of the link to list workflow steps for (UUID) * @param {number} [pageSize] The maximum number of workflow steps to return (optional) * @param {string} [pageToken] The token for retrieving the next page of results (optional) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceListRaw(requestParameters: WorkflowStepsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves all workflow steps for a specific link * List workflow steps for a link */ workflowStepsServiceList(requestParameters: WorkflowStepsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceResolveStepCollisions without sending the request * @param {string} linkId * @param {string} stepId * @param {object} body * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceResolveStepCollisionsRequestOpts(requestParameters: WorkflowStepsServiceResolveStepCollisionsRequest): Promise; /** * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout. * @summary Resolve step collisions * @param {string} linkId * @param {string} stepId * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceResolveStepCollisionsRaw(requestParameters: WorkflowStepsServiceResolveStepCollisionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout. * Resolve step collisions */ workflowStepsServiceResolveStepCollisions(requestParameters: WorkflowStepsServiceResolveStepCollisionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceUpdate without sending the request * @param {string} linkId The ID of the link (UUID) * @param {string} id The ID of the workflow step to update (UUID) * @param {WorkflowStepsServiceUpdateBody} workflowStepsServiceUpdateBody * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceUpdateRequestOpts(requestParameters: WorkflowStepsServiceUpdateRequest): Promise; /** * Updates an existing workflow step for a link. * @summary Update a workflow step * @param {string} linkId The ID of the link (UUID) * @param {string} id The ID of the workflow step to update (UUID) * @param {WorkflowStepsServiceUpdateBody} workflowStepsServiceUpdateBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceUpdateRaw(requestParameters: WorkflowStepsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates an existing workflow step for a link. * Update a workflow step */ workflowStepsServiceUpdate(requestParameters: WorkflowStepsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceValidateWorkflow without sending the request * @param {string} linkId * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceValidateWorkflowRequestOpts(requestParameters: WorkflowStepsServiceValidateWorkflowRequest): Promise; /** * * @param {string} linkId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkflowStepsApiInterface */ workflowStepsServiceValidateWorkflowRaw(requestParameters: WorkflowStepsServiceValidateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ workflowStepsServiceValidateWorkflow(requestParameters: WorkflowStepsServiceValidateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class WorkflowStepsApi extends runtime.BaseAPI implements WorkflowStepsApiInterface { /** * Creates request options for workflowStepsServiceAutoLayoutWorkflow without sending the request */ workflowStepsServiceAutoLayoutWorkflowRequestOpts(requestParameters: WorkflowStepsServiceAutoLayoutWorkflowRequest): Promise; /** * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch. * Auto-layout workflow */ workflowStepsServiceAutoLayoutWorkflowRaw(requestParameters: WorkflowStepsServiceAutoLayoutWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Arranges all workflow steps in a clean left-to-right DAG layout. Useful after building a workflow from scratch. * Auto-layout workflow */ workflowStepsServiceAutoLayoutWorkflow(requestParameters: WorkflowStepsServiceAutoLayoutWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceConnectStep without sending the request */ workflowStepsServiceConnectStepRequestOpts(requestParameters: WorkflowStepsServiceConnectStepRequest): Promise; /** * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to. Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all. Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op. * Connect one exit of a workflow step to another step */ workflowStepsServiceConnectStepRaw(requestParameters: WorkflowStepsServiceConnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Every workflow step is connected the same way: name the branch it leaves from, and the step it leads to. Atomic steps (redirect, password, form, message page) have exactly one branch, \"next\". Composite steps (multi-link, conditions) have one branch per button, option or range, plus \"else\" for a condition\'s fallback. Exit steps end the journey and have no branches at all. Read a step to see its branches, their ids and their current destinations. Idempotent: connecting a branch to the step it already leads to is a no-op. * Connect one exit of a workflow step to another step */ workflowStepsServiceConnectStep(requestParameters: WorkflowStepsServiceConnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceCreate without sending the request */ workflowStepsServiceCreateRequestOpts(requestParameters: WorkflowStepsServiceCreateRequest): Promise; /** * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations. * Create a new workflow step */ workflowStepsServiceCreateRaw(requestParameters: WorkflowStepsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows users to create a new workflow step for a link. Workflow steps define the behavior of links, such as redirection destinations. * Create a new workflow step */ workflowStepsServiceCreate(requestParameters: WorkflowStepsServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceDelete without sending the request */ workflowStepsServiceDeleteRequestOpts(requestParameters: WorkflowStepsServiceDeleteRequest): Promise; /** * Removes a workflow step from the link. This operation cannot be undone. * Delete a workflow step */ workflowStepsServiceDeleteRaw(requestParameters: WorkflowStepsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes a workflow step from the link. This operation cannot be undone. * Delete a workflow step */ workflowStepsServiceDelete(requestParameters: WorkflowStepsServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceDisconnectStep without sending the request */ workflowStepsServiceDisconnectStepRequestOpts(requestParameters: WorkflowStepsServiceDisconnectStepRequest): Promise; /** * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is. * Clear one exit of a workflow step */ workflowStepsServiceDisconnectStepRaw(requestParameters: WorkflowStepsServiceDisconnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Leaves the branch with no destination. Clearing a branch that is already clear succeeds. See ConnectStep for what a branch id is. * Clear one exit of a workflow step */ workflowStepsServiceDisconnectStep(requestParameters: WorkflowStepsServiceDisconnectStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceGet without sending the request */ workflowStepsServiceGetRequestOpts(requestParameters: WorkflowStepsServiceGetRequest): Promise; /** * Retrieves information about a specific workflow step. * Get workflow step details */ workflowStepsServiceGetRaw(requestParameters: WorkflowStepsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves information about a specific workflow step. * Get workflow step details */ workflowStepsServiceGet(requestParameters: WorkflowStepsServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceList without sending the request */ workflowStepsServiceListRequestOpts(requestParameters: WorkflowStepsServiceListRequest): Promise; /** * Retrieves all workflow steps for a specific link * List workflow steps for a link */ workflowStepsServiceListRaw(requestParameters: WorkflowStepsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves all workflow steps for a specific link * List workflow steps for a link */ workflowStepsServiceList(requestParameters: WorkflowStepsServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceResolveStepCollisions without sending the request */ workflowStepsServiceResolveStepCollisionsRequestOpts(requestParameters: WorkflowStepsServiceResolveStepCollisionsRequest): Promise; /** * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout. * Resolve step collisions */ workflowStepsServiceResolveStepCollisionsRaw(requestParameters: WorkflowStepsServiceResolveStepCollisionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Pushes overlapping steps away from a given anchor step using iterative radial repulsion. The anchor step stays fixed. Use after adding or moving individual steps to preserve the existing layout. * Resolve step collisions */ workflowStepsServiceResolveStepCollisions(requestParameters: WorkflowStepsServiceResolveStepCollisionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceUpdate without sending the request */ workflowStepsServiceUpdateRequestOpts(requestParameters: WorkflowStepsServiceUpdateRequest): Promise; /** * Updates an existing workflow step for a link. * Update a workflow step */ workflowStepsServiceUpdateRaw(requestParameters: WorkflowStepsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates an existing workflow step for a link. * Update a workflow step */ workflowStepsServiceUpdate(requestParameters: WorkflowStepsServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workflowStepsServiceValidateWorkflow without sending the request */ workflowStepsServiceValidateWorkflowRequestOpts(requestParameters: WorkflowStepsServiceValidateWorkflowRequest): Promise; /** */ workflowStepsServiceValidateWorkflowRaw(requestParameters: WorkflowStepsServiceValidateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ workflowStepsServiceValidateWorkflow(requestParameters: WorkflowStepsServiceValidateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }