cloudflare 7.2.0 → 7.3.0

package/src/resources/email-security/settings/block-senders.ts

@@ -98,9 +98,10 @@ export class BaseBlockSenders extends APIResource {
   }
 
   /**
-   * Executes multiple operations atomically. All four operation arrays (deletes,
-   * patches, puts, posts) are required and executed in order. Send empty arrays for
-   * unused operations.
+   * Executes multiple blocked sender operations atomically: delete, partially
+   * update, replace, and create blocked sender patterns in a single request. All
+   * four operation arrays (deletes, patches, puts, posts) are required and executed
+   * in order. Send empty arrays for unused operations.
    *
    * @example
    * ```ts
@@ -209,6 +210,9 @@ export interface BlockSenderCreateResponse {
 
   created_at?: string;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal value.
+   */
   is_regex?: boolean;
 
   /**
@@ -257,6 +261,9 @@ export interface BlockSenderListResponse {
 
   created_at?: string;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal value.
+   */
   is_regex?: boolean;
 
   /**
@@ -330,6 +337,9 @@ export namespace BlockSenderBatchResponse {
 
     created_at?: string;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal value.
+     */
     is_regex?: boolean;
 
     /**
@@ -378,6 +388,9 @@ export namespace BlockSenderBatchResponse {
 
     created_at?: string;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal value.
+     */
     is_regex?: boolean;
 
     /**
@@ -426,6 +439,9 @@ export namespace BlockSenderBatchResponse {
 
     created_at?: string;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal value.
+     */
     is_regex?: boolean;
 
     /**
@@ -475,6 +491,9 @@ export interface BlockSenderEditResponse {
 
   created_at?: string;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal value.
+   */
   is_regex?: boolean;
 
   /**
@@ -523,6 +542,9 @@ export interface BlockSenderGetResponse {
 
   created_at?: string;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal value.
+   */
   is_regex?: boolean;
 
   /**
@@ -565,7 +587,8 @@ export interface BlockSenderCreateParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: Whether `pattern` is a regular expression instead of a literal
+   * value.
    */
   is_regex: boolean;
 
@@ -647,22 +670,24 @@ export interface BlockSenderBatchParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: IDs of the blocked sender patterns to delete.
    */
   deletes: Array<BlockSenderBatchParams.Delete>;
 
   /**
-   * Body param
+   * Body param: Partial updates to apply — each entry carries the pattern's ID and
+   * only the fields to change.
    */
   patches: Array<BlockSenderBatchParams.Patch>;
 
   /**
-   * Body param
+   * Body param: Blocked sender patterns to create.
    */
   posts: Array<BlockSenderBatchParams.Post>;
 
   /**
-   * Body param
+   * Body param: Full replacements to apply — each entry carries the pattern's ID and
+   * every field of its new value.
    */
   puts: Array<BlockSenderBatchParams.Put>;
 }
@@ -681,6 +706,9 @@ export namespace BlockSenderBatchParams {
   export interface Patch {
     comments?: string | null;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal value.
+     */
     is_regex?: boolean;
 
     /**
@@ -713,6 +741,9 @@ export namespace BlockSenderBatchParams {
    * Create a blocked sender pattern.
    */
   export interface Post {
+    /**
+     * Whether `pattern` is a regular expression instead of a literal value.
+     */
     is_regex: boolean;
 
     /**
@@ -747,6 +778,9 @@ export namespace BlockSenderBatchParams {
    * A blocked sender pattern.
    */
   export interface Put {
+    /**
+     * Whether `pattern` is a regular expression instead of a literal value.
+     */
     is_regex: boolean;
 
     /**
@@ -790,7 +824,8 @@ export interface BlockSenderEditParams {
   comments?: string | null;
 
   /**
-   * Body param
+   * Body param: Whether `pattern` is a regular expression instead of a literal
+   * value.
    */
   is_regex?: boolean;
 

package/src/resources/email-security/settings/content-policies.ts

@@ -103,9 +103,10 @@ export class BaseContentPolicies extends APIResource {
   }
 
   /**
-   * Executes multiple operations atomically. All four operation arrays (deletes,
-   * patches, puts, posts) are required and executed in order. Send empty arrays for
-   * unused operations.
+   * Executes multiple content policy operations atomically: delete, partially
+   * update, replace, and create content policies in a single request. All four
+   * operation arrays (deletes, patches, puts, posts) are required and executed in
+   * order. Send empty arrays for unused operations.
    *
    * @example
    * ```ts
@@ -216,16 +217,31 @@ export interface ContentPolicyCreateResponse {
 
   created_at?: string;
 
+  /**
+   * Whether the policy is active.
+   */
   enabled?: boolean;
 
   modified_at?: string;
 
+  /**
+   * Human-readable name of the policy.
+   */
   name?: string;
 
+  /**
+   * Optional note describing the purpose of the policy.
+   */
   notes?: string | null;
 
+  /**
+   * Regular expression the policy matches against.
+   */
   pattern?: string;
 
+  /**
+   * Parts of the email the pattern is matched against.
+   */
   targets?: Array<'SUBJECT' | 'BODY'>;
 }
 
@@ -240,16 +256,31 @@ export interface ContentPolicyListResponse {
 
   created_at?: string;
 
+  /**
+   * Whether the policy is active.
+   */
   enabled?: boolean;
 
   modified_at?: string;
 
+  /**
+   * Human-readable name of the policy.
+   */
   name?: string;
 
+  /**
+   * Optional note describing the purpose of the policy.
+   */
   notes?: string | null;
 
+  /**
+   * Regular expression the policy matches against.
+   */
   pattern?: string;
 
+  /**
+   * Parts of the email the pattern is matched against.
+   */
   targets?: Array<'SUBJECT' | 'BODY'>;
 }
 
@@ -289,16 +320,31 @@ export namespace ContentPolicyBatchResponse {
 
     created_at?: string;
 
+    /**
+     * Whether the policy is active.
+     */
     enabled?: boolean;
 
     modified_at?: string;
 
+    /**
+     * Human-readable name of the policy.
+     */
     name?: string;
 
+    /**
+     * Optional note describing the purpose of the policy.
+     */
     notes?: string | null;
 
+    /**
+     * Regular expression the policy matches against.
+     */
     pattern?: string;
 
+    /**
+     * Parts of the email the pattern is matched against.
+     */
     targets?: Array<'SUBJECT' | 'BODY'>;
   }
 
@@ -313,16 +359,31 @@ export namespace ContentPolicyBatchResponse {
 
     created_at?: string;
 
+    /**
+     * Whether the policy is active.
+     */
     enabled?: boolean;
 
     modified_at?: string;
 
+    /**
+     * Human-readable name of the policy.
+     */
     name?: string;
 
+    /**
+     * Optional note describing the purpose of the policy.
+     */
     notes?: string | null;
 
+    /**
+     * Regular expression the policy matches against.
+     */
     pattern?: string;
 
+    /**
+     * Parts of the email the pattern is matched against.
+     */
     targets?: Array<'SUBJECT' | 'BODY'>;
   }
 
@@ -337,16 +398,31 @@ export namespace ContentPolicyBatchResponse {
 
     created_at?: string;
 
+    /**
+     * Whether the policy is active.
+     */
     enabled?: boolean;
 
     modified_at?: string;
 
+    /**
+     * Human-readable name of the policy.
+     */
     name?: string;
 
+    /**
+     * Optional note describing the purpose of the policy.
+     */
     notes?: string | null;
 
+    /**
+     * Regular expression the policy matches against.
+     */
     pattern?: string;
 
+    /**
+     * Parts of the email the pattern is matched against.
+     */
     targets?: Array<'SUBJECT' | 'BODY'>;
   }
 }
@@ -362,16 +438,31 @@ export interface ContentPolicyEditResponse {
 
   created_at?: string;
 
+  /**
+   * Whether the policy is active.
+   */
   enabled?: boolean;
 
   modified_at?: string;
 
+  /**
+   * Human-readable name of the policy.
+   */
   name?: string;
 
+  /**
+   * Optional note describing the purpose of the policy.
+   */
   notes?: string | null;
 
+  /**
+   * Regular expression the policy matches against.
+   */
   pattern?: string;
 
+  /**
+   * Parts of the email the pattern is matched against.
+   */
   targets?: Array<'SUBJECT' | 'BODY'>;
 }
 
@@ -386,16 +477,31 @@ export interface ContentPolicyGetResponse {
 
   created_at?: string;
 
+  /**
+   * Whether the policy is active.
+   */
   enabled?: boolean;
 
   modified_at?: string;
 
+  /**
+   * Human-readable name of the policy.
+   */
   name?: string;
 
+  /**
+   * Optional note describing the purpose of the policy.
+   */
   notes?: string | null;
 
+  /**
+   * Regular expression the policy matches against.
+   */
   pattern?: string;
 
+  /**
+   * Parts of the email the pattern is matched against.
+   */
   targets?: Array<'SUBJECT' | 'BODY'>;
 }
 
@@ -406,27 +512,27 @@ export interface ContentPolicyCreateParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: Whether the policy is active.
    */
   enabled: boolean;
 
   /**
-   * Body param
+   * Body param: Human-readable name of the policy.
    */
   name: string;
 
   /**
-   * Body param
+   * Body param: Regular expression the policy matches against.
    */
   pattern: string;
 
   /**
-   * Body param
+   * Body param: Parts of the email the pattern is matched against.
    */
   targets: Array<'SUBJECT' | 'BODY'>;
 
   /**
-   * Body param
+   * Body param: Optional note describing the purpose of the policy.
    */
   notes?: string | null;
 }
@@ -477,22 +583,24 @@ export interface ContentPolicyBatchParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: IDs of the content policies to delete.
    */
   deletes: Array<ContentPolicyBatchParams.Delete>;
 
   /**
-   * Body param
+   * Body param: Partial updates to apply — each entry carries the policy's ID and
+   * only the fields to change.
    */
   patches: Array<ContentPolicyBatchParams.Patch>;
 
   /**
-   * Body param
+   * Body param: Content policies to create.
    */
   posts: Array<ContentPolicyBatchParams.Post>;
 
   /**
-   * Body param
+   * Body param: Full replacements to apply — each entry carries the policy's ID and
+   * every field of its new value.
    */
   puts: Array<ContentPolicyBatchParams.Put>;
 }
@@ -509,14 +617,29 @@ export namespace ContentPolicyBatchParams {
    * A content policy pattern that matches against the subject or body of an email.
    */
   export interface Patch {
+    /**
+     * Whether the policy is active.
+     */
     enabled?: boolean;
 
+    /**
+     * Human-readable name of the policy.
+     */
     name?: string;
 
+    /**
+     * Optional note describing the purpose of the policy.
+     */
     notes?: string | null;
 
+    /**
+     * Regular expression the policy matches against.
+     */
     pattern?: string;
 
+    /**
+     * Parts of the email the pattern is matched against.
+     */
     targets?: Array<'SUBJECT' | 'BODY'>;
   }
 
@@ -524,14 +647,29 @@ export namespace ContentPolicyBatchParams {
    * Create a content policy.
    */
   export interface Post {
+    /**
+     * Whether the policy is active.
+     */
     enabled: boolean;
 
+    /**
+     * Human-readable name of the policy.
+     */
     name: string;
 
+    /**
+     * Regular expression the policy matches against.
+     */
     pattern: string;
 
+    /**
+     * Parts of the email the pattern is matched against.
+     */
     targets: Array<'SUBJECT' | 'BODY'>;
 
+    /**
+     * Optional note describing the purpose of the policy.
+     */
     notes?: string | null;
   }
 
@@ -539,14 +677,29 @@ export namespace ContentPolicyBatchParams {
    * A content policy pattern that matches against the subject or body of an email.
    */
   export interface Put {
+    /**
+     * Whether the policy is active.
+     */
     enabled: boolean;
 
+    /**
+     * Human-readable name of the policy.
+     */
     name: string;
 
+    /**
+     * Regular expression the policy matches against.
+     */
     pattern: string;
 
+    /**
+     * Parts of the email the pattern is matched against.
+     */
     targets: Array<'SUBJECT' | 'BODY'>;
 
+    /**
+     * Optional note describing the purpose of the policy.
+     */
     notes?: string | null;
   }
 }
@@ -558,27 +711,27 @@ export interface ContentPolicyEditParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: Whether the policy is active.
    */
   enabled?: boolean;
 
   /**
-   * Body param
+   * Body param: Human-readable name of the policy.
    */
   name?: string;
 
   /**
-   * Body param
+   * Body param: Optional note describing the purpose of the policy.
    */
   notes?: string | null;
 
   /**
-   * Body param
+   * Body param: Regular expression the policy matches against.
    */
   pattern?: string;
 
   /**
-   * Body param
+   * Body param: Parts of the email the pattern is matched against.
    */
   targets?: Array<'SUBJECT' | 'BODY'>;
 }