feat(api): api update (#2127)

stainless-app[bot] · meorphis · commit c5ec71794dcd · 2025-01-13T10:21:12.000-05:00
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 1417
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-238bdc2301e165198e92ece05a86c3b80aa6653c5cd7334b3dc59fd9d687acce.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-1c64fbec9a1e17ca560abf251c26a4adb4d60123dbe3f7dcc10819494cd97a6f.yml
diff --git a/src/resources/email-security/investigate.ts b/src/resources/email-security/investigate.ts
@@ -6,8 +6,7 @@ import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../p
 
 export class Investigate extends APIResource {
   /**
-   * This endpoint returns information for each email that matches the search
-   * parameter(s).
+   * Returns information for each email that matches the search parameter(s).
    */
   list(
     params: InvestigateListParams,
@@ -22,8 +21,8 @@ export class Investigate extends APIResource {
   }
 
   /**
-   * For emails that have a detection, this endpoint returns detection details such
-   * as threat categories, sender information, and links.
+   * Returns detection details such as threat categories and sender information for
+   * non-benign messages.
    */
   detections(
     postfixId: string,
@@ -57,8 +56,8 @@ export class Investigate extends APIResource {
   }
 
   /**
-   * For emails that have a detection, this endpoint returns a preview of the message
-   * body as a base64 encoded PNG image.
+   * Returns a preview of the message body as a base64 encoded PNG image for
+   * non-benign messages.
    */
   preview(
     postfixId: string,
@@ -75,8 +74,7 @@ export class Investigate extends APIResource {
   }
 
   /**
-   * For emails that have a detection, this endpoint returns the raw email as an EML
-   * file.
+   * Returns the raw eml of any non-benign message.
    */
   raw(
     postfixId: string,
@@ -126,7 +124,7 @@ export interface InvestigateListResponse {
   is_quarantined: boolean;
 
   /**
-   * Message identifier
+   * The identifier of the message.
    */
   postfix_id: string;
 
@@ -261,12 +259,12 @@ export namespace InvestigateDetectionsResponse {
 
   export interface SenderInfo {
     /**
-     * Name of the autonomous system
+     * The name of the autonomous system.
      */
     as_name?: string | null;
 
     /**
-     * Number of the autonomous system
+     * The number of the autonomous system.
      */
     as_number?: number | null;
 
@@ -310,7 +308,7 @@ export interface InvestigateGetResponse {
   is_quarantined: boolean;
 
   /**
-   * Message identifier
+   * The identifier of the message.
    */
   postfix_id: string;
 
@@ -380,14 +378,14 @@ export namespace InvestigateGetResponse {
 
 export interface InvestigatePreviewResponse {
   /**
-   * Base64 encoded PNG image
+   * A base64 encoded PNG image of the email.
    */
   screenshot: string;
 }
 
 export interface InvestigateRawResponse {
   /**
-   * UTF-8 encoded eml file
+   * A UTF-8 encoded eml file of the email.
    */
   raw: string;
 }
@@ -435,8 +433,7 @@ export interface InvestigateListParams extends V4PagePaginationArrayParams {
   account_id: string;
 
   /**
-   * Query param: Controls whether the message action log in included in the
-   * response.
+   * Query param: Determines if the message action log is included in the response.
    */
   action_log?: boolean;
 
@@ -446,12 +443,12 @@ export interface InvestigateListParams extends V4PagePaginationArrayParams {
   alert_id?: string;
 
   /**
-   * Query param: If `false`, the search includes non-detections.
+   * Query param: Determines if the search results will include detections or not.
    */
   detections_only?: boolean;
 
   /**
-   * Query param: Filter by the sender domain
+   * Query param: The sender domains the search filters by.
    */
   domain?: string;
 
@@ -461,12 +458,12 @@ export interface InvestigateListParams extends V4PagePaginationArrayParams {
   end?: string;
 
   /**
-   * Query param: Filter messages by the provided disposition.
+   * Query param: The dispositions the search filters by.
    */
   final_disposition?: 'MALICIOUS' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK';
 
   /**
-   * Query param: Filter messages by actions applied to them
+   * Query param: The message actions the search filters by.
    */
   message_action?: 'PREVIEW' | 'QUARANTINE_RELEASED' | 'MOVED';
 
@@ -481,7 +478,8 @@ export interface InvestigateListParams extends V4PagePaginationArrayParams {
   metric?: string;
 
   /**
-   * Query param: Space delimited query term(s). The search is case-insensitive.
+   * Query param: The space-delimited term used in the query. The search is
+   * case-insensitive.
    *
    * The content of the following email metadata fields are searched:
    *
diff --git a/src/resources/email-security/settings/allow-patterns.ts b/src/resources/email-security/settings/allow-patterns.ts
@@ -22,7 +22,7 @@ export class AllowPatterns extends APIResource {
   }
 
   /**
-   * List, search, and sort an accounts's email allow patterns.
+   * Lists, searches, and sorts an account’s email allow patterns.
    */
   list(
     params: AllowPatternListParams,
diff --git a/src/resources/email-security/settings/domains.ts b/src/resources/email-security/settings/domains.ts
@@ -6,7 +6,7 @@ import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../.
 
 export class Domains extends APIResource {
   /**
-   * List, search, and sort an account's email domains.
+   * Lists, searches, and sorts an account’s email domains.
    */
   list(
     params: DomainListParams,
@@ -59,7 +59,7 @@ export class DomainListResponsesV4PagePaginationArray extends V4PagePaginationAr
 
 export interface DomainListResponse {
   /**
-   * Unique domain identifier
+   * The unique identifier for the domain.
    */
   id: number;
 
@@ -82,14 +82,14 @@ export interface DomainListResponse {
 
 export interface DomainDeleteResponse {
   /**
-   * Unique domain identifier
+   * The unique identifier for the domain.
    */
   id: number;
 }
 
 export interface DomainEditResponse {
   /**
-   * Unique domain identifier
+   * The unique identifier for the domain.
    */
   id: number;
 
@@ -117,8 +117,7 @@ export interface DomainListParams extends V4PagePaginationArrayParams {
   account_id: string;
 
   /**
-   * Query param: If present, the response contains only domains with the provided
-   * delivery mode.
+   * Query param: Filters response to domains with the provided delivery mode.
    */
   allowed_delivery_mode?: 'DIRECT' | 'BCC' | 'JOURNAL' | 'API' | 'RETRO_SCAN';
 
@@ -128,8 +127,8 @@ export interface DomainListParams extends V4PagePaginationArrayParams {
   direction?: 'asc' | 'desc';
 
   /**
-   * Query param: Filter result by the provided domains. Allows for multiple
-   * occurrences, e.g., `domain=example.com&domain=example.xyz`.
+   * Query param: Filters results by the provided domains, allowing for multiple
+   * occurrences.
    */
   domain?: Array<string>;
 
diff --git a/src/resources/email-security/settings/impersonation-registry.ts b/src/resources/email-security/settings/impersonation-registry.ts
@@ -22,7 +22,7 @@ export class ImpersonationRegistry extends APIResource {
   }
 
   /**
-   * List, search, and sort entries in impersonation registry.
+   * Lists, searches, and sorts entries in the impersonation registry.
    */
   list(
     params: ImpersonationRegistryListParams,
diff --git a/src/resources/email-security/settings/trusted-domains.ts b/src/resources/email-security/settings/trusted-domains.ts
@@ -22,7 +22,7 @@ export class TrustedDomains extends APIResource {
   }
 
   /**
-   * List, search, and sort an account's trusted email domains.
+   * Lists, searches, and sorts an account’s trusted email domains.
    */
   list(
     params: TrustedDomainListParams,

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`configured_endpoints: 1417`
`2`		`-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-238bdc2301e165198e92ece05a86c3b80aa6653c5cd7334b3dc59fd9d687acce.yml`
	`2`	`+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-1c64fbec9a1e17ca560abf251c26a4adb4d60123dbe3f7dcc10819494cd97a6f.yml`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ export class AllowPatterns extends APIResource {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/**`
`25`		`- * List, search, and sort an accounts's email allow patterns.`
	`25`	`+ * Lists, searches, and sorts an account’s email allow patterns.`
`26`	`26`	`*/`
`27`	`27`	`list(`
`28`	`28`	`params: AllowPatternListParams,`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ export class ImpersonationRegistry extends APIResource {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/**`
`25`		`- * List, search, and sort entries in impersonation registry.`
	`25`	`+ * Lists, searches, and sorts entries in the impersonation registry.`
`26`	`26`	`*/`
`27`	`27`	`list(`
`28`	`28`	`params: ImpersonationRegistryListParams,`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ export class TrustedDomains extends APIResource {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/**`
`25`		`- * List, search, and sort an account's trusted email domains.`
	`25`	`+ * Lists, searches, and sorts an account’s trusted email domains.`
`26`	`26`	`*/`
`27`	`27`	`list(`
`28`	`28`	`params: TrustedDomainListParams,`