cloudflare 7.2.0 → 7.3.0

package/src/resources/email-security/settings/impersonation-registry.ts

@@ -169,14 +169,27 @@ export interface ImpersonationRegistryCreateResponse {
    */
   id?: string;
 
+  /**
+   * Optional note describing the entry.
+   */
   comments?: string | null;
 
   created_at?: string;
 
+  /**
+   * Identifier of the directory the entry was synced from, when directory-synced.
+   */
   directory_id?: number | null;
 
+  /**
+   * Identifier of the directory node the entry was synced from, when
+   * directory-synced.
+   */
   directory_node_id?: number | null;
 
+  /**
+   * Email address (or pattern) of the protected identity.
+   */
   email?: string;
 
   /**
@@ -184,6 +197,9 @@ export interface ImpersonationRegistryCreateResponse {
    */
   external_directory_node_id?: string | null;
 
+  /**
+   * Whether `email` is a regular expression instead of a literal address.
+   */
   is_email_regex?: boolean;
 
   /**
@@ -193,8 +209,14 @@ export interface ImpersonationRegistryCreateResponse {
 
   modified_at?: string;
 
+  /**
+   * Display name of the protected identity.
+   */
   name?: string;
 
+  /**
+   * Source the entry was created from.
+   */
   provenance?:
     | 'A1S_INTERNAL'
     | 'SNOOPY-CASB_OFFICE_365'
@@ -212,14 +234,27 @@ export interface ImpersonationRegistryListResponse {
    */
   id?: string;
 
+  /**
+   * Optional note describing the entry.
+   */
   comments?: string | null;
 
   created_at?: string;
 
+  /**
+   * Identifier of the directory the entry was synced from, when directory-synced.
+   */
   directory_id?: number | null;
 
+  /**
+   * Identifier of the directory node the entry was synced from, when
+   * directory-synced.
+   */
   directory_node_id?: number | null;
 
+  /**
+   * Email address (or pattern) of the protected identity.
+   */
   email?: string;
 
   /**
@@ -227,6 +262,9 @@ export interface ImpersonationRegistryListResponse {
    */
   external_directory_node_id?: string | null;
 
+  /**
+   * Whether `email` is a regular expression instead of a literal address.
+   */
   is_email_regex?: boolean;
 
   /**
@@ -236,8 +274,14 @@ export interface ImpersonationRegistryListResponse {
 
   modified_at?: string;
 
+  /**
+   * Display name of the protected identity.
+   */
   name?: string;
 
+  /**
+   * Source the entry was created from.
+   */
   provenance?:
     | 'A1S_INTERNAL'
     | 'SNOOPY-CASB_OFFICE_365'
@@ -262,14 +306,27 @@ export interface ImpersonationRegistryEditResponse {
    */
   id?: string;
 
+  /**
+   * Optional note describing the entry.
+   */
   comments?: string | null;
 
   created_at?: string;
 
+  /**
+   * Identifier of the directory the entry was synced from, when directory-synced.
+   */
   directory_id?: number | null;
 
+  /**
+   * Identifier of the directory node the entry was synced from, when
+   * directory-synced.
+   */
   directory_node_id?: number | null;
 
+  /**
+   * Email address (or pattern) of the protected identity.
+   */
   email?: string;
 
   /**
@@ -277,6 +334,9 @@ export interface ImpersonationRegistryEditResponse {
    */
   external_directory_node_id?: string | null;
 
+  /**
+   * Whether `email` is a regular expression instead of a literal address.
+   */
   is_email_regex?: boolean;
 
   /**
@@ -286,8 +346,14 @@ export interface ImpersonationRegistryEditResponse {
 
   modified_at?: string;
 
+  /**
+   * Display name of the protected identity.
+   */
   name?: string;
 
+  /**
+   * Source the entry was created from.
+   */
   provenance?:
     | 'A1S_INTERNAL'
     | 'SNOOPY-CASB_OFFICE_365'
@@ -305,14 +371,27 @@ export interface ImpersonationRegistryGetResponse {
    */
   id?: string;
 
+  /**
+   * Optional note describing the entry.
+   */
   comments?: string | null;
 
   created_at?: string;
 
+  /**
+   * Identifier of the directory the entry was synced from, when directory-synced.
+   */
   directory_id?: number | null;
 
+  /**
+   * Identifier of the directory node the entry was synced from, when
+   * directory-synced.
+   */
   directory_node_id?: number | null;
 
+  /**
+   * Email address (or pattern) of the protected identity.
+   */
   email?: string;
 
   /**
@@ -320,6 +399,9 @@ export interface ImpersonationRegistryGetResponse {
    */
   external_directory_node_id?: string | null;
 
+  /**
+   * Whether `email` is a regular expression instead of a literal address.
+   */
   is_email_regex?: boolean;
 
   /**
@@ -329,8 +411,14 @@ export interface ImpersonationRegistryGetResponse {
 
   modified_at?: string;
 
+  /**
+   * Display name of the protected identity.
+   */
   name?: string;
 
+  /**
+   * Source the entry was created from.
+   */
   provenance?:
     | 'A1S_INTERNAL'
     | 'SNOOPY-CASB_OFFICE_365'
@@ -346,32 +434,35 @@ export interface ImpersonationRegistryCreateParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: Email address (or pattern) of the protected identity.
    */
   email: string;
 
   /**
-   * Body param
+   * Body param: Whether `email` is a regular expression instead of a literal
+   * address.
    */
   is_email_regex: boolean;
 
   /**
-   * Body param
+   * Body param: Display name of the protected identity.
    */
   name: string;
 
   /**
-   * Body param
+   * Body param: Optional note describing the entry.
    */
   comments?: string | null;
 
   /**
-   * Body param
+   * Body param: Identifier of the directory the entry was synced from, when
+   * directory-synced.
    */
   directory_id?: number | null;
 
   /**
-   * Body param
+   * Body param: Identifier of the directory node the entry was synced from, when
+   * directory-synced.
    */
   directory_node_id?: number | null;
 
@@ -381,7 +472,7 @@ export interface ImpersonationRegistryCreateParams {
   external_directory_node_id?: string | null;
 
   /**
-   * Body param
+   * Body param: Source the entry was created from.
    */
   provenance?:
     | 'A1S_INTERNAL'
@@ -432,22 +523,24 @@ export interface ImpersonationRegistryEditParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: Optional note describing the entry.
    */
   comments?: string | null;
 
   /**
-   * Body param
+   * Body param: Identifier of the directory the entry was synced from, when
+   * directory-synced.
    */
   directory_id?: number | null;
 
   /**
-   * Body param
+   * Body param: Identifier of the directory node the entry was synced from, when
+   * directory-synced.
    */
   directory_node_id?: number | null;
 
   /**
-   * Body param
+   * Body param: Email address (or pattern) of the protected identity.
    */
   email?: string;
 
@@ -457,17 +550,18 @@ export interface ImpersonationRegistryEditParams {
   external_directory_node_id?: string | null;
 
   /**
-   * Body param
+   * Body param: Whether `email` is a regular expression instead of a literal
+   * address.
    */
   is_email_regex?: boolean;
 
   /**
-   * Body param
+   * Body param: Display name of the protected identity.
    */
   name?: string;
 
   /**
-   * Body param
+   * Body param: Source the entry was created from.
    */
   provenance?:
     | 'A1S_INTERNAL'

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

@@ -104,9 +104,10 @@ export class BaseTrustedDomains 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 trusted domain operations atomically: delete, partially
+   * update, replace, and create trusted domain 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
@@ -224,6 +225,9 @@ export interface TrustedDomainCreateResponse {
    */
   is_recent?: boolean;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal domain.
+   */
   is_regex?: boolean;
 
   /**
@@ -239,6 +243,9 @@ export interface TrustedDomainCreateResponse {
 
   modified_at?: string;
 
+  /**
+   * The domain pattern to trust, e.g. `example.com`.
+   */
   pattern?: string;
 }
 
@@ -261,6 +268,9 @@ export interface TrustedDomainListResponse {
    */
   is_recent?: boolean;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal domain.
+   */
   is_regex?: boolean;
 
   /**
@@ -276,6 +286,9 @@ export interface TrustedDomainListResponse {
 
   modified_at?: string;
 
+  /**
+   * The domain pattern to trust, e.g. `example.com`.
+   */
   pattern?: string;
 }
 
@@ -323,6 +336,9 @@ export namespace TrustedDomainBatchResponse {
      */
     is_recent?: boolean;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal domain.
+     */
     is_regex?: boolean;
 
     /**
@@ -338,6 +354,9 @@ export namespace TrustedDomainBatchResponse {
 
     modified_at?: string;
 
+    /**
+     * The domain pattern to trust, e.g. `example.com`.
+     */
     pattern?: string;
   }
 
@@ -360,6 +379,9 @@ export namespace TrustedDomainBatchResponse {
      */
     is_recent?: boolean;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal domain.
+     */
     is_regex?: boolean;
 
     /**
@@ -375,6 +397,9 @@ export namespace TrustedDomainBatchResponse {
 
     modified_at?: string;
 
+    /**
+     * The domain pattern to trust, e.g. `example.com`.
+     */
     pattern?: string;
   }
 
@@ -397,6 +422,9 @@ export namespace TrustedDomainBatchResponse {
      */
     is_recent?: boolean;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal domain.
+     */
     is_regex?: boolean;
 
     /**
@@ -412,6 +440,9 @@ export namespace TrustedDomainBatchResponse {
 
     modified_at?: string;
 
+    /**
+     * The domain pattern to trust, e.g. `example.com`.
+     */
     pattern?: string;
   }
 }
@@ -435,6 +466,9 @@ export interface TrustedDomainEditResponse {
    */
   is_recent?: boolean;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal domain.
+   */
   is_regex?: boolean;
 
   /**
@@ -450,6 +484,9 @@ export interface TrustedDomainEditResponse {
 
   modified_at?: string;
 
+  /**
+   * The domain pattern to trust, e.g. `example.com`.
+   */
   pattern?: string;
 }
 
@@ -472,6 +509,9 @@ export interface TrustedDomainGetResponse {
    */
   is_recent?: boolean;
 
+  /**
+   * Whether `pattern` is a regular expression instead of a literal domain.
+   */
   is_regex?: boolean;
 
   /**
@@ -487,6 +527,9 @@ export interface TrustedDomainGetResponse {
 
   modified_at?: string;
 
+  /**
+   * The domain pattern to trust, e.g. `example.com`.
+   */
   pattern?: string;
 }
 
@@ -503,7 +546,8 @@ export interface TrustedDomainCreateParams {
   is_recent: boolean;
 
   /**
-   * Body param
+   * Body param: Whether `pattern` is a regular expression instead of a literal
+   * domain.
    */
   is_regex: boolean;
 
@@ -515,7 +559,7 @@ export interface TrustedDomainCreateParams {
   is_similarity: boolean;
 
   /**
-   * Body param
+   * Body param: The domain pattern to trust, e.g. `example.com`.
    */
   pattern: string;
 
@@ -578,22 +622,24 @@ export interface TrustedDomainBatchParams {
   account_id: string;
 
   /**
-   * Body param
+   * Body param: IDs of the trusted domain patterns to delete.
    */
   deletes: Array<TrustedDomainBatchParams.Delete>;
 
   /**
-   * Body param
+   * Body param: Partial updates to apply — each entry carries the pattern's ID and
+   * only the fields to change.
    */
   patches: Array<TrustedDomainBatchParams.Patch>;
 
   /**
-   * Body param
+   * Body param: Trusted domain patterns to create.
    */
   posts: Array<TrustedDomainBatchParams.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<TrustedDomainBatchParams.Put>;
 }
@@ -618,6 +664,9 @@ export namespace TrustedDomainBatchParams {
      */
     is_recent?: boolean;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal domain.
+     */
     is_regex?: boolean;
 
     /**
@@ -626,6 +675,9 @@ export namespace TrustedDomainBatchParams {
      */
     is_similarity?: boolean;
 
+    /**
+     * The domain pattern to trust, e.g. `example.com`.
+     */
     pattern?: string;
   }
 
@@ -639,6 +691,9 @@ export namespace TrustedDomainBatchParams {
      */
     is_recent: boolean;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal domain.
+     */
     is_regex: boolean;
 
     /**
@@ -647,6 +702,9 @@ export namespace TrustedDomainBatchParams {
      */
     is_similarity: boolean;
 
+    /**
+     * The domain pattern to trust, e.g. `example.com`.
+     */
     pattern: string;
 
     comments?: string | null;
@@ -662,6 +720,9 @@ export namespace TrustedDomainBatchParams {
      */
     is_recent: boolean;
 
+    /**
+     * Whether `pattern` is a regular expression instead of a literal domain.
+     */
     is_regex: boolean;
 
     /**
@@ -670,6 +731,9 @@ export namespace TrustedDomainBatchParams {
      */
     is_similarity: boolean;
 
+    /**
+     * The domain pattern to trust, e.g. `example.com`.
+     */
     pattern: string;
 
     comments?: string | null;
@@ -694,7 +758,8 @@ export interface TrustedDomainEditParams {
   is_recent?: boolean;
 
   /**
-   * Body param
+   * Body param: Whether `pattern` is a regular expression instead of a literal
+   * domain.
    */
   is_regex?: boolean;
 
@@ -706,7 +771,7 @@ export interface TrustedDomainEditParams {
   is_similarity?: boolean;
 
   /**
-   * Body param
+   * Body param: The domain pattern to trust, e.g. `example.com`.
    */
   pattern?: string;
 }

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

@@ -52,16 +52,35 @@ export interface SubmissionListResponse {
 
   customer_status?: 'escalated' | 'reviewed' | 'unreviewed' | null;
 
+  /**
+   * The disposition a message is submitted to have.
+   */
   escalated_as?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'NONE' | null;
 
+  /**
+   * When the submission was escalated to the security team.
+   */
   escalated_at?: string | null;
 
+  /**
+   * Email address of the user who escalated the submission.
+   */
   escalated_by?: string | null;
 
+  /**
+   * Submission ID of the escalated team submission, when this user submission was
+   * escalated.
+   */
   escalated_submission_id?: string | null;
 
+  /**
+   * The disposition a message is submitted to have.
+   */
   original_disposition?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'NONE' | null;
 
+  /**
+   * EDF hash of the original message.
+   */
   original_edf_hash?: string | null;
 
   /**
@@ -69,12 +88,24 @@ export interface SubmissionListResponse {
    */
   original_postfix_id?: string | null;
 
+  /**
+   * Processing outcome of the submission.
+   */
   outcome?: string | null;
 
+  /**
+   * The disposition a message is submitted to have.
+   */
   outcome_disposition?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'NONE' | null;
 
+  /**
+   * Email address of the user who requested the submission.
+   */
   requested_by?: string | null;
 
+  /**
+   * The disposition a message is submitted to have.
+   */
   requested_disposition?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'NONE' | null;
 
   /**
@@ -82,8 +113,14 @@ export interface SubmissionListResponse {
    */
   requested_ts?: string;
 
+  /**
+   * Processing status of the submission.
+   */
   status?: string | null;
 
+  /**
+   * Subject line of the submitted message.
+   */
   subject?: string | null;
 
   /**
@@ -127,22 +164,22 @@ export interface SubmissionListParams extends V4PagePaginationArrayParams {
     | 'requested_at';
 
   /**
-   * Query param
+   * Query param: The disposition a message is submitted to have.
    */
   original_disposition?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'NONE';
 
   /**
-   * Query param
+   * Query param: The disposition a message is submitted to have.
    */
   outcome_disposition?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'NONE';
 
   /**
-   * Query param
+   * Query param: Search term for filtering submissions.
    */
   query?: string | null;
 
   /**
-   * Query param
+   * Query param: The disposition a message is submitted to have.
    */
   requested_disposition?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'NONE';
 
@@ -153,17 +190,18 @@ export interface SubmissionListParams extends V4PagePaginationArrayParams {
   start?: string;
 
   /**
-   * Query param
+   * Query param: Filter by review status — `escalated`, `reviewed`, or `unreviewed`.
    */
   status?: string;
 
   /**
-   * Query param
+   * Query param: Filter by a specific submission ID.
    */
   submission_id?: string;
 
   /**
-   * Query param
+   * Query param: Filter by who created the submission — `TEAM` for security team
+   * members or `USER` for end users.
    */
   type?: 'TEAM' | 'USER';
 }