cloudflare 4.0.0 → 4.1.0

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

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
+import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
 
 export class Domains extends APIResource {
   /**
@@ -43,14 +43,13 @@ export class Domains extends APIResource {
   bulkDelete(
     params: DomainBulkDeleteParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<DomainBulkDeleteResponse> {
+  ): Core.PagePromise<DomainBulkDeleteResponsesSinglePage, DomainBulkDeleteResponse> {
     const { account_id } = params;
-    return (
-      this._client.delete(
-        `/accounts/${account_id}/email-security/settings/domains`,
-        options,
-      ) as Core.APIPromise<{ result: DomainBulkDeleteResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/email-security/settings/domains`,
+      DomainBulkDeleteResponsesSinglePage,
+      { method: 'delete', ...options },
+    );
   }
 
   /**
@@ -90,6 +89,8 @@ export class Domains extends APIResource {
 
 export class DomainListResponsesV4PagePaginationArray extends V4PagePaginationArray<DomainListResponse> {}
 
+export class DomainBulkDeleteResponsesSinglePage extends SinglePage<DomainBulkDeleteResponse> {}
+
 export interface DomainListResponse {
   /**
    * The unique identifier for the domain.
@@ -123,6 +124,10 @@ export interface DomainListResponse {
 
   transport: string;
 
+  authorization?: DomainListResponse.Authorization | null;
+
+  emails_processed?: DomainListResponse.EmailsProcessed | null;
+
   folder?: 'AllItems' | 'Inbox' | null;
 
   inbox_provider?: 'Microsoft' | 'Google' | null;
@@ -136,6 +141,24 @@ export interface DomainListResponse {
   require_tls_outbound?: boolean | null;
 }
 
+export namespace DomainListResponse {
+  export interface Authorization {
+    authorized: boolean;
+
+    timestamp: string;
+
+    status_message?: string | null;
+  }
+
+  export interface EmailsProcessed {
+    timestamp: string;
+
+    total_emails_processed: number;
+
+    total_emails_processed_previous: number;
+  }
+}
+
 export interface DomainDeleteResponse {
   /**
    * The unique identifier for the domain.
@@ -143,15 +166,11 @@ export interface DomainDeleteResponse {
   id: number;
 }
 
-export type DomainBulkDeleteResponse = Array<DomainBulkDeleteResponse.DomainBulkDeleteResponseItem>;
-
-export namespace DomainBulkDeleteResponse {
-  export interface DomainBulkDeleteResponseItem {
-    /**
-     * The unique identifier for the domain.
-     */
-    id: number;
-  }
+export interface DomainBulkDeleteResponse {
+  /**
+   * The unique identifier for the domain.
+   */
+  id: number;
 }
 
 export interface DomainEditResponse {
@@ -187,6 +206,10 @@ export interface DomainEditResponse {
 
   transport: string;
 
+  authorization?: DomainEditResponse.Authorization | null;
+
+  emails_processed?: DomainEditResponse.EmailsProcessed | null;
+
   folder?: 'AllItems' | 'Inbox' | null;
 
   inbox_provider?: 'Microsoft' | 'Google' | null;
@@ -200,6 +223,24 @@ export interface DomainEditResponse {
   require_tls_outbound?: boolean | null;
 }
 
+export namespace DomainEditResponse {
+  export interface Authorization {
+    authorized: boolean;
+
+    timestamp: string;
+
+    status_message?: string | null;
+  }
+
+  export interface EmailsProcessed {
+    timestamp: string;
+
+    total_emails_processed: number;
+
+    total_emails_processed_previous: number;
+  }
+}
+
 export interface DomainGetResponse {
   /**
    * The unique identifier for the domain.
@@ -233,6 +274,10 @@ export interface DomainGetResponse {
 
   transport: string;
 
+  authorization?: DomainGetResponse.Authorization | null;
+
+  emails_processed?: DomainGetResponse.EmailsProcessed | null;
+
   folder?: 'AllItems' | 'Inbox' | null;
 
   inbox_provider?: 'Microsoft' | 'Google' | null;
@@ -246,12 +291,36 @@ export interface DomainGetResponse {
   require_tls_outbound?: boolean | null;
 }
 
+export namespace DomainGetResponse {
+  export interface Authorization {
+    authorized: boolean;
+
+    timestamp: string;
+
+    status_message?: string | null;
+  }
+
+  export interface EmailsProcessed {
+    timestamp: string;
+
+    total_emails_processed: number;
+
+    total_emails_processed_previous: number;
+  }
+}
+
 export interface DomainListParams extends V4PagePaginationArrayParams {
   /**
    * Path param: Account Identifier
    */
   account_id: string;
 
+  /**
+   * Query param: Filters response to domains with the currently active delivery
+   * mode.
+   */
+  active_delivery_mode?: 'DIRECT' | 'BCC' | 'JOURNAL' | 'API' | 'RETRO_SCAN';
+
   /**
    * Query param: Filters response to domains with the provided delivery mode.
    */
@@ -366,6 +435,7 @@ export interface DomainGetParams {
 }
 
 Domains.DomainListResponsesV4PagePaginationArray = DomainListResponsesV4PagePaginationArray;
+Domains.DomainBulkDeleteResponsesSinglePage = DomainBulkDeleteResponsesSinglePage;
 
 export declare namespace Domains {
   export {
@@ -375,6 +445,7 @@ export declare namespace Domains {
     type DomainEditResponse as DomainEditResponse,
     type DomainGetResponse as DomainGetResponse,
     DomainListResponsesV4PagePaginationArray as DomainListResponsesV4PagePaginationArray,
+    DomainBulkDeleteResponsesSinglePage as DomainBulkDeleteResponsesSinglePage,
     type DomainListParams as DomainListParams,
     type DomainDeleteParams as DomainDeleteParams,
     type DomainBulkDeleteParams as DomainBulkDeleteParams,

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

@@ -30,6 +30,7 @@ export {
 } from './block-senders';
 export {
   DomainListResponsesV4PagePaginationArray,
+  DomainBulkDeleteResponsesSinglePage,
   Domains,
   type DomainListResponse,
   type DomainDeleteResponse,

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

@@ -35,6 +35,7 @@ import * as DomainsAPI from './domains';
 import {
   DomainBulkDeleteParams,
   DomainBulkDeleteResponse,
+  DomainBulkDeleteResponsesSinglePage,
   DomainDeleteParams,
   DomainDeleteResponse,
   DomainEditParams,
@@ -92,6 +93,7 @@ Settings.BlockSenders = BlockSenders;
 Settings.BlockSenderListResponsesV4PagePaginationArray = BlockSenderListResponsesV4PagePaginationArray;
 Settings.Domains = Domains;
 Settings.DomainListResponsesV4PagePaginationArray = DomainListResponsesV4PagePaginationArray;
+Settings.DomainBulkDeleteResponsesSinglePage = DomainBulkDeleteResponsesSinglePage;
 Settings.ImpersonationRegistry = ImpersonationRegistry;
 Settings.ImpersonationRegistryListResponsesV4PagePaginationArray =
   ImpersonationRegistryListResponsesV4PagePaginationArray;
@@ -137,6 +139,7 @@ export declare namespace Settings {
     type DomainEditResponse as DomainEditResponse,
     type DomainGetResponse as DomainGetResponse,
     DomainListResponsesV4PagePaginationArray as DomainListResponsesV4PagePaginationArray,
+    DomainBulkDeleteResponsesSinglePage as DomainBulkDeleteResponsesSinglePage,
     type DomainListParams as DomainListParams,
     type DomainDeleteParams as DomainDeleteParams,
     type DomainBulkDeleteParams as DomainBulkDeleteParams,

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

@@ -297,7 +297,7 @@ export declare namespace TrustedDomainCreateParams {
     /**
      * Body param:
      */
-    body: Array<TrustedDomainCreateParams.Variant1.Body>;
+    body: Array<Variant1.Body>;
   }
 
   export namespace Variant1 {

package/src/resources/filters.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../pagination';
+import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from '../pagination';
 
 export class Filters extends APIResource {
   /**
@@ -13,13 +13,13 @@ export class Filters extends APIResource {
   create(
     params: FilterCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<FilterCreateResponse | null> {
+  ): Core.PagePromise<FirewallFiltersSinglePage, FirewallFilter> {
     const { zone_id, ...body } = params;
-    return (
-      this._client.post(`/zones/${zone_id}/filters`, { body, ...options }) as Core.APIPromise<{
-        result: FilterCreateResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/filters`, FirewallFiltersSinglePage, {
+      body,
+      method: 'post',
+      ...options,
+    });
   }
 
   /**
@@ -84,13 +84,12 @@ export class Filters extends APIResource {
   bulkDelete(
     params: FilterBulkDeleteParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<FilterBulkDeleteResponse | null> {
+  ): Core.PagePromise<FirewallFiltersSinglePage, FirewallFilter> {
     const { zone_id } = params;
-    return (
-      this._client.delete(`/zones/${zone_id}/filters`, options) as Core.APIPromise<{
-        result: FilterBulkDeleteResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/filters`, FirewallFiltersSinglePage, {
+      method: 'delete',
+      ...options,
+    });
   }
 
   /**
@@ -101,13 +100,13 @@ export class Filters extends APIResource {
   bulkUpdate(
     params: FilterBulkUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<FilterBulkUpdateResponse | null> {
+  ): Core.PagePromise<FirewallFiltersSinglePage, FirewallFilter> {
     const { zone_id, ...body } = params;
-    return (
-      this._client.put(`/zones/${zone_id}/filters`, { body, ...options }) as Core.APIPromise<{
-        result: FilterBulkUpdateResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/filters`, FirewallFiltersSinglePage, {
+      body,
+      method: 'put',
+      ...options,
+    });
   }
 
   /**
@@ -129,6 +128,8 @@ export class Filters extends APIResource {
   }
 }
 
+export class FirewallFiltersSinglePage extends SinglePage<FirewallFilter> {}
+
 export class FirewallFiltersV4PagePaginationArray extends V4PagePaginationArray<FirewallFilter> {}
 
 export interface FirewallFilter {
@@ -182,12 +183,6 @@ export interface FirewallFilterParam {
   ref?: string;
 }
 
-export type FilterCreateResponse = Array<FirewallFilter>;
-
-export type FilterBulkDeleteResponse = Array<FirewallFilter>;
-
-export type FilterBulkUpdateResponse = Array<FirewallFilter>;
-
 export interface FilterCreateParams {
   /**
    * Path param: Identifier

package/src/resources/firewall/access-rules.ts

@@ -3,7 +3,7 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import { CloudflareError } from "../../error";
+import { CloudflareError } from '../../error';
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class AccessRules extends APIResource {

package/src/resources/firewall/firewall.ts

@@ -41,19 +41,15 @@ import * as RulesAPI from './rules';
 import {
   DeletedFilter,
   FirewallRule,
+  FirewallRulesSinglePage,
   FirewallRulesV4PagePaginationArray,
   Product,
   RuleBulkDeleteParams,
-  RuleBulkDeleteResponse,
   RuleBulkEditParams,
-  RuleBulkEditResponse,
   RuleBulkUpdateParams,
-  RuleBulkUpdateResponse,
   RuleCreateParams,
-  RuleCreateResponse,
   RuleDeleteParams,
   RuleEditParams,
-  RuleEditResponse,
   RuleGetParams,
   RuleListParams,
   RuleUpdateParams,
@@ -88,6 +84,7 @@ export class Firewall extends APIResource {
 Firewall.Lockdowns = Lockdowns;
 Firewall.LockdownsV4PagePaginationArray = LockdownsV4PagePaginationArray;
 Firewall.Rules = Rules;
+Firewall.FirewallRulesSinglePage = FirewallRulesSinglePage;
 Firewall.FirewallRulesV4PagePaginationArray = FirewallRulesV4PagePaginationArray;
 Firewall.AccessRules = AccessRules;
 Firewall.AccessRuleListResponsesV4PagePaginationArray = AccessRuleListResponsesV4PagePaginationArray;
@@ -117,11 +114,7 @@ export declare namespace Firewall {
     type DeletedFilter as DeletedFilter,
     type FirewallRule as FirewallRule,
     type Product as Product,
-    type RuleCreateResponse as RuleCreateResponse,
-    type RuleBulkDeleteResponse as RuleBulkDeleteResponse,
-    type RuleBulkEditResponse as RuleBulkEditResponse,
-    type RuleBulkUpdateResponse as RuleBulkUpdateResponse,
-    type RuleEditResponse as RuleEditResponse,
+    FirewallRulesSinglePage as FirewallRulesSinglePage,
     FirewallRulesV4PagePaginationArray as FirewallRulesV4PagePaginationArray,
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,

package/src/resources/firewall/index.ts

@@ -21,16 +21,12 @@ export {
 } from './access-rules';
 export { Firewall } from './firewall';
 export {
+  FirewallRulesSinglePage,
   FirewallRulesV4PagePaginationArray,
   Rules,
   type DeletedFilter,
   type FirewallRule,
   type Product,
-  type RuleCreateResponse,
-  type RuleBulkDeleteResponse,
-  type RuleBulkEditResponse,
-  type RuleBulkUpdateResponse,
-  type RuleEditResponse,
   type RuleCreateParams,
   type RuleUpdateParams,
   type RuleListParams,

package/src/resources/firewall/rules.ts

@@ -4,7 +4,7 @@ import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as FiltersAPI from '../filters';
 import * as RateLimitsAPI from '../rate-limits';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
+import { SinglePage, V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class Rules extends APIResource {
   /**
@@ -15,13 +15,13 @@ export class Rules extends APIResource {
   create(
     params: RuleCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleCreateResponse | null> {
+  ): Core.PagePromise<FirewallRulesSinglePage, FirewallRule> {
     const { zone_id, ...body } = params;
-    return (
-      this._client.post(`/zones/${zone_id}/firewall/rules`, { body, ...options }) as Core.APIPromise<{
-        result: RuleCreateResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/firewall/rules`, FirewallRulesSinglePage, {
+      body,
+      method: 'post',
+      ...options,
+    });
   }
 
   /**
@@ -86,13 +86,12 @@ export class Rules extends APIResource {
   bulkDelete(
     params: RuleBulkDeleteParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleBulkDeleteResponse | null> {
+  ): Core.PagePromise<FirewallRulesSinglePage, FirewallRule> {
     const { zone_id } = params;
-    return (
-      this._client.delete(`/zones/${zone_id}/firewall/rules`, options) as Core.APIPromise<{
-        result: RuleBulkDeleteResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/firewall/rules`, FirewallRulesSinglePage, {
+      method: 'delete',
+      ...options,
+    });
   }
 
   /**
@@ -103,13 +102,13 @@ export class Rules extends APIResource {
   bulkEdit(
     params: RuleBulkEditParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleBulkEditResponse | null> {
+  ): Core.PagePromise<FirewallRulesSinglePage, FirewallRule> {
     const { zone_id, body } = params;
-    return (
-      this._client.patch(`/zones/${zone_id}/firewall/rules`, { body: body, ...options }) as Core.APIPromise<{
-        result: RuleBulkEditResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/firewall/rules`, FirewallRulesSinglePage, {
+      body: body,
+      method: 'patch',
+      ...options,
+    });
   }
 
   /**
@@ -120,13 +119,13 @@ export class Rules extends APIResource {
   bulkUpdate(
     params: RuleBulkUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleBulkUpdateResponse | null> {
+  ): Core.PagePromise<FirewallRulesSinglePage, FirewallRule> {
     const { zone_id, body } = params;
-    return (
-      this._client.put(`/zones/${zone_id}/firewall/rules`, { body: body, ...options }) as Core.APIPromise<{
-        result: RuleBulkUpdateResponse | null;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/firewall/rules`, FirewallRulesSinglePage, {
+      body: body,
+      method: 'put',
+      ...options,
+    });
   }
 
   /**
@@ -138,14 +137,13 @@ export class Rules extends APIResource {
     ruleId: string,
     params: RuleEditParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleEditResponse | null> {
+  ): Core.PagePromise<FirewallRulesSinglePage, FirewallRule> {
     const { zone_id, ...body } = params;
-    return (
-      this._client.patch(`/zones/${zone_id}/firewall/rules/${ruleId}`, {
-        body,
-        ...options,
-      }) as Core.APIPromise<{ result: RuleEditResponse | null }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/zones/${zone_id}/firewall/rules/${ruleId}`, FirewallRulesSinglePage, {
+      body,
+      method: 'patch',
+      ...options,
+    });
   }
 
   /**
@@ -164,6 +162,8 @@ export class Rules extends APIResource {
   }
 }
 
+export class FirewallRulesSinglePage extends SinglePage<FirewallRule> {}
+
 export class FirewallRulesV4PagePaginationArray extends V4PagePaginationArray<FirewallRule> {}
 
 export interface DeletedFilter {
@@ -222,16 +222,6 @@ export interface FirewallRule {
  */
 export type Product = 'zoneLockdown' | 'uaBlock' | 'bic' | 'hot' | 'securityLevel' | 'rateLimit' | 'waf';
 
-export type RuleCreateResponse = Array<FirewallRule>;
-
-export type RuleBulkDeleteResponse = Array<FirewallRule>;
-
-export type RuleBulkEditResponse = Array<FirewallRule>;
-
-export type RuleBulkUpdateResponse = Array<FirewallRule>;
-
-export type RuleEditResponse = Array<FirewallRule>;
-
 export interface RuleCreateParams {
   /**
    * Path param: Identifier
@@ -462,6 +452,7 @@ export interface RuleGetParams {
   id?: string;
 }
 
+Rules.FirewallRulesSinglePage = FirewallRulesSinglePage;
 Rules.FirewallRulesV4PagePaginationArray = FirewallRulesV4PagePaginationArray;
 
 export declare namespace Rules {
@@ -469,11 +460,7 @@ export declare namespace Rules {
     type DeletedFilter as DeletedFilter,
     type FirewallRule as FirewallRule,
     type Product as Product,
-    type RuleCreateResponse as RuleCreateResponse,
-    type RuleBulkDeleteResponse as RuleBulkDeleteResponse,
-    type RuleBulkEditResponse as RuleBulkEditResponse,
-    type RuleBulkUpdateResponse as RuleBulkUpdateResponse,
-    type RuleEditResponse as RuleEditResponse,
+    FirewallRulesSinglePage as FirewallRulesSinglePage,
     FirewallRulesV4PagePaginationArray as FirewallRulesV4PagePaginationArray,
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,

package/src/resources/hostnames/settings/index.ts

@@ -2,6 +2,7 @@
 
 export { Settings } from './settings';
 export {
+  TLSGetResponsesSinglePage,
   TLS,
   type Setting,
   type SettingValue,

package/src/resources/hostnames/settings/settings.ts

@@ -10,6 +10,7 @@ import {
   TLSDeleteResponse,
   TLSGetParams,
   TLSGetResponse,
+  TLSGetResponsesSinglePage,
   TLSUpdateParams,
 } from './tls';
 
@@ -18,6 +19,7 @@ export class Settings extends APIResource {
 }
 
 Settings.TLS = TLS;
+Settings.TLSGetResponsesSinglePage = TLSGetResponsesSinglePage;
 
 export declare namespace Settings {
   export {
@@ -26,6 +28,7 @@ export declare namespace Settings {
     type SettingValue as SettingValue,
     type TLSDeleteResponse as TLSDeleteResponse,
     type TLSGetResponse as TLSGetResponse,
+    TLSGetResponsesSinglePage as TLSGetResponsesSinglePage,
     type TLSUpdateParams as TLSUpdateParams,
     type TLSDeleteParams as TLSDeleteParams,
     type TLSGetParams as TLSGetParams,