cloudflare/src/resources/workflows/instances/status.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../core/resource';
import { APIPromise } from '../../../core/api-promise';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseStatus extends APIResource {
  static override readonly _key: readonly ['workflows', 'instances', 'status'] = Object.freeze([
    'workflows',
    'instances',
    'status',
  ] as const);

  /**
   * Changes the execution status of a workflow instance (e.g., pause, resume,
   * terminate).
   */
  edit(
    instanceID: string,
    params: StatusEditParams,
    options?: RequestOptions,
  ): APIPromise<StatusEditResponse> {
    const { account_id, workflow_name, ...body } = params;
    return (
      this._client.patch(
        path`/accounts/${account_id}/workflows/${workflow_name}/instances/${instanceID}/status`,
        { body, ...options },
      ) as APIPromise<{ result: StatusEditResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Status extends BaseStatus {}

export interface StatusEditResponse {
  status:
    | 'queued'
    | 'running'
    | 'paused'
    | 'errored'
    | 'terminated'
    | 'complete'
    | 'waitingForPause'
    | 'waiting'
    | 'rollingBack';

  /**
   * Accepts ISO 8601 with no timezone offsets and in UTC.
   */
  timestamp: string;
}

export type StatusEditParams =
  | StatusEditParams.Variant0
  | StatusEditParams.Variant1
  | StatusEditParams.Variant2
  | StatusEditParams.Variant3;

export declare namespace StatusEditParams {
  export interface Variant0 {
    /**
     * Path param
     */
    account_id: string;

    /**
     * Path param
     */
    workflow_name: string;

    /**
     * Body param
     */
    status: 'pause';
  }

  export interface Variant1 {
    /**
     * Path param
     */
    account_id: string;

    /**
     * Path param
     */
    workflow_name: string;

    /**
     * Body param
     */
    status: 'resume';
  }

  export interface Variant2 {
    /**
     * Path param
     */
    account_id: string;

    /**
     * Path param
     */
    workflow_name: string;

    /**
     * Body param
     */
    status: 'terminate';

    /**
     * Body param: Run rollback before terminating.
     */
    rollback?: boolean;
  }

  export interface Variant3 {
    /**
     * Path param
     */
    account_id: string;

    /**
     * Path param
     */
    workflow_name: string;

    /**
     * Body param
     */
    status: 'restart';

    /**
     * Body param: Step to restart from.
     */
    from?: Variant3.From;
  }

  export namespace Variant3 {
    /**
     * Step to restart from.
     */
    export interface From {
      name: string;

      count?: number;

      type?: 'do' | 'sleep' | 'waitForEvent';
    }
  }
}

export declare namespace Status {
  export { type StatusEditResponse as StatusEditResponse, type StatusEditParams as StatusEditParams };
}