cloudflare 4.4.1 → 4.5.0

package/src/resources/accounts/tokens/tokens.ts

@@ -8,7 +8,6 @@ import * as PermissionGroupsAPI from './permission-groups';
 import {
   PermissionGroupGetParams,
   PermissionGroupGetResponse,
-  PermissionGroupGetResponsesSinglePage,
   PermissionGroupListParams,
   PermissionGroupListResponse,
   PermissionGroupListResponsesSinglePage,
@@ -39,12 +38,7 @@ export class Tokens extends APIResource {
    *         { id: 'c8fed203ed3043cba015a93ad1616f1f' },
    *         { id: '82e64a83756745bbbb1c9c2701bf816b' },
    *       ],
-   *       resources: {
-   *         'com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43':
-   *           '*',
-   *         'com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4':
-   *           '*',
-   *       },
+   *       resources: { foo: 'string' },
    *     },
    *   ],
    * });
@@ -76,15 +70,9 @@ export class Tokens extends APIResource {
    *           { id: 'c8fed203ed3043cba015a93ad1616f1f' },
    *           { id: '82e64a83756745bbbb1c9c2701bf816b' },
    *         ],
-   *         resources: {
-   *           'com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43':
-   *             '*',
-   *           'com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4':
-   *             '*',
-   *         },
+   *         resources: { foo: 'string' },
    *       },
    *     ],
-   *     status: 'active',
    *   },
    * );
    * ```
@@ -376,11 +364,6 @@ export interface TokenUpdateParams {
    */
   policies: Array<Shared.TokenPolicyParam>;
 
-  /**
-   * Body param: Status of the token.
-   */
-  status: 'active' | 'disabled' | 'expired';
-
   /**
    * Body param:
    */
@@ -396,6 +379,11 @@ export interface TokenUpdateParams {
    * Body param: The time before which the token MUST NOT be accepted for processing.
    */
   not_before?: string;
+
+  /**
+   * Body param: Status of the token.
+   */
+  status?: 'active' | 'disabled' | 'expired';
 }
 
 export namespace TokenUpdateParams {
@@ -459,7 +447,6 @@ export interface TokenVerifyParams {
 
 Tokens.PermissionGroups = PermissionGroups;
 Tokens.PermissionGroupListResponsesSinglePage = PermissionGroupListResponsesSinglePage;
-Tokens.PermissionGroupGetResponsesSinglePage = PermissionGroupGetResponsesSinglePage;
 Tokens.Value = Value;
 
 export declare namespace Tokens {
@@ -480,7 +467,6 @@ export declare namespace Tokens {
     type PermissionGroupListResponse as PermissionGroupListResponse,
     type PermissionGroupGetResponse as PermissionGroupGetResponse,
     PermissionGroupListResponsesSinglePage as PermissionGroupListResponsesSinglePage,
-    PermissionGroupGetResponsesSinglePage as PermissionGroupGetResponsesSinglePage,
     type PermissionGroupListParams as PermissionGroupListParams,
     type PermissionGroupGetParams as PermissionGroupGetParams,
   };

package/src/resources/ai/ai.ts

@@ -659,7 +659,7 @@ export declare namespace AIRunParams {
         /**
          * Definitions of each parameter.
          */
-        properties: Record<string, Parameters.Properties>;
+        properties: { [key: string]: Parameters.Properties };
 
         /**
          * The type of the parameters object (usually 'object').
@@ -728,7 +728,7 @@ export declare namespace AIRunParams {
           /**
            * Definitions of each parameter.
            */
-          properties: Record<string, Parameters.Properties>;
+          properties: { [key: string]: Parameters.Properties };
 
           /**
            * The type of the parameters object (usually 'object').

package/src/resources/ai-gateway/logs.ts

@@ -515,7 +515,7 @@ export interface LogEditParams {
   /**
    * Body param:
    */
-  metadata?: Record<string, string | number | boolean> | null;
+  metadata?: { [key: string]: string | number | boolean } | null;
 
   /**
    * Body param:

package/src/resources/alerting/available-alerts.ts

@@ -28,7 +28,7 @@ export class AvailableAlerts extends APIResource {
   }
 }
 
-export type AvailableAlertListResponse = Record<string, Array<AvailableAlertListResponse.Item>>;
+export type AvailableAlertListResponse = { [key: string]: Array<AvailableAlertListResponse.Item> };
 
 export namespace AvailableAlertListResponse {
   export interface Item {

package/src/resources/alerting/destinations/eligible.ts

@@ -26,7 +26,7 @@ export class Eligible extends APIResource {
   }
 }
 
-export type EligibleGetResponse = Record<string, Array<EligibleGetResponse.Item>>;
+export type EligibleGetResponse = { [key: string]: Array<EligibleGetResponse.Item> };
 
 export namespace EligibleGetResponse {
   export interface Item {

package/src/resources/api-gateway/discovery/operations.ts

@@ -87,7 +87,7 @@ export class Operations extends APIResource {
   }
 }
 
-export type OperationBulkEditResponse = Record<string, OperationBulkEditResponse.item>;
+export type OperationBulkEditResponse = { [key: string]: OperationBulkEditResponse.item };
 
 export namespace OperationBulkEditResponse {
   /**
@@ -184,7 +184,7 @@ export interface OperationBulkEditParams {
   /**
    * Body param:
    */
-  body: Record<string, OperationBulkEditParams.Body>;
+  body: { [key: string]: OperationBulkEditParams.Body };
 }
 
 export namespace OperationBulkEditParams {

package/src/resources/api-gateway/operations/schema-validation.ts

@@ -7,14 +7,7 @@ export class SchemaValidation extends APIResource {
   /**
    * Updates operation-level schema validation settings on the zone
    *
-   * @example
-   * ```ts
-   * const schemaValidation =
-   *   await client.apiGateway.operations.schemaValidation.update(
-   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   update(
     operationId: string,
@@ -31,17 +24,7 @@ export class SchemaValidation extends APIResource {
   /**
    * Updates multiple operation-level schema validation settings on the zone
    *
-   * @example
-   * ```ts
-   * const settingsMultipleRequest =
-   *   await client.apiGateway.operations.schemaValidation.edit({
-   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     settings_multiple_request: {
-   *       '3818d821-5901-4147-a474-f5f5aec1d54e': {},
-   *       'b17c8043-99a0-4202-b7d9-8f7cdbee02cd': {},
-   *     },
-   *   });
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   edit(
     params: SchemaValidationEditParams,
@@ -59,14 +42,7 @@ export class SchemaValidation extends APIResource {
   /**
    * Retrieves operation-level schema validation settings on the zone
    *
-   * @example
-   * ```ts
-   * const schemaValidation =
-   *   await client.apiGateway.operations.schemaValidation.get(
-   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   get(
     operationId: string,
@@ -81,7 +57,7 @@ export class SchemaValidation extends APIResource {
   }
 }
 
-export type SettingsMultipleRequest = Record<string, SettingsMultipleRequest.item>;
+export type SettingsMultipleRequest = { [key: string]: SettingsMultipleRequest.item };
 
 export namespace SettingsMultipleRequest {
   /**
@@ -102,7 +78,7 @@ export namespace SettingsMultipleRequest {
   }
 }
 
-export type SettingsMultipleRequestParam = Record<string, SettingsMultipleRequestParam.item>;
+export type SettingsMultipleRequestParam = { [key: string]: SettingsMultipleRequestParam.item };
 
 export namespace SettingsMultipleRequestParam {
   /**

package/src/resources/api-gateway/settings/schema-validation.ts

@@ -8,14 +8,7 @@ export class SchemaValidation extends APIResource {
   /**
    * Updates zone level schema validation settings on the zone
    *
-   * @example
-   * ```ts
-   * const settings =
-   *   await client.apiGateway.settings.schemaValidation.update({
-   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     validation_default_mitigation_action: 'block',
-   *   });
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   update(
     params: SchemaValidationUpdateParams,
@@ -28,13 +21,7 @@ export class SchemaValidation extends APIResource {
   /**
    * Updates zone level schema validation settings on the zone
    *
-   * @example
-   * ```ts
-   * const settings =
-   *   await client.apiGateway.settings.schemaValidation.edit({
-   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   });
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   edit(
     params: SchemaValidationEditParams,
@@ -50,13 +37,7 @@ export class SchemaValidation extends APIResource {
   /**
    * Retrieves zone level schema validation settings currently set on the zone
    *
-   * @example
-   * ```ts
-   * const settings =
-   *   await client.apiGateway.settings.schemaValidation.get({
-   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   });
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   get(
     params: SchemaValidationGetParams,

package/src/resources/api-gateway/user-schemas/hosts.ts

@@ -8,15 +8,7 @@ export class Hosts extends APIResource {
   /**
    * Retrieve schema hosts in a zone
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const hostListResponse of client.apiGateway.userSchemas.hosts.list(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   list(
     params: HostListParams,

package/src/resources/api-gateway/user-schemas/operations.ts

@@ -9,16 +9,7 @@ export class Operations extends APIResource {
    * Retrieves all operations from the schema. Operations that already exist in API
    * Shield Endpoint Management will be returned as full operations.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const operationListResponse of client.apiGateway.userSchemas.operations.list(
-   *   'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   list(
     schemaId: string,

package/src/resources/api-gateway/user-schemas/user-schemas.ts

@@ -20,15 +20,7 @@ export class UserSchemas extends APIResource {
   /**
    * Upload a schema to a zone
    *
-   * @example
-   * ```ts
-   * const schemaUpload =
-   *   await client.apiGateway.userSchemas.create({
-   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     file: fs.createReadStream('path/to/file'),
-   *     kind: 'openapi_v3',
-   *   });
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   create(params: UserSchemaCreateParams, options?: Core.RequestOptions): Core.APIPromise<SchemaUpload> {
     const { zone_id, ...body } = params;
@@ -43,15 +35,7 @@ export class UserSchemas extends APIResource {
   /**
    * Retrieve information about all schemas on a zone
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const publicSchema of client.apiGateway.userSchemas.list(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   list(
     params: UserSchemaListParams,
@@ -68,14 +52,7 @@ export class UserSchemas extends APIResource {
   /**
    * Delete a schema
    *
-   * @example
-   * ```ts
-   * const userSchema =
-   *   await client.apiGateway.userSchemas.delete(
-   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   delete(
     schemaId: string,
@@ -89,14 +66,7 @@ export class UserSchemas extends APIResource {
   /**
    * Enable validation for a schema
    *
-   * @example
-   * ```ts
-   * const publicSchema =
-   *   await client.apiGateway.userSchemas.edit(
-   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   edit(
     schemaId: string,
@@ -115,14 +85,7 @@ export class UserSchemas extends APIResource {
   /**
    * Retrieve information about a specific schema on a zone
    *
-   * @example
-   * ```ts
-   * const publicSchema =
-   *   await client.apiGateway.userSchemas.get(
-   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
   get(
     schemaId: string,

package/src/resources/bot-management.ts

@@ -115,9 +115,10 @@ export class BotManagement extends APIResource {
 
 export interface BotFightModeConfiguration {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -190,9 +191,10 @@ export namespace BotFightModeConfiguration {
 
 export interface BotFightModeConfigurationParam {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -213,9 +215,10 @@ export interface BotFightModeConfigurationParam {
 
 export interface SubscriptionConfiguration {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Automatically update to the newest bot detection models created by Cloudflare as
@@ -296,9 +299,10 @@ export namespace SubscriptionConfiguration {
 
 export interface SubscriptionConfigurationParam {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Automatically update to the newest bot detection models created by Cloudflare as
@@ -327,9 +331,10 @@ export interface SubscriptionConfigurationParam {
 
 export interface SuperBotFightModeDefinitelyConfiguration {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -398,9 +403,10 @@ export namespace SuperBotFightModeDefinitelyConfiguration {
 
 export interface SuperBotFightModeDefinitelyConfigurationParam {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -438,9 +444,10 @@ export interface SuperBotFightModeDefinitelyConfigurationParam {
 
 export interface SuperBotFightModeLikelyConfiguration {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -508,9 +515,10 @@ export namespace SuperBotFightModeLikelyConfiguration {
 
 export interface SuperBotFightModeLikelyConfigurationParam {
   /**
-   * Enable rule to block AI Scrapers and Crawlers.
+   * Enable rule to block AI Scrapers and Crawlers. Please note the value
+   * `only_on_ad_pages` is currently not available for Enterprise customers.
    */
-  ai_bots_protection?: 'block' | 'disabled';
+  ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -577,9 +585,10 @@ export declare namespace BotManagementUpdateParams {
     zone_id: string;
 
     /**
-     * Body param: Enable rule to block AI Scrapers and Crawlers.
+     * Body param: Enable rule to block AI Scrapers and Crawlers. Please note the value
+     * `only_on_ad_pages` is currently not available for Enterprise customers.
      */
-    ai_bots_protection?: 'block' | 'disabled';
+    ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -606,9 +615,10 @@ export declare namespace BotManagementUpdateParams {
     zone_id: string;
 
     /**
-     * Body param: Enable rule to block AI Scrapers and Crawlers.
+     * Body param: Enable rule to block AI Scrapers and Crawlers. Please note the value
+     * `only_on_ad_pages` is currently not available for Enterprise customers.
      */
-    ai_bots_protection?: 'block' | 'disabled';
+    ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -654,9 +664,10 @@ export declare namespace BotManagementUpdateParams {
     zone_id: string;
 
     /**
-     * Body param: Enable rule to block AI Scrapers and Crawlers.
+     * Body param: Enable rule to block AI Scrapers and Crawlers. Please note the value
+     * `only_on_ad_pages` is currently not available for Enterprise customers.
      */
-    ai_bots_protection?: 'block' | 'disabled';
+    ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
@@ -708,9 +719,10 @@ export declare namespace BotManagementUpdateParams {
     zone_id: string;
 
     /**
-     * Body param: Enable rule to block AI Scrapers and Crawlers.
+     * Body param: Enable rule to block AI Scrapers and Crawlers. Please note the value
+     * `only_on_ad_pages` is currently not available for Enterprise customers.
      */
-    ai_bots_protection?: 'block' | 'disabled';
+    ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
     /**
      * Body param: Automatically update to the newest bot detection models created by