cloudflare/src/resources/queues/subscriptions.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 '../../resource';
import * as Core from '../../core';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';

export class Subscriptions extends APIResource {
  /**
   * Create a new event subscription for a queue
   *
   * @example
   * ```ts
   * const subscription =
   *   await client.queues.subscriptions.create({
   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   *   });
   * ```
   */
  create(
    params: SubscriptionCreateParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<SubscriptionCreateResponse> {
    const { account_id, ...body } = params;
    return (
      this._client.post(`/accounts/${account_id}/event_subscriptions/subscriptions`, {
        body,
        ...options,
      }) as Core.APIPromise<{ result: SubscriptionCreateResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Update an existing event subscription
   *
   * @example
   * ```ts
   * const subscription =
   *   await client.queues.subscriptions.update(
   *     '023e105f4ecef8ad9ca31a8372d0c353',
   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  update(
    subscriptionId: string,
    params: SubscriptionUpdateParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<SubscriptionUpdateResponse> {
    const { account_id, ...body } = params;
    return (
      this._client.patch(`/accounts/${account_id}/event_subscriptions/subscriptions/${subscriptionId}`, {
        body,
        ...options,
      }) as Core.APIPromise<{ result: SubscriptionUpdateResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Get a paginated list of event subscriptions with optional sorting and filtering
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const subscriptionListResponse of client.queues.subscriptions.list(
   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   * )) {
   *   // ...
   * }
   * ```
   */
  list(
    params: SubscriptionListParams,
    options?: Core.RequestOptions,
  ): Core.PagePromise<SubscriptionListResponsesV4PagePaginationArray, SubscriptionListResponse> {
    const { account_id, ...query } = params;
    return this._client.getAPIList(
      `/accounts/${account_id}/event_subscriptions/subscriptions`,
      SubscriptionListResponsesV4PagePaginationArray,
      { query, ...options },
    );
  }

  /**
   * Delete an existing event subscription
   *
   * @example
   * ```ts
   * const subscription =
   *   await client.queues.subscriptions.delete(
   *     '023e105f4ecef8ad9ca31a8372d0c353',
   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   * ```
   */
  delete(
    subscriptionId: string,
    params: SubscriptionDeleteParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<SubscriptionDeleteResponse> {
    const { account_id } = params;
    return (
      this._client.delete(
        `/accounts/${account_id}/event_subscriptions/subscriptions/${subscriptionId}`,
        options,
      ) as Core.APIPromise<{ result: SubscriptionDeleteResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}

export class SubscriptionListResponsesV4PagePaginationArray extends V4PagePaginationArray<SubscriptionListResponse> {}

export interface SubscriptionCreateResponse {
  /**
   * Unique identifier for the subscription
   */
  id: string;

  /**
   * When the subscription was created
   */
  created_at: string;

  /**
   * Destination configuration for the subscription
   */
  destination: SubscriptionCreateResponse.Destination;

  /**
   * Whether the subscription is active
   */
  enabled: boolean;

  /**
   * List of event types this subscription handles
   */
  events: Array<string>;

  /**
   * When the subscription was last modified
   */
  modified_at: string;

  /**
   * Name of the subscription
   */
  name: string;

  /**
   * Source configuration for the subscription
   */
  source:
    | SubscriptionCreateResponse.MqEventSourceImages
    | SubscriptionCreateResponse.MqEventSourceKV
    | SubscriptionCreateResponse.MqEventSourceR2
    | SubscriptionCreateResponse.MqEventSourceSuperSlurper
    | SubscriptionCreateResponse.MqEventSourceVectorize
    | SubscriptionCreateResponse.MqEventSourceWorkersAIModel
    | SubscriptionCreateResponse.MqEventSourceWorkersBuildsWorker
    | SubscriptionCreateResponse.MqEventSourceWorkflowsWorkflow;
}

export namespace SubscriptionCreateResponse {
  /**
   * Destination configuration for the subscription
   */
  export interface Destination {
    /**
     * ID of the target queue
     */
    queue_id: string;

    /**
     * Type of destination
     */
    type: 'queues.queue';
  }

  export interface MqEventSourceImages {
    /**
     * Type of source
     */
    type?: 'images';
  }

  export interface MqEventSourceKV {
    /**
     * Type of source
     */
    type?: 'kv';
  }

  export interface MqEventSourceR2 {
    /**
     * Type of source
     */
    type?: 'r2';
  }

  export interface MqEventSourceSuperSlurper {
    /**
     * Type of source
     */
    type?: 'superSlurper';
  }

  export interface MqEventSourceVectorize {
    /**
     * Type of source
     */
    type?: 'vectorize';
  }

  export interface MqEventSourceWorkersAIModel {
    /**
     * Name of the Workers AI model
     */
    model_name?: string;

    /**
     * Type of source
     */
    type?: 'workersAi.model';
  }

  export interface MqEventSourceWorkersBuildsWorker {
    /**
     * Type of source
     */
    type?: 'workersBuilds.worker';

    /**
     * Name of the worker
     */
    worker_name?: string;
  }

  export interface MqEventSourceWorkflowsWorkflow {
    /**
     * Type of source
     */
    type?: 'workflows.workflow';

    /**
     * Name of the workflow
     */
    workflow_name?: string;
  }
}

export interface SubscriptionUpdateResponse {
  /**
   * Unique identifier for the subscription
   */
  id: string;

  /**
   * When the subscription was created
   */
  created_at: string;

  /**
   * Destination configuration for the subscription
   */
  destination: SubscriptionUpdateResponse.Destination;

  /**
   * Whether the subscription is active
   */
  enabled: boolean;

  /**
   * List of event types this subscription handles
   */
  events: Array<string>;

  /**
   * When the subscription was last modified
   */
  modified_at: string;

  /**
   * Name of the subscription
   */
  name: string;

  /**
   * Source configuration for the subscription
   */
  source:
    | SubscriptionUpdateResponse.MqEventSourceImages
    | SubscriptionUpdateResponse.MqEventSourceKV
    | SubscriptionUpdateResponse.MqEventSourceR2
    | SubscriptionUpdateResponse.MqEventSourceSuperSlurper
    | SubscriptionUpdateResponse.MqEventSourceVectorize
    | SubscriptionUpdateResponse.MqEventSourceWorkersAIModel
    | SubscriptionUpdateResponse.MqEventSourceWorkersBuildsWorker
    | SubscriptionUpdateResponse.MqEventSourceWorkflowsWorkflow;
}

export namespace SubscriptionUpdateResponse {
  /**
   * Destination configuration for the subscription
   */
  export interface Destination {
    /**
     * ID of the target queue
     */
    queue_id: string;

    /**
     * Type of destination
     */
    type: 'queues.queue';
  }

  export interface MqEventSourceImages {
    /**
     * Type of source
     */
    type?: 'images';
  }

  export interface MqEventSourceKV {
    /**
     * Type of source
     */
    type?: 'kv';
  }

  export interface MqEventSourceR2 {
    /**
     * Type of source
     */
    type?: 'r2';
  }

  export interface MqEventSourceSuperSlurper {
    /**
     * Type of source
     */
    type?: 'superSlurper';
  }

  export interface MqEventSourceVectorize {
    /**
     * Type of source
     */
    type?: 'vectorize';
  }

  export interface MqEventSourceWorkersAIModel {
    /**
     * Name of the Workers AI model
     */
    model_name?: string;

    /**
     * Type of source
     */
    type?: 'workersAi.model';
  }

  export interface MqEventSourceWorkersBuildsWorker {
    /**
     * Type of source
     */
    type?: 'workersBuilds.worker';

    /**
     * Name of the worker
     */
    worker_name?: string;
  }

  export interface MqEventSourceWorkflowsWorkflow {
    /**
     * Type of source
     */
    type?: 'workflows.workflow';

    /**
     * Name of the workflow
     */
    workflow_name?: string;
  }
}

export interface SubscriptionListResponse {
  /**
   * Unique identifier for the subscription
   */
  id: string;

  /**
   * When the subscription was created
   */
  created_at: string;

  /**
   * Destination configuration for the subscription
   */
  destination: SubscriptionListResponse.Destination;

  /**
   * Whether the subscription is active
   */
  enabled: boolean;

  /**
   * List of event types this subscription handles
   */
  events: Array<string>;

  /**
   * When the subscription was last modified
   */
  modified_at: string;

  /**
   * Name of the subscription
   */
  name: string;

  /**
   * Source configuration for the subscription
   */
  source:
    | SubscriptionListResponse.MqEventSourceImages
    | SubscriptionListResponse.MqEventSourceKV
    | SubscriptionListResponse.MqEventSourceR2
    | SubscriptionListResponse.MqEventSourceSuperSlurper
    | SubscriptionListResponse.MqEventSourceVectorize
    | SubscriptionListResponse.MqEventSourceWorkersAIModel
    | SubscriptionListResponse.MqEventSourceWorkersBuildsWorker
    | SubscriptionListResponse.MqEventSourceWorkflowsWorkflow;
}

export namespace SubscriptionListResponse {
  /**
   * Destination configuration for the subscription
   */
  export interface Destination {
    /**
     * ID of the target queue
     */
    queue_id: string;

    /**
     * Type of destination
     */
    type: 'queues.queue';
  }

  export interface MqEventSourceImages {
    /**
     * Type of source
     */
    type?: 'images';
  }

  export interface MqEventSourceKV {
    /**
     * Type of source
     */
    type?: 'kv';
  }

  export interface MqEventSourceR2 {
    /**
     * Type of source
     */
    type?: 'r2';
  }

  export interface MqEventSourceSuperSlurper {
    /**
     * Type of source
     */
    type?: 'superSlurper';
  }

  export interface MqEventSourceVectorize {
    /**
     * Type of source
     */
    type?: 'vectorize';
  }

  export interface MqEventSourceWorkersAIModel {
    /**
     * Name of the Workers AI model
     */
    model_name?: string;

    /**
     * Type of source
     */
    type?: 'workersAi.model';
  }

  export interface MqEventSourceWorkersBuildsWorker {
    /**
     * Type of source
     */
    type?: 'workersBuilds.worker';

    /**
     * Name of the worker
     */
    worker_name?: string;
  }

  export interface MqEventSourceWorkflowsWorkflow {
    /**
     * Type of source
     */
    type?: 'workflows.workflow';

    /**
     * Name of the workflow
     */
    workflow_name?: string;
  }
}

export interface SubscriptionDeleteResponse {
  /**
   * Unique identifier for the subscription
   */
  id: string;

  /**
   * When the subscription was created
   */
  created_at: string;

  /**
   * Destination configuration for the subscription
   */
  destination: SubscriptionDeleteResponse.Destination;

  /**
   * Whether the subscription is active
   */
  enabled: boolean;

  /**
   * List of event types this subscription handles
   */
  events: Array<string>;

  /**
   * When the subscription was last modified
   */
  modified_at: string;

  /**
   * Name of the subscription
   */
  name: string;

  /**
   * Source configuration for the subscription
   */
  source:
    | SubscriptionDeleteResponse.MqEventSourceImages
    | SubscriptionDeleteResponse.MqEventSourceKV
    | SubscriptionDeleteResponse.MqEventSourceR2
    | SubscriptionDeleteResponse.MqEventSourceSuperSlurper
    | SubscriptionDeleteResponse.MqEventSourceVectorize
    | SubscriptionDeleteResponse.MqEventSourceWorkersAIModel
    | SubscriptionDeleteResponse.MqEventSourceWorkersBuildsWorker
    | SubscriptionDeleteResponse.MqEventSourceWorkflowsWorkflow;
}

export namespace SubscriptionDeleteResponse {
  /**
   * Destination configuration for the subscription
   */
  export interface Destination {
    /**
     * ID of the target queue
     */
    queue_id: string;

    /**
     * Type of destination
     */
    type: 'queues.queue';
  }

  export interface MqEventSourceImages {
    /**
     * Type of source
     */
    type?: 'images';
  }

  export interface MqEventSourceKV {
    /**
     * Type of source
     */
    type?: 'kv';
  }

  export interface MqEventSourceR2 {
    /**
     * Type of source
     */
    type?: 'r2';
  }

  export interface MqEventSourceSuperSlurper {
    /**
     * Type of source
     */
    type?: 'superSlurper';
  }

  export interface MqEventSourceVectorize {
    /**
     * Type of source
     */
    type?: 'vectorize';
  }

  export interface MqEventSourceWorkersAIModel {
    /**
     * Name of the Workers AI model
     */
    model_name?: string;

    /**
     * Type of source
     */
    type?: 'workersAi.model';
  }

  export interface MqEventSourceWorkersBuildsWorker {
    /**
     * Type of source
     */
    type?: 'workersBuilds.worker';

    /**
     * Name of the worker
     */
    worker_name?: string;
  }

  export interface MqEventSourceWorkflowsWorkflow {
    /**
     * Type of source
     */
    type?: 'workflows.workflow';

    /**
     * Name of the workflow
     */
    workflow_name?: string;
  }
}

export interface SubscriptionCreateParams {
  /**
   * Path param: A Resource identifier.
   */
  account_id: string;

  /**
   * Body param: Destination configuration for the subscription
   */
  destination?: SubscriptionCreateParams.Destination;

  /**
   * Body param: Whether the subscription is active
   */
  enabled?: boolean;

  /**
   * Body param: List of event types this subscription handles
   */
  events?: Array<string>;

  /**
   * Body param: Name of the subscription
   */
  name?: string;

  /**
   * Body param: Source configuration for the subscription
   */
  source?:
    | SubscriptionCreateParams.MqEventSourceImages
    | SubscriptionCreateParams.MqEventSourceKV
    | SubscriptionCreateParams.MqEventSourceR2
    | SubscriptionCreateParams.MqEventSourceSuperSlurper
    | SubscriptionCreateParams.MqEventSourceVectorize
    | SubscriptionCreateParams.MqEventSourceWorkersAIModel
    | SubscriptionCreateParams.MqEventSourceWorkersBuildsWorker
    | SubscriptionCreateParams.MqEventSourceWorkflowsWorkflow;
}

export namespace SubscriptionCreateParams {
  /**
   * Destination configuration for the subscription
   */
  export interface Destination {
    /**
     * ID of the target queue
     */
    queue_id: string;

    /**
     * Type of destination
     */
    type: 'queues.queue';
  }

  export interface MqEventSourceImages {
    /**
     * Type of source
     */
    type?: 'images';
  }

  export interface MqEventSourceKV {
    /**
     * Type of source
     */
    type?: 'kv';
  }

  export interface MqEventSourceR2 {
    /**
     * Type of source
     */
    type?: 'r2';
  }

  export interface MqEventSourceSuperSlurper {
    /**
     * Type of source
     */
    type?: 'superSlurper';
  }

  export interface MqEventSourceVectorize {
    /**
     * Type of source
     */
    type?: 'vectorize';
  }

  export interface MqEventSourceWorkersAIModel {
    /**
     * Name of the Workers AI model
     */
    model_name?: string;

    /**
     * Type of source
     */
    type?: 'workersAi.model';
  }

  export interface MqEventSourceWorkersBuildsWorker {
    /**
     * Type of source
     */
    type?: 'workersBuilds.worker';

    /**
     * Name of the worker
     */
    worker_name?: string;
  }

  export interface MqEventSourceWorkflowsWorkflow {
    /**
     * Type of source
     */
    type?: 'workflows.workflow';

    /**
     * Name of the workflow
     */
    workflow_name?: string;
  }
}

export interface SubscriptionUpdateParams {
  /**
   * Path param: A Resource identifier.
   */
  account_id: string;

  /**
   * Body param: Destination configuration for the subscription
   */
  destination?: SubscriptionUpdateParams.Destination;

  /**
   * Body param: Whether the subscription is active
   */
  enabled?: boolean;

  /**
   * Body param: List of event types this subscription handles
   */
  events?: Array<string>;

  /**
   * Body param: Name of the subscription
   */
  name?: string;
}

export namespace SubscriptionUpdateParams {
  /**
   * Destination configuration for the subscription
   */
  export interface Destination {
    /**
     * ID of the target queue
     */
    queue_id: string;

    /**
     * Type of destination
     */
    type: 'queues.queue';
  }
}

export interface SubscriptionListParams extends V4PagePaginationArrayParams {
  /**
   * Path param: A Resource identifier.
   */
  account_id: string;

  /**
   * Query param: Sort direction
   */
  direction?: 'asc' | 'desc';

  /**
   * Query param: Field to sort by
   */
  order?: 'created_at' | 'name' | 'enabled' | 'source';
}

export interface SubscriptionDeleteParams {
  /**
   * A Resource identifier.
   */
  account_id: string;
}

Subscriptions.SubscriptionListResponsesV4PagePaginationArray = SubscriptionListResponsesV4PagePaginationArray;

export declare namespace Subscriptions {
  export {
    type SubscriptionCreateResponse as SubscriptionCreateResponse,
    type SubscriptionUpdateResponse as SubscriptionUpdateResponse,
    type SubscriptionListResponse as SubscriptionListResponse,
    type SubscriptionDeleteResponse as SubscriptionDeleteResponse,
    SubscriptionListResponsesV4PagePaginationArray as SubscriptionListResponsesV4PagePaginationArray,
    type SubscriptionCreateParams as SubscriptionCreateParams,
    type SubscriptionUpdateParams as SubscriptionUpdateParams,
    type SubscriptionListParams as SubscriptionListParams,
    type SubscriptionDeleteParams as SubscriptionDeleteParams,
  };
}