cloudflare 6.3.0 → 6.5.0

package/src/resources/email-auth/email-auth.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as DMARCReportsAPI from './dmarc-reports';
+import {
+  DMARCReportEditParams,
+  DMARCReportEditResponse,
+  DMARCReportGetParams,
+  DMARCReportGetResponse,
+  DMARCReports,
+} from './dmarc-reports';
+import * as SPFAPI from './spf/spf';
+import { SPF } from './spf/spf';
+
+export class EmailAuth extends APIResource {
+  dmarcReports: DMARCReportsAPI.DMARCReports = new DMARCReportsAPI.DMARCReports(this._client);
+  spf: SPFAPI.SPF = new SPFAPI.SPF(this._client);
+}
+
+EmailAuth.DMARCReports = DMARCReports;
+EmailAuth.SPF = SPF;
+
+export declare namespace EmailAuth {
+  export {
+    DMARCReports as DMARCReports,
+    type DMARCReportEditResponse as DMARCReportEditResponse,
+    type DMARCReportGetResponse as DMARCReportGetResponse,
+    type DMARCReportEditParams as DMARCReportEditParams,
+    type DMARCReportGetParams as DMARCReportGetParams,
+  };
+
+  export { SPF as SPF };
+}

package/src/resources/email-auth/index.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  DMARCReports,
+  type DMARCReportEditResponse,
+  type DMARCReportGetResponse,
+  type DMARCReportEditParams,
+  type DMARCReportGetParams,
+} from './dmarc-reports';
+export { EmailAuth } from './email-auth';
+export { SPF } from './spf/index';

package/src/resources/email-auth/spf/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Inspect, type InspectGetResponse, type InspectGetParams } from './inspect';
+export { SPF } from './spf';

package/src/resources/email-auth/spf/inspect.ts

@@ -0,0 +1,129 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+
+export class Inspect extends APIResource {
+  /**
+   * Inspects a specific SPF TXT record and returns a parsed tree structure in the
+   * spflimit-worker format.
+   *
+   * The record ID must be provided via the `id` query parameter.
+   *
+   * Returns a recursive tree showing:
+   *
+   * - Parsed components with their qualifiers and types
+   * - Nested includes recursively resolved within components
+   * - Per-component and total lookup counts
+   * - Detailed error information with context
+   *
+   * @example
+   * ```ts
+   * const inspect = await client.emailAuth.spf.inspect.get({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   id: 'id',
+   * });
+   * ```
+   */
+  get(params: InspectGetParams, options?: Core.RequestOptions): Core.APIPromise<InspectGetResponse> {
+    const { zone_id, ...query } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/email/auth/spf/inspect`, { query, ...options }) as Core.APIPromise<{
+        result: InspectGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+/**
+ * Recursive SPF inspection tree
+ */
+export interface InspectGetResponse {
+  /**
+   * Parsed SPF components (mechanisms)
+   */
+  components: Array<unknown>;
+
+  /**
+   * Domain being inspected
+   */
+  domain: string;
+
+  /**
+   * Raw SPF record content
+   */
+  record: string;
+
+  /**
+   * Total number of DNS lookups performed across all includes
+   */
+  total_lookups: number;
+
+  /**
+   * All errors encountered during inspection, collected from the entire tree. This
+   * includes errors from nested includes at any depth, providing a quick overview of
+   * all issues without needing to traverse the nested structure. Each error includes
+   * a `domain` field to identify where it occurred. Empty array if no errors
+   * (omitted from JSON when empty).
+   */
+  errors?: Array<InspectGetResponse.Error>;
+}
+
+export namespace InspectGetResponse {
+  /**
+   * An error encountered during SPF inspection
+   */
+  export interface Error {
+    /**
+     * Error code. Known values:
+     *
+     * - `lookup_failed` — DNS TXT lookup failed
+     * - `spf_not_found` — no SPF record found
+     * - `invalid_spf` — record does not start with `v=spf1`
+     * - `invalid_domain` — PSL validation failed
+     * - `loop_detected` — include/redirect cycle detected
+     * - `invalid_mechanism` — unrecognised or malformed mechanism
+     * - `resource_limit_exceeded` — internal resource protection limits exceeded
+     *   (recursion depth or query budget)
+     * - `max_lookups` — RFC 7208 10-lookup limit exceeded
+     */
+    code: string;
+
+    /**
+     * Domain where the error occurred
+     */
+    domain: string;
+
+    /**
+     * Human-readable error message
+     */
+    message: string;
+
+    /**
+     * Additional error-specific details (optional).
+     *
+     * - For `invalid_domain` errors: the invalid domain string
+     * - For `invalid_mechanism` errors: the invalid mechanism text (e.g.,
+     *   "invalidmech123")
+     * - For `loop_detected` errors: the domain that caused the loop
+     * - For other error types: not present
+     */
+    details?: string;
+  }
+}
+
+export interface InspectGetParams {
+  /**
+   * Path param: Identifier.
+   */
+  zone_id: string;
+
+  /**
+   * Query param: DNS record ID (rec_tag) to inspect
+   */
+  id: string;
+}
+
+export declare namespace Inspect {
+  export { type InspectGetResponse as InspectGetResponse, type InspectGetParams as InspectGetParams };
+}

package/src/resources/email-auth/spf/spf.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as InspectAPI from './inspect';
+import { Inspect, InspectGetParams, InspectGetResponse } from './inspect';
+
+export class SPF extends APIResource {
+  inspect: InspectAPI.Inspect = new InspectAPI.Inspect(this._client);
+}
+
+SPF.Inspect = Inspect;
+
+export declare namespace SPF {
+  export {
+    Inspect as Inspect,
+    type InspectGetResponse as InspectGetResponse,
+    type InspectGetParams as InspectGetParams,
+  };
+}

package/src/resources/email-auth/spf.ts

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

package/src/resources/email-auth.ts

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

package/src/resources/email-routing/api.md

@@ -36,7 +36,6 @@ Methods:
 
 - <code title="post /zones/{zone_id}/email/routing/rules">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">create</a>({ ...params }) -> EmailRoutingRule</code>
 - <code title="put /zones/{zone_id}/email/routing/rules/{rule_identifier}">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">update</a>(ruleIdentifier, { ...params }) -> EmailRoutingRule</code>
-- <code title="get /zones/{zone_id}/email/routing/rules">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">list</a>({ ...params }) -> EmailRoutingRulesV4PagePaginationArray</code>
 - <code title="delete /zones/{zone_id}/email/routing/rules/{rule_identifier}">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">delete</a>(ruleIdentifier, { ...params }) -> EmailRoutingRule</code>
 - <code title="get /zones/{zone_id}/email/routing/rules/{rule_identifier}">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">get</a>(ruleIdentifier, { ...params }) -> EmailRoutingRule</code>
 

package/src/resources/email-routing/email-routing.ts

@@ -27,12 +27,10 @@ import * as RulesAPI from './rules/rules';
 import {
   Action,
   EmailRoutingRule,
-  EmailRoutingRulesV4PagePaginationArray,
   Matcher,
   RuleCreateParams,
   RuleDeleteParams,
   RuleGetParams,
-  RuleListParams,
   RuleUpdateParams,
   Rules,
 } from './rules/rules';
@@ -127,6 +125,12 @@ export interface Settings {
    */
   status?: 'ready' | 'unconfigured' | 'misconfigured' | 'misconfigured/locked' | 'unlocked';
 
+  /**
+   * Whether subaddressing (plus-addressing) is honored when matching incoming mail
+   * against routing rules.
+   */
+  support_subaddress?: true | false;
+
   /**
    * @deprecated Email Routing settings tag. (Deprecated, replaced by Email Routing
    * settings identifier)
@@ -168,7 +172,6 @@ export interface EmailRoutingGetParams {
 EmailRouting.DNS = DNS;
 EmailRouting.DNSRecordsSinglePage = DNSRecordsSinglePage;
 EmailRouting.Rules = Rules;
-EmailRouting.EmailRoutingRulesV4PagePaginationArray = EmailRoutingRulesV4PagePaginationArray;
 EmailRouting.Addresses = Addresses;
 EmailRouting.AddressesV4PagePaginationArray = AddressesV4PagePaginationArray;
 
@@ -196,10 +199,8 @@ export declare namespace EmailRouting {
     type Action as Action,
     type EmailRoutingRule as EmailRoutingRule,
     type Matcher as Matcher,
-    EmailRoutingRulesV4PagePaginationArray as EmailRoutingRulesV4PagePaginationArray,
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,
-    type RuleListParams as RuleListParams,
     type RuleDeleteParams as RuleDeleteParams,
     type RuleGetParams as RuleGetParams,
   };

package/src/resources/email-routing/index.ts

@@ -21,14 +21,12 @@ export {
 } from './dns';
 export { EmailRouting } from './email-routing';
 export {
-  EmailRoutingRulesV4PagePaginationArray,
   Rules,
   type Action,
   type EmailRoutingRule,
   type Matcher,
   type RuleCreateParams,
   type RuleUpdateParams,
-  type RuleListParams,
   type RuleDeleteParams,
   type RuleGetParams,
 } from './rules/index';

package/src/resources/email-routing/rules/index.ts

@@ -10,14 +10,12 @@ export {
   type CatchAllGetParams,
 } from './catch-alls';
 export {
-  EmailRoutingRulesV4PagePaginationArray,
   Rules,
   type Action,
   type EmailRoutingRule,
   type Matcher,
   type RuleCreateParams,
   type RuleUpdateParams,
-  type RuleListParams,
   type RuleDeleteParams,
   type RuleGetParams,
 } from './rules';

package/src/resources/email-routing/rules/rules.ts

@@ -12,7 +12,6 @@ import {
   CatchAllUpdateResponse,
   CatchAlls,
 } from './catch-alls';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
 
 export class Rules extends APIResource {
   catchAlls: CatchAllsAPI.CatchAlls = new CatchAllsAPI.CatchAlls(this._client);
@@ -73,31 +72,6 @@ export class Rules extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
-  /**
-   * Lists existing routing rules.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const emailRoutingRule of client.emailRouting.rules.list(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    params: RuleListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<EmailRoutingRulesV4PagePaginationArray, EmailRoutingRule> {
-    const { zone_id, ...query } = params;
-    return this._client.getAPIList(
-      `/zones/${zone_id}/email/routing/rules`,
-      EmailRoutingRulesV4PagePaginationArray,
-      { query, ...options },
-    );
-  }
-
   /**
    * Delete a specific routing rule.
    *
@@ -151,8 +125,6 @@ export class Rules extends APIResource {
   }
 }
 
-export class EmailRoutingRulesV4PagePaginationArray extends V4PagePaginationArray<EmailRoutingRule> {}
-
 /**
  * Actions pattern.
  */
@@ -318,18 +290,6 @@ export interface RuleUpdateParams {
   priority?: number;
 }
 
-export interface RuleListParams extends V4PagePaginationArrayParams {
-  /**
-   * Path param: Identifier.
-   */
-  zone_id: string;
-
-  /**
-   * Query param: Filter by enabled routing rules.
-   */
-  enabled?: true | false;
-}
-
 export interface RuleDeleteParams {
   /**
    * Identifier.
@@ -344,7 +304,6 @@ export interface RuleGetParams {
   zone_id: string;
 }
 
-Rules.EmailRoutingRulesV4PagePaginationArray = EmailRoutingRulesV4PagePaginationArray;
 Rules.CatchAlls = CatchAlls;
 
 export declare namespace Rules {
@@ -352,10 +311,8 @@ export declare namespace Rules {
     type Action as Action,
     type EmailRoutingRule as EmailRoutingRule,
     type Matcher as Matcher,
-    EmailRoutingRulesV4PagePaginationArray as EmailRoutingRulesV4PagePaginationArray,
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,
-    type RuleListParams as RuleListParams,
     type RuleDeleteParams as RuleDeleteParams,
     type RuleGetParams as RuleGetParams,
   };

package/src/resources/email-security/api.md

@@ -86,6 +86,42 @@ Methods:
 
 - <code title="post /accounts/{account_id}/email-security/investigate/release">client.emailSecurity.investigate.release.<a href="./src/resources/email-security/investigate/release.ts">bulk</a>([ ...body ]) -> ReleaseBulkResponsesSinglePage</code>
 
+### Bulk
+
+Types:
+
+- <code><a href="./src/resources/email-security/investigate/bulk/bulk.ts">BulkCreateResponse</a></code>
+- <code><a href="./src/resources/email-security/investigate/bulk/bulk.ts">BulkListResponse</a></code>
+- <code><a href="./src/resources/email-security/investigate/bulk/bulk.ts">BulkDeleteResponse</a></code>
+- <code><a href="./src/resources/email-security/investigate/bulk/bulk.ts">BulkGetResponse</a></code>
+
+Methods:
+
+- <code title="post /accounts/{account_id}/email-security/investigate/bulk">client.emailSecurity.investigate.bulk.<a href="./src/resources/email-security/investigate/bulk/bulk.ts">create</a>({ ...params }) -> BulkCreateResponse</code>
+- <code title="get /accounts/{account_id}/email-security/investigate/bulk">client.emailSecurity.investigate.bulk.<a href="./src/resources/email-security/investigate/bulk/bulk.ts">list</a>({ ...params }) -> BulkListResponsesV4PagePaginationArray</code>
+- <code title="delete /accounts/{account_id}/email-security/investigate/bulk/{job_id}">client.emailSecurity.investigate.bulk.<a href="./src/resources/email-security/investigate/bulk/bulk.ts">delete</a>(jobId, { ...params }) -> BulkDeleteResponse</code>
+- <code title="get /accounts/{account_id}/email-security/investigate/bulk/{job_id}">client.emailSecurity.investigate.bulk.<a href="./src/resources/email-security/investigate/bulk/bulk.ts">get</a>(jobId, { ...params }) -> BulkGetResponse</code>
+
+#### Cancel
+
+Types:
+
+- <code><a href="./src/resources/email-security/investigate/bulk/cancel.ts">CancelCreateResponse</a></code>
+
+Methods:
+
+- <code title="post /accounts/{account_id}/email-security/investigate/bulk/{job_id}/cancel">client.emailSecurity.investigate.bulk.cancel.<a href="./src/resources/email-security/investigate/bulk/cancel.ts">create</a>(jobId, { ...params }) -> CancelCreateResponse</code>
+
+#### Messages
+
+Types:
+
+- <code><a href="./src/resources/email-security/investigate/bulk/messages.ts">MessageListResponse</a></code>
+
+Methods:
+
+- <code title="get /accounts/{account_id}/email-security/investigate/bulk/{job_id}/messages">client.emailSecurity.investigate.bulk.messages.<a href="./src/resources/email-security/investigate/bulk/messages.ts">list</a>(jobId, { ...params }) -> MessageListResponsesV4PagePaginationArray</code>
+
 ## Phishguard
 
 ### Reports
@@ -170,6 +206,24 @@ Methods:
 - <code title="patch /accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}">client.emailSecurity.settings.impersonationRegistry.<a href="./src/resources/email-security/settings/impersonation-registry.ts">edit</a>(impersonationRegistryId, { ...params }) -> ImpersonationRegistryEditResponse</code>
 - <code title="get /accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}">client.emailSecurity.settings.impersonationRegistry.<a href="./src/resources/email-security/settings/impersonation-registry.ts">get</a>(impersonationRegistryId, { ...params }) -> ImpersonationRegistryGetResponse</code>
 
+### SendingDomainRestrictions
+
+Types:
+
+- <code><a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">SendingDomainRestrictionCreateResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">SendingDomainRestrictionListResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">SendingDomainRestrictionDeleteResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">SendingDomainRestrictionEditResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">SendingDomainRestrictionGetResponse</a></code>
+
+Methods:
+
+- <code title="post /accounts/{account_id}/email-security/settings/sending_domain_restrictions">client.emailSecurity.settings.sendingDomainRestrictions.<a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">create</a>({ ...params }) -> SendingDomainRestrictionCreateResponse</code>
+- <code title="get /accounts/{account_id}/email-security/settings/sending_domain_restrictions">client.emailSecurity.settings.sendingDomainRestrictions.<a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">list</a>({ ...params }) -> SendingDomainRestrictionListResponsesV4PagePaginationArray</code>
+- <code title="delete /accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}">client.emailSecurity.settings.sendingDomainRestrictions.<a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">delete</a>(sendingDomainRestrictionId, { ...params }) -> SendingDomainRestrictionDeleteResponse</code>
+- <code title="patch /accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}">client.emailSecurity.settings.sendingDomainRestrictions.<a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">edit</a>(sendingDomainRestrictionId, { ...params }) -> SendingDomainRestrictionEditResponse</code>
+- <code title="get /accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}">client.emailSecurity.settings.sendingDomainRestrictions.<a href="./src/resources/email-security/settings/sending-domain-restrictions.ts">get</a>(sendingDomainRestrictionId, { ...params }) -> SendingDomainRestrictionGetResponse</code>
+
 ### TrustedDomains
 
 Types:
@@ -188,6 +242,24 @@ Methods:
 - <code title="patch /accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}">client.emailSecurity.settings.trustedDomains.<a href="./src/resources/email-security/settings/trusted-domains.ts">edit</a>(trustedDomainId, { ...params }) -> TrustedDomainEditResponse</code>
 - <code title="get /accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}">client.emailSecurity.settings.trustedDomains.<a href="./src/resources/email-security/settings/trusted-domains.ts">get</a>(trustedDomainId, { ...params }) -> TrustedDomainGetResponse</code>
 
+### URLIgnorePatterns
+
+Types:
+
+- <code><a href="./src/resources/email-security/settings/url-ignore-patterns.ts">URLIgnorePatternCreateResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/url-ignore-patterns.ts">URLIgnorePatternListResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/url-ignore-patterns.ts">URLIgnorePatternDeleteResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/url-ignore-patterns.ts">URLIgnorePatternEditResponse</a></code>
+- <code><a href="./src/resources/email-security/settings/url-ignore-patterns.ts">URLIgnorePatternGetResponse</a></code>
+
+Methods:
+
+- <code title="post /accounts/{account_id}/email-security/settings/url_ignore_patterns">client.emailSecurity.settings.urlIgnorePatterns.<a href="./src/resources/email-security/settings/url-ignore-patterns.ts">create</a>({ ...params }) -> URLIgnorePatternCreateResponse</code>
+- <code title="get /accounts/{account_id}/email-security/settings/url_ignore_patterns">client.emailSecurity.settings.urlIgnorePatterns.<a href="./src/resources/email-security/settings/url-ignore-patterns.ts">list</a>({ ...params }) -> URLIgnorePatternListResponsesV4PagePaginationArray</code>
+- <code title="delete /accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}">client.emailSecurity.settings.urlIgnorePatterns.<a href="./src/resources/email-security/settings/url-ignore-patterns.ts">delete</a>(patternId, { ...params }) -> URLIgnorePatternDeleteResponse</code>
+- <code title="patch /accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}">client.emailSecurity.settings.urlIgnorePatterns.<a href="./src/resources/email-security/settings/url-ignore-patterns.ts">edit</a>(patternId, { ...params }) -> URLIgnorePatternEditResponse</code>
+- <code title="get /accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}">client.emailSecurity.settings.urlIgnorePatterns.<a href="./src/resources/email-security/settings/url-ignore-patterns.ts">get</a>(patternId, { ...params }) -> URLIgnorePatternGetResponse</code>
+
 ## Submissions
 
 Types: