cloudflare 6.3.0 → 6.5.0

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

@@ -0,0 +1,162 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as Core from '../../../../core';
+
+export class Cancel extends APIResource {
+  /**
+   * Marks the job as cancelled and stops any pending message processing. The job
+   * record remains visible in list and detail endpoints.
+   *
+   * @example
+   * ```ts
+   * const cancel =
+   *   await client.emailSecurity.investigate.bulk.cancel.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  create(
+    jobId: string,
+    params: CancelCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CancelCreateResponse> {
+    const { account_id } = params;
+    return (
+      this._client.post(
+        `/accounts/${account_id}/email-security/investigate/bulk/${jobId}/cancel`,
+        options,
+      ) as Core.APIPromise<{ result: CancelCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface CancelCreateResponse {
+  action_params: CancelCreateResponse.Move | CancelCreateResponse.Release;
+
+  action_type: 'MOVE' | 'RELEASE';
+
+  created_at: string;
+
+  job_id: string;
+
+  messages_failed: number;
+
+  messages_pending: number;
+
+  messages_successful: number;
+
+  search_params: CancelCreateResponse.SearchParams;
+
+  status: 'PENDING' | 'DISCOVERING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'SKIPPED';
+
+  total_messages_discovered: number;
+
+  comment?: string | null;
+
+  completed_at?: string | null;
+
+  started_at?: string | null;
+
+  status_message?: string | null;
+}
+
+export namespace CancelCreateResponse {
+  export interface Move {
+    destination:
+      | 'Inbox'
+      | 'JunkEmail'
+      | 'DeletedItems'
+      | 'RecoverableItemsDeletions'
+      | 'RecoverableItemsPurges';
+
+    type: 'MOVE';
+
+    expected_disposition?:
+      | 'MALICIOUS'
+      | 'MALICIOUS-BEC'
+      | 'SUSPICIOUS'
+      | 'SPOOF'
+      | 'SPAM'
+      | 'BULK'
+      | 'ENCRYPTED'
+      | 'EXTERNAL'
+      | 'UNKNOWN'
+      | 'NONE';
+  }
+
+  export interface Release {
+    type: 'RELEASE';
+  }
+
+  export interface SearchParams {
+    /**
+     * @deprecated Deprecated, use `GET /investigate/{investigate_id}/action_log`
+     * instead. End of life: November 1, 2026.
+     */
+    action_log?: boolean;
+
+    alert_id?: string | null;
+
+    /**
+     * Delivery status of the message.
+     */
+    delivery_status?: 'delivered' | 'moved' | 'quarantined' | 'rejected' | 'deferred' | 'bounced' | 'queued';
+
+    detections_only?: boolean;
+
+    domain?: string | null;
+
+    /**
+     * End of search date range
+     */
+    end?: string;
+
+    exact_subject?: string | null;
+
+    final_disposition?:
+      | 'MALICIOUS'
+      | 'MALICIOUS-BEC'
+      | 'SUSPICIOUS'
+      | 'SPOOF'
+      | 'SPAM'
+      | 'BULK'
+      | 'ENCRYPTED'
+      | 'EXTERNAL'
+      | 'UNKNOWN'
+      | 'NONE';
+
+    message_action?: 'PREVIEW' | 'QUARANTINE_RELEASED' | 'MOVED' | null;
+
+    message_id?: string | null;
+
+    metric?: string | null;
+
+    query?: string | null;
+
+    recipient?: string | null;
+
+    sender?: string | null;
+
+    /**
+     * Beginning of search date range
+     */
+    start?: string;
+
+    subject?: string | null;
+
+    submissions?: boolean;
+  }
+}
+
+export interface CancelCreateParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export declare namespace Cancel {
+  export { type CancelCreateResponse as CancelCreateResponse, type CancelCreateParams as CancelCreateParams };
+}

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

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  BulkListResponsesV4PagePaginationArray,
+  Bulk,
+  type BulkCreateResponse,
+  type BulkListResponse,
+  type BulkDeleteResponse,
+  type BulkGetResponse,
+  type BulkCreateParams,
+  type BulkListParams,
+  type BulkDeleteParams,
+  type BulkGetParams,
+} from './bulk';
+export { Cancel, type CancelCreateResponse, type CancelCreateParams } from './cancel';
+export {
+  MessageListResponsesV4PagePaginationArray,
+  Messages,
+  type MessageListResponse,
+  type MessageListParams,
+} from './messages';

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

@@ -0,0 +1,120 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as Core from '../../../../core';
+import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../../pagination';
+
+export class Messages extends APIResource {
+  /**
+   * List messages for a bulk action job
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const messageListResponse of client.emailSecurity.investigate.bulk.messages.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    jobId: string,
+    params: MessageListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<MessageListResponsesV4PagePaginationArray, MessageListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/email-security/investigate/bulk/${jobId}/messages`,
+      MessageListResponsesV4PagePaginationArray,
+      { query, ...options },
+    );
+  }
+}
+
+export class MessageListResponsesV4PagePaginationArray extends V4PagePaginationArray<MessageListResponse> {}
+
+export interface MessageListResponse {
+  action_params: MessageListResponse.Move | MessageListResponse.Release;
+
+  action_type: 'MOVE' | 'RELEASE';
+
+  created_at: string;
+
+  message_id: string;
+
+  postfix_id: string;
+
+  retry_count: number;
+
+  status: 'PENDING' | 'DISCOVERING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'SKIPPED';
+
+  alert_id?: string | null;
+
+  email_message_id?: string | null;
+
+  processed_at?: string | null;
+
+  /**
+   * When to retry the action if it failed
+   */
+  retry_after?: string | null;
+
+  status_message?: string | null;
+}
+
+export namespace MessageListResponse {
+  export interface Move {
+    client_recipient: string;
+
+    destination:
+      | 'Inbox'
+      | 'JunkEmail'
+      | 'DeletedItems'
+      | 'RecoverableItemsDeletions'
+      | 'RecoverableItemsPurges';
+
+    type: 'MOVE';
+
+    expected_disposition?:
+      | 'MALICIOUS'
+      | 'MALICIOUS-BEC'
+      | 'SUSPICIOUS'
+      | 'SPOOF'
+      | 'SPAM'
+      | 'BULK'
+      | 'ENCRYPTED'
+      | 'EXTERNAL'
+      | 'UNKNOWN'
+      | 'NONE';
+  }
+
+  export interface Release {
+    client_recipient: string;
+
+    type: 'RELEASE';
+  }
+}
+
+export interface MessageListParams extends V4PagePaginationArrayParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Query param
+   */
+  status?: 'PENDING' | 'DISCOVERING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'SKIPPED';
+}
+
+Messages.MessageListResponsesV4PagePaginationArray = MessageListResponsesV4PagePaginationArray;
+
+export declare namespace Messages {
+  export {
+    type MessageListResponse as MessageListResponse,
+    MessageListResponsesV4PagePaginationArray as MessageListResponsesV4PagePaginationArray,
+    type MessageListParams as MessageListParams,
+  };
+}

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

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './bulk/index';

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

@@ -1,5 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  BulkListResponsesV4PagePaginationArray,
+  Bulk,
+  type BulkCreateResponse,
+  type BulkListResponse,
+  type BulkDeleteResponse,
+  type BulkGetResponse,
+  type BulkCreateParams,
+  type BulkListParams,
+  type BulkDeleteParams,
+  type BulkGetParams,
+} from './bulk/index';
 export { Detections, type DetectionGetResponse, type DetectionGetParams } from './detections';
 export {
   InvestigateListResponsesV4PagePaginationArray,

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

@@ -30,6 +30,19 @@ import * as ReleaseAPI from './release';
 import { Release, ReleaseBulkParams, ReleaseBulkResponse, ReleaseBulkResponsesSinglePage } from './release';
 import * as TraceAPI from './trace';
 import { Trace, TraceGetParams, TraceGetResponse } from './trace';
+import * as BulkAPI from './bulk/bulk';
+import {
+  Bulk,
+  BulkCreateParams,
+  BulkCreateResponse,
+  BulkDeleteParams,
+  BulkDeleteResponse,
+  BulkGetParams,
+  BulkGetResponse,
+  BulkListParams,
+  BulkListResponse,
+  BulkListResponsesV4PagePaginationArray,
+} from './bulk/bulk';
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
 
 export class Investigate extends APIResource {
@@ -40,6 +53,7 @@ export class Investigate extends APIResource {
   move: MoveAPI.Move = new MoveAPI.Move(this._client);
   reclassify: ReclassifyAPI.Reclassify = new ReclassifyAPI.Reclassify(this._client);
   release: ReleaseAPI.Release = new ReleaseAPI.Release(this._client);
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
 
   /**
    * Returns information for each email that matches the search parameter(s).
@@ -623,11 +637,6 @@ export interface InvestigateListParams extends V4PagePaginationArrayParams {
    */
   account_id: string;
 
-  /**
-   * Query param: Whether to include the message action log in the response.
-   */
-  action_log?: boolean;
-
   /**
    * Query param
    */
@@ -729,6 +738,8 @@ Investigate.MoveBulkResponsesSinglePage = MoveBulkResponsesSinglePage;
 Investigate.Reclassify = Reclassify;
 Investigate.Release = Release;
 Investigate.ReleaseBulkResponsesSinglePage = ReleaseBulkResponsesSinglePage;
+Investigate.Bulk = Bulk;
+Investigate.BulkListResponsesV4PagePaginationArray = BulkListResponsesV4PagePaginationArray;
 
 export declare namespace Investigate {
   export {
@@ -779,4 +790,17 @@ export declare namespace Investigate {
     ReleaseBulkResponsesSinglePage as ReleaseBulkResponsesSinglePage,
     type ReleaseBulkParams as ReleaseBulkParams,
   };
+
+  export {
+    Bulk as Bulk,
+    type BulkCreateResponse as BulkCreateResponse,
+    type BulkListResponse as BulkListResponse,
+    type BulkDeleteResponse as BulkDeleteResponse,
+    type BulkGetResponse as BulkGetResponse,
+    BulkListResponsesV4PagePaginationArray as BulkListResponsesV4PagePaginationArray,
+    type BulkCreateParams as BulkCreateParams,
+    type BulkListParams as BulkListParams,
+    type BulkDeleteParams as BulkDeleteParams,
+    type BulkGetParams as BulkGetParams,
+  };
 }

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

@@ -183,6 +183,21 @@ export interface MoveCreateParams {
     | 'DeletedItems'
     | 'RecoverableItemsDeletions'
     | 'RecoverableItemsPurges';
+
+  /**
+   * Body param
+   */
+  expected_disposition?:
+    | 'MALICIOUS'
+    | 'MALICIOUS-BEC'
+    | 'SUSPICIOUS'
+    | 'SPOOF'
+    | 'SPAM'
+    | 'BULK'
+    | 'ENCRYPTED'
+    | 'EXTERNAL'
+    | 'UNKNOWN'
+    | 'NONE';
 }
 
 export interface MoveBulkParams {
@@ -201,6 +216,21 @@ export interface MoveBulkParams {
     | 'RecoverableItemsDeletions'
     | 'RecoverableItemsPurges';
 
+  /**
+   * Body param
+   */
+  expected_disposition?:
+    | 'MALICIOUS'
+    | 'MALICIOUS-BEC'
+    | 'SUSPICIOUS'
+    | 'SPOOF'
+    | 'SPAM'
+    | 'BULK'
+    | 'ENCRYPTED'
+    | 'EXTERNAL'
+    | 'UNKNOWN'
+    | 'NONE';
+
   /**
    * Body param: List of message IDs to move
    */

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

@@ -54,6 +54,20 @@ export {
   type ImpersonationRegistryEditParams,
   type ImpersonationRegistryGetParams,
 } from './impersonation-registry';
+export {
+  SendingDomainRestrictionListResponsesV4PagePaginationArray,
+  SendingDomainRestrictions,
+  type SendingDomainRestrictionCreateResponse,
+  type SendingDomainRestrictionListResponse,
+  type SendingDomainRestrictionDeleteResponse,
+  type SendingDomainRestrictionEditResponse,
+  type SendingDomainRestrictionGetResponse,
+  type SendingDomainRestrictionCreateParams,
+  type SendingDomainRestrictionListParams,
+  type SendingDomainRestrictionDeleteParams,
+  type SendingDomainRestrictionEditParams,
+  type SendingDomainRestrictionGetParams,
+} from './sending-domain-restrictions';
 export { Settings } from './settings';
 export {
   TrustedDomainListResponsesV4PagePaginationArray,
@@ -69,3 +83,17 @@ export {
   type TrustedDomainEditParams,
   type TrustedDomainGetParams,
 } from './trusted-domains';
+export {
+  URLIgnorePatternListResponsesV4PagePaginationArray,
+  URLIgnorePatterns,
+  type URLIgnorePatternCreateResponse,
+  type URLIgnorePatternListResponse,
+  type URLIgnorePatternDeleteResponse,
+  type URLIgnorePatternEditResponse,
+  type URLIgnorePatternGetResponse,
+  type URLIgnorePatternCreateParams,
+  type URLIgnorePatternListParams,
+  type URLIgnorePatternDeleteParams,
+  type URLIgnorePatternEditParams,
+  type URLIgnorePatternGetParams,
+} from './url-ignore-patterns';