cloudflare 4.5.0 → 5.0.0

package/src/resources/workers/beta/workers/workers.ts

@@ -0,0 +1,559 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as Core from '../../../../core';
+import * as VersionsAPI from './versions';
+import {
+  Version,
+  VersionCreateParams,
+  VersionDeleteParams,
+  VersionDeleteResponse,
+  VersionGetParams,
+  VersionListParams,
+  Versions,
+  VersionsV4PagePaginationArray,
+} from './versions';
+import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../../pagination';
+
+export class Workers extends APIResource {
+  versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
+
+  /**
+   * Create a new Worker.
+   *
+   * @example
+   * ```ts
+   * const worker = await client.workers.beta.workers.create({
+   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   name: 'my-worker',
+   * });
+   * ```
+   */
+  create(params: WorkerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Worker> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/workers/workers`, { body, ...options }) as Core.APIPromise<{
+        result: Worker;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Update an existing Worker.
+   *
+   * @example
+   * ```ts
+   * const worker = await client.workers.beta.workers.update(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   {
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     name: 'my-worker',
+   *   },
+   * );
+   * ```
+   */
+  update(
+    workerId: string,
+    params: WorkerUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Worker> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.put(`/accounts/${account_id}/workers/workers/${workerId}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: Worker }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * List all Workers for an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const worker of client.workers.beta.workers.list(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: WorkerListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<WorkersV4PagePaginationArray, Worker> {
+    const { account_id, ...query } = params;
+    return this._client.getAPIList(`/accounts/${account_id}/workers/workers`, WorkersV4PagePaginationArray, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a Worker and all its associated resources (versions, deployments, etc.).
+   *
+   * @example
+   * ```ts
+   * const worker = await client.workers.beta.workers.delete(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
+   */
+  delete(
+    workerId: string,
+    params: WorkerDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WorkerDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(`/accounts/${account_id}/workers/workers/${workerId}`, options);
+  }
+
+  /**
+   * Get details about a specific Worker.
+   *
+   * @example
+   * ```ts
+   * const worker = await client.workers.beta.workers.get(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
+   */
+  get(workerId: string, params: WorkerGetParams, options?: Core.RequestOptions): Core.APIPromise<Worker> {
+    const { account_id } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/workers/workers/${workerId}`, options) as Core.APIPromise<{
+        result: Worker;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export class WorkersV4PagePaginationArray extends V4PagePaginationArray<Worker> {}
+
+export interface Worker {
+  /**
+   * Identifier.
+   */
+  id: string;
+
+  /**
+   * When the Worker was created.
+   */
+  created_on: string;
+
+  /**
+   * Name of the Worker.
+   */
+  name: string;
+
+  /**
+   * When the Worker was most recently updated.
+   */
+  updated_on: string;
+
+  /**
+   * Whether logpush is enabled for the Worker.
+   */
+  logpush?: boolean;
+
+  /**
+   * Observability settings for the Worker.
+   */
+  observability?: Worker.Observability;
+
+  /**
+   * Subdomain settings for the Worker.
+   */
+  subdomain?: Worker.Subdomain;
+
+  /**
+   * Tags associated with the Worker.
+   */
+  tags?: Array<string>;
+
+  /**
+   * Other Workers that should consume logs from the Worker.
+   */
+  tail_consumers?: Array<Worker.TailConsumer>;
+}
+
+export namespace Worker {
+  /**
+   * Observability settings for the Worker.
+   */
+  export interface Observability {
+    /**
+     * Whether observability is enabled for the Worker.
+     */
+    enabled?: boolean;
+
+    /**
+     * The sampling rate for observability. From 0 to 1 (1 = 100%, 0.1 = 10%).
+     */
+    head_sampling_rate?: number;
+
+    /**
+     * Log settings for the Worker.
+     */
+    logs?: Observability.Logs;
+  }
+
+  export namespace Observability {
+    /**
+     * Log settings for the Worker.
+     */
+    export interface Logs {
+      /**
+       * Whether logs are enabled for the Worker.
+       */
+      enabled?: boolean;
+
+      /**
+       * The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%).
+       */
+      head_sampling_rate?: number;
+
+      /**
+       * Whether
+       * [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
+       * are enabled for the Worker.
+       */
+      invocation_logs?: boolean;
+    }
+  }
+
+  /**
+   * Subdomain settings for the Worker.
+   */
+  export interface Subdomain {
+    /**
+     * Whether the \*.workers.dev subdomain is enabled for the Worker.
+     */
+    enabled?: boolean;
+
+    /**
+     * Whether
+     * [preview URLs](https://developers.cloudflare.com/workers/configuration/previews/)
+     * are enabled for the Worker.
+     */
+    previews_enabled?: boolean;
+  }
+
+  export interface TailConsumer {
+    /**
+     * Name of the consumer Worker.
+     */
+    name: string;
+  }
+}
+
+export interface WorkerDeleteResponse {
+  errors: Array<WorkerDeleteResponse.Error>;
+
+  messages: Array<WorkerDeleteResponse.Message>;
+
+  /**
+   * Whether the API call was successful.
+   */
+  success: true;
+}
+
+export namespace WorkerDeleteResponse {
+  export interface Error {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Error.Source;
+  }
+
+  export namespace Error {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+
+  export interface Message {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Message.Source;
+  }
+
+  export namespace Message {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+}
+
+export interface WorkerCreateParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: Name of the Worker.
+   */
+  name: string;
+
+  /**
+   * Body param: Whether logpush is enabled for the Worker.
+   */
+  logpush?: boolean;
+
+  /**
+   * Body param: Observability settings for the Worker.
+   */
+  observability?: WorkerCreateParams.Observability;
+
+  /**
+   * Body param: Subdomain settings for the Worker.
+   */
+  subdomain?: WorkerCreateParams.Subdomain;
+
+  /**
+   * Body param: Tags associated with the Worker.
+   */
+  tags?: Array<string>;
+
+  /**
+   * Body param: Other Workers that should consume logs from the Worker.
+   */
+  tail_consumers?: Array<WorkerCreateParams.TailConsumer>;
+}
+
+export namespace WorkerCreateParams {
+  /**
+   * Observability settings for the Worker.
+   */
+  export interface Observability {
+    /**
+     * Whether observability is enabled for the Worker.
+     */
+    enabled?: boolean;
+
+    /**
+     * The sampling rate for observability. From 0 to 1 (1 = 100%, 0.1 = 10%).
+     */
+    head_sampling_rate?: number;
+
+    /**
+     * Log settings for the Worker.
+     */
+    logs?: Observability.Logs;
+  }
+
+  export namespace Observability {
+    /**
+     * Log settings for the Worker.
+     */
+    export interface Logs {
+      /**
+       * Whether logs are enabled for the Worker.
+       */
+      enabled?: boolean;
+
+      /**
+       * The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%).
+       */
+      head_sampling_rate?: number;
+
+      /**
+       * Whether
+       * [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
+       * are enabled for the Worker.
+       */
+      invocation_logs?: boolean;
+    }
+  }
+
+  /**
+   * Subdomain settings for the Worker.
+   */
+  export interface Subdomain {
+    /**
+     * Whether the \*.workers.dev subdomain is enabled for the Worker.
+     */
+    enabled?: boolean;
+
+    /**
+     * Whether
+     * [preview URLs](https://developers.cloudflare.com/workers/configuration/previews/)
+     * are enabled for the Worker.
+     */
+    previews_enabled?: boolean;
+  }
+
+  export interface TailConsumer {
+    /**
+     * Name of the consumer Worker.
+     */
+    name: string;
+  }
+}
+
+export interface WorkerUpdateParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: Name of the Worker.
+   */
+  name: string;
+
+  /**
+   * Body param: Whether logpush is enabled for the Worker.
+   */
+  logpush?: boolean;
+
+  /**
+   * Body param: Observability settings for the Worker.
+   */
+  observability?: WorkerUpdateParams.Observability;
+
+  /**
+   * Body param: Subdomain settings for the Worker.
+   */
+  subdomain?: WorkerUpdateParams.Subdomain;
+
+  /**
+   * Body param: Tags associated with the Worker.
+   */
+  tags?: Array<string>;
+
+  /**
+   * Body param: Other Workers that should consume logs from the Worker.
+   */
+  tail_consumers?: Array<WorkerUpdateParams.TailConsumer>;
+}
+
+export namespace WorkerUpdateParams {
+  /**
+   * Observability settings for the Worker.
+   */
+  export interface Observability {
+    /**
+     * Whether observability is enabled for the Worker.
+     */
+    enabled?: boolean;
+
+    /**
+     * The sampling rate for observability. From 0 to 1 (1 = 100%, 0.1 = 10%).
+     */
+    head_sampling_rate?: number;
+
+    /**
+     * Log settings for the Worker.
+     */
+    logs?: Observability.Logs;
+  }
+
+  export namespace Observability {
+    /**
+     * Log settings for the Worker.
+     */
+    export interface Logs {
+      /**
+       * Whether logs are enabled for the Worker.
+       */
+      enabled?: boolean;
+
+      /**
+       * The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%).
+       */
+      head_sampling_rate?: number;
+
+      /**
+       * Whether
+       * [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
+       * are enabled for the Worker.
+       */
+      invocation_logs?: boolean;
+    }
+  }
+
+  /**
+   * Subdomain settings for the Worker.
+   */
+  export interface Subdomain {
+    /**
+     * Whether the \*.workers.dev subdomain is enabled for the Worker.
+     */
+    enabled?: boolean;
+
+    /**
+     * Whether
+     * [preview URLs](https://developers.cloudflare.com/workers/configuration/previews/)
+     * are enabled for the Worker.
+     */
+    previews_enabled?: boolean;
+  }
+
+  export interface TailConsumer {
+    /**
+     * Name of the consumer Worker.
+     */
+    name: string;
+  }
+}
+
+export interface WorkerListParams extends V4PagePaginationArrayParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+}
+
+export interface WorkerDeleteParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export interface WorkerGetParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+Workers.WorkersV4PagePaginationArray = WorkersV4PagePaginationArray;
+Workers.Versions = Versions;
+Workers.VersionsV4PagePaginationArray = VersionsV4PagePaginationArray;
+
+export declare namespace Workers {
+  export {
+    type Worker as Worker,
+    type WorkerDeleteResponse as WorkerDeleteResponse,
+    WorkersV4PagePaginationArray as WorkersV4PagePaginationArray,
+    type WorkerCreateParams as WorkerCreateParams,
+    type WorkerUpdateParams as WorkerUpdateParams,
+    type WorkerListParams as WorkerListParams,
+    type WorkerDeleteParams as WorkerDeleteParams,
+    type WorkerGetParams as WorkerGetParams,
+  };
+
+  export {
+    Versions as Versions,
+    type Version as Version,
+    type VersionDeleteResponse as VersionDeleteResponse,
+    VersionsV4PagePaginationArray as VersionsV4PagePaginationArray,
+    type VersionCreateParams as VersionCreateParams,
+    type VersionListParams as VersionListParams,
+    type VersionDeleteParams as VersionDeleteParams,
+    type VersionGetParams as VersionGetParams,
+  };
+}

package/src/resources/workers/beta/workers.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './workers/index';

package/src/resources/workers/beta.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './beta/index';

package/src/resources/workers/index.ts

@@ -8,6 +8,7 @@ export {
   type AccountSettingGetParams,
 } from './account-settings';
 export { Assets } from './assets/index';
+export { Beta } from './beta/index';
 export {
   DomainsSinglePage,
   Domains,

package/src/resources/workers/scripts/content.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
-import * as WorkersAPI from '../workers';
 import * as ScriptsAPI from './scripts';
 import { type Response } from '../../../_shims/index';
 
@@ -85,10 +84,21 @@ export interface ContentUpdateParams {
   account_id: string;
 
   /**
-   * Body param: JSON encoded metadata about the uploaded parts and Worker
+   * Body param: JSON-encoded metadata about the uploaded parts and Worker
    * configuration.
    */
-  metadata: WorkersAPI.WorkerMetadataParam;
+  metadata: ContentUpdateParams.Metadata;
+
+  /**
+   * Body param: An array of modules (often JavaScript files) comprising a Worker
+   * script. At least one module must be present and referenced in the metadata as
+   * `main_module` or `body_part` by filename.<br/>Possible Content-Type(s) are:
+   * `application/javascript+module`, `text/javascript+module`,
+   * `application/javascript`, `text/javascript`, `text/x-python`,
+   * `text/x-python-requirement`, `application/wasm`, `text/plain`,
+   * `application/octet-stream`, `application/source-map`.
+   */
+  files?: Array<Core.Uploadable>;
 
   /**
    * Header param: The multipart name of a script upload part containing script
@@ -101,8 +111,25 @@ export interface ContentUpdateParams {
    * content in es module format. Alternative to including in a metadata part.
    */
   'CF-WORKER-MAIN-MODULE-PART'?: string;
+}
 
-  [k: string]: Array<Core.Uploadable> | string | WorkersAPI.WorkerMetadataParam | undefined;
+export namespace ContentUpdateParams {
+  /**
+   * JSON-encoded metadata about the uploaded parts and Worker configuration.
+   */
+  export interface Metadata {
+    /**
+     * Name of the uploaded file that contains the Worker script (e.g. the file adding
+     * a listener to the `fetch` event). Indicates a `service worker syntax` Worker.
+     */
+    body_part?: string;
+
+    /**
+     * Name of the uploaded file that contains the main module (e.g. the file exporting
+     * a `fetch` handler). Indicates a `module syntax` Worker.
+     */
+    main_module?: string;
+  }
 }
 
 export interface ContentGetParams {