cloudflare 6.3.0 → 6.5.0

package/src/resources/resource-sharing/api.md

@@ -45,7 +45,7 @@ Types:
 Methods:
 
 - <code title="post /accounts/{account_id}/shares/{share_id}/resources">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">create</a>(shareId, { ...params }) -> ResourceCreateResponse</code>
-- <code title="put /accounts/{account_id}/shares/{share_id}/resources/{resource_id}">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">update</a>(shareId, resourceId, { ...params }) -> ResourceUpdateResponse</code>
+- <code title="put /accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">update</a>(shareId, shareResourceId, { ...params }) -> ResourceUpdateResponse</code>
 - <code title="get /accounts/{account_id}/shares/{share_id}/resources">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">list</a>(shareId, { ...params }) -> ResourceListResponsesV4PagePaginationArray</code>
-- <code title="delete /accounts/{account_id}/shares/{share_id}/resources/{resource_id}">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">delete</a>(shareId, resourceId, { ...params }) -> ResourceDeleteResponse</code>
-- <code title="get /accounts/{account_id}/shares/{share_id}/resources/{resource_id}">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">get</a>(shareId, resourceId, { ...params }) -> ResourceGetResponse</code>
+- <code title="delete /accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">delete</a>(shareId, shareResourceId, { ...params }) -> ResourceDeleteResponse</code>
+- <code title="get /accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}">client.resourceSharing.resources.<a href="./src/resources/resource-sharing/resources.ts">get</a>(shareId, shareResourceId, { ...params }) -> ResourceGetResponse</code>

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

@@ -338,7 +338,8 @@ export interface RecipientCreateParams {
   path_account_id: string;
 
   /**
-   * Body param: Account identifier.
+   * @deprecated This field has been renamed to `recipient_account_id`. Both names
+   * are accepted during the deprecation period.
    */
   body_account_id?: string;
 
@@ -346,6 +347,11 @@ export interface RecipientCreateParams {
    * Body param: Organization identifier.
    */
   organization_id?: string;
+
+  /**
+   * Body param: The account that will receive the share.
+   */
+  recipient_account_id?: string;
 }
 
 export interface RecipientListParams extends V4PagePaginationArrayParams {

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

@@ -842,11 +842,16 @@ export interface ResourceSharingCreateParams {
 
 export namespace ResourceSharingCreateParams {
   /**
-   * Account or organization ID must be provided.
+   * Optionally specify `recipient_account_id` to target a specific account, or
+   * `organization_id` to target the caller's whole organization. If neither is
+   * provided, the caller's organization is used. The legacy field `account_id` is
+   * accepted as a synonym for `recipient_account_id` during the deprecation period
+   * (see `x-sunset` on that field).
    */
   export interface Recipient {
     /**
-     * Account identifier.
+     * @deprecated This field has been renamed to `recipient_account_id`. Both names
+     * are accepted during the deprecation period.
      */
     account_id?: string;
 
@@ -854,6 +859,11 @@ export namespace ResourceSharingCreateParams {
      * Organization identifier.
      */
     organization_id?: string;
+
+    /**
+     * The account that will receive the share.
+     */
+    recipient_account_id?: string;
   }
 
   export interface Resource {

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

@@ -57,13 +57,13 @@ export class Resources extends APIResource {
    */
   update(
     shareId: string,
-    resourceId: string,
+    shareResourceId: string,
     params: ResourceUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ResourceUpdateResponse> {
     const { account_id, ...body } = params;
     return (
-      this._client.put(`/accounts/${account_id}/shares/${shareId}/resources/${resourceId}`, {
+      this._client.put(`/accounts/${account_id}/shares/${shareId}/resources/${shareResourceId}`, {
         body,
         ...options,
       }) as Core.APIPromise<{ result: ResourceUpdateResponse }>
@@ -113,14 +113,14 @@ export class Resources extends APIResource {
    */
   delete(
     shareId: string,
-    resourceId: string,
+    shareResourceId: string,
     params: ResourceDeleteParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ResourceDeleteResponse> {
     const { account_id } = params;
     return (
       this._client.delete(
-        `/accounts/${account_id}/shares/${shareId}/resources/${resourceId}`,
+        `/accounts/${account_id}/shares/${shareId}/resources/${shareResourceId}`,
         options,
       ) as Core.APIPromise<{ result: ResourceDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
@@ -140,14 +140,14 @@ export class Resources extends APIResource {
    */
   get(
     shareId: string,
-    resourceId: string,
+    shareResourceId: string,
     params: ResourceGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ResourceGetResponse> {
     const { account_id } = params;
     return (
       this._client.get(
-        `/accounts/${account_id}/shares/${shareId}/resources/${resourceId}`,
+        `/accounts/${account_id}/shares/${shareId}/resources/${shareResourceId}`,
         options,
       ) as Core.APIPromise<{ result: ResourceGetResponse }>
     )._thenUnwrap((obj) => obj.result);

package/src/resources/resource-tagging/api.md

@@ -53,3 +53,5 @@ Types:
 Methods:
 
 - <code title="get /accounts/{account_id}/tags/values/{tag_key}">client.resourceTagging.values.<a href="./src/resources/resource-tagging/values.ts">list</a>(tagKey, { ...params }) -> ValueListResponsesCursorPaginationAfter</code>
+
+## Summary

package/src/resources/resource-tagging/index.ts

@@ -15,6 +15,7 @@ export {
   type KeyListParams,
 } from './keys';
 export { ResourceTagging } from './resource-tagging';
+export { Summary } from './summary';
 export {
   ValueListResponsesCursorPaginationAfter,
   Values,

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

@@ -13,6 +13,8 @@ import {
 } from './account-tags';
 import * as KeysAPI from './keys';
 import { KeyListParams, KeyListResponse, KeyListResponsesCursorPaginationAfter, Keys } from './keys';
+import * as SummaryAPI from './summary';
+import { Summary } from './summary';
 import * as ValuesAPI from './values';
 import {
   ValueListParams,
@@ -36,6 +38,7 @@ export class ResourceTagging extends APIResource {
   zoneTags: ZoneTagsAPI.ZoneTags = new ZoneTagsAPI.ZoneTags(this._client);
   keys: KeysAPI.Keys = new KeysAPI.Keys(this._client);
   values: ValuesAPI.Values = new ValuesAPI.Values(this._client);
+  summary: SummaryAPI.Summary = new SummaryAPI.Summary(this._client);
 
   /**
    * Lists all tagged resources for an account.
@@ -1041,6 +1044,7 @@ ResourceTagging.Keys = Keys;
 ResourceTagging.KeyListResponsesCursorPaginationAfter = KeyListResponsesCursorPaginationAfter;
 ResourceTagging.Values = Values;
 ResourceTagging.ValueListResponsesCursorPaginationAfter = ValueListResponsesCursorPaginationAfter;
+ResourceTagging.Summary = Summary;
 
 export declare namespace ResourceTagging {
   export {
@@ -1080,4 +1084,6 @@ export declare namespace ResourceTagging {
     ValueListResponsesCursorPaginationAfter as ValueListResponsesCursorPaginationAfter,
     type ValueListParams as ValueListParams,
   };
+
+  export { Summary as Summary };
 }

package/src/resources/resource-tagging/summary.ts

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+
+export class Summary extends APIResource {}

package/src/resources/rulesets/rules.ts

@@ -4947,6 +4947,13 @@ export namespace SetCacheSettingsRule {
      * Whether to strip Set-Cookie headers from the origin response before caching.
      */
     strip_set_cookie?: boolean;
+
+    /**
+     * Controls how cached responses vary based on request headers. `default` is
+     * required by the API and applies to any Vary response header that does not have a
+     * per-header override.
+     */
+    vary?: ActionParameters.Vary;
   }
 
   export namespace ActionParameters {
@@ -5247,6 +5254,58 @@ export namespace SetCacheSettingsRule {
        */
       match_pattern: string;
     }
+
+    /**
+     * Controls how cached responses vary based on request headers. `default` is
+     * required by the API and applies to any Vary response header that does not have a
+     * per-header override.
+     */
+    export interface Vary {
+      /**
+       * Controls how response Vary headers without a per-header override contribute to
+       * the cache key.
+       */
+      default?: Vary.Default;
+
+      /**
+       * A mapping of lowercase request header names to their vary configuration.
+       */
+      headers?: { [key: string]: Vary.Headers };
+    }
+
+    export namespace Vary {
+      /**
+       * Controls how response Vary headers without a per-header override contribute to
+       * the cache key.
+       */
+      export interface Default {
+        /**
+         * How the header value is treated when building the cache key.
+         */
+        action: 'bypass' | 'passthrough' | 'normalize';
+      }
+
+      /**
+       * Controls how a single request header contributes to the cache key.
+       */
+      export interface Headers {
+        /**
+         * How the header value is treated when building the cache key.
+         */
+        action: 'bypass' | 'passthrough' | 'normalize';
+
+        /**
+         * The set of languages to normalize against. Only valid for the `accept-language`
+         * header.
+         */
+        languages?: Array<string>;
+
+        /**
+         * The set of media types to normalize against. Only valid for the `accept` header.
+         */
+        media_types?: Array<string>;
+      }
+    }
   }
 
   /**
@@ -5459,6 +5518,13 @@ export namespace SetCacheSettingsRuleParam {
      * Whether to strip Set-Cookie headers from the origin response before caching.
      */
     strip_set_cookie?: boolean;
+
+    /**
+     * Controls how cached responses vary based on request headers. `default` is
+     * required by the API and applies to any Vary response header that does not have a
+     * per-header override.
+     */
+    vary?: ActionParameters.Vary;
   }
 
   export namespace ActionParameters {
@@ -5759,6 +5825,58 @@ export namespace SetCacheSettingsRuleParam {
        */
       match_pattern: string;
     }
+
+    /**
+     * Controls how cached responses vary based on request headers. `default` is
+     * required by the API and applies to any Vary response header that does not have a
+     * per-header override.
+     */
+    export interface Vary {
+      /**
+       * Controls how response Vary headers without a per-header override contribute to
+       * the cache key.
+       */
+      default?: Vary.Default;
+
+      /**
+       * A mapping of lowercase request header names to their vary configuration.
+       */
+      headers?: { [key: string]: Vary.Headers };
+    }
+
+    export namespace Vary {
+      /**
+       * Controls how response Vary headers without a per-header override contribute to
+       * the cache key.
+       */
+      export interface Default {
+        /**
+         * How the header value is treated when building the cache key.
+         */
+        action: 'bypass' | 'passthrough' | 'normalize';
+      }
+
+      /**
+       * Controls how a single request header contributes to the cache key.
+       */
+      export interface Headers {
+        /**
+         * How the header value is treated when building the cache key.
+         */
+        action: 'bypass' | 'passthrough' | 'normalize';
+
+        /**
+         * The set of languages to normalize against. Only valid for the `accept-language`
+         * header.
+         */
+        languages?: Array<string>;
+
+        /**
+         * The set of media types to normalize against. Only valid for the `accept` header.
+         */
+        media_types?: Array<string>;
+      }
+    }
   }
 
   /**
@@ -14295,6 +14413,13 @@ export declare namespace RuleCreateParams {
        * Whether to strip Set-Cookie headers from the origin response before caching.
        */
       strip_set_cookie?: boolean;
+
+      /**
+       * Controls how cached responses vary based on request headers. `default` is
+       * required by the API and applies to any Vary response header that does not have a
+       * per-header override.
+       */
+      vary?: ActionParameters.Vary;
     }
 
     export namespace ActionParameters {
@@ -14595,6 +14720,58 @@ export declare namespace RuleCreateParams {
          */
         match_pattern: string;
       }
+
+      /**
+       * Controls how cached responses vary based on request headers. `default` is
+       * required by the API and applies to any Vary response header that does not have a
+       * per-header override.
+       */
+      export interface Vary {
+        /**
+         * Controls how response Vary headers without a per-header override contribute to
+         * the cache key.
+         */
+        default?: Vary.Default;
+
+        /**
+         * A mapping of lowercase request header names to their vary configuration.
+         */
+        headers?: { [key: string]: Vary.Headers };
+      }
+
+      export namespace Vary {
+        /**
+         * Controls how response Vary headers without a per-header override contribute to
+         * the cache key.
+         */
+        export interface Default {
+          /**
+           * How the header value is treated when building the cache key.
+           */
+          action: 'bypass' | 'passthrough' | 'normalize';
+        }
+
+        /**
+         * Controls how a single request header contributes to the cache key.
+         */
+        export interface Headers {
+          /**
+           * How the header value is treated when building the cache key.
+           */
+          action: 'bypass' | 'passthrough' | 'normalize';
+
+          /**
+           * The set of languages to normalize against. Only valid for the `accept-language`
+           * header.
+           */
+          languages?: Array<string>;
+
+          /**
+           * The set of media types to normalize against. Only valid for the `accept` header.
+           */
+          media_types?: Array<string>;
+        }
+      }
     }
 
     /**
@@ -19484,6 +19661,13 @@ export declare namespace RuleEditParams {
        * Whether to strip Set-Cookie headers from the origin response before caching.
        */
       strip_set_cookie?: boolean;
+
+      /**
+       * Controls how cached responses vary based on request headers. `default` is
+       * required by the API and applies to any Vary response header that does not have a
+       * per-header override.
+       */
+      vary?: ActionParameters.Vary;
     }
 
     export namespace ActionParameters {
@@ -19784,6 +19968,58 @@ export declare namespace RuleEditParams {
          */
         match_pattern: string;
       }
+
+      /**
+       * Controls how cached responses vary based on request headers. `default` is
+       * required by the API and applies to any Vary response header that does not have a
+       * per-header override.
+       */
+      export interface Vary {
+        /**
+         * Controls how response Vary headers without a per-header override contribute to
+         * the cache key.
+         */
+        default?: Vary.Default;
+
+        /**
+         * A mapping of lowercase request header names to their vary configuration.
+         */
+        headers?: { [key: string]: Vary.Headers };
+      }
+
+      export namespace Vary {
+        /**
+         * Controls how response Vary headers without a per-header override contribute to
+         * the cache key.
+         */
+        export interface Default {
+          /**
+           * How the header value is treated when building the cache key.
+           */
+          action: 'bypass' | 'passthrough' | 'normalize';
+        }
+
+        /**
+         * Controls how a single request header contributes to the cache key.
+         */
+        export interface Headers {
+          /**
+           * How the header value is treated when building the cache key.
+           */
+          action: 'bypass' | 'passthrough' | 'normalize';
+
+          /**
+           * The set of languages to normalize against. Only valid for the `accept-language`
+           * header.
+           */
+          languages?: Array<string>;
+
+          /**
+           * The set of media types to normalize against. Only valid for the `accept` header.
+           */
+          media_types?: Array<string>;
+        }
+      }
     }
 
     /**

package/src/resources/shared.ts

@@ -105,12 +105,12 @@ export namespace AuditLog {
 }
 
 /**
- * The Certificate Authority that will issue the certificate
+ * The Certificate Authority that will issue the certificate.
  */
 export type CertificateCA = 'digicert' | 'google' | 'lets_encrypt' | 'ssl_com';
 
 /**
- * The Certificate Authority that will issue the certificate
+ * The Certificate Authority that will issue the certificate.
  */
 export type CertificateCAParam = 'digicert' | 'google' | 'lets_encrypt' | 'ssl_com';
 

package/src/resources/snippets/api.md

@@ -27,9 +27,11 @@ Types:
 - <code><a href="./src/resources/snippets/rules.ts">RuleUpdateResponse</a></code>
 - <code><a href="./src/resources/snippets/rules.ts">RuleListResponse</a></code>
 - <code><a href="./src/resources/snippets/rules.ts">RuleDeleteResponse</a></code>
+- <code><a href="./src/resources/snippets/rules.ts">RuleGetResponse</a></code>
 
 Methods:
 
 - <code title="put /zones/{zone_id}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">update</a>({ ...params }) -> RuleUpdateResponse</code>
 - <code title="get /zones/{zone_id}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">list</a>({ ...params }) -> RuleListResponse</code>
 - <code title="delete /zones/{zone_id}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">delete</a>({ ...params }) -> RuleDeleteResponse</code>
+- <code title="get /zones/{zone_id}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">get</a>({ ...params }) -> RuleGetResponse</code>

package/src/resources/snippets/index.ts

@@ -6,8 +6,10 @@ export {
   type RuleUpdateResponse,
   type RuleListResponse,
   type RuleDeleteResponse,
+  type RuleGetResponse,
   type RuleUpdateParams,
   type RuleListParams,
   type RuleDeleteParams,
+  type RuleGetParams,
 } from './rules';
 export { Snippets } from './snippets';

package/src/resources/snippets/rules.ts

@@ -39,6 +39,18 @@ export class Rules extends APIResource {
       }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Fetches all snippet rules belonging to the zone.
+   */
+  get(params: RuleGetParams, options?: Core.RequestOptions): Core.APIPromise<RuleGetResponse> {
+    const { zone_id } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/snippets/snippet_rules`, options) as Core.APIPromise<{
+        result: RuleGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
 /**
@@ -56,6 +68,11 @@ export type RuleListResponse = unknown;
  */
 export type RuleDeleteResponse = unknown;
 
+/**
+ * Contain the response result.
+ */
+export type RuleGetResponse = unknown;
+
 export interface RuleUpdateParams {
   /**
    * Path param: Use this field to specify the unique ID of the zone.
@@ -109,13 +126,22 @@ export interface RuleDeleteParams {
   zone_id: string;
 }
 
+export interface RuleGetParams {
+  /**
+   * Use this field to specify the unique ID of the zone.
+   */
+  zone_id: string;
+}
+
 export declare namespace Rules {
   export {
     type RuleUpdateResponse as RuleUpdateResponse,
     type RuleListResponse as RuleListResponse,
     type RuleDeleteResponse as RuleDeleteResponse,
+    type RuleGetResponse as RuleGetResponse,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,
     type RuleDeleteParams as RuleDeleteParams,
+    type RuleGetParams as RuleGetParams,
   };
 }

package/src/resources/snippets/snippets.ts

@@ -8,6 +8,8 @@ import * as RulesAPI from './rules';
 import {
   RuleDeleteParams,
   RuleDeleteResponse,
+  RuleGetParams,
+  RuleGetResponse,
   RuleListParams,
   RuleListResponse,
   RuleUpdateParams,
@@ -222,8 +224,10 @@ export declare namespace Snippets {
     type RuleUpdateResponse as RuleUpdateResponse,
     type RuleListResponse as RuleListResponse,
     type RuleDeleteResponse as RuleDeleteResponse,
+    type RuleGetResponse as RuleGetResponse,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,
     type RuleDeleteParams as RuleDeleteParams,
+    type RuleGetParams as RuleGetParams,
   };
 }

package/src/resources/ssl/api.md

@@ -44,13 +44,17 @@ Methods:
 
 ## Recommendations
 
+## AutoOriginTLSKex
+
 Types:
 
-- <code><a href="./src/resources/ssl/recommendations.ts">RecommendationGetResponse</a></code>
+- <code><a href="./src/resources/ssl/auto-origin-tls-kex.ts">AutoOriginTLSKexEditResponse</a></code>
+- <code><a href="./src/resources/ssl/auto-origin-tls-kex.ts">AutoOriginTLSKexGetResponse</a></code>
 
 Methods:
 
-- <code title="get /zones/{zone_id}/ssl/recommendation">client.ssl.recommendations.<a href="./src/resources/ssl/recommendations.ts">get</a>({ ...params }) -> RecommendationGetResponse</code>
+- <code title="patch /zones/{zone_id}/settings/auto_origin_tls_kex">client.ssl.autoOriginTLSKex.<a href="./src/resources/ssl/auto-origin-tls-kex.ts">edit</a>({ ...params }) -> AutoOriginTLSKexEditResponse</code>
+- <code title="get /zones/{zone_id}/settings/auto_origin_tls_kex">client.ssl.autoOriginTLSKex.<a href="./src/resources/ssl/auto-origin-tls-kex.ts">get</a>({ ...params }) -> AutoOriginTLSKexGetResponse</code>
 
 ## Universal