cloudflare 5.1.0 → 6.0.0-beta.1

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

@@ -42,7 +42,9 @@ export class Investigate extends APIResource {
   release: ReleaseAPI.Release = new ReleaseAPI.Release(this._client);
 
   /**
-   * Returns information for each email that matches the search parameter(s).
+   * Returns information for each email that matches the search parameter(s). If the
+   * search takes too long, the endpoint returns 202 with a Location header pointing
+   * to a polling endpoint where results can be retrieved once ready.
    *
    * @example
    * ```ts
@@ -135,6 +137,10 @@ export interface InvestigateListResponse {
 
   edf_hash?: string | null;
 
+  envelope_from?: string | null;
+
+  envelope_to?: Array<string> | null;
+
   final_disposition?:
     | 'MALICIOUS'
     | 'MALICIOUS-BEC'
@@ -158,6 +164,10 @@ export interface InvestigateListResponse {
 
   message_id?: string | null;
 
+  postfix_id_outbound?: string | null;
+
+  replyto?: string | null;
+
   sent_date?: string | null;
 
   subject?: string | null;
@@ -182,7 +192,8 @@ export namespace InvestigateListResponse {
       | 'allowed_recipient'
       | 'domain_similarity'
       | 'domain_recency'
-      | 'managed_acceptable_sender';
+      | 'managed_acceptable_sender'
+      | 'outbound_ndr';
 
     blocklisted_message?: boolean;
 
@@ -195,14 +206,38 @@ export namespace InvestigateListResponse {
       | 'allowed_recipient'
       | 'domain_similarity'
       | 'domain_recency'
-      | 'managed_acceptable_sender';
+      | 'managed_acceptable_sender'
+      | 'outbound_ndr';
   }
 
   export interface Finding {
+    attachment?: string | null;
+
     detail?: string | null;
 
+    detection?:
+      | 'MALICIOUS'
+      | 'MALICIOUS-BEC'
+      | 'SUSPICIOUS'
+      | 'SPOOF'
+      | 'SPAM'
+      | 'BULK'
+      | 'ENCRYPTED'
+      | 'EXTERNAL'
+      | 'UNKNOWN'
+      | 'NONE'
+      | null;
+
+    field?: string | null;
+
     name?: string | null;
 
+    portion?: string | null;
+
+    reason?: string | null;
+
+    score?: number | null;
+
     value?: string | null;
   }
 
@@ -257,6 +292,10 @@ export interface InvestigateGetResponse {
 
   edf_hash?: string | null;
 
+  envelope_from?: string | null;
+
+  envelope_to?: Array<string> | null;
+
   final_disposition?:
     | 'MALICIOUS'
     | 'MALICIOUS-BEC'
@@ -280,6 +319,10 @@ export interface InvestigateGetResponse {
 
   message_id?: string | null;
 
+  postfix_id_outbound?: string | null;
+
+  replyto?: string | null;
+
   sent_date?: string | null;
 
   subject?: string | null;
@@ -304,7 +347,8 @@ export namespace InvestigateGetResponse {
       | 'allowed_recipient'
       | 'domain_similarity'
       | 'domain_recency'
-      | 'managed_acceptable_sender';
+      | 'managed_acceptable_sender'
+      | 'outbound_ndr';
 
     blocklisted_message?: boolean;
 
@@ -317,14 +361,38 @@ export namespace InvestigateGetResponse {
       | 'allowed_recipient'
       | 'domain_similarity'
       | 'domain_recency'
-      | 'managed_acceptable_sender';
+      | 'managed_acceptable_sender'
+      | 'outbound_ndr';
   }
 
   export interface Finding {
+    attachment?: string | null;
+
     detail?: string | null;
 
+    detection?:
+      | 'MALICIOUS'
+      | 'MALICIOUS-BEC'
+      | 'SUSPICIOUS'
+      | 'SPOOF'
+      | 'SPAM'
+      | 'BULK'
+      | 'ENCRYPTED'
+      | 'EXTERNAL'
+      | 'UNKNOWN'
+      | 'NONE'
+      | null;
+
+    field?: string | null;
+
     name?: string | null;
 
+    portion?: string | null;
+
+    reason?: string | null;
+
+    score?: number | null;
+
     value?: string | null;
   }
 
@@ -355,6 +423,11 @@ export interface InvestigateListParams extends V4PagePaginationArrayParams {
    */
   alert_id?: string;
 
+  /**
+   * Query param:
+   */
+  cursor?: string;
+
   /**
    * Query param: Determines if the search results will include detections or not.
    */

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

@@ -72,8 +72,13 @@ export class MoveBulkResponsesSinglePage extends SinglePage<MoveBulkResponse> {}
 export interface MoveCreateResponse {
   completed_timestamp: string;
 
+  /**
+   * @deprecated
+   */
   item_count: number;
 
+  success: boolean;
+
   destination?: string | null;
 
   message_id?: string | null;
@@ -88,8 +93,13 @@ export interface MoveCreateResponse {
 export interface MoveBulkResponse {
   completed_timestamp: string;
 
+  /**
+   * @deprecated
+   */
   item_count: number;
 
+  success: boolean;
+
   destination?: string | null;
 
   message_id?: string | null;

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

@@ -173,6 +173,8 @@ export interface DomainListResponse {
 
   authorization?: DomainListResponse.Authorization | null;
 
+  dmarc_status?: 'none' | 'good' | 'invalid' | null;
+
   emails_processed?: DomainListResponse.EmailsProcessed | null;
 
   folder?: 'AllItems' | 'Inbox' | null;
@@ -186,6 +188,8 @@ export interface DomainListResponse {
   require_tls_inbound?: boolean | null;
 
   require_tls_outbound?: boolean | null;
+
+  spf_status?: 'none' | 'good' | 'neutral' | 'open' | 'invalid' | null;
 }
 
 export namespace DomainListResponse {
@@ -257,6 +261,8 @@ export interface DomainEditResponse {
 
   authorization?: DomainEditResponse.Authorization | null;
 
+  dmarc_status?: 'none' | 'good' | 'invalid' | null;
+
   emails_processed?: DomainEditResponse.EmailsProcessed | null;
 
   folder?: 'AllItems' | 'Inbox' | null;
@@ -270,6 +276,8 @@ export interface DomainEditResponse {
   require_tls_inbound?: boolean | null;
 
   require_tls_outbound?: boolean | null;
+
+  spf_status?: 'none' | 'good' | 'neutral' | 'open' | 'invalid' | null;
 }
 
 export namespace DomainEditResponse {
@@ -327,6 +335,8 @@ export interface DomainGetResponse {
 
   authorization?: DomainGetResponse.Authorization | null;
 
+  dmarc_status?: 'none' | 'good' | 'invalid' | null;
+
   emails_processed?: DomainGetResponse.EmailsProcessed | null;
 
   folder?: 'AllItems' | 'Inbox' | null;
@@ -340,6 +350,8 @@ export interface DomainGetResponse {
   require_tls_inbound?: boolean | null;
 
   require_tls_outbound?: boolean | null;
+
+  spf_status?: 'none' | 'good' | 'neutral' | 'open' | 'invalid' | null;
 }
 
 export namespace DomainGetResponse {
@@ -388,6 +400,11 @@ export interface DomainListParams extends V4PagePaginationArrayParams {
    */
   domain?: Array<string>;
 
+  /**
+   * Query param: Filters response to domains with the provided integration ID.
+   */
+  integration_id?: string;
+
   /**
    * Query param: The field to sort by.
    */

package/src/resources/hyperdrive/configs.ts

@@ -185,7 +185,8 @@ export interface ConfigCreateParams {
   account_id: string;
 
   /**
-   * Body param:
+   * Body param: The name of the Hyperdrive configuration. Used to identify the
+   * configuration in the Cloudflare dashboard and API.
    */
   name: string;
 
@@ -234,7 +235,8 @@ export namespace ConfigCreateParams {
     password: string;
 
     /**
-     * Defines the port (default: 5432 for Postgres) of your origin database.
+     * Defines the port of your origin database. Defaults to 5432 for PostgreSQL or
+     * 3306 for MySQL if not specified.
      */
     port: number;
 
@@ -303,14 +305,14 @@ export namespace ConfigCreateParams {
     disabled?: boolean;
 
     /**
-     * Specify the maximum duration items should persist in the cache. Not returned if
-     * set to the default (60).
+     * Specify the maximum duration (in seconds) items should persist in the cache.
+     * Defaults to 60 seconds if not specified.
      */
     max_age?: number;
 
     /**
-     * Specify the number of seconds the cache may serve a stale response. Omitted if
-     * set to the default (15).
+     * Specify the number of seconds the cache may serve a stale response. Defaults to
+     * 15 seconds if not specified.
      */
     stale_while_revalidate?: number;
   }
@@ -340,7 +342,8 @@ export interface ConfigUpdateParams {
   account_id: string;
 
   /**
-   * Body param:
+   * Body param: The name of the Hyperdrive configuration. Used to identify the
+   * configuration in the Cloudflare dashboard and API.
    */
   name: string;
 
@@ -389,7 +392,8 @@ export namespace ConfigUpdateParams {
     password: string;
 
     /**
-     * Defines the port (default: 5432 for Postgres) of your origin database.
+     * Defines the port of your origin database. Defaults to 5432 for PostgreSQL or
+     * 3306 for MySQL if not specified.
      */
     port: number;
 
@@ -458,14 +462,14 @@ export namespace ConfigUpdateParams {
     disabled?: boolean;
 
     /**
-     * Specify the maximum duration items should persist in the cache. Not returned if
-     * set to the default (60).
+     * Specify the maximum duration (in seconds) items should persist in the cache.
+     * Defaults to 60 seconds if not specified.
      */
     max_age?: number;
 
     /**
-     * Specify the number of seconds the cache may serve a stale response. Omitted if
-     * set to the default (15).
+     * Specify the number of seconds the cache may serve a stale response. Defaults to
+     * 15 seconds if not specified.
      */
     stale_while_revalidate?: number;
   }
@@ -521,7 +525,8 @@ export interface ConfigEditParams {
   mtls?: ConfigEditParams.MTLS;
 
   /**
-   * Body param:
+   * Body param: The name of the Hyperdrive configuration. Used to identify the
+   * configuration in the Cloudflare dashboard and API.
    */
   name?: string;
 
@@ -555,14 +560,14 @@ export namespace ConfigEditParams {
     disabled?: boolean;
 
     /**
-     * Specify the maximum duration items should persist in the cache. Not returned if
-     * set to the default (60).
+     * Specify the maximum duration (in seconds) items should persist in the cache.
+     * Defaults to 60 seconds if not specified.
      */
     max_age?: number;
 
     /**
-     * Specify the number of seconds the cache may serve a stale response. Omitted if
-     * set to the default (15).
+     * Specify the number of seconds the cache may serve a stale response. Defaults to
+     * 15 seconds if not specified.
      */
     stale_while_revalidate?: number;
   }
@@ -614,7 +619,8 @@ export namespace ConfigEditParams {
     host: string;
 
     /**
-     * Defines the port (default: 5432 for Postgres) of your origin database.
+     * Defines the port of your origin database. Defaults to 5432 for PostgreSQL or
+     * 3306 for MySQL if not specified.
      */
     port: number;
   }

package/src/resources/hyperdrive/hyperdrive.ts

@@ -30,7 +30,8 @@ export namespace Configuration {
     host: string;
 
     /**
-     * Defines the port (default: 5432 for Postgres) of your origin database.
+     * Defines the port of your origin database. Defaults to 5432 for PostgreSQL or
+     * 3306 for MySQL if not specified.
      */
     port: number;
 
@@ -85,6 +86,10 @@ export interface Hyperdrive {
    */
   id: string;
 
+  /**
+   * The name of the Hyperdrive configuration. Used to identify the configuration in
+   * the Cloudflare dashboard and API.
+   */
   name: string;
 
   origin: Hyperdrive.PublicDatabase | Hyperdrive.AccessProtectedDatabaseBehindCloudflareTunnel;
@@ -123,7 +128,8 @@ export namespace Hyperdrive {
     host: string;
 
     /**
-     * Defines the port (default: 5432 for Postgres) of your origin database.
+     * Defines the port of your origin database. Defaults to 5432 for PostgreSQL or
+     * 3306 for MySQL if not specified.
      */
     port: number;
 
@@ -180,14 +186,14 @@ export namespace Hyperdrive {
     disabled?: boolean;
 
     /**
-     * Specify the maximum duration items should persist in the cache. Not returned if
-     * set to the default (60).
+     * Specify the maximum duration (in seconds) items should persist in the cache.
+     * Defaults to 60 seconds if not specified.
      */
     max_age?: number;
 
     /**
-     * Specify the number of seconds the cache may serve a stale response. Omitted if
-     * set to the default (15).
+     * Specify the number of seconds the cache may serve a stale response. Defaults to
+     * 15 seconds if not specified.
      */
     stale_while_revalidate?: number;
   }

package/src/resources/iam/iam.ts

@@ -25,6 +25,23 @@ import {
   ResourceGroupUpdateResponse,
   ResourceGroups,
 } from './resource-groups';
+import * as SSOAPI from './sso';
+import {
+  SSO,
+  SSOBeginVerificationParams,
+  SSOBeginVerificationResponse,
+  SSOCreateParams,
+  SSOCreateResponse,
+  SSODeleteParams,
+  SSODeleteResponse,
+  SSOGetParams,
+  SSOGetResponse,
+  SSOListParams,
+  SSOListResponse,
+  SSOListResponsesSinglePage,
+  SSOUpdateParams,
+  SSOUpdateResponse,
+} from './sso';
 import * as UserGroupsAPI from './user-groups/user-groups';
 import {
   UserGroupCreateParams,
@@ -47,6 +64,7 @@ export class IAM extends APIResource {
   );
   resourceGroups: ResourceGroupsAPI.ResourceGroups = new ResourceGroupsAPI.ResourceGroups(this._client);
   userGroups: UserGroupsAPI.UserGroups = new UserGroupsAPI.UserGroups(this._client);
+  sso: SSOAPI.SSO = new SSOAPI.SSO(this._client);
 }
 
 IAM.PermissionGroups = PermissionGroups;
@@ -55,6 +73,8 @@ IAM.ResourceGroups = ResourceGroups;
 IAM.ResourceGroupListResponsesSinglePage = ResourceGroupListResponsesSinglePage;
 IAM.UserGroups = UserGroups;
 IAM.UserGroupListResponsesV4PagePaginationArray = UserGroupListResponsesV4PagePaginationArray;
+IAM.SSO = SSO;
+IAM.SSOListResponsesSinglePage = SSOListResponsesSinglePage;
 
 export declare namespace IAM {
   export {
@@ -95,4 +115,21 @@ export declare namespace IAM {
     type UserGroupDeleteParams as UserGroupDeleteParams,
     type UserGroupGetParams as UserGroupGetParams,
   };
+
+  export {
+    SSO as SSO,
+    type SSOCreateResponse as SSOCreateResponse,
+    type SSOUpdateResponse as SSOUpdateResponse,
+    type SSOListResponse as SSOListResponse,
+    type SSODeleteResponse as SSODeleteResponse,
+    type SSOBeginVerificationResponse as SSOBeginVerificationResponse,
+    type SSOGetResponse as SSOGetResponse,
+    SSOListResponsesSinglePage as SSOListResponsesSinglePage,
+    type SSOCreateParams as SSOCreateParams,
+    type SSOUpdateParams as SSOUpdateParams,
+    type SSOListParams as SSOListParams,
+    type SSODeleteParams as SSODeleteParams,
+    type SSOBeginVerificationParams as SSOBeginVerificationParams,
+    type SSOGetParams as SSOGetParams,
+  };
 }

package/src/resources/iam/index.ts

@@ -23,6 +23,22 @@ export {
   type ResourceGroupDeleteParams,
   type ResourceGroupGetParams,
 } from './resource-groups';
+export {
+  SSOListResponsesSinglePage,
+  SSO,
+  type SSOCreateResponse,
+  type SSOUpdateResponse,
+  type SSOListResponse,
+  type SSODeleteResponse,
+  type SSOBeginVerificationResponse,
+  type SSOGetResponse,
+  type SSOCreateParams,
+  type SSOUpdateParams,
+  type SSOListParams,
+  type SSODeleteParams,
+  type SSOBeginVerificationParams,
+  type SSOGetParams,
+} from './sso';
 export {
   UserGroupListResponsesV4PagePaginationArray,
   UserGroups,

package/src/resources/iam/permission-groups.ts

@@ -48,7 +48,12 @@ export class PermissionGroups extends APIResource {
     options?: Core.RequestOptions,
   ): Core.APIPromise<PermissionGroupGetResponse> {
     const { account_id } = params;
-    return this._client.get(`/accounts/${account_id}/iam/permission_groups/${permissionGroupId}`, options);
+    return (
+      this._client.get(
+        `/accounts/${account_id}/iam/permission_groups/${permissionGroupId}`,
+        options,
+      ) as Core.APIPromise<{ result: PermissionGroupGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
   }
 }
 

package/src/resources/iam/resource-groups.ts

@@ -30,7 +30,12 @@ export class ResourceGroups extends APIResource {
     options?: Core.RequestOptions,
   ): Core.APIPromise<ResourceGroupCreateResponse> {
     const { account_id, ...body } = params;
-    return this._client.post(`/accounts/${account_id}/iam/resource_groups`, { body, ...options });
+    return (
+      this._client.post(`/accounts/${account_id}/iam/resource_groups`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: ResourceGroupCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
   }
 
   /**
@@ -51,10 +56,12 @@ export class ResourceGroups extends APIResource {
     options?: Core.RequestOptions,
   ): Core.APIPromise<ResourceGroupUpdateResponse> {
     const { account_id, ...body } = params;
-    return this._client.put(`/accounts/${account_id}/iam/resource_groups/${resourceGroupId}`, {
-      body,
-      ...options,
-    });
+    return (
+      this._client.put(`/accounts/${account_id}/iam/resource_groups/${resourceGroupId}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: ResourceGroupUpdateResponse }>
+    )._thenUnwrap((obj) => obj.result);
   }
 
   /**
@@ -125,7 +132,12 @@ export class ResourceGroups extends APIResource {
     options?: Core.RequestOptions,
   ): Core.APIPromise<ResourceGroupGetResponse> {
     const { account_id } = params;
-    return this._client.get(`/accounts/${account_id}/iam/resource_groups/${resourceGroupId}`, options);
+    return (
+      this._client.get(
+        `/accounts/${account_id}/iam/resource_groups/${resourceGroupId}`,
+        options,
+      ) as Core.APIPromise<{ result: ResourceGroupGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
   }
 }
 
@@ -136,19 +148,24 @@ export class ResourceGroupListResponsesSinglePage extends SinglePage<ResourceGro
  */
 export interface ResourceGroupCreateResponse {
   /**
-   * Identifier of the group.
+   * Identifier of the resource group.
    */
-  id?: string;
+  id: string;
+
+  /**
+   * The scope associated to the resource group
+   */
+  scope: Array<ResourceGroupCreateResponse.Scope>;
 
   /**
    * Attributes associated to the resource group.
    */
-  meta?: unknown;
+  meta?: ResourceGroupCreateResponse.Meta;
 
   /**
-   * A scope is a combination of scope objects which provides additional context.
+   * Name of the resource group.
    */
-  scope?: ResourceGroupCreateResponse.Scope;
+  name?: string;
 }
 
 export namespace ResourceGroupCreateResponse {
@@ -163,8 +180,7 @@ export namespace ResourceGroupCreateResponse {
     key: string;
 
     /**
-     * A list of scope objects for additional context. The number of Scope objects
-     * should not be zero.
+     * A list of scope objects for additional context.
      */
     objects: Array<Scope.Object>;
   }
@@ -182,6 +198,15 @@ export namespace ResourceGroupCreateResponse {
       key: string;
     }
   }
+
+  /**
+   * Attributes associated to the resource group.
+   */
+  export interface Meta {
+    key?: string;
+
+    value?: string;
+  }
 }
 
 /**