cloudflare 4.4.1 → 5.0.0

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.
@@ -135,6 +136,12 @@ export interface BotFightModeConfiguration {
    */
   fight_mode?: boolean;
 
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
+
   /**
    * A read-only field that shows which unauthorized settings are currently active on
    * the zone. These settings typically result from upgrades or downgrades.
@@ -190,9 +197,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.
@@ -209,13 +217,20 @@ export interface BotFightModeConfigurationParam {
    * Whether to enable Bot Fight Mode.
    */
   fight_mode?: boolean;
+
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
 }
 
 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
@@ -224,6 +239,12 @@ export interface SubscriptionConfiguration {
    */
   auto_update_model?: boolean;
 
+  /**
+   * Indicates that the bot management cookie can be placed on end user devices
+   * accessing the site. Defaults to true
+   */
+  bm_cookie_enabled?: boolean;
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -235,6 +256,12 @@ export interface SubscriptionConfiguration {
    */
   enable_js?: boolean;
 
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
+
   /**
    * A read-only field that shows which unauthorized settings are currently active on
    * the zone. These settings typically result from upgrades or downgrades.
@@ -296,9 +323,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
@@ -307,6 +335,12 @@ export interface SubscriptionConfigurationParam {
    */
   auto_update_model?: boolean;
 
+  /**
+   * Indicates that the bot management cookie can be placed on end user devices
+   * accessing the site. Defaults to true
+   */
+  bm_cookie_enabled?: boolean;
+
   /**
    * Enable rule to punish AI Scrapers and Crawlers via a link maze.
    */
@@ -318,6 +352,12 @@ export interface SubscriptionConfigurationParam {
    */
   enable_js?: boolean;
 
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
+
   /**
    * Whether to disable tracking the highest bot score for a session in the Bot
    * Management cookie.
@@ -327,9 +367,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.
@@ -342,6 +383,12 @@ export interface SuperBotFightModeDefinitelyConfiguration {
    */
   enable_js?: boolean;
 
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
+
   /**
    * Whether to optimize Super Bot Fight Mode protections for Wordpress.
    */
@@ -398,9 +445,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.
@@ -413,6 +461,12 @@ export interface SuperBotFightModeDefinitelyConfigurationParam {
    */
   enable_js?: boolean;
 
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
+
   /**
    * Whether to optimize Super Bot Fight Mode protections for Wordpress.
    */
@@ -438,9 +492,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.
@@ -453,6 +508,12 @@ export interface SuperBotFightModeLikelyConfiguration {
    */
   enable_js?: boolean;
 
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
+
   /**
    * Whether to optimize Super Bot Fight Mode protections for Wordpress.
    */
@@ -508,9 +569,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.
@@ -523,6 +585,12 @@ export interface SuperBotFightModeLikelyConfigurationParam {
    */
   enable_js?: boolean;
 
+  /**
+   * Enable cloudflare managed robots.txt. If an existing robots.txt is detected,
+   * then managed robots.txt will be prepended to the existing robots.txt.
+   */
+  is_robots_txt_managed?: boolean;
+
   /**
    * Whether to optimize Super Bot Fight Mode protections for Wordpress.
    */
@@ -577,9 +645,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.
@@ -597,6 +666,12 @@ export declare namespace BotManagementUpdateParams {
      * Body param: Whether to enable Bot Fight Mode.
      */
     fight_mode?: boolean;
+
+    /**
+     * Body param: Enable cloudflare managed robots.txt. If an existing robots.txt is
+     * detected, then managed robots.txt will be prepended to the existing robots.txt.
+     */
+    is_robots_txt_managed?: boolean;
   }
 
   export interface SuperBotFightModeDefinitelyConfiguration {
@@ -606,9 +681,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.
@@ -622,6 +698,12 @@ export declare namespace BotManagementUpdateParams {
      */
     enable_js?: boolean;
 
+    /**
+     * Body param: Enable cloudflare managed robots.txt. If an existing robots.txt is
+     * detected, then managed robots.txt will be prepended to the existing robots.txt.
+     */
+    is_robots_txt_managed?: boolean;
+
     /**
      * Body param: Whether to optimize Super Bot Fight Mode protections for Wordpress.
      */
@@ -654,9 +736,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.
@@ -670,6 +753,12 @@ export declare namespace BotManagementUpdateParams {
      */
     enable_js?: boolean;
 
+    /**
+     * Body param: Enable cloudflare managed robots.txt. If an existing robots.txt is
+     * detected, then managed robots.txt will be prepended to the existing robots.txt.
+     */
+    is_robots_txt_managed?: boolean;
+
     /**
      * Body param: Whether to optimize Super Bot Fight Mode protections for Wordpress.
      */
@@ -708,9 +797,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
@@ -719,6 +809,12 @@ export declare namespace BotManagementUpdateParams {
      */
     auto_update_model?: boolean;
 
+    /**
+     * Body param: Indicates that the bot management cookie can be placed on end user
+     * devices accessing the site. Defaults to true
+     */
+    bm_cookie_enabled?: boolean;
+
     /**
      * Body param: Enable rule to punish AI Scrapers and Crawlers via a link maze.
      */
@@ -731,6 +827,12 @@ export declare namespace BotManagementUpdateParams {
      */
     enable_js?: boolean;
 
+    /**
+     * Body param: Enable cloudflare managed robots.txt. If an existing robots.txt is
+     * detected, then managed robots.txt will be prepended to the existing robots.txt.
+     */
+    is_robots_txt_managed?: boolean;
+
     /**
      * Body param: Whether to disable tracking the highest bot score for a session in
      * the Bot Management cookie.

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

@@ -0,0 +1,286 @@
+// 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 {
+  LogoMatchDownloadParams,
+  LogoMatchDownloadResponse,
+  LogoMatchGetParams,
+  LogoMatchGetResponse,
+  LogoMatches,
+} from './logo-matches';
+import * as LogosAPI from './logos';
+import { LogoCreateParams, LogoCreateResponse, LogoDeleteParams, Logos } from './logos';
+import * as MatchesAPI from './matches';
+import {
+  MatchDownloadParams,
+  MatchDownloadResponse,
+  MatchGetParams,
+  MatchGetResponse,
+  Matches,
+} from './matches';
+import * as QueriesAPI from './queries';
+import { Queries, QueryBulkParams, QueryCreateParams, QueryDeleteParams } from './queries';
+import { SinglePage } from '../../pagination';
+
+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);
+
+  /**
+   * Return new URL submissions
+   */
+  submit(
+    params: BrandProtectionSubmitParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BrandProtectionSubmitResponse> {
+    const { account_id } = params;
+    return this._client.post(`/accounts/${account_id}/brand-protection/submit`, options);
+  }
+
+  /**
+   * Return submitted URLs based on ID
+   */
+  urlInfo(
+    params: BrandProtectionURLInfoParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BrandProtectionURLInfoResponsesSinglePage, BrandProtectionURLInfoResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/brand-protection/url-info`,
+      BrandProtectionURLInfoResponsesSinglePage,
+      options,
+    );
+  }
+}
+
+export class BrandProtectionURLInfoResponsesSinglePage extends SinglePage<BrandProtectionURLInfoResponse> {}
+
+export interface Info {
+  /**
+   * List of categorizations applied to this submission.
+   */
+  categorizations?: Array<Info.Categorization>;
+
+  /**
+   * List of model results for completed scans.
+   */
+  model_results?: Array<Info.ModelResult>;
+
+  /**
+   * List of signatures that matched against site content found when crawling the
+   * URL.
+   */
+  rule_matches?: Array<Info.RuleMatch>;
+
+  /**
+   * Status of the most recent scan found.
+   */
+  scan_status?: Info.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 ModelResult {
+    /**
+     * 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 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 BrandProtectionSubmitResponse {
+  skipped_urls?: Array<{ [key: string]: unknown }>;
+
+  submitted_urls?: Array<{ [key: string]: unknown }>;
+}
+
+export type BrandProtectionURLInfoResponse = { [key: string]: unknown };
+
+export interface BrandProtectionSubmitParams {
+  account_id: string;
+}
+
+export interface BrandProtectionURLInfoParams {
+  account_id: string;
+}
+
+BrandProtection.BrandProtectionURLInfoResponsesSinglePage = BrandProtectionURLInfoResponsesSinglePage;
+BrandProtection.Queries = Queries;
+BrandProtection.Matches = Matches;
+BrandProtection.Logos = Logos;
+BrandProtection.LogoMatches = LogoMatches;
+
+export declare namespace BrandProtection {
+  export {
+    type Info as Info,
+    type Submit as Submit,
+    type BrandProtectionSubmitResponse as BrandProtectionSubmitResponse,
+    type BrandProtectionURLInfoResponse as BrandProtectionURLInfoResponse,
+    BrandProtectionURLInfoResponsesSinglePage as BrandProtectionURLInfoResponsesSinglePage,
+    type BrandProtectionSubmitParams as BrandProtectionSubmitParams,
+    type BrandProtectionURLInfoParams as BrandProtectionURLInfoParams,
+  };
+
+  export {
+    Queries as Queries,
+    type QueryCreateParams as QueryCreateParams,
+    type QueryDeleteParams as QueryDeleteParams,
+    type QueryBulkParams as QueryBulkParams,
+  };
+
+  export {
+    Matches as Matches,
+    type MatchDownloadResponse as MatchDownloadResponse,
+    type MatchGetResponse as MatchGetResponse,
+    type MatchDownloadParams as MatchDownloadParams,
+    type MatchGetParams as MatchGetParams,
+  };
+
+  export {
+    Logos as Logos,
+    type LogoCreateResponse as LogoCreateResponse,
+    type LogoCreateParams as LogoCreateParams,
+    type LogoDeleteParams as LogoDeleteParams,
+  };
+
+  export {
+    LogoMatches as LogoMatches,
+    type LogoMatchDownloadResponse as LogoMatchDownloadResponse,
+    type LogoMatchGetResponse as LogoMatchGetResponse,
+    type LogoMatchDownloadParams as LogoMatchDownloadParams,
+    type LogoMatchGetParams as LogoMatchGetParams,
+  };
+}

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

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { BrandProtection } from './brand-protection';
+export {
+  LogoMatches,
+  type LogoMatchDownloadResponse,
+  type LogoMatchGetResponse,
+  type LogoMatchDownloadParams,
+  type LogoMatchGetParams,
+} from './logo-matches';
+export { Logos, type LogoCreateResponse, type LogoCreateParams, type LogoDeleteParams } from './logos';
+export {
+  Matches,
+  type MatchDownloadResponse,
+  type MatchGetResponse,
+  type MatchDownloadParams,
+  type MatchGetParams,
+} from './matches';
+export { Queries, type QueryCreateParams, type QueryDeleteParams, type QueryBulkParams } from './queries';