cloudflare 4.4.0 → 4.5.0

package/src/resources/dns-firewall/reverse-dns.ts

@@ -59,14 +59,14 @@ export interface ReverseDNSEditResponse {
   /**
    * Map of cluster IP addresses to PTR record contents
    */
-  ptr: Record<string, string>;
+  ptr: { [key: string]: string };
 }
 
 export interface ReverseDNSGetResponse {
   /**
    * Map of cluster IP addresses to PTR record contents
    */
-  ptr: Record<string, string>;
+  ptr: { [key: string]: string };
 }
 
 export interface ReverseDNSEditParams {
@@ -78,7 +78,7 @@ export interface ReverseDNSEditParams {
   /**
    * Body param: Map of cluster IP addresses to PTR record contents
    */
-  ptr?: Record<string, string>;
+  ptr?: { [key: string]: string };
 }
 
 export interface ReverseDNSGetParams {

package/src/resources/email-security/investigate/investigate.ts

@@ -169,6 +169,11 @@ export interface InvestigateListResponse {
 
 export namespace InvestigateListResponse {
   export interface Properties {
+    allowlisted_pattern_type?: string;
+
+    /**
+     * @deprecated
+     */
     whitelisted_pattern_type?: string;
   }
 
@@ -257,6 +262,11 @@ export interface InvestigateGetResponse {
 
 export namespace InvestigateGetResponse {
   export interface Properties {
+    allowlisted_pattern_type?: string;
+
+    /**
+     * @deprecated
+     */
     whitelisted_pattern_type?: string;
   }
 

package/src/resources/email-security/investigate/move.ts

@@ -72,33 +72,33 @@ export class MoveBulkResponsesSinglePage extends SinglePage<MoveBulkResponse> {}
 export interface MoveCreateResponse {
   completed_timestamp: string;
 
-  destination: string;
-
   item_count: number;
 
-  message_id: string;
+  destination?: string | null;
+
+  message_id?: string | null;
 
-  operation: string;
+  operation?: string | null;
 
-  recipient: string;
+  recipient?: string | null;
 
-  status: string;
+  status?: string | null;
 }
 
 export interface MoveBulkResponse {
   completed_timestamp: string;
 
-  destination: string;
-
   item_count: number;
 
-  message_id: string;
+  destination?: string | null;
+
+  message_id?: string | null;
 
-  operation: string;
+  operation?: string | null;
 
-  recipient: string;
+  recipient?: string | null;
 
-  status: string;
+  status?: string | null;
 }
 
 export interface MoveCreateParams {

package/src/resources/email-security/settings/domains.ts

@@ -428,7 +428,7 @@ export interface DomainEditParams {
   /**
    * Body param:
    */
-  domain?: string | null;
+  domain?: string;
 
   /**
    * Body param:
@@ -454,12 +454,12 @@ export interface DomainEditParams {
   /**
    * Body param:
    */
-  integration_id?: string | null;
+  integration_id?: string;
 
   /**
    * Body param:
    */
-  lookback_hops?: number | null;
+  lookback_hops?: number;
 
   /**
    * Body param:

package/src/resources/email-security/settings/trusted-domains.ts

@@ -424,30 +424,30 @@ export interface TrustedDomainEditParams {
   /**
    * Body param:
    */
-  comments?: string | null;
+  comments?: string;
 
   /**
    * Body param: Select to prevent recently registered domains from triggering a
    * Suspicious or Malicious disposition.
    */
-  is_recent?: boolean | null;
+  is_recent?: boolean;
 
   /**
    * Body param:
    */
-  is_regex?: boolean | null;
+  is_regex?: boolean;
 
   /**
    * Body param: Select for partner or other approved domains that have similar
    * spelling to your connected domains. Prevents listed domains from triggering a
    * Spoof disposition.
    */
-  is_similarity?: boolean | null;
+  is_similarity?: boolean;
 
   /**
    * Body param:
    */
-  pattern?: string | null;
+  pattern?: string;
 }
 
 export interface TrustedDomainGetParams {

package/src/resources/firewall/lockdowns.ts

@@ -271,8 +271,8 @@ export interface LockdownCreateParams {
   urls: Array<OverridesAPI.OverrideURLParam>;
 
   /**
-   * Body param: An informative summary of the rate limit. This value is sanitized
-   * and any tags will be removed.
+   * Body param: An informative summary of the rule. This value is sanitized and any
+   * tags will be removed.
    */
   description?: string;
 

package/src/resources/firewall/ua-rules.ts

@@ -133,9 +133,97 @@ export class UARules extends APIResource {
 
 export class UARuleListResponsesV4PagePaginationArray extends V4PagePaginationArray<UARuleListResponse> {}
 
-export type UARuleCreateResponse = unknown | string | null;
+export interface UARuleCreateResponse {
+  /**
+   * The unique identifier of the User Agent Blocking rule.
+   */
+  id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleCreateResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
+}
+
+export namespace UARuleCreateResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
 
-export type UARuleUpdateResponse = unknown | string | null;
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
+
+export interface UARuleUpdateResponse {
+  /**
+   * The unique identifier of the User Agent Blocking rule.
+   */
+  id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleUpdateResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
+}
+
+export namespace UARuleUpdateResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
+
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
 
 export interface UARuleListResponse {
   /**
@@ -188,9 +276,92 @@ export interface UARuleDeleteResponse {
    * The unique identifier of the User Agent Blocking rule.
    */
   id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleDeleteResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
+}
+
+export namespace UARuleDeleteResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
+
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
+
+export interface UARuleGetResponse {
+  /**
+   * The unique identifier of the User Agent Blocking rule.
+   */
+  id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleGetResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
 }
 
-export type UARuleGetResponse = unknown | string | null;
+export namespace UARuleGetResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
+
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
 
 export interface UARuleCreateParams {
   /**
@@ -207,6 +378,17 @@ export interface UARuleCreateParams {
    * Body param: The action to apply to a matched request.
    */
   mode: 'block' | 'challenge' | 'whitelist' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * Body param: An informative summary of the rule. This value is sanitized and any
+   * tags will be removed.
+   */
+  description?: string;
+
+  /**
+   * Body param: When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
 }
 
 export namespace UARuleCreateParams {
@@ -244,6 +426,17 @@ export interface UARuleUpdateParams {
    * Body param: The action to apply to a matched request.
    */
   mode: 'block' | 'challenge' | 'whitelist' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * Body param: An informative summary of the rule. This value is sanitized and any
+   * tags will be removed.
+   */
+  description?: string;
+
+  /**
+   * Body param: When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
 }
 
 export interface UARuleListParams extends V4PagePaginationArrayParams {
@@ -258,14 +451,14 @@ export interface UARuleListParams extends V4PagePaginationArrayParams {
   description?: string;
 
   /**
-   * Query param: A string to search for in the description of existing rules.
+   * Query param: When true, indicates that the rule is currently paused.
    */
-  description_search?: string;
+  paused?: boolean;
 
   /**
    * Query param: A string to search for in the user agent values of existing rules.
    */
-  ua_search?: string;
+  user_agent?: string;
 }
 
 export interface UARuleDeleteParams {

package/src/resources/firewall/waf/overrides.ts

@@ -129,10 +129,10 @@ export interface Override {
    * creating a new URI-based WAF override, you must provide a `groups` object or a
    * `rules` object.
    */
-  groups?: Record<string, unknown>;
+  groups?: { [key: string]: unknown };
 
   /**
-   * When true, indicates that the WAF package is currently paused.
+   * When true, indicates that the rule is currently paused.
    */
   paused?: boolean;
 
@@ -239,7 +239,7 @@ export interface RewriteActionParam {
  * group that this WAF rule belongs to. When creating a new URI-based WAF override,
  * you must provide a `groups` object or a `rules` object.
  */
-export type WAFRule = Record<string, 'challenge' | 'block' | 'simulate' | 'disable' | 'default'>;
+export type WAFRule = { [key: string]: 'challenge' | 'block' | 'simulate' | 'disable' | 'default' };
 
 /**
  * An object that allows you to override the action of specific WAF rules. Each key
@@ -248,7 +248,7 @@ export type WAFRule = Record<string, 'challenge' | 'block' | 'simulate' | 'disab
  * group that this WAF rule belongs to. When creating a new URI-based WAF override,
  * you must provide a `groups` object or a `rules` object.
  */
-export type WAFRuleParam = Record<string, 'challenge' | 'block' | 'simulate' | 'disable' | 'default'>;
+export type WAFRuleParam = { [key: string]: 'challenge' | 'block' | 'simulate' | 'disable' | 'default' };
 
 export interface OverrideDeleteResponse {
   /**

package/src/resources/healthchecks/healthchecks.ts

@@ -339,7 +339,7 @@ export interface HTTPConfiguration {
    * The HTTP request headers to send in the health check. It is recommended you set
    * a Host header by default. The User-Agent header cannot be overridden.
    */
-  header?: Record<string, Array<string>> | null;
+  header?: { [key: string]: Array<string> } | null;
 
   /**
    * The HTTP method to use for the health check.
@@ -388,7 +388,7 @@ export interface HTTPConfigurationParam {
    * The HTTP request headers to send in the health check. It is recommended you set
    * a Host header by default. The User-Agent header cannot be overridden.
    */
-  header?: Record<string, Array<string>> | null;
+  header?: { [key: string]: Array<string> } | null;
 
   /**
    * The HTTP method to use for the health check.

package/src/resources/hyperdrive/configs.ts

@@ -207,6 +207,12 @@ export interface ConfigCreateParams {
    * Body param:
    */
   mtls?: ConfigCreateParams.MTLS;
+
+  /**
+   * Body param: The (soft) maximum number of connections the Hyperdrive is allowed
+   * to make to the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace ConfigCreateParams {
@@ -356,6 +362,12 @@ export interface ConfigUpdateParams {
    * Body param:
    */
   mtls?: ConfigUpdateParams.MTLS;
+
+  /**
+   * Body param: The (soft) maximum number of connections the Hyperdrive is allowed
+   * to make to the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace ConfigUpdateParams {
@@ -520,6 +532,12 @@ export interface ConfigEditParams {
     | ConfigEditParams.HyperdriveHyperdriveDatabase
     | ConfigEditParams.HyperdriveInternetOrigin
     | ConfigEditParams.HyperdriveOverAccessOrigin;
+
+  /**
+   * Body param: The (soft) maximum number of connections the Hyperdrive is allowed
+   * to make to the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace ConfigEditParams {

package/src/resources/hyperdrive/hyperdrive.ts

@@ -102,6 +102,12 @@ export interface Hyperdrive {
   modified_on?: string;
 
   mtls?: Hyperdrive.MTLS;
+
+  /**
+   * The (soft) maximum number of connections the Hyperdrive is allowed to make to
+   * the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace Hyperdrive {

package/src/resources/images/v1/v1.ts

@@ -191,10 +191,15 @@ export interface V1CreateParams {
    */
   account_id: string;
 
+  /**
+   * Body param: An optional custom unique identifier for your image.
+   */
+  id?: string;
+
   /**
    * Body param: An image binary data. Only needed when type is uploading a file.
    */
-  file?: unknown;
+  file?: Core.Uploadable;
 
   /**
    * Body param: User modifiable key-value store. Can use used for keeping references

package/src/resources/index.ts

@@ -14,7 +14,7 @@ export { AuditLogs } from './audit-logs';
 export { Billing } from './billing/billing';
 export { BotManagement } from './bot-management';
 export { BotnetFeed } from './botnet-feed/botnet-feed';
-export { BrandProtection } from './brand-protection';
+export { BrandProtection } from './brand-protection/brand-protection';
 export { BrowserRendering } from './browser-rendering/browser-rendering';
 export { Cache } from './cache/cache';
 export { Calls } from './calls/calls';