cloudflare 4.5.0 → 5.0.0

package/src/resources/rulesets/versions.ts

@@ -251,21 +251,21 @@ export interface VersionGetResponse {
     | RulesAPI.BlockRule
     | VersionGetResponse.RulesetsChallengeRule
     | RulesAPI.CompressResponseRule
+    | RulesAPI.DDoSDynamicRule
     | RulesAPI.ExecuteRule
+    | RulesAPI.ForceConnectionCloseRule
     | VersionGetResponse.RulesetsJSChallengeRule
     | RulesAPI.LogRule
+    | RulesAPI.LogCustomFieldRule
     | RulesAPI.ManagedChallengeRule
     | RulesAPI.RedirectRule
     | RulesAPI.RewriteRule
     | RulesAPI.RouteRule
     | RulesAPI.ScoreRule
     | RulesAPI.ServeErrorRule
+    | RulesAPI.SetCacheSettingsRule
     | RulesAPI.SetConfigRule
     | RulesAPI.SkipRule
-    | RulesAPI.SetCacheSettingsRule
-    | RulesAPI.LogCustomFieldRule
-    | RulesAPI.DDoSDynamicRule
-    | RulesAPI.ForceConnectionCloseRule
   >;
 
   /**
@@ -322,7 +322,7 @@ export namespace VersionGetResponse {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
 
@@ -337,38 +337,38 @@ export namespace VersionGetResponse {
     logging?: RulesAPI.Logging;
 
     /**
-     * An object configuring the rule's ratelimit behavior.
+     * An object configuring the rule's rate limit behavior.
      */
     ratelimit?: RulesetsChallengeRule.Ratelimit;
 
     /**
-     * The reference of the rule (the rule ID by default).
+     * The reference of the rule (the rule's ID by default).
      */
     ref?: string;
   }
 
   export namespace RulesetsChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export interface ExposedCredentialCheck {
       /**
-       * Expression that selects the password used in the credentials check.
+       * An expression that selects the password used in the credentials check.
        */
       password_expression: string;
 
       /**
-       * Expression that selects the user ID used in the credentials check.
+       * An expression that selects the user ID used in the credentials check.
        */
       username_expression: string;
     }
 
     /**
-     * An object configuring the rule's ratelimit behavior.
+     * An object configuring the rule's rate limit behavior.
      */
     export interface Ratelimit {
       /**
-       * Characteristics of the request on which the ratelimiter counter will be
+       * Characteristics of the request on which the rate limit counter will be
        * incremented.
        */
       characteristics: Array<string>;
@@ -379,7 +379,7 @@ export namespace VersionGetResponse {
       period: number;
 
       /**
-       * Defines when the ratelimit counter should be incremented. It is optional and
+       * An expression that defines when the rate limit counter should be incremented. It
        * defaults to the same as the rule's expression.
        */
       counting_expression?: string;
@@ -397,7 +397,7 @@ export namespace VersionGetResponse {
       requests_per_period?: number;
 
       /**
-       * Defines if ratelimit counting is only done when an origin is reached.
+       * Whether counting is only performed when an origin is reached.
        */
       requests_to_origin?: boolean;
 
@@ -408,8 +408,8 @@ export namespace VersionGetResponse {
       score_per_period?: number;
 
       /**
-       * The response header name provided by the origin which should contain the score
-       * to increment ratelimit counter on.
+       * A response header name provided by the origin, which contains the score to
+       * increment rate limit counter with.
        */
       score_response_header_name?: string;
     }
@@ -457,7 +457,7 @@ export namespace VersionGetResponse {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
 
@@ -472,38 +472,38 @@ export namespace VersionGetResponse {
     logging?: RulesAPI.Logging;
 
     /**
-     * An object configuring the rule's ratelimit behavior.
+     * An object configuring the rule's rate limit behavior.
      */
     ratelimit?: RulesetsJSChallengeRule.Ratelimit;
 
     /**
-     * The reference of the rule (the rule ID by default).
+     * The reference of the rule (the rule's ID by default).
      */
     ref?: string;
   }
 
   export namespace RulesetsJSChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export interface ExposedCredentialCheck {
       /**
-       * Expression that selects the password used in the credentials check.
+       * An expression that selects the password used in the credentials check.
        */
       password_expression: string;
 
       /**
-       * Expression that selects the user ID used in the credentials check.
+       * An expression that selects the user ID used in the credentials check.
        */
       username_expression: string;
     }
 
     /**
-     * An object configuring the rule's ratelimit behavior.
+     * An object configuring the rule's rate limit behavior.
      */
     export interface Ratelimit {
       /**
-       * Characteristics of the request on which the ratelimiter counter will be
+       * Characteristics of the request on which the rate limit counter will be
        * incremented.
        */
       characteristics: Array<string>;
@@ -514,7 +514,7 @@ export namespace VersionGetResponse {
       period: number;
 
       /**
-       * Defines when the ratelimit counter should be incremented. It is optional and
+       * An expression that defines when the rate limit counter should be incremented. It
        * defaults to the same as the rule's expression.
        */
       counting_expression?: string;
@@ -532,7 +532,7 @@ export namespace VersionGetResponse {
       requests_per_period?: number;
 
       /**
-       * Defines if ratelimit counting is only done when an origin is reached.
+       * Whether counting is only performed when an origin is reached.
        */
       requests_to_origin?: boolean;
 
@@ -543,8 +543,8 @@ export namespace VersionGetResponse {
       score_per_period?: number;
 
       /**
-       * The response header name provided by the origin which should contain the score
-       * to increment ratelimit counter on.
+       * A response header name provided by the origin, which contains the score to
+       * increment rate limit counter with.
        */
       score_response_header_name?: string;
     }

package/src/resources/secrets-store/stores/secrets.ts

@@ -18,7 +18,7 @@ export class Secrets extends APIResource {
    *     body: [
    *       {
    *         name: 'MY_API_KEY',
-   *         scopes: ['workers'],
+   *         scopes: ['workers', 'ai_gateway'],
    *         value: 'api-token-secret-123',
    *       },
    *     ],
@@ -135,6 +135,7 @@ export class Secrets extends APIResource {
    *     {
    *       account_id: '985e105f4ecef8ad9ca31a8372d0c353',
    *       name: 'MY_API_KEY',
+   *       scopes: ['workers', 'ai_gateway'],
    *     },
    *   );
    * ```
@@ -163,10 +164,7 @@ export class Secrets extends APIResource {
    *   await client.secretsStore.stores.secrets.edit(
    *     '023e105f4ecef8ad9ca31a8372d0c353',
    *     '3fd85f74b32742f1bff64a85009dda07',
-   *     {
-   *       account_id: '985e105f4ecef8ad9ca31a8372d0c353',
-   *       name: 'MY_API_KEY',
-   *     },
+   *     { account_id: '985e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
    */
@@ -486,6 +484,11 @@ export namespace SecretCreateParams {
      * provide this value, it is only used to create/modify secrets.
      */
     value: string;
+
+    /**
+     * Freeform text describing the secret
+     */
+    comment?: string;
   }
 }
 
@@ -505,6 +508,11 @@ export interface SecretListParams extends V4PagePaginationArrayParams {
    */
   order?: 'name' | 'comment' | 'created' | 'modified' | 'status';
 
+  /**
+   * Query param: Only secrets with the given scopes will be returned
+   */
+  scopes?: Array<Array<string>>;
+
   /**
    * Query param: Search secrets using a filter string, filtering across name and
    * comment
@@ -536,6 +544,16 @@ export interface SecretDuplicateParams {
    * Body param: The name of the secret
    */
   name: string;
+
+  /**
+   * Body param: The list of services that can use this secret.
+   */
+  scopes: Array<string>;
+
+  /**
+   * Body param: Freeform text describing the secret
+   */
+  comment?: string;
 }
 
 export interface SecretEditParams {
@@ -545,20 +563,14 @@ export interface SecretEditParams {
   account_id: string;
 
   /**
-   * Body param: The name of the secret
+   * Body param: Freeform text describing the secret
    */
-  name: string;
+  comment?: string;
 
   /**
    * Body param: The list of services that can use this secret.
    */
   scopes?: Array<string>;
-
-  /**
-   * Body param: The value of the secret. Note that this is 'write only' - no API
-   * reponse will provide this value, it is only used to create/modify secrets.
-   */
-  value?: string;
 }
 
 export interface SecretGetParams {

package/src/resources/shared.ts

@@ -140,6 +140,13 @@ export interface CloudflareTunnel {
    */
   account_tag?: string;
 
+  /**
+   * Indicates if this is a locally or remotely configured tunnel. If `local`, manage
+   * the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the
+   * tunnel on the Zero Trust dashboard.
+   */
+  config_src?: 'local' | 'cloudflare';
+
   /**
    * @deprecated This field will start returning an empty array. To fetch the
    * connections of a given tunnel, please use the dedicated endpoint
@@ -181,8 +188,7 @@ export interface CloudflareTunnel {
   name?: string;
 
   /**
-   * If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
-   * If `false`, the tunnel must be configured locally on the origin machine.
+   * @deprecated Use the config_src field instead.
    */
   remote_config?: boolean;
 
@@ -285,6 +291,11 @@ export interface Member {
    */
   id?: string;
 
+  /**
+   * The contact email address of the user.
+   */
+  email?: string;
+
   /**
    * Access policy for the membership
    */
@@ -890,7 +901,7 @@ export interface TokenPolicy {
   /**
    * A list of resource names that the policy applies to.
    */
-  resources: { [key: string]: string | { [key: string]: string } };
+  resources: { [key: string]: string } | { [key: string]: { [key: string]: string } };
 }
 
 export namespace TokenPolicy {
@@ -941,7 +952,7 @@ export interface TokenPolicyParam {
   /**
    * A list of resource names that the policy applies to.
    */
-  resources: { [key: string]: string | { [key: string]: string } };
+  resources: { [key: string]: string } | { [key: string]: { [key: string]: string } };
 }
 
 export namespace TokenPolicyParam {

package/src/resources/snippets/content.ts

@@ -6,18 +6,7 @@ import { type Response } from '../../_shims/index';
 
 export class Content extends APIResource {
   /**
-   * Snippet Content
-   *
-   * @example
-   * ```ts
-   * const content = await client.snippets.content.get(
-   *   'snippet_name_01',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   *
-   * const data = await content.blob();
-   * console.log(data);
-   * ```
+   * Fetches the content of a snippet belonging to the zone.
    */
   get(
     snippetName: string,
@@ -35,7 +24,7 @@ export class Content extends APIResource {
 
 export interface ContentGetParams {
   /**
-   * Identifier
+   * The unique ID of the zone.
    */
   zone_id: string;
 }

package/src/resources/snippets/index.ts

@@ -4,6 +4,7 @@ export { Content, type ContentGetParams } from './content';
 export {
   RuleUpdateResponsesSinglePage,
   RuleListResponsesSinglePage,
+  RuleDeleteResponsesSinglePage,
   Rules,
   type RuleUpdateResponse,
   type RuleListResponse,

package/src/resources/snippets/rules.ts

@@ -2,22 +2,11 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import * as Shared from '../shared';
 import { SinglePage } from '../../pagination';
 
 export class Rules extends APIResource {
   /**
-   * Put Rules
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const ruleUpdateResponse of client.snippets.rules.update(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * Updates all snippet rules belonging to the zone.
    */
   update(
     params: RuleUpdateParams,
@@ -32,17 +21,7 @@ export class Rules extends APIResource {
   }
 
   /**
-   * Rules
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const ruleListResponse of client.snippets.rules.list(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * Fetches all snippet rules belonging to the zone.
    */
   list(
     params: RuleListParams,
@@ -57,18 +36,18 @@ export class Rules extends APIResource {
   }
 
   /**
-   * Delete All Rules
-   *
-   * @example
-   * ```ts
-   * const rule = await client.snippets.rules.delete({
-   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * });
-   * ```
+   * Deletes all snippet rules belonging to the zone.
    */
-  delete(params: RuleDeleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse> {
+  delete(
+    params: RuleDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RuleDeleteResponsesSinglePage, RuleDeleteResponse> {
     const { zone_id } = params;
-    return this._client.delete(`/zones/${zone_id}/snippets/snippet_rules`, options);
+    return this._client.getAPIList(
+      `/zones/${zone_id}/snippets/snippet_rules`,
+      RuleDeleteResponsesSinglePage,
+      { method: 'delete', ...options },
+    );
   }
 }
 
@@ -76,86 +55,169 @@ export class RuleUpdateResponsesSinglePage extends SinglePage<RuleUpdateResponse
 
 export class RuleListResponsesSinglePage extends SinglePage<RuleListResponse> {}
 
+export class RuleDeleteResponsesSinglePage extends SinglePage<RuleDeleteResponse> {}
+
+/**
+ * A snippet rule.
+ */
 export interface RuleUpdateResponse {
-  description?: string;
+  /**
+   * The unique ID of the rule.
+   */
+  id: string;
 
-  enabled?: boolean;
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression: string;
 
-  expression?: string;
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
 
   /**
-   * Snippet identifying name
+   * The identifying name of the snippet.
    */
-  snippet_name?: string;
-}
+  snippet_name: string;
 
-export interface RuleListResponse {
+  /**
+   * An informative description of the rule.
+   */
   description?: string;
 
+  /**
+   * Whether the rule should be executed.
+   */
   enabled?: boolean;
+}
+
+/**
+ * A snippet rule.
+ */
+export interface RuleListResponse {
+  /**
+   * The unique ID of the rule.
+   */
+  id: string;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression: string;
+
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The identifying name of the snippet.
+   */
+  snippet_name: string;
 
-  expression?: string;
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
 
   /**
-   * Snippet identifying name
+   * Whether the rule should be executed.
    */
-  snippet_name?: string;
+  enabled?: boolean;
 }
 
+/**
+ * A snippet rule.
+ */
 export interface RuleDeleteResponse {
-  errors: Array<Shared.ResponseInfo>;
+  /**
+   * The unique ID of the rule.
+   */
+  id: string;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression: string;
+
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The identifying name of the snippet.
+   */
+  snippet_name: string;
 
-  messages: Array<Shared.ResponseInfo>;
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
 
   /**
-   * Whether the API call was successful
+   * Whether the rule should be executed.
    */
-  success: true;
+  enabled?: boolean;
 }
 
 export interface RuleUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: The unique ID of the zone.
    */
   zone_id: string;
 
   /**
-   * Body param: List of snippet rules
+   * Body param: A list of snippet rules.
    */
-  rules?: Array<RuleUpdateParams.Rule>;
+  rules: Array<RuleUpdateParams.Rule>;
 }
 
 export namespace RuleUpdateParams {
+  /**
+   * A snippet rule.
+   */
   export interface Rule {
-    description?: string;
+    /**
+     * The expression defining which traffic will match the rule.
+     */
+    expression: string;
 
-    enabled?: boolean;
+    /**
+     * The identifying name of the snippet.
+     */
+    snippet_name: string;
 
-    expression?: string;
+    /**
+     * An informative description of the rule.
+     */
+    description?: string;
 
     /**
-     * Snippet identifying name
+     * Whether the rule should be executed.
      */
-    snippet_name?: string;
+    enabled?: boolean;
   }
 }
 
 export interface RuleListParams {
   /**
-   * Identifier
+   * The unique ID of the zone.
    */
   zone_id: string;
 }
 
 export interface RuleDeleteParams {
   /**
-   * Identifier
+   * The unique ID of the zone.
    */
   zone_id: string;
 }
 
 Rules.RuleUpdateResponsesSinglePage = RuleUpdateResponsesSinglePage;
 Rules.RuleListResponsesSinglePage = RuleListResponsesSinglePage;
+Rules.RuleDeleteResponsesSinglePage = RuleDeleteResponsesSinglePage;
 
 export declare namespace Rules {
   export {
@@ -164,6 +226,7 @@ export declare namespace Rules {
     type RuleDeleteResponse as RuleDeleteResponse,
     RuleUpdateResponsesSinglePage as RuleUpdateResponsesSinglePage,
     RuleListResponsesSinglePage as RuleListResponsesSinglePage,
+    RuleDeleteResponsesSinglePage as RuleDeleteResponsesSinglePage,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,
     type RuleDeleteParams as RuleDeleteParams,