cloudflare 3.1.0 → 3.2.0

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

@@ -32,11 +32,8 @@ export class Tail extends APIResource {
     params: TailDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<TailDeleteResponse> {
-    const { account_id, body } = params;
-    return this._client.delete(`/accounts/${account_id}/workers/scripts/${scriptName}/tails/${id}`, {
-      body: body,
-      ...options,
-    });
+    const { account_id } = params;
+    return this._client.delete(`/accounts/${account_id}/workers/scripts/${scriptName}/tails/${id}`, options);
   }
 
   /**
@@ -77,6 +74,26 @@ export interface ConsumerScript {
   namespace?: string;
 }
 
+/**
+ * A reference to a script that will consume logs from the attached Worker.
+ */
+export interface ConsumerScriptParam {
+  /**
+   * Name of Worker that is to be the consumer.
+   */
+  service: string;
+
+  /**
+   * Optional environment if the Worker utilizes one.
+   */
+  environment?: string;
+
+  /**
+   * Optional dispatch namespace the script belongs to.
+   */
+  namespace?: string;
+}
+
 export interface TailCreateResponse {
   id?: unknown;
 
@@ -118,14 +135,9 @@ export interface TailCreateParams {
 
 export interface TailDeleteParams {
   /**
-   * Path param: Identifier
+   * Identifier
    */
   account_id: string;
-
-  /**
-   * Body param:
-   */
-  body: unknown;
 }
 
 export interface TailGetParams {

package/src/resources/workers/workers.ts

@@ -47,6 +47,33 @@ export namespace Binding {
   }
 }
 
+/**
+ * A binding to allow the Worker to communicate with resources
+ */
+export type BindingParam =
+  | KVNamespaceBindingParam
+  | ServiceBindingParam
+  | DurableObjectBindingParam
+  | R2BindingParam
+  | BindingParam.WorkersQueueBinding
+  | D1BindingParam
+  | DispatchNamespaceBindingParam
+  | MTLSCERTBindingParam;
+
+export namespace BindingParam {
+  export interface WorkersQueueBinding {
+    /**
+     * Name of the Queue to bind to
+     */
+    queue_name: string;
+
+    /**
+     * The class of resource that the binding provides.
+     */
+    type: 'queue';
+  }
+}
+
 export interface D1Binding {
   /**
    * ID of the D1 database to bind to
@@ -69,6 +96,23 @@ export interface D1Binding {
   type: 'd1';
 }
 
+export interface D1BindingParam {
+  /**
+   * ID of the D1 database to bind to
+   */
+  id: string;
+
+  /**
+   * The name of the D1 database associated with the 'id' provided.
+   */
+  name: string;
+
+  /**
+   * The class of resource that the binding provides.
+   */
+  type: 'd1';
+}
+
 export interface DispatchNamespaceBinding {
   /**
    * A JavaScript variable name for the binding.
@@ -126,6 +170,58 @@ export namespace DispatchNamespaceBinding {
   }
 }
 
+export interface DispatchNamespaceBindingParam {
+  /**
+   * Namespace to bind to
+   */
+  namespace: string;
+
+  /**
+   * The class of resource that the binding provides.
+   */
+  type: 'dispatch_namespace';
+
+  /**
+   * Outbound worker
+   */
+  outbound?: DispatchNamespaceBindingParam.Outbound;
+}
+
+export namespace DispatchNamespaceBindingParam {
+  /**
+   * Outbound worker
+   */
+  export interface Outbound {
+    /**
+     * Pass information from the Dispatch Worker to the Outbound Worker through the
+     * parameters
+     */
+    params?: Array<string>;
+
+    /**
+     * Outbound worker
+     */
+    worker?: Outbound.Worker;
+  }
+
+  export namespace Outbound {
+    /**
+     * Outbound worker
+     */
+    export interface Worker {
+      /**
+       * Environment of the outbound worker
+       */
+      environment?: string;
+
+      /**
+       * Name of the outbound worker
+       */
+      service?: string;
+    }
+  }
+}
+
 export interface DurableObjectBinding {
   /**
    * The exported class name of the Durable Object
@@ -158,6 +254,28 @@ export interface DurableObjectBinding {
   script_name?: string;
 }
 
+export interface DurableObjectBindingParam {
+  /**
+   * The exported class name of the Durable Object
+   */
+  class_name: string;
+
+  /**
+   * The class of resource that the binding provides.
+   */
+  type: 'durable_object_namespace';
+
+  /**
+   * The environment of the script_name to bind to
+   */
+  environment?: string;
+
+  /**
+   * The script where the Durable Object is defined, if it is external to this Worker
+   */
+  script_name?: string;
+}
+
 export interface KVNamespaceBinding {
   /**
    * A JavaScript variable name for the binding.
@@ -175,6 +293,13 @@ export interface KVNamespaceBinding {
   type: 'kv_namespace';
 }
 
+export interface KVNamespaceBindingParam {
+  /**
+   * The class of resource that the binding provides.
+   */
+  type: 'kv_namespace';
+}
+
 export interface MigrationStep {
   /**
    * A list of classes to delete Durable Object namespaces from.
@@ -214,9 +339,46 @@ export namespace MigrationStep {
   }
 }
 
-export interface MTLSCERTBinding {
-  certificate: unknown;
+export interface MigrationStepParam {
+  /**
+   * A list of classes to delete Durable Object namespaces from.
+   */
+  deleted_classes?: Array<string>;
+
+  /**
+   * A list of classes to create Durable Object namespaces from.
+   */
+  new_classes?: Array<string>;
+
+  /**
+   * A list of classes with Durable Object namespaces that were renamed.
+   */
+  renamed_classes?: Array<MigrationStepParam.RenamedClass>;
+
+  /**
+   * A list of transfers for Durable Object namespaces from a different Worker and
+   * class to a class defined in this Worker.
+   */
+  transferred_classes?: Array<MigrationStepParam.TransferredClass>;
+}
+
+export namespace MigrationStepParam {
+  export interface RenamedClass {
+    from?: string;
+
+    to?: string;
+  }
+
+  export interface TransferredClass {
+    from?: string;
+
+    from_script?: string;
 
+    to?: string;
+  }
+}
+
+export interface MTLSCERTBinding {
   /**
    * A JavaScript variable name for the binding.
    */
@@ -233,6 +395,18 @@ export interface MTLSCERTBinding {
   certificate_id?: string;
 }
 
+export interface MTLSCERTBindingParam {
+  /**
+   * The class of resource that the binding provides.
+   */
+  type: 'mtls_certificate';
+
+  /**
+   * ID of the certificate to bind to
+   */
+  certificate_id?: string;
+}
+
 export interface PlacementConfiguration {
   /**
    * Enables
@@ -242,6 +416,15 @@ export interface PlacementConfiguration {
   mode?: 'smart';
 }
 
+export interface PlacementConfigurationParam {
+  /**
+   * Enables
+   * [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
+   * Only `"smart"` is currently supported
+   */
+  mode?: 'smart';
+}
+
 export interface R2Binding {
   /**
    * R2 bucket to bind to
@@ -259,6 +442,18 @@ export interface R2Binding {
   type: 'r2_bucket';
 }
 
+export interface R2BindingParam {
+  /**
+   * R2 bucket to bind to
+   */
+  bucket_name: string;
+
+  /**
+   * The class of resource that the binding provides.
+   */
+  type: 'r2_bucket';
+}
+
 export interface ServiceBinding {
   /**
    * Optional environment if the Worker utilizes one.
@@ -281,6 +476,23 @@ export interface ServiceBinding {
   type: 'service';
 }
 
+export interface ServiceBindingParam {
+  /**
+   * Optional environment if the Worker utilizes one.
+   */
+  environment: string;
+
+  /**
+   * Name of Worker to bind to
+   */
+  service: string;
+
+  /**
+   * The class of resource that the binding provides.
+   */
+  type: 'service';
+}
+
 /**
  * A single set of migrations to apply.
  */
@@ -334,6 +546,59 @@ export namespace SingleStepMigration {
   }
 }
 
+/**
+ * A single set of migrations to apply.
+ */
+export interface SingleStepMigrationParam {
+  /**
+   * A list of classes to delete Durable Object namespaces from.
+   */
+  deleted_classes?: Array<string>;
+
+  /**
+   * A list of classes to create Durable Object namespaces from.
+   */
+  new_classes?: Array<string>;
+
+  /**
+   * Tag to set as the latest migration tag.
+   */
+  new_tag?: string;
+
+  /**
+   * Tag used to verify against the latest migration tag for this Worker. If they
+   * don't match, the upload is rejected.
+   */
+  old_tag?: string;
+
+  /**
+   * A list of classes with Durable Object namespaces that were renamed.
+   */
+  renamed_classes?: Array<SingleStepMigrationParam.RenamedClass>;
+
+  /**
+   * A list of transfers for Durable Object namespaces from a different Worker and
+   * class to a class defined in this Worker.
+   */
+  transferred_classes?: Array<SingleStepMigrationParam.TransferredClass>;
+}
+
+export namespace SingleStepMigrationParam {
+  export interface RenamedClass {
+    from?: string;
+
+    to?: string;
+  }
+
+  export interface TransferredClass {
+    from?: string;
+
+    from_script?: string;
+
+    to?: string;
+  }
+}
+
 export interface SteppedMigration {
   /**
    * Tag to set as the latest migration tag.
@@ -352,6 +617,24 @@ export interface SteppedMigration {
   steps?: Array<MigrationStep>;
 }
 
+export interface SteppedMigrationParam {
+  /**
+   * Tag to set as the latest migration tag.
+   */
+  new_tag?: string;
+
+  /**
+   * Tag used to verify against the latest migration tag for this Worker. If they
+   * don't match, the upload is rejected.
+   */
+  old_tag?: string;
+
+  /**
+   * Migrations to apply in order.
+   */
+  steps?: Array<MigrationStepParam>;
+}
+
 /**
  * JSON encoded metadata about the uploaded parts and Worker configuration.
  */
@@ -370,6 +653,24 @@ export interface WorkerMetadata {
   main_module?: string;
 }
 
+/**
+ * JSON encoded metadata about the uploaded parts and Worker configuration.
+ */
+export interface WorkerMetadataParam {
+  /**
+   * Name of the part in the multipart request that contains the script (e.g. the
+   * file adding a listener to the `fetch` event). Indicates a
+   * `service worker syntax` Worker.
+   */
+  body_part?: string;
+
+  /**
+   * Name of the part in the multipart request that contains the main module (e.g.
+   * the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
+   */
+  main_module?: string;
+}
+
 export namespace Workers {
   export import AI = AIAPI.AI;
   export import AIRunResponse = AIAPI.AIRunResponse;

package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/content.ts

@@ -79,7 +79,7 @@ export interface ContentUpdateParams {
    * Body param: JSON encoded metadata about the uploaded parts and Worker
    * configuration.
    */
-  metadata?: WorkersAPI.WorkerMetadata;
+  metadata?: WorkersAPI.WorkerMetadataParam;
 
   /**
    * Header param: The multipart name of a script upload part containing script

package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.ts

@@ -50,10 +50,10 @@ export class Scripts extends APIResource {
     params: ScriptDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<void> {
-    const { account_id, body, force } = params;
+    const { account_id, force } = params;
     return this._client.delete(
       `/accounts/${account_id}/workers/dispatch/namespaces/${dispatchNamespace}/scripts/${scriptName}`,
-      { query: { force }, body: body, ...options, headers: { Accept: '*/*', ...options?.headers } },
+      { query: { force }, ...options, headers: { Accept: '*/*', ...options?.headers } },
     );
   }
 
@@ -172,9 +172,9 @@ export namespace ScriptUpdateParams {
       /**
        * Migrations to apply for Durable Objects associated with this Worker.
        */
-      migrations?: WorkersAPI.SingleStepMigration | WorkersAPI.SteppedMigration;
+      migrations?: WorkersAPI.SingleStepMigrationParam | WorkersAPI.SteppedMigrationParam;
 
-      placement?: WorkersAPI.PlacementConfiguration;
+      placement?: WorkersAPI.PlacementConfigurationParam;
 
       /**
        * List of strings to use as tags for this Worker
@@ -184,7 +184,7 @@ export namespace ScriptUpdateParams {
       /**
        * List of Workers that will consume logs from the attached Worker.
        */
-      tail_consumers?: Array<TailAPI.ConsumerScript>;
+      tail_consumers?: Array<TailAPI.ConsumerScriptParam>;
 
       /**
        * Usage model to apply to invocations.
@@ -218,11 +218,6 @@ export interface ScriptDeleteParams {
    */
   account_id: string;
 
-  /**
-   * Body param:
-   */
-  body: unknown;
-
   /**
    * Query param: If set to true, delete will not be stopped by associated service
    * binding, durable object, or other binding. Any of these associated

package/src/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.ts

@@ -184,7 +184,7 @@ export namespace SettingEditParams {
     /**
      * List of bindings attached to this Worker
      */
-    bindings?: Array<WorkersAPI.Binding>;
+    bindings?: Array<WorkersAPI.BindingParam>;
 
     /**
      * Opt your Worker into changes after this date
@@ -209,9 +209,9 @@ export namespace SettingEditParams {
     /**
      * Migrations to apply for Durable Objects associated with this Worker.
      */
-    migrations?: WorkersAPI.SingleStepMigration | WorkersAPI.SteppedMigration;
+    migrations?: WorkersAPI.SingleStepMigrationParam | WorkersAPI.SteppedMigrationParam;
 
-    placement?: WorkersAPI.PlacementConfiguration;
+    placement?: WorkersAPI.PlacementConfigurationParam;
 
     /**
      * Tags to help you manage your Workers
@@ -221,7 +221,7 @@ export namespace SettingEditParams {
     /**
      * List of Workers that will consume logs from the attached Worker.
      */
-    tail_consumers?: Array<TailAPI.ConsumerScript>;
+    tail_consumers?: Array<TailAPI.ConsumerScriptParam>;
 
     /**
      * Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').