cloudflare 7.2.0 → 7.3.0

package/src/resources/memberships/memberships.ts

@@ -267,9 +267,45 @@ export namespace MembershipUpdateResponse {
        * Attributes associated to the permission group.
        */
       export interface Meta {
-        key?: string;
+        /**
+         * A category used to group permission groups.
+         */
+        category?: string;
 
-        value?: string;
+        /**
+         * Indicates whether the permission group is deprecated.
+         */
+        deprecated?: string;
+
+        /**
+         * Additional information about the permission group.
+         */
+        description?: string;
+
+        /**
+         * Indicates whether the permission group can be edited.
+         */
+        editable?: string;
+
+        /**
+         * The planned end-of-life date and time, when provided.
+         */
+        eol_at?: string;
+
+        /**
+         * A label identifying the permission group.
+         */
+        label?: string;
+
+        /**
+         * The scope associated with the permission group.
+         */
+        scopes?: string;
+
+        /**
+         * Indicates the permission group's availability or visibility.
+         */
+        visibility?: string;
       }
     }
 
@@ -462,9 +498,45 @@ export namespace MembershipGetResponse {
        * Attributes associated to the permission group.
        */
       export interface Meta {
-        key?: string;
+        /**
+         * A category used to group permission groups.
+         */
+        category?: string;
 
-        value?: string;
+        /**
+         * Indicates whether the permission group is deprecated.
+         */
+        deprecated?: string;
+
+        /**
+         * Additional information about the permission group.
+         */
+        description?: string;
+
+        /**
+         * Indicates whether the permission group can be edited.
+         */
+        editable?: string;
+
+        /**
+         * The planned end-of-life date and time, when provided.
+         */
+        eol_at?: string;
+
+        /**
+         * A label identifying the permission group.
+         */
+        label?: string;
+
+        /**
+         * The scope associated with the permission group.
+         */
+        scopes?: string;
+
+        /**
+         * Indicates the permission group's availability or visibility.
+         */
+        visibility?: string;
       }
     }
 

package/src/resources/mtls-certificates/associations.ts

@@ -18,7 +18,7 @@ export class BaseAssociations extends APIResource {
    * ```ts
    * // Automatically fetches more pages as needed.
    * for await (const certificateAsssociation of client.mtlsCertificates.associations.get(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * )) {
    *   // ...

package/src/resources/mtls-certificates/mtls-certificates.ts

@@ -82,7 +82,7 @@ export class BaseMTLSCertificates extends APIResource {
    * ```ts
    * const mtlsCertificate =
    *   await client.mtlsCertificates.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -109,7 +109,7 @@ export class BaseMTLSCertificates extends APIResource {
    * @example
    * ```ts
    * const mtlsCertificate = await client.mtlsCertificates.get(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -136,7 +136,7 @@ export type MTLSCertificatesSinglePage = SinglePage<MTLSCertificate>;
 
 export interface MTLSCertificate {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -188,7 +188,7 @@ export interface MTLSCertificate {
 
 export interface MTLSCertificateCreateResponse {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 

package/src/resources/organizations/billing/usage.ts

@@ -125,13 +125,15 @@ export namespace UsageGetResponse {
 
     /**
      * Public identifier of the Cloudflare account (account tag). Omitted when account
-     * is not part of the requested grouping.
+     * is not part of the requested grouping, and always omitted for usage measured at
+     * contract level, even when grouping by account: that usage is returned as its own
+     * record with no account.
      */
     BillingAccountId?: string;
 
     /**
      * Display name of the Cloudflare account. Omitted when account is not part of the
-     * requested grouping.
+     * requested grouping, and for usage measured at contract level.
      */
     BillingAccountName?: string;
 
@@ -255,12 +257,16 @@ export namespace UsageGetResponse {
     x_ProductFamilyName?: string;
 
     /**
-     * The identifier for the Cloudflare zone (zone tag). Cloudflare extension.
+     * The identifier for the Cloudflare zone (zone tag). Omitted when zone is not part
+     * of the requested grouping, and always omitted for usage measured at contract
+     * level, even when grouping by zone. Cloudflare extension.
      */
     x_ZoneId?: string | null;
 
     /**
-     * The display name of the Cloudflare zone. Cloudflare extension.
+     * The display name of the Cloudflare zone. Omitted when zone is not part of the
+     * requested grouping, and for usage measured at contract level. Cloudflare
+     * extension.
      */
     x_ZoneName?: string | null;
   }

package/src/resources/organizations/organizations.ts

@@ -21,7 +21,8 @@ export class BaseOrganizations extends APIResource {
   static override readonly _key: readonly ['organizations'] = Object.freeze(['organizations'] as const);
 
   /**
-   * Create a new organization for a user. (Currently in Public Beta - see
+   * Create a new organization for a user. Sub-organization creation availability
+   * depends on the organization's capabilities. (Currently in Public Beta - see
    * https://developers.cloudflare.com/fundamentals/organizations/)
    */
   create(body: OrganizationCreateParams, options?: RequestOptions): APIPromise<Organization> {
@@ -31,7 +32,7 @@ export class BaseOrganizations extends APIResource {
   }
 
   /**
-   * Modify organization. (Currently in Public Beta - see
+   * Update an organization's name. (Currently in Public Beta - see
    * https://developers.cloudflare.com/fundamentals/organizations/)
    */
   update(
@@ -59,7 +60,8 @@ export class BaseOrganizations extends APIResource {
 
   /**
    * Delete an organization. The organization MUST be empty before deleting. It must
-   * not contain any sub-organizations, accounts, members or users. (Currently in
+   * not contain any sub-organizations, accounts, members or users. Sub-organization
+   * deletion availability depends on the organization's capabilities. (Currently in
    * Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/)
    *
    * **Access Control:** Restricted to enterprise organizations.

package/src/resources/origin-ca-certificates/origin-ca-certificates.ts

@@ -71,7 +71,7 @@ export class BaseOriginCACertificates extends APIResource {
    * ```ts
    * const originCACertificate =
    *   await client.originCACertificates.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '328578533902268680212849205732770752308931942346',
    *   );
    * ```
    */
@@ -92,7 +92,7 @@ export class BaseOriginCACertificates extends APIResource {
    * ```ts
    * const originCACertificate =
    *   await client.originCACertificates.get(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '328578533902268680212849205732770752308931942346',
    *   );
    * ```
    */
@@ -138,7 +138,7 @@ export interface OriginCACertificate {
   requested_validity: CertificatePacksAPI.RequestValidity;
 
   /**
-   * Identifier.
+   * The x509 serial number of the Origin CA certificate.
    */
   id?: string;
 
@@ -155,7 +155,7 @@ export interface OriginCACertificate {
 
 export interface OriginCACertificateDeleteResponse {
   /**
-   * Identifier.
+   * The x509 serial number of the Origin CA certificate.
    */
   id?: string;
 

package/src/resources/origin-tls-client-auth/hostname-certificates.ts

@@ -80,7 +80,7 @@ export class BaseHostnameCertificates extends APIResource {
    * ```ts
    * const hostnameCertificate =
    *   await client.originTLSClientAuth.hostnameCertificates.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -106,7 +106,7 @@ export class BaseHostnameCertificates extends APIResource {
    * ```ts
    * const hostnameCertificate =
    *   await client.originTLSClientAuth.hostnameCertificates.get(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -131,7 +131,7 @@ export type HostnameCertificateListResponsesSinglePage = SinglePage<HostnameCert
 
 export interface Certificate {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -180,7 +180,7 @@ export interface Certificate {
 
 export interface HostnameCertificateCreateResponse {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -229,7 +229,7 @@ export interface HostnameCertificateCreateResponse {
 
 export interface HostnameCertificateListResponse {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -278,7 +278,7 @@ export interface HostnameCertificateListResponse {
 
 export interface HostnameCertificateDeleteResponse {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -327,7 +327,7 @@ export interface HostnameCertificateDeleteResponse {
 
 export interface HostnameCertificateGetResponse {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 

package/src/resources/origin-tls-client-auth/hostnames.ts

@@ -77,7 +77,7 @@ export type HostnameUpdateResponsesSinglePage = SinglePage<HostnameUpdateRespons
 
 export interface AuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   cert_id?: string;
 
@@ -165,12 +165,12 @@ export interface AuthenticatedOriginPull {
 
 export interface HostnameUpdateResponse extends AuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   cert_id?: string;
 

package/src/resources/origin-tls-client-auth/origin-tls-client-auth.ts

@@ -152,7 +152,7 @@ export type OriginTLSClientAuthListResponsesSinglePage = SinglePage<OriginTLSCli
 
 export interface OriginTLSClientAuthCreateResponse extends ZoneCertificatesAPI.ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -174,7 +174,7 @@ export interface OriginTLSClientAuthCreateResponse extends ZoneCertificatesAPI.Z
 
 export interface OriginTLSClientAuthListResponse extends ZoneCertificatesAPI.ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -196,7 +196,7 @@ export interface OriginTLSClientAuthListResponse extends ZoneCertificatesAPI.Zon
 
 export interface OriginTLSClientAuthDeleteResponse extends ZoneCertificatesAPI.ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -218,7 +218,7 @@ export interface OriginTLSClientAuthDeleteResponse extends ZoneCertificatesAPI.Z
 
 export interface OriginTLSClientAuthGetResponse extends ZoneCertificatesAPI.ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 

package/src/resources/origin-tls-client-auth/zone-certificates.ts

@@ -76,7 +76,7 @@ export class BaseZoneCertificates extends APIResource {
    * ```ts
    * const zoneCertificate =
    *   await client.originTLSClientAuth.zoneCertificates.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -103,7 +103,7 @@ export class BaseZoneCertificates extends APIResource {
    * ```ts
    * const zoneCertificate =
    *   await client.originTLSClientAuth.zoneCertificates.get(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -128,7 +128,7 @@ export type ZoneCertificateListResponsesSinglePage = SinglePage<ZoneCertificateL
 
 export interface ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -172,7 +172,7 @@ export interface ZoneAuthenticatedOriginPull {
 
 export interface ZoneCertificateCreateResponse extends ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -194,7 +194,7 @@ export interface ZoneCertificateCreateResponse extends ZoneAuthenticatedOriginPu
 
 export interface ZoneCertificateListResponse extends ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -216,7 +216,7 @@ export interface ZoneCertificateListResponse extends ZoneAuthenticatedOriginPull
 
 export interface ZoneCertificateDeleteResponse extends ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 
@@ -238,7 +238,7 @@ export interface ZoneCertificateDeleteResponse extends ZoneAuthenticatedOriginPu
 
 export interface ZoneCertificateGetResponse extends ZoneAuthenticatedOriginPull {
   /**
-   * Identifier.
+   * Certificate identifier tag.
    */
   id?: string;
 

package/src/resources/pages/projects/deployments/deployments.ts

@@ -33,8 +33,8 @@ export class BaseDeployments extends APIResource {
   ] as const);
 
   /**
-   * Start a new deployment from production. The repository and account must have
-   * already been authorized on the Cloudflare Pages dashboard.
+   * Create a Cloudflare Pages deployment from a Git branch or Direct Upload
+   * manifest. Git repositories must already be authorized in Cloudflare Pages.
    *
    * @example
    * ```ts
@@ -60,7 +60,7 @@ export class BaseDeployments extends APIResource {
   }
 
   /**
-   * Fetch a list of project deployments.
+   * List the production or preview deployments for a Cloudflare Pages project.
    *
    * @example
    * ```ts
@@ -87,13 +87,13 @@ export class BaseDeployments extends APIResource {
   }
 
   /**
-   * Delete a deployment.
+   * Remove a deployment from a Cloudflare Pages project.
    *
    * @example
    * ```ts
    * const deployment =
    *   await client.pages.projects.deployments.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     'f64788e9-fccd-4d4a-a28a-cb84f88f6e12',
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       project_name: 'this-is-my-project-01',
@@ -116,13 +116,13 @@ export class BaseDeployments extends APIResource {
   }
 
   /**
-   * Fetch information about a deployment.
+   * Retrieve the status and details of a Cloudflare Pages deployment.
    *
    * @example
    * ```ts
    * const deployment =
    *   await client.pages.projects.deployments.get(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     'f64788e9-fccd-4d4a-a28a-cb84f88f6e12',
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       project_name: 'this-is-my-project-01',
@@ -145,13 +145,13 @@ export class BaseDeployments extends APIResource {
   }
 
   /**
-   * Retry a previous deployment.
+   * Retry a previous Cloudflare Pages deployment.
    *
    * @example
    * ```ts
    * const deployment =
    *   await client.pages.projects.deployments.retry(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     'f64788e9-fccd-4d4a-a28a-cb84f88f6e12',
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       project_name: 'this-is-my-project-01',
@@ -174,14 +174,13 @@ export class BaseDeployments extends APIResource {
   }
 
   /**
-   * Rollback the production deployment to a previous deployment. You can only
-   * rollback to succesful builds on production.
+   * Roll back production to a previous successful Cloudflare Pages deployment.
    *
    * @example
    * ```ts
    * const deployment =
    *   await client.pages.projects.deployments.rollback(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     'f64788e9-fccd-4d4a-a28a-cb84f88f6e12',
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       project_name: 'this-is-my-project-01',
@@ -245,24 +244,24 @@ export interface DeploymentCreateParams {
   '_worker.js'?: Uploadable;
 
   /**
-   * Body param: The branch to build the new deployment from. The `HEAD` of the
-   * branch will be used. If omitted, the production branch will be used by default.
+   * Body param: Git branch to deploy. Uses the branch's `HEAD`; defaults to the
+   * project's production branch.
    */
   branch?: string;
 
   /**
-   * Body param: Boolean string indicating if the working directory has uncommitted
-   * changes.
+   * Body param: Whether the associated Git working tree has uncommitted changes.
+   * Provide `true` or `false`.
    */
   commit_dirty?: 'true' | 'false';
 
   /**
-   * Body param: Git commit SHA associated with this deployment.
+   * Body param: Git commit SHA associated with the deployment.
    */
   commit_hash?: string;
 
   /**
-   * Body param: Git commit message associated with this deployment.
+   * Body param: Git commit message associated with the deployment.
    */
   commit_message?: string;
 
@@ -272,9 +271,8 @@ export interface DeploymentCreateParams {
   'functions-filepath-routing-config.json'?: Uploadable;
 
   /**
-   * Body param: JSON string containing a manifest of files to deploy. Maps file
-   * paths to their content hashes. Required for direct upload deployments. Maximum
-   * 20,000 entries.
+   * Body param: JSON-encoded object mapping deployment file paths to their uploaded
+   * content hashes. Required for Direct Upload deployments. Maximum 20,000 entries.
    */
   manifest?: string;
 
@@ -296,7 +294,8 @@ export interface DeploymentListParams extends V4PagePaginationArrayParams {
   account_id: string;
 
   /**
-   * Query param: What type of deployments to fetch.
+   * Query param: Deployment environment to return. Valid values are `production` and
+   * `preview`.
    */
   env?: 'production' | 'preview';
 }
@@ -308,13 +307,14 @@ export interface DeploymentDeleteParams {
   account_id: string;
 
   /**
-   * Path param: Name of the project.
+   * Path param: Name of the Pages project. Must begin with a lowercase letter or
+   * digit and contain only lowercase letters, digits, and hyphens.
    */
   project_name: string;
 
   /**
-   * Query param: Allow deletion of aliased non-production deployments when a normal
-   * delete would be rejected.
+   * Query param: Allow deletion when a non-production deployment has an active
+   * alias.
    */
   force?: boolean;
 }
@@ -326,7 +326,8 @@ export interface DeploymentGetParams {
   account_id: string;
 
   /**
-   * Name of the project.
+   * Name of the Pages project. Must begin with a lowercase letter or digit and
+   * contain only lowercase letters, digits, and hyphens.
    */
   project_name: string;
 }
@@ -338,7 +339,8 @@ export interface DeploymentRetryParams {
   account_id: string;
 
   /**
-   * Name of the project.
+   * Name of the Pages project. Must begin with a lowercase letter or digit and
+   * contain only lowercase letters, digits, and hyphens.
    */
   project_name: string;
 }
@@ -350,7 +352,8 @@ export interface DeploymentRollbackParams {
   account_id: string;
 
   /**
-   * Name of the project.
+   * Name of the Pages project. Must begin with a lowercase letter or digit and
+   * contain only lowercase letters, digits, and hyphens.
    */
   project_name: string;
 }

package/src/resources/pages/projects/deployments/history/logs.ts

@@ -10,13 +10,13 @@ export class BaseLogs extends APIResource {
     Object.freeze(['pages', 'projects', 'deployments', 'history', 'logs'] as const);
 
   /**
-   * Fetch deployment logs for a project.
+   * Retrieve the build logs for a Cloudflare Pages deployment.
    *
    * @example
    * ```ts
    * const log =
    *   await client.pages.projects.deployments.history.logs.get(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     'f64788e9-fccd-4d4a-a28a-cb84f88f6e12',
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       project_name: 'this-is-my-project-01',
@@ -59,7 +59,8 @@ export interface LogGetParams {
   account_id: string;
 
   /**
-   * Name of the project.
+   * Name of the Pages project. Must begin with a lowercase letter or digit and
+   * contain only lowercase letters, digits, and hyphens.
    */
   project_name: string;
 }

package/src/resources/pages/projects/deployments/tails.ts

@@ -20,7 +20,7 @@ export class BaseTails extends APIResource {
    * ```ts
    * const tail =
    *   await client.pages.projects.deployments.tails.create(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     'f64788e9-fccd-4d4a-a28a-cb84f88f6e12',
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       project_name: 'this-is-my-project-01',
@@ -53,7 +53,7 @@ export class BaseTails extends APIResource {
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       project_name: 'this-is-my-project-01',
-   *       deployment_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *       deployment_id: 'f64788e9-fccd-4d4a-a28a-cb84f88f6e12',
    *     },
    *   );
    * ```
@@ -99,7 +99,8 @@ export interface TailCreateParams {
   account_id: string;
 
   /**
-   * Path param: Name of the project.
+   * Path param: Name of the Pages project. Must begin with a lowercase letter or
+   * digit and contain only lowercase letters, digits, and hyphens.
    */
   project_name: string;
 
@@ -116,12 +117,14 @@ export interface TailDeleteParams {
   account_id: string;
 
   /**
-   * Name of the project.
+   * Name of the Pages project. Must begin with a lowercase letter or digit and
+   * contain only lowercase letters, digits, and hyphens.
    */
   project_name: string;
 
   /**
-   * Identifier.
+   * UUID of the Pages deployment, as returned by deployment list or create
+   * operations.
    */
   deployment_id: string;
 }