cloudflare 4.4.0 → 4.5.0

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

package/src/resources/brand-protection/brand-protection.ts

@@ -0,0 +1,275 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as LogoMatchesAPI from './logo-matches';
+import { LogoMatches } from './logo-matches';
+import * as LogosAPI from './logos';
+import { Logos } from './logos';
+import * as MatchesAPI from './matches';
+import { Matches } from './matches';
+import * as QueriesAPI from './queries';
+import { Queries } from './queries';
+
+export class BrandProtection extends APIResource {
+  queries: QueriesAPI.Queries = new QueriesAPI.Queries(this._client);
+  matches: MatchesAPI.Matches = new MatchesAPI.Matches(this._client);
+  logos: LogosAPI.Logos = new LogosAPI.Logos(this._client);
+  logoMatches: LogoMatchesAPI.LogoMatches = new LogoMatchesAPI.LogoMatches(this._client);
+
+  /**
+   * Submit suspicious URL for scanning.
+   *
+   * @example
+   * ```ts
+   * const submit = await client.brandProtection.submit({
+   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   * });
+   * ```
+   */
+  submit(params: BrandProtectionSubmitParams, options?: Core.RequestOptions): Core.APIPromise<Submit> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/brand-protection/submit`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: Submit }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Gets phishing details about a URL.
+   *
+   * @example
+   * ```ts
+   * const info = await client.brandProtection.urlInfo({
+   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   * });
+   * ```
+   */
+  urlInfo(params: BrandProtectionURLInfoParams, options?: Core.RequestOptions): Core.APIPromise<Info> {
+    const { account_id, ...query } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/brand-protection/url-info`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: Info }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface Info {
+  /**
+   * List of categorizations applied to this submission.
+   */
+  categorizations?: Array<Info.Categorization>;
+
+  /**
+   * List of model results for completed scans.
+   */
+  model_results?: Array<URLInfoModelResults>;
+
+  /**
+   * List of signatures that matched against site content found when crawling the
+   * URL.
+   */
+  rule_matches?: Array<RuleMatch>;
+
+  /**
+   * Status of the most recent scan found.
+   */
+  scan_status?: ScanStatus;
+
+  /**
+   * For internal use.
+   */
+  screenshot_download_signature?: string;
+
+  /**
+   * For internal use.
+   */
+  screenshot_path?: string;
+
+  /**
+   * URL that was submitted.
+   */
+  url?: string;
+}
+
+export namespace Info {
+  export interface Categorization {
+    /**
+     * Name of the category applied.
+     */
+    category?: string;
+
+    /**
+     * Result of human review for this categorization.
+     */
+    verification_status?: string;
+  }
+}
+
+export interface RuleMatch {
+  /**
+   * For internal use.
+   */
+  banning?: boolean;
+
+  /**
+   * For internal use.
+   */
+  blocking?: boolean;
+
+  /**
+   * Description of the signature that matched.
+   */
+  description?: string;
+
+  /**
+   * Name of the signature that matched.
+   */
+  name?: string;
+}
+
+/**
+ * Status of the most recent scan found.
+ */
+export interface ScanStatus {
+  /**
+   * Timestamp of when the submission was processed.
+   */
+  last_processed?: string;
+
+  /**
+   * For internal use.
+   */
+  scan_complete?: boolean;
+
+  /**
+   * Status code that the crawler received when loading the submitted URL.
+   */
+  status_code?: number;
+
+  /**
+   * ID of the most recent submission.
+   */
+  submission_id?: number;
+}
+
+export interface Submit {
+  /**
+   * URLs that were excluded from scanning because their domain is in our no-scan
+   * list.
+   */
+  excluded_urls?: Array<Submit.ExcludedURL>;
+
+  /**
+   * URLs that were skipped because the same URL is currently being scanned.
+   */
+  skipped_urls?: Array<Submit.SkippedURL>;
+
+  /**
+   * URLs that were successfully submitted for scanning.
+   */
+  submitted_urls?: Array<Submit.SubmittedURL>;
+}
+
+export namespace Submit {
+  export interface ExcludedURL {
+    /**
+     * URL that was excluded.
+     */
+    url?: string;
+  }
+
+  export interface SkippedURL {
+    /**
+     * URL that was skipped.
+     */
+    url?: string;
+
+    /**
+     * ID of the submission of that URL that is currently scanning.
+     */
+    url_id?: number;
+  }
+
+  export interface SubmittedURL {
+    /**
+     * URL that was submitted.
+     */
+    url?: string;
+
+    /**
+     * ID assigned to this URL submission. Used to retrieve scanning results.
+     */
+    url_id?: number;
+  }
+}
+
+export interface URLInfoModelResults {
+  /**
+   * Name of the model.
+   */
+  model_name?: string;
+
+  /**
+   * This is the score that is outputted by the model for this submission.
+   */
+  model_score?: number;
+}
+
+export interface BrandProtectionSubmitParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: URL(s) to filter submissions results by.
+   */
+  url?: string;
+}
+
+export interface BrandProtectionURLInfoParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Query param: Submission URL(s) to filter submission results by.
+   */
+  url?: Array<string>;
+
+  /**
+   * Query param: Submission ID(s) to filter submission results by.
+   */
+  url_id?: Array<number>;
+}
+
+BrandProtection.Queries = Queries;
+BrandProtection.Matches = Matches;
+BrandProtection.Logos = Logos;
+BrandProtection.LogoMatches = LogoMatches;
+
+export declare namespace BrandProtection {
+  export {
+    type Info as Info,
+    type RuleMatch as RuleMatch,
+    type ScanStatus as ScanStatus,
+    type Submit as Submit,
+    type URLInfoModelResults as URLInfoModelResults,
+    type BrandProtectionSubmitParams as BrandProtectionSubmitParams,
+    type BrandProtectionURLInfoParams as BrandProtectionURLInfoParams,
+  };
+
+  export { Queries as Queries };
+
+  export { Matches as Matches };
+
+  export { Logos as Logos };
+
+  export { LogoMatches as LogoMatches };
+}

package/src/resources/brand-protection/index.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { BrandProtection } from './brand-protection';
+export { LogoMatches } from './logo-matches';
+export { Logos } from './logos';
+export { Matches } from './matches';
+export { Queries } from './queries';

package/src/resources/brand-protection/logo-matches.ts

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

package/src/resources/brand-protection/logos.ts

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

package/src/resources/brand-protection/matches.ts

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

package/src/resources/brand-protection/queries.ts

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