cloudflare 4.2.0 → 4.3.0

package/src/resources/firewall/access-rules.ts

@@ -13,6 +13,17 @@ export class AccessRules extends APIResource {
    *
    * Note: To create an IP Access rule that applies to a single zone, refer to the
    * [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.
+   *
+   * @example
+   * ```ts
+   * const accessRule = await client.firewall.accessRules.create(
+   *   {
+   *     configuration: {},
+   *     mode: 'challenge',
+   *     account_id: 'account_id',
+   *   },
+   * );
+   * ```
    */
   create(
     params: AccessRuleCreateParams,
@@ -47,6 +58,16 @@ export class AccessRules extends APIResource {
    * Fetches IP Access rules of an account or zone. These rules apply to all the
    * zones in the account or zone. You can filter the results using several optional
    * parameters.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const accessRuleListResponse of client.firewall.accessRules.list(
+   *   { account_id: 'account_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params?: AccessRuleListParams,
@@ -90,6 +111,14 @@ export class AccessRules extends APIResource {
    * Deletes an existing IP Access rule defined.
    *
    * Note: This operation will affect all zones in the account or zone.
+   *
+   * @example
+   * ```ts
+   * const accessRule = await client.firewall.accessRules.delete(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   { account_id: 'account_id' },
+   * );
+   * ```
    */
   delete(
     ruleId: string,
@@ -134,6 +163,18 @@ export class AccessRules extends APIResource {
    * Updates an IP Access rule defined.
    *
    * Note: This operation will affect all zones in the account or zone.
+   *
+   * @example
+   * ```ts
+   * const response = await client.firewall.accessRules.edit(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   {
+   *     configuration: {},
+   *     mode: 'challenge',
+   *     account_id: 'account_id',
+   *   },
+   * );
+   * ```
    */
   edit(
     ruleId: string,
@@ -167,6 +208,14 @@ export class AccessRules extends APIResource {
 
   /**
    * Fetches the details of an IP Access rule defined.
+   *
+   * @example
+   * ```ts
+   * const accessRule = await client.firewall.accessRules.get(
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   { account_id: 'account_id' },
+   * );
+   * ```
    */
   get(
     ruleId: string,
@@ -399,7 +448,7 @@ export namespace AccessRuleCreateResponse {
    */
   export interface Scope {
     /**
-     * Identifier
+     * Defines an identifier.
      */
     id?: string;
 
@@ -409,7 +458,7 @@ export namespace AccessRuleCreateResponse {
     email?: string;
 
     /**
-     * The scope of the rule.
+     * Defines the scope of the rule.
      */
     type?: 'user' | 'organization';
   }
@@ -468,7 +517,7 @@ export namespace AccessRuleListResponse {
    */
   export interface Scope {
     /**
-     * Identifier
+     * Defines an identifier.
      */
     id?: string;
 
@@ -478,7 +527,7 @@ export namespace AccessRuleListResponse {
     email?: string;
 
     /**
-     * The scope of the rule.
+     * Defines the scope of the rule.
      */
     type?: 'user' | 'organization';
   }
@@ -486,7 +535,7 @@ export namespace AccessRuleListResponse {
 
 export interface AccessRuleDeleteResponse {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   id: string;
 }
@@ -544,7 +593,7 @@ export namespace AccessRuleEditResponse {
    */
   export interface Scope {
     /**
-     * Identifier
+     * Defines an identifier.
      */
     id?: string;
 
@@ -554,7 +603,7 @@ export namespace AccessRuleEditResponse {
     email?: string;
 
     /**
-     * The scope of the rule.
+     * Defines the scope of the rule.
      */
     type?: 'user' | 'organization';
   }
@@ -613,7 +662,7 @@ export namespace AccessRuleGetResponse {
    */
   export interface Scope {
     /**
-     * Identifier
+     * Defines an identifier.
      */
     id?: string;
 
@@ -623,7 +672,7 @@ export namespace AccessRuleGetResponse {
     email?: string;
 
     /**
-     * The scope of the rule.
+     * Defines the scope of the rule.
      */
     type?: 'user' | 'organization';
   }
@@ -683,13 +732,14 @@ export interface AccessRuleListParams extends V4PagePaginationArrayParams {
   configuration?: AccessRuleListParams.Configuration;
 
   /**
-   * Query param: The direction used to sort returned rules.
+   * Query param: Defines the direction used to sort returned rules.
    */
   direction?: 'asc' | 'desc';
 
   /**
-   * Query param: When set to `all`, all the search requirements must match. When set
-   * to `any`, only one of the search requirements has to match.
+   * Query param: Defines the search requirements. When set to `all`, all the search
+   * requirements must match. When set to `any`, only one of the search requirements
+   * has to match.
    */
   match?: 'any' | 'all';
 
@@ -699,14 +749,14 @@ export interface AccessRuleListParams extends V4PagePaginationArrayParams {
   mode?: 'block' | 'challenge' | 'whitelist' | 'js_challenge' | 'managed_challenge';
 
   /**
-   * Query param: The string to search for in the notes of existing IP Access rules.
-   * Notes: For example, the string 'attack' would match IP Access rules with notes
-   * 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
+   * Query param: Defines the string to search for in the notes of existing IP Access
+   * rules. Notes: For example, the string 'attack' would match IP Access rules with
+   * notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.
    */
   notes?: string;
 
   /**
-   * Query param: The field used to sort returned rules.
+   * Query param: Defines the field used to sort returned rules.
    */
   order?: 'configuration.target' | 'configuration.value' | 'mode';
 }
@@ -714,15 +764,16 @@ export interface AccessRuleListParams extends V4PagePaginationArrayParams {
 export namespace AccessRuleListParams {
   export interface Configuration {
     /**
-     * The target to search in existing rules.
+     * Defines the target to search in existing rules.
      */
     target?: 'ip' | 'ip_range' | 'asn' | 'country';
 
     /**
-     * The target value to search for in existing rules: an IP address, an IP address
-     * range, or a country code, depending on the provided `configuration.target`.
-     * Notes: You can search for a single IPv4 address, an IP address range with a
-     * subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.
+     * Defines the target value to search for in existing rules: an IP address, an IP
+     * address range, or a country code, depending on the provided
+     * `configuration.target`. Notes: You can search for a single IPv4 address, an IP
+     * address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1
+     * alpha-2 country code.
      */
     value?: string;
   }

package/src/resources/firewall/lockdowns.ts

@@ -8,6 +8,15 @@ import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../p
 export class Lockdowns extends APIResource {
   /**
    * Creates a new Zone Lockdown rule.
+   *
+   * @example
+   * ```ts
+   * const lockdown = await client.firewall.lockdowns.create({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   configurations: [{}],
+   *   urls: ['shop.example.com/*'],
+   * });
+   * ```
    */
   create(params: LockdownCreateParams, options?: Core.RequestOptions): Core.APIPromise<Lockdown> {
     const { zone_id, ...body } = params;
@@ -20,6 +29,18 @@ export class Lockdowns extends APIResource {
 
   /**
    * Updates an existing Zone Lockdown rule.
+   *
+   * @example
+   * ```ts
+   * const lockdown = await client.firewall.lockdowns.update(
+   *   '372e67954025e0ba6aaa6d586b9e0b59',
+   *   {
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     configurations: [{}],
+   *     urls: ['shop.example.com/*'],
+   *   },
+   * );
+   * ```
    */
   update(
     lockDownsId: string,
@@ -38,6 +59,16 @@ export class Lockdowns extends APIResource {
   /**
    * Fetches Zone Lockdown rules. You can filter the results using several optional
    * parameters.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const lockdown of client.firewall.lockdowns.list(
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: LockdownListParams,
@@ -52,6 +83,14 @@ export class Lockdowns extends APIResource {
 
   /**
    * Deletes an existing Zone Lockdown rule.
+   *
+   * @example
+   * ```ts
+   * const lockdown = await client.firewall.lockdowns.delete(
+   *   '372e67954025e0ba6aaa6d586b9e0b59',
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   delete(
     lockDownsId: string,
@@ -68,6 +107,14 @@ export class Lockdowns extends APIResource {
 
   /**
    * Fetches the details of a Zone Lockdown rule.
+   *
+   * @example
+   * ```ts
+   * const lockdown = await client.firewall.lockdowns.get(
+   *   '372e67954025e0ba6aaa6d586b9e0b59',
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   get(
     lockDownsId: string,
@@ -205,7 +252,7 @@ export interface LockdownDeleteResponse {
 
 export interface LockdownCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -226,7 +273,7 @@ export interface LockdownCreateParams {
 
 export interface LockdownUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -247,7 +294,7 @@ export interface LockdownUpdateParams {
 
 export interface LockdownListParams extends V4PagePaginationArrayParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -301,14 +348,14 @@ export interface LockdownListParams extends V4PagePaginationArrayParams {
 
 export interface LockdownDeleteParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }
 
 export interface LockdownGetParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }

package/src/resources/firewall/rules.ts

@@ -226,7 +226,7 @@ export type Product = 'zoneLockdown' | 'uaBlock' | 'bic' | 'hot' | 'securityLeve
 
 export interface RuleCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -299,7 +299,7 @@ export namespace RuleCreateParams {
 
 export interface RuleUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -372,7 +372,7 @@ export namespace RuleUpdateParams {
 
 export interface RuleListParams extends V4PagePaginationArrayParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -399,21 +399,21 @@ export interface RuleListParams extends V4PagePaginationArrayParams {
 
 export interface RuleDeleteParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }
 
 export interface RuleBulkDeleteParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }
 
 export interface RuleBulkEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -425,7 +425,7 @@ export interface RuleBulkEditParams {
 
 export interface RuleBulkUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -437,14 +437,14 @@ export interface RuleBulkUpdateParams {
 
 export interface RuleEditParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }
 
 export interface RuleGetParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }

package/src/resources/firewall/ua-rules.ts

@@ -8,6 +8,15 @@ import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../p
 export class UARules extends APIResource {
   /**
    * Creates a new User Agent Blocking rule in a zone.
+   *
+   * @example
+   * ```ts
+   * const uaRule = await client.firewall.uaRules.create({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   configuration: {},
+   *   mode: 'challenge',
+   * });
+   * ```
    */
   create(params: UARuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<UARuleCreateResponse> {
     const { zone_id, ...body } = params;
@@ -20,6 +29,18 @@ export class UARules extends APIResource {
 
   /**
    * Updates an existing User Agent Blocking rule.
+   *
+   * @example
+   * ```ts
+   * const uaRule = await client.firewall.uaRules.update(
+   *   '372e67954025e0ba6aaa6d586b9e0b59',
+   *   {
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     configuration: {},
+   *     mode: 'challenge',
+   *   },
+   * );
+   * ```
    */
   update(
     uaRuleId: string,
@@ -38,6 +59,16 @@ export class UARules extends APIResource {
   /**
    * Fetches User Agent Blocking rules in a zone. You can filter the results using
    * several optional parameters.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const uaRuleListResponse of client.firewall.uaRules.list(
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: UARuleListParams,
@@ -53,6 +84,14 @@ export class UARules extends APIResource {
 
   /**
    * Deletes an existing User Agent Blocking rule.
+   *
+   * @example
+   * ```ts
+   * const uaRule = await client.firewall.uaRules.delete(
+   *   '372e67954025e0ba6aaa6d586b9e0b59',
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   delete(
     uaRuleId: string,
@@ -69,6 +108,14 @@ export class UARules extends APIResource {
 
   /**
    * Fetches the details of a User Agent Blocking rule.
+   *
+   * @example
+   * ```ts
+   * const uaRule = await client.firewall.uaRules.get(
+   *   '372e67954025e0ba6aaa6d586b9e0b59',
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   get(
     uaRuleId: string,
@@ -147,7 +194,7 @@ export type UARuleGetResponse = unknown | string | null;
 
 export interface UARuleCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -169,7 +216,7 @@ export interface UARuleCreateParams {
 
 export interface UARuleUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -191,7 +238,7 @@ export interface UARuleUpdateParams {
 
 export interface UARuleListParams extends V4PagePaginationArrayParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -213,14 +260,14 @@ export interface UARuleListParams extends V4PagePaginationArrayParams {
 
 export interface UARuleDeleteParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }
 
 export interface UARuleGetParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }

package/src/resources/firewall/waf/overrides.ts

@@ -10,6 +10,16 @@ export class Overrides extends APIResource {
    *
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
+   *
+   * @example
+   * ```ts
+   * const override = await client.firewall.waf.overrides.create(
+   *   {
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     urls: ['shop.example.com/*'],
+   *   },
+   * );
+   * ```
    */
   create(params: OverrideCreateParams, options?: Core.RequestOptions): Core.APIPromise<Override> {
     const { zone_id, ...body } = params;
@@ -25,6 +35,20 @@ export class Overrides extends APIResource {
    *
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
+   *
+   * @example
+   * ```ts
+   * const override = await client.firewall.waf.overrides.update(
+   *   'de677e5818985db1285d0e80225f06e5',
+   *   {
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     rewrite_action: {},
+   *     rules: { '100015': 'disable' },
+   *     urls: ['shop.example.com/*'],
+   *   },
+   * );
+   * ```
    */
   update(
     overridesId: string,
@@ -45,6 +69,16 @@ export class Overrides extends APIResource {
    *
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const override of client.firewall.waf.overrides.list(
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: OverrideListParams,
@@ -63,6 +97,14 @@ export class Overrides extends APIResource {
    *
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
+   *
+   * @example
+   * ```ts
+   * const override = await client.firewall.waf.overrides.delete(
+   *   'de677e5818985db1285d0e80225f06e5',
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   delete(
     overridesId: string,
@@ -83,6 +125,14 @@ export class Overrides extends APIResource {
    *
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
+   *
+   * @example
+   * ```ts
+   * const override = await client.firewall.waf.overrides.get(
+   *   'de677e5818985db1285d0e80225f06e5',
+   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   get(
     overridesId: string,
@@ -249,7 +299,7 @@ export interface OverrideDeleteResponse {
 
 export interface OverrideCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
@@ -263,12 +313,12 @@ export interface OverrideCreateParams {
 
 export interface OverrideUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 
   /**
-   * Body param: Identifier
+   * Body param: Defines an identifier.
    */
   id: string;
 
@@ -297,21 +347,21 @@ export interface OverrideUpdateParams {
 
 export interface OverrideListParams extends V4PagePaginationArrayParams {
   /**
-   * Path param: Identifier
+   * Path param: Defines an identifier.
    */
   zone_id: string;
 }
 
 export interface OverrideDeleteParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }
 
 export interface OverrideGetParams {
   /**
-   * Identifier
+   * Defines an identifier.
    */
   zone_id: string;
 }