cloudflare 4.5.0 → 5.0.0

package/src/resources/bot-management.ts

@@ -136,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.
@@ -211,6 +217,12 @@ 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 {
@@ -227,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.
    */
@@ -238,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.
@@ -311,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.
    */
@@ -322,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.
@@ -347,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.
    */
@@ -419,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.
    */
@@ -460,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.
    */
@@ -531,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.
    */
@@ -606,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 {
@@ -632,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.
      */
@@ -681,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.
      */
@@ -731,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.
      */
@@ -743,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

@@ -3,13 +3,26 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as LogoMatchesAPI from './logo-matches';
-import { LogoMatches } from './logo-matches';
+import {
+  LogoMatchDownloadParams,
+  LogoMatchDownloadResponse,
+  LogoMatchGetParams,
+  LogoMatchGetResponse,
+  LogoMatches,
+} from './logo-matches';
 import * as LogosAPI from './logos';
-import { Logos } from './logos';
+import { LogoCreateParams, LogoCreateResponse, LogoDeleteParams, Logos } from './logos';
 import * as MatchesAPI from './matches';
-import { Matches } from './matches';
+import {
+  MatchDownloadParams,
+  MatchDownloadResponse,
+  MatchGetParams,
+  MatchGetResponse,
+  Matches,
+} from './matches';
 import * as QueriesAPI from './queries';
-import { Queries } 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);
@@ -18,46 +31,34 @@ export class BrandProtection extends APIResource {
   logoMatches: LogoMatchesAPI.LogoMatches = new LogoMatchesAPI.LogoMatches(this._client);
 
   /**
-   * Submit suspicious URL for scanning.
-   *
-   * @example
-   * ```ts
-   * const submit = await client.brandProtection.submit({
-   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * });
-   * ```
+   * Return new URL submissions
    */
-  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);
+  submit(
+    params: BrandProtectionSubmitParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BrandProtectionSubmitResponse> {
+    const { account_id } = params;
+    return this._client.post(`/accounts/${account_id}/brand-protection/submit`, options);
   }
 
   /**
-   * Gets phishing details about a URL.
-   *
-   * @example
-   * ```ts
-   * const info = await client.brandProtection.urlInfo({
-   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * });
-   * ```
+   * Return submitted URLs based on ID
    */
-  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);
+  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.
@@ -67,18 +68,18 @@ export interface Info {
   /**
    * List of model results for completed scans.
    */
-  model_results?: Array<URLInfoModelResults>;
+  model_results?: Array<Info.ModelResult>;
 
   /**
    * List of signatures that matched against site content found when crawling the
    * URL.
    */
-  rule_matches?: Array<RuleMatch>;
+  rule_matches?: Array<Info.RuleMatch>;
 
   /**
    * Status of the most recent scan found.
    */
-  scan_status?: ScanStatus;
+  scan_status?: Info.ScanStatus;
 
   /**
    * For internal use.
@@ -108,53 +109,65 @@ export namespace Info {
      */
     verification_status?: string;
   }
-}
 
-export interface RuleMatch {
-  /**
-   * For internal use.
-   */
-  banning?: boolean;
+  export interface ModelResult {
+    /**
+     * Name of the model.
+     */
+    model_name?: string;
 
-  /**
-   * For internal use.
-   */
-  blocking?: boolean;
+    /**
+     * This is the score that is outputted by the model for this submission.
+     */
+    model_score?: number;
+  }
 
-  /**
-   * Description of the signature that matched.
-   */
-  description?: string;
+  export interface RuleMatch {
+    /**
+     * For internal use.
+     */
+    banning?: boolean;
 
-  /**
-   * Name of the signature that matched.
-   */
-  name?: string;
-}
+    /**
+     * For internal use.
+     */
+    blocking?: boolean;
 
-/**
- * Status of the most recent scan found.
- */
-export interface ScanStatus {
-  /**
-   * Timestamp of when the submission was processed.
-   */
-  last_processed?: string;
+    /**
+     * Description of the signature that matched.
+     */
+    description?: string;
 
-  /**
-   * For internal use.
-   */
-  scan_complete?: boolean;
+    /**
+     * Name of the signature that matched.
+     */
+    name?: string;
+  }
 
   /**
-   * Status code that the crawler received when loading the submitted URL.
+   * Status of the most recent scan found.
    */
-  status_code?: number;
+  export interface ScanStatus {
+    /**
+     * Timestamp of when the submission was processed.
+     */
+    last_processed?: string;
 
-  /**
-   * ID of the most recent submission.
-   */
-  submission_id?: number;
+    /**
+     * 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 {
@@ -208,47 +221,23 @@ export namespace Submit {
   }
 }
 
-export interface URLInfoModelResults {
-  /**
-   * Name of the model.
-   */
-  model_name?: string;
+export interface BrandProtectionSubmitResponse {
+  skipped_urls?: Array<{ [key: string]: unknown }>;
 
-  /**
-   * This is the score that is outputted by the model for this submission.
-   */
-  model_score?: number;
+  submitted_urls?: Array<{ [key: string]: unknown }>;
 }
 
+export type BrandProtectionURLInfoResponse = { [key: string]: unknown };
+
 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.BrandProtectionURLInfoResponsesSinglePage = BrandProtectionURLInfoResponsesSinglePage;
 BrandProtection.Queries = Queries;
 BrandProtection.Matches = Matches;
 BrandProtection.Logos = Logos;
@@ -257,19 +246,41 @@ 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 BrandProtectionSubmitResponse as BrandProtectionSubmitResponse,
+    type BrandProtectionURLInfoResponse as BrandProtectionURLInfoResponse,
+    BrandProtectionURLInfoResponsesSinglePage as BrandProtectionURLInfoResponsesSinglePage,
     type BrandProtectionSubmitParams as BrandProtectionSubmitParams,
     type BrandProtectionURLInfoParams as BrandProtectionURLInfoParams,
   };
 
-  export { Queries as Queries };
+  export {
+    Queries as Queries,
+    type QueryCreateParams as QueryCreateParams,
+    type QueryDeleteParams as QueryDeleteParams,
+    type QueryBulkParams as QueryBulkParams,
+  };
 
-  export { Matches as Matches };
+  export {
+    Matches as Matches,
+    type MatchDownloadResponse as MatchDownloadResponse,
+    type MatchGetResponse as MatchGetResponse,
+    type MatchDownloadParams as MatchDownloadParams,
+    type MatchGetParams as MatchGetParams,
+  };
 
-  export { Logos as Logos };
+  export {
+    Logos as Logos,
+    type LogoCreateResponse as LogoCreateResponse,
+    type LogoCreateParams as LogoCreateParams,
+    type LogoDeleteParams as LogoDeleteParams,
+  };
 
-  export { LogoMatches as LogoMatches };
+  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

@@ -1,7 +1,19 @@
 // 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';
+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';

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

@@ -1,5 +1,93 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
 
-export class LogoMatches extends APIResource {}
+export class LogoMatches extends APIResource {
+  /**
+   * Return matches as CSV for logo queries based on ID
+   */
+  download(
+    params: LogoMatchDownloadParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<LogoMatchDownloadResponse> {
+    const { account_id, ...query } = params;
+    return this._client.get(`/accounts/${account_id}/brand-protection/logo-matches/download`, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Return matches for logo queries based on ID
+   */
+  get(params: LogoMatchGetParams, options?: Core.RequestOptions): Core.APIPromise<LogoMatchGetResponse> {
+    const { account_id, ...query } = params;
+    return this._client.get(`/accounts/${account_id}/brand-protection/logo-matches`, { query, ...options });
+  }
+}
+
+export interface LogoMatchDownloadResponse {
+  matches?: Array<{ [key: string]: unknown }>;
+
+  total?: number;
+}
+
+export interface LogoMatchGetResponse {
+  matches?: Array<{ [key: string]: unknown }>;
+
+  total?: number;
+}
+
+export interface LogoMatchDownloadParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
+
+  /**
+   * Query param:
+   */
+  limit?: string;
+
+  /**
+   * Query param:
+   */
+  logo_id?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  offset?: string;
+}
+
+export interface LogoMatchGetParams {
+  /**
+   * Path param:
+   */
+  account_id: string;
+
+  /**
+   * Query param:
+   */
+  limit?: string;
+
+  /**
+   * Query param:
+   */
+  logo_id?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  offset?: string;
+}
+
+export declare namespace LogoMatches {
+  export {
+    type LogoMatchDownloadResponse as LogoMatchDownloadResponse,
+    type LogoMatchGetResponse as LogoMatchGetResponse,
+    type LogoMatchDownloadParams as LogoMatchDownloadParams,
+    type LogoMatchGetParams as LogoMatchGetParams,
+  };
+}