cloudflare 5.1.0 → 6.0.0-beta.1

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

@@ -6,7 +6,6 @@ import {
   Configuration,
   ConfigurationGetParams,
   ConfigurationUpdateParams,
-  ConfigurationUpdateResponse,
   Configurations,
 } from './configurations';
 import * as SchemasAPI from './schemas';
@@ -44,10 +43,10 @@ import { Settings } from './settings/settings';
 import * as UserSchemasAPI from './user-schemas/user-schemas';
 import {
   Message,
-  PublicSchema,
-  PublicSchemasV4PagePaginationArray,
-  SchemaUpload,
+  OldPublicSchema,
+  OldPublicSchemasV4PagePaginationArray,
   UserSchemaCreateParams,
+  UserSchemaCreateResponse,
   UserSchemaDeleteParams,
   UserSchemaDeleteResponse,
   UserSchemaEditParams,
@@ -75,14 +74,13 @@ APIGateway.OperationListResponsesV4PagePaginationArray = OperationListResponsesV
 APIGateway.OperationBulkCreateResponsesSinglePage = OperationBulkCreateResponsesSinglePage;
 APIGateway.Schemas = Schemas;
 APIGateway.UserSchemas = UserSchemas;
-APIGateway.PublicSchemasV4PagePaginationArray = PublicSchemasV4PagePaginationArray;
+APIGateway.OldPublicSchemasV4PagePaginationArray = OldPublicSchemasV4PagePaginationArray;
 APIGateway.ExpressionTemplate = ExpressionTemplate;
 
 export declare namespace APIGateway {
   export {
     Configurations as Configurations,
     type Configuration as Configuration,
-    type ConfigurationUpdateResponse as ConfigurationUpdateResponse,
     type ConfigurationUpdateParams as ConfigurationUpdateParams,
     type ConfigurationGetParams as ConfigurationGetParams,
   };
@@ -124,10 +122,10 @@ export declare namespace APIGateway {
   export {
     UserSchemas as UserSchemas,
     type Message as Message,
-    type PublicSchema as PublicSchema,
-    type SchemaUpload as SchemaUpload,
+    type OldPublicSchema as OldPublicSchema,
+    type UserSchemaCreateResponse as UserSchemaCreateResponse,
     type UserSchemaDeleteResponse as UserSchemaDeleteResponse,
-    PublicSchemasV4PagePaginationArray as PublicSchemasV4PagePaginationArray,
+    OldPublicSchemasV4PagePaginationArray as OldPublicSchemasV4PagePaginationArray,
     type UserSchemaCreateParams as UserSchemaCreateParams,
     type UserSchemaListParams as UserSchemaListParams,
     type UserSchemaDeleteParams as UserSchemaDeleteParams,

package/src/resources/api-gateway/configurations.ts

@@ -2,11 +2,10 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import * as UserSchemasAPI from './user-schemas/user-schemas';
 
 export class Configurations extends APIResource {
   /**
-   * Set configuration properties
+   * Update configuration properties
    *
    * @example
    * ```ts
@@ -19,12 +18,15 @@ export class Configurations extends APIResource {
    *   });
    * ```
    */
-  update(
-    params: ConfigurationUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ConfigurationUpdateResponse> {
-    const { zone_id, ...body } = params;
-    return this._client.put(`/zones/${zone_id}/api_gateway/configuration`, { body, ...options });
+  update(params: ConfigurationUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Configuration> {
+    const { zone_id, normalize, ...body } = params;
+    return (
+      this._client.put(`/zones/${zone_id}/api_gateway/configuration`, {
+        query: { normalize },
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: Configuration }>
+    )._thenUnwrap((obj) => obj.result);
   }
 
   /**
@@ -93,17 +95,6 @@ export namespace Configuration {
   }
 }
 
-export interface ConfigurationUpdateResponse {
-  errors: UserSchemasAPI.Message;
-
-  messages: UserSchemasAPI.Message;
-
-  /**
-   * Whether the API call was successful.
-   */
-  success: true;
-}
-
 export interface ConfigurationUpdateParams {
   /**
    * Path param: Identifier.
@@ -117,6 +108,12 @@ export interface ConfigurationUpdateParams {
     | ConfigurationUpdateParams.APIShieldAuthIDCharacteristic
     | ConfigurationUpdateParams.APIShieldAuthIDCharacteristicJWTClaim
   >;
+
+  /**
+   * Query param: Ensures that the configuration is written or retrieved in
+   * normalized fashion
+   */
+  normalize?: boolean;
 }
 
 export namespace ConfigurationUpdateParams {
@@ -164,15 +161,15 @@ export interface ConfigurationGetParams {
   zone_id: string;
 
   /**
-   * Query param: Requests information about certain properties.
+   * Query param: Ensures that the configuration is written or retrieved in
+   * normalized fashion
    */
-  properties?: Array<'auth_id_characteristics'>;
+  normalize?: boolean;
 }
 
 export declare namespace Configurations {
   export {
     type Configuration as Configuration,
-    type ConfigurationUpdateResponse as ConfigurationUpdateResponse,
     type ConfigurationUpdateParams as ConfigurationUpdateParams,
     type ConfigurationGetParams as ConfigurationGetParams,
   };

package/src/resources/api-gateway/index.ts

@@ -4,7 +4,6 @@ export { APIGateway } from './api-gateway';
 export {
   Configurations,
   type Configuration,
-  type ConfigurationUpdateResponse,
   type ConfigurationUpdateParams,
   type ConfigurationGetParams,
 } from './configurations';
@@ -16,6 +15,19 @@ export {
   type DiscoveryGetParams,
 } from './discovery/index';
 export { ExpressionTemplate } from './expression-template/index';
+export {
+  OldPublicSchemasV4PagePaginationArray,
+  UserSchemas,
+  type Message,
+  type OldPublicSchema,
+  type UserSchemaCreateResponse,
+  type UserSchemaDeleteResponse,
+  type UserSchemaCreateParams,
+  type UserSchemaListParams,
+  type UserSchemaDeleteParams,
+  type UserSchemaEditParams,
+  type UserSchemaGetParams,
+} from './user-schemas/index';
 export {
   OperationListResponsesV4PagePaginationArray,
   OperationBulkCreateResponsesSinglePage,
@@ -34,18 +46,5 @@ export {
   type OperationBulkDeleteParams,
   type OperationGetParams,
 } from './operations/index';
-export {
-  PublicSchemasV4PagePaginationArray,
-  UserSchemas,
-  type Message,
-  type PublicSchema,
-  type SchemaUpload,
-  type UserSchemaDeleteResponse,
-  type UserSchemaCreateParams,
-  type UserSchemaListParams,
-  type UserSchemaDeleteParams,
-  type UserSchemaEditParams,
-  type UserSchemaGetParams,
-} from './user-schemas/index';
 export { Schemas, type SchemaListResponse, type SchemaListParams } from './schemas';
 export { Settings } from './settings/index';

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

@@ -3,6 +3,9 @@
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
 
+/**
+ * @deprecated Please use the [Schema Validation Operations Settings](https://developers.cloudflare.com/api/resources/schema_validation/subresources/settings/subresources/operations/) APIs instead
+ */
 export class SchemaValidation extends APIResource {
   /**
    * Updates operation-level schema validation settings on the zone

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

@@ -9,6 +9,9 @@ import {
   SchemaValidationUpdateParams,
 } from './schema-validation';
 
+/**
+ * @deprecated Please use the [Schema Validation Settings](https://developers.cloudflare.com/api/resources/schema_validation/subresources/settings/) APIs instead
+ */
 export class Settings extends APIResource {
   schemaValidation: SchemaValidationAPI.SchemaValidation = new SchemaValidationAPI.SchemaValidation(
     this._client,

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

@@ -7,17 +7,11 @@ export {
   type HostListParams,
 } from './hosts';
 export {
-  OperationListResponsesV4PagePaginationArray,
-  Operations,
-  type OperationListResponse,
-  type OperationListParams,
-} from './operations';
-export {
-  PublicSchemasV4PagePaginationArray,
+  OldPublicSchemasV4PagePaginationArray,
   UserSchemas,
   type Message,
-  type PublicSchema,
-  type SchemaUpload,
+  type OldPublicSchema,
+  type UserSchemaCreateResponse,
   type UserSchemaDeleteResponse,
   type UserSchemaCreateParams,
   type UserSchemaListParams,
@@ -25,3 +19,9 @@ export {
   type UserSchemaEditParams,
   type UserSchemaGetParams,
 } from './user-schemas';
+export {
+  OperationListResponsesV4PagePaginationArray,
+  Operations,
+  type OperationListResponse,
+  type OperationListParams,
+} from './operations';

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

@@ -13,6 +13,9 @@ import {
 } from './operations';
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
 
+/**
+ * @deprecated Please use the [Schema Validation](https://developers.cloudflare.com/api/resources/schema_validation/) APIs instead
+ */
 export class UserSchemas extends APIResource {
   operations: OperationsAPI.Operations = new OperationsAPI.Operations(this._client);
   hosts: HostsAPI.Hosts = new HostsAPI.Hosts(this._client);
@@ -22,13 +25,16 @@ export class UserSchemas extends APIResource {
    *
    * @deprecated Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead.
    */
-  create(params: UserSchemaCreateParams, options?: Core.RequestOptions): Core.APIPromise<SchemaUpload> {
+  create(
+    params: UserSchemaCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<UserSchemaCreateResponse> {
     const { zone_id, ...body } = params;
     return (
       this._client.post(
         `/zones/${zone_id}/api_gateway/user_schemas`,
         Core.multipartFormRequestOptions({ body, ...options }),
-      ) as Core.APIPromise<{ result: SchemaUpload }>
+      ) as Core.APIPromise<{ result: UserSchemaCreateResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -40,11 +46,11 @@ export class UserSchemas extends APIResource {
   list(
     params: UserSchemaListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PublicSchemasV4PagePaginationArray, PublicSchema> {
+  ): Core.PagePromise<OldPublicSchemasV4PagePaginationArray, OldPublicSchema> {
     const { zone_id, ...query } = params;
     return this._client.getAPIList(
       `/zones/${zone_id}/api_gateway/user_schemas`,
-      PublicSchemasV4PagePaginationArray,
+      OldPublicSchemasV4PagePaginationArray,
       { query, ...options },
     );
   }
@@ -72,13 +78,13 @@ export class UserSchemas extends APIResource {
     schemaId: string,
     params: UserSchemaEditParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<PublicSchema> {
+  ): Core.APIPromise<OldPublicSchema> {
     const { zone_id, ...body } = params;
     return (
       this._client.patch(`/zones/${zone_id}/api_gateway/user_schemas/${schemaId}`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: PublicSchema }>
+      }) as Core.APIPromise<{ result: OldPublicSchema }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -91,18 +97,18 @@ export class UserSchemas extends APIResource {
     schemaId: string,
     params: UserSchemaGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<PublicSchema> {
+  ): Core.APIPromise<OldPublicSchema> {
     const { zone_id, ...query } = params;
     return (
       this._client.get(`/zones/${zone_id}/api_gateway/user_schemas/${schemaId}`, {
         query,
         ...options,
-      }) as Core.APIPromise<{ result: PublicSchema }>
+      }) as Core.APIPromise<{ result: OldPublicSchema }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export class PublicSchemasV4PagePaginationArray extends V4PagePaginationArray<PublicSchema> {}
+export class OldPublicSchemasV4PagePaginationArray extends V4PagePaginationArray<OldPublicSchema> {}
 
 export type Message = Array<Message.MessageItem>;
 
@@ -124,7 +130,7 @@ export namespace Message {
   }
 }
 
-export interface PublicSchema {
+export interface OldPublicSchema {
   created_at: string;
 
   /**
@@ -153,13 +159,13 @@ export interface PublicSchema {
   validation_enabled?: boolean;
 }
 
-export interface SchemaUpload {
-  schema: PublicSchema;
+export interface UserSchemaCreateResponse {
+  schema: OldPublicSchema;
 
-  upload_details?: SchemaUpload.UploadDetails;
+  upload_details?: UserSchemaCreateResponse.UploadDetails;
 }
 
-export namespace SchemaUpload {
+export namespace UserSchemaCreateResponse {
   export interface UploadDetails {
     /**
      * Diagnostic warning events that occurred during processing. These events are
@@ -276,7 +282,7 @@ export interface UserSchemaGetParams {
   omit_source?: boolean;
 }
 
-UserSchemas.PublicSchemasV4PagePaginationArray = PublicSchemasV4PagePaginationArray;
+UserSchemas.OldPublicSchemasV4PagePaginationArray = OldPublicSchemasV4PagePaginationArray;
 UserSchemas.Operations = Operations;
 UserSchemas.OperationListResponsesV4PagePaginationArray = OperationListResponsesV4PagePaginationArray;
 UserSchemas.Hosts = Hosts;
@@ -285,10 +291,10 @@ UserSchemas.HostListResponsesV4PagePaginationArray = HostListResponsesV4PagePagi
 export declare namespace UserSchemas {
   export {
     type Message as Message,
-    type PublicSchema as PublicSchema,
-    type SchemaUpload as SchemaUpload,
+    type OldPublicSchema as OldPublicSchema,
+    type UserSchemaCreateResponse as UserSchemaCreateResponse,
     type UserSchemaDeleteResponse as UserSchemaDeleteResponse,
-    PublicSchemasV4PagePaginationArray as PublicSchemasV4PagePaginationArray,
+    OldPublicSchemasV4PagePaginationArray as OldPublicSchemasV4PagePaginationArray,
     type UserSchemaCreateParams as UserSchemaCreateParams,
     type UserSchemaListParams as UserSchemaListParams,
     type UserSchemaDeleteParams as UserSchemaDeleteParams,

package/src/resources/bot-management.ts

@@ -72,6 +72,7 @@ export class BotManagement extends APIResource {
    * const botManagement = await client.botManagement.update({
    *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *   ai_bots_protection: 'disabled',
+   *   cf_robots_variant: 'off',
    *   crawler_protection: 'disabled',
    *   enable_js: true,
    *   fight_mode: true,
@@ -120,6 +121,11 @@ export interface BotFightModeConfiguration {
    */
   ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -202,6 +208,11 @@ export interface BotFightModeConfigurationParam {
    */
   ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -245,6 +256,11 @@ export interface SubscriptionConfiguration {
    */
   bm_cookie_enabled?: boolean;
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -341,6 +357,11 @@ export interface SubscriptionConfigurationParam {
    */
   bm_cookie_enabled?: boolean;
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -372,6 +393,11 @@ export interface SuperBotFightModeDefinitelyConfiguration {
    */
   ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -450,6 +476,11 @@ export interface SuperBotFightModeDefinitelyConfigurationParam {
    */
   ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -497,6 +528,11 @@ export interface SuperBotFightModeLikelyConfiguration {
    */
   ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -574,6 +610,11 @@ export interface SuperBotFightModeLikelyConfigurationParam {
    */
   ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+  /**
+   * Specifies the Robots Access Control License variant to use.
+   */
+  cf_robots_variant?: 'off' | 'policy_only';
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -650,6 +691,11 @@ export declare namespace BotManagementUpdateParams {
      */
     ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+    /**
+     * Body param: Specifies the Robots Access Control License variant to use.
+     */
+    cf_robots_variant?: 'off' | 'policy_only';
+
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
      */
@@ -686,6 +732,11 @@ export declare namespace BotManagementUpdateParams {
      */
     ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+    /**
+     * Body param: Specifies the Robots Access Control License variant to use.
+     */
+    cf_robots_variant?: 'off' | 'policy_only';
+
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
      */
@@ -741,6 +792,11 @@ export declare namespace BotManagementUpdateParams {
      */
     ai_bots_protection?: 'block' | 'disabled' | 'only_on_ad_pages';
 
+    /**
+     * Body param: Specifies the Robots Access Control License variant to use.
+     */
+    cf_robots_variant?: 'off' | 'policy_only';
+
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
      */
@@ -815,6 +871,11 @@ export declare namespace BotManagementUpdateParams {
      */
     bm_cookie_enabled?: boolean;
 
+    /**
+     * Body param: Specifies the Robots Access Control License variant to use.
+     */
+    cf_robots_variant?: 'off' | 'policy_only';
+
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
      */