cloudflare 5.1.0 → 6.0.0-beta.1

package/src/resources/resource-sharing/resource-sharing.ts

@@ -165,11 +165,12 @@ export class ResourceSharing extends APIResource {
     params: ResourceSharingGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ResourceSharingGetResponse> {
-    const { account_id } = params;
+    const { account_id, ...query } = params;
     return (
-      this._client.get(`/accounts/${account_id}/shares/${shareId}`, options) as Core.APIPromise<{
-        result: ResourceSharingGetResponse;
-      }>
+      this._client.get(`/accounts/${account_id}/shares/${shareId}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: ResourceSharingGetResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
@@ -216,7 +217,92 @@ export interface ResourceSharingCreateResponse {
 
   target_type: 'account' | 'organization';
 
+  /**
+   * The number of recipients in the 'associated' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'associating' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associating_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociated' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociating' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociating_recipient_count?: number;
+
   kind?: 'sent' | 'received';
+
+  /**
+   * A list of resources that are part of the share. This field is only included when
+   * requested via the 'include_resources' parameter.
+   */
+  resources?: Array<ResourceSharingCreateResponse.Resource>;
+}
+
+export namespace ResourceSharingCreateResponse {
+  export interface Resource {
+    /**
+     * Share Resource identifier.
+     */
+    id: string;
+
+    /**
+     * When the share was created.
+     */
+    created: string;
+
+    /**
+     * Resource Metadata.
+     */
+    meta: unknown;
+
+    /**
+     * When the share was modified.
+     */
+    modified: string;
+
+    /**
+     * Account identifier.
+     */
+    resource_account_id: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Type.
+     */
+    resource_type:
+      | 'custom-ruleset'
+      | 'widget'
+      | 'gateway-policy'
+      | 'gateway-destination-ip'
+      | 'gateway-block-page-settings'
+      | 'gateway-extended-email-matching';
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+
+    /**
+     * Resource Status.
+     */
+    status: 'active' | 'deleting' | 'deleted';
+  }
 }
 
 export interface ResourceSharingUpdateResponse {
@@ -259,7 +345,92 @@ export interface ResourceSharingUpdateResponse {
 
   target_type: 'account' | 'organization';
 
+  /**
+   * The number of recipients in the 'associated' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'associating' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associating_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociated' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociating' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociating_recipient_count?: number;
+
   kind?: 'sent' | 'received';
+
+  /**
+   * A list of resources that are part of the share. This field is only included when
+   * requested via the 'include_resources' parameter.
+   */
+  resources?: Array<ResourceSharingUpdateResponse.Resource>;
+}
+
+export namespace ResourceSharingUpdateResponse {
+  export interface Resource {
+    /**
+     * Share Resource identifier.
+     */
+    id: string;
+
+    /**
+     * When the share was created.
+     */
+    created: string;
+
+    /**
+     * Resource Metadata.
+     */
+    meta: unknown;
+
+    /**
+     * When the share was modified.
+     */
+    modified: string;
+
+    /**
+     * Account identifier.
+     */
+    resource_account_id: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Type.
+     */
+    resource_type:
+      | 'custom-ruleset'
+      | 'widget'
+      | 'gateway-policy'
+      | 'gateway-destination-ip'
+      | 'gateway-block-page-settings'
+      | 'gateway-extended-email-matching';
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+
+    /**
+     * Resource Status.
+     */
+    status: 'active' | 'deleting' | 'deleted';
+  }
 }
 
 export interface ResourceSharingListResponse {
@@ -302,7 +473,92 @@ export interface ResourceSharingListResponse {
 
   target_type: 'account' | 'organization';
 
+  /**
+   * The number of recipients in the 'associated' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'associating' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associating_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociated' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociating' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociating_recipient_count?: number;
+
   kind?: 'sent' | 'received';
+
+  /**
+   * A list of resources that are part of the share. This field is only included when
+   * requested via the 'include_resources' parameter.
+   */
+  resources?: Array<ResourceSharingListResponse.Resource>;
+}
+
+export namespace ResourceSharingListResponse {
+  export interface Resource {
+    /**
+     * Share Resource identifier.
+     */
+    id: string;
+
+    /**
+     * When the share was created.
+     */
+    created: string;
+
+    /**
+     * Resource Metadata.
+     */
+    meta: unknown;
+
+    /**
+     * When the share was modified.
+     */
+    modified: string;
+
+    /**
+     * Account identifier.
+     */
+    resource_account_id: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Type.
+     */
+    resource_type:
+      | 'custom-ruleset'
+      | 'widget'
+      | 'gateway-policy'
+      | 'gateway-destination-ip'
+      | 'gateway-block-page-settings'
+      | 'gateway-extended-email-matching';
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+
+    /**
+     * Resource Status.
+     */
+    status: 'active' | 'deleting' | 'deleted';
+  }
 }
 
 export interface ResourceSharingDeleteResponse {
@@ -345,7 +601,92 @@ export interface ResourceSharingDeleteResponse {
 
   target_type: 'account' | 'organization';
 
+  /**
+   * The number of recipients in the 'associated' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'associating' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associating_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociated' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociating' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociating_recipient_count?: number;
+
   kind?: 'sent' | 'received';
+
+  /**
+   * A list of resources that are part of the share. This field is only included when
+   * requested via the 'include_resources' parameter.
+   */
+  resources?: Array<ResourceSharingDeleteResponse.Resource>;
+}
+
+export namespace ResourceSharingDeleteResponse {
+  export interface Resource {
+    /**
+     * Share Resource identifier.
+     */
+    id: string;
+
+    /**
+     * When the share was created.
+     */
+    created: string;
+
+    /**
+     * Resource Metadata.
+     */
+    meta: unknown;
+
+    /**
+     * When the share was modified.
+     */
+    modified: string;
+
+    /**
+     * Account identifier.
+     */
+    resource_account_id: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Type.
+     */
+    resource_type:
+      | 'custom-ruleset'
+      | 'widget'
+      | 'gateway-policy'
+      | 'gateway-destination-ip'
+      | 'gateway-block-page-settings'
+      | 'gateway-extended-email-matching';
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+
+    /**
+     * Resource Status.
+     */
+    status: 'active' | 'deleting' | 'deleted';
+  }
 }
 
 export interface ResourceSharingGetResponse {
@@ -388,7 +729,92 @@ export interface ResourceSharingGetResponse {
 
   target_type: 'account' | 'organization';
 
+  /**
+   * The number of recipients in the 'associated' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'associating' state. This field is only included
+   * when requested via the 'include_recipient_counts' parameter.
+   */
+  associating_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociated' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociated_recipient_count?: number;
+
+  /**
+   * The number of recipients in the 'disassociating' state. This field is only
+   * included when requested via the 'include_recipient_counts' parameter.
+   */
+  disassociating_recipient_count?: number;
+
   kind?: 'sent' | 'received';
+
+  /**
+   * A list of resources that are part of the share. This field is only included when
+   * requested via the 'include_resources' parameter.
+   */
+  resources?: Array<ResourceSharingGetResponse.Resource>;
+}
+
+export namespace ResourceSharingGetResponse {
+  export interface Resource {
+    /**
+     * Share Resource identifier.
+     */
+    id: string;
+
+    /**
+     * When the share was created.
+     */
+    created: string;
+
+    /**
+     * Resource Metadata.
+     */
+    meta: unknown;
+
+    /**
+     * When the share was modified.
+     */
+    modified: string;
+
+    /**
+     * Account identifier.
+     */
+    resource_account_id: string;
+
+    /**
+     * Share Resource identifier.
+     */
+    resource_id: string;
+
+    /**
+     * Resource Type.
+     */
+    resource_type:
+      | 'custom-ruleset'
+      | 'widget'
+      | 'gateway-policy'
+      | 'gateway-destination-ip'
+      | 'gateway-block-page-settings'
+      | 'gateway-extended-email-matching';
+
+    /**
+     * Resource Version.
+     */
+    resource_version: number;
+
+    /**
+     * Resource Status.
+     */
+    status: 'active' | 'deleting' | 'deleted';
+  }
 }
 
 export interface ResourceSharingCreateParams {
@@ -448,7 +874,13 @@ export namespace ResourceSharingCreateParams {
     /**
      * Resource Type.
      */
-    resource_type: 'custom-ruleset' | 'widget';
+    resource_type:
+      | 'custom-ruleset'
+      | 'widget'
+      | 'gateway-policy'
+      | 'gateway-destination-ip'
+      | 'gateway-block-page-settings'
+      | 'gateway-extended-email-matching';
   }
 }
 
@@ -475,6 +907,16 @@ export interface ResourceSharingListParams extends V4PagePaginationArrayParams {
    */
   direction?: 'asc' | 'desc';
 
+  /**
+   * Query param: Include recipient counts in the response.
+   */
+  include_recipient_counts?: boolean;
+
+  /**
+   * Query param: Include resources in the response.
+   */
+  include_resources?: boolean;
+
   /**
    * Query param: Filter shares by kind.
    */
@@ -485,6 +927,18 @@ export interface ResourceSharingListParams extends V4PagePaginationArrayParams {
    */
   order?: 'name' | 'created';
 
+  /**
+   * Query param: Filter share resources by resource_types.
+   */
+  resource_types?: Array<
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching'
+  >;
+
   /**
    * Query param: Filter shares by status.
    */
@@ -505,9 +959,19 @@ export interface ResourceSharingDeleteParams {
 
 export interface ResourceSharingGetParams {
   /**
-   * Account identifier.
+   * Path param: Account identifier.
    */
   account_id: string;
+
+  /**
+   * Query param: Include recipient counts in the response.
+   */
+  include_recipient_counts?: boolean;
+
+  /**
+   * Query param: Include resources in the response.
+   */
+  include_resources?: boolean;
 }
 
 ResourceSharing.ResourceSharingListResponsesV4PagePaginationArray =

package/src/resources/resource-sharing/resources.ts

@@ -190,7 +190,13 @@ export interface ResourceCreateResponse {
   /**
    * Resource Type.
    */
-  resource_type: 'custom-ruleset' | 'widget';
+  resource_type:
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching';
 
   /**
    * Resource Version.
@@ -237,7 +243,13 @@ export interface ResourceUpdateResponse {
   /**
    * Resource Type.
    */
-  resource_type: 'custom-ruleset' | 'widget';
+  resource_type:
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching';
 
   /**
    * Resource Version.
@@ -284,7 +296,13 @@ export interface ResourceListResponse {
   /**
    * Resource Type.
    */
-  resource_type: 'custom-ruleset' | 'widget';
+  resource_type:
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching';
 
   /**
    * Resource Version.
@@ -331,7 +349,13 @@ export interface ResourceDeleteResponse {
   /**
    * Resource Type.
    */
-  resource_type: 'custom-ruleset' | 'widget';
+  resource_type:
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching';
 
   /**
    * Resource Version.
@@ -378,7 +402,13 @@ export interface ResourceGetResponse {
   /**
    * Resource Type.
    */
-  resource_type: 'custom-ruleset' | 'widget';
+  resource_type:
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching';
 
   /**
    * Resource Version.
@@ -415,7 +445,13 @@ export interface ResourceCreateParams {
   /**
    * Body param: Resource Type.
    */
-  resource_type: 'custom-ruleset' | 'widget';
+  resource_type:
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching';
 }
 
 export interface ResourceUpdateParams {
@@ -439,7 +475,13 @@ export interface ResourceListParams extends V4PagePaginationArrayParams {
   /**
    * Query param: Filter share resources by resource_type.
    */
-  resource_type?: 'custom-ruleset' | 'widget';
+  resource_type?:
+    | 'custom-ruleset'
+    | 'widget'
+    | 'gateway-policy'
+    | 'gateway-destination-ip'
+    | 'gateway-block-page-settings'
+    | 'gateway-extended-email-matching';
 
   /**
    * Query param: Filter share resources by status.

package/src/resources/rules/lists/items.ts

@@ -12,6 +12,9 @@ export class Items extends APIResource {
    * This operation is asynchronous. To get current the operation status, invoke the
    * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
+   * There is a limit of 1 pending bulk operation per account. If an outstanding bulk
+   * operation is in progress, the request will be rejected.
+   *
    * @example
    * ```ts
    * const item = await client.rules.lists.items.create(
@@ -44,6 +47,9 @@ export class Items extends APIResource {
    * This operation is asynchronous. To get current the operation status, invoke the
    * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
+   * There is a limit of 1 pending bulk operation per account. If an outstanding bulk
+   * operation is in progress, the request will be rejected.
+   *
    * @example
    * ```ts
    * const item = await client.rules.lists.items.update(
@@ -102,6 +108,9 @@ export class Items extends APIResource {
    * This operation is asynchronous. To get current the operation status, invoke the
    * `Get bulk operation status` endpoint with the returned `operation_id`.
    *
+   * There is a limit of 1 pending bulk operation per account. If an outstanding bulk
+   * operation is in progress, the request will be rejected.
+   *
    * @example
    * ```ts
    * const item = await client.rules.lists.items.delete(
@@ -591,7 +600,12 @@ export interface ItemDeleteParams {
 }
 
 export namespace ItemDeleteParams {
-  export interface Item {}
+  export interface Item {
+    /**
+     * Defines the unique ID of the item in the List.
+     */
+    id: string;
+  }
 }
 
 export interface ItemGetParams {