cloudflare 7.2.0 → 7.3.0

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

@@ -14,7 +14,7 @@ export class BaseDomains extends APIResource {
   ] as const);
 
   /**
-   * Add a new domain for the Pages project.
+   * Attach a custom domain to a Cloudflare Pages project.
    *
    * @example
    * ```ts
@@ -22,7 +22,7 @@ export class BaseDomains extends APIResource {
    *   'this-is-my-project-01',
    *   {
    *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     name: 'this-is-my-domain-01.com',
+   *     name: 'example.com',
    *   },
    * );
    * ```
@@ -42,7 +42,7 @@ export class BaseDomains extends APIResource {
   }
 
   /**
-   * Fetch a list of all domains associated with a Pages project.
+   * List the custom domains associated with a Cloudflare Pages project.
    *
    * @example
    * ```ts
@@ -69,12 +69,12 @@ export class BaseDomains extends APIResource {
   }
 
   /**
-   * Delete a Pages project's domain.
+   * Remove a custom domain from a Cloudflare Pages project.
    *
    * @example
    * ```ts
    * const domain = await client.pages.projects.domains.delete(
-   *   'this-is-my-domain-01.com',
+   *   'example.com',
    *   {
    *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *     project_name: 'this-is-my-project-01',
@@ -97,12 +97,12 @@ export class BaseDomains extends APIResource {
   }
 
   /**
-   * Retry the validation status of a single domain.
+   * Retry validation for a custom domain attached to a Cloudflare Pages project.
    *
    * @example
    * ```ts
    * const response = await client.pages.projects.domains.edit(
-   *   'this-is-my-domain-01.com',
+   *   'example.com',
    *   {
    *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *     project_name: 'this-is-my-project-01',
@@ -125,12 +125,13 @@ export class BaseDomains extends APIResource {
   }
 
   /**
-   * Fetch a single domain.
+   * Retrieve the configuration and validation status of a custom domain attached to
+   * a Cloudflare Pages project.
    *
    * @example
    * ```ts
    * const domain = await client.pages.projects.domains.get(
-   *   'this-is-my-domain-01.com',
+   *   'example.com',
    *   {
    *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *     project_name: 'this-is-my-project-01',
@@ -162,7 +163,7 @@ export interface DomainCreateResponse {
   domain_id: string;
 
   /**
-   * The domain name.
+   * Fully qualified domain name for the Pages project, such as `example.com`.
    */
   name: string;
 
@@ -205,7 +206,7 @@ export interface DomainListResponse {
   domain_id: string;
 
   /**
-   * The domain name.
+   * Fully qualified domain name for the Pages project, such as `example.com`.
    */
   name: string;
 
@@ -250,7 +251,7 @@ export interface DomainEditResponse {
   domain_id: string;
 
   /**
-   * The domain name.
+   * Fully qualified domain name for the Pages project, such as `example.com`.
    */
   name: string;
 
@@ -293,7 +294,7 @@ export interface DomainGetResponse {
   domain_id: string;
 
   /**
-   * The domain name.
+   * Fully qualified domain name for the Pages project, such as `example.com`.
    */
   name: string;
 
@@ -333,7 +334,8 @@ export interface DomainCreateParams {
   account_id: string;
 
   /**
-   * Body param: The domain name.
+   * Body param: Fully qualified domain name for the Pages project, such as
+   * `example.com`.
    */
   name: string;
 }
@@ -352,7 +354,8 @@ export interface DomainDeleteParams {
   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;
 }
@@ -364,7 +367,8 @@ export interface DomainEditParams {
   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;
 }
@@ -376,7 +380,8 @@ export interface DomainGetParams {
   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/projects.ts

@@ -45,7 +45,8 @@ export class BaseProjects extends APIResource {
   ] as const);
 
   /**
-   * Create a new project.
+   * Create a Cloudflare Pages project for configuring and deploying a site or
+   * application.
    *
    * @example
    * ```ts
@@ -66,7 +67,7 @@ export class BaseProjects extends APIResource {
   }
 
   /**
-   * Fetch a list of all user projects.
+   * List the Cloudflare Pages projects in an account.
    *
    * @example
    * ```ts
@@ -91,7 +92,7 @@ export class BaseProjects extends APIResource {
   }
 
   /**
-   * Delete a project by name.
+   * Permanently delete a Cloudflare Pages project and its deployments.
    *
    * @example
    * ```ts
@@ -116,8 +117,8 @@ export class BaseProjects extends APIResource {
   }
 
   /**
-   * Set new attributes for an existing project. Modify environment variables. To
-   * delete an environment variable, set the key to null.
+   * Update the build, deployment, source, or environment settings for a Cloudflare
+   * Pages project. To delete an environment variable, set its key to `null`.
    *
    * @example
    * ```ts
@@ -138,7 +139,8 @@ export class BaseProjects extends APIResource {
   }
 
   /**
-   * Fetch a project by name.
+   * Retrieve the configuration and deployment settings for a Cloudflare Pages
+   * project.
    *
    * @example
    * ```ts
@@ -183,7 +185,8 @@ export class BaseProjects extends APIResource {
   }
 
   /**
-   * Purge all cached build artifacts for a Pages project
+   * Remove cached build artifacts so subsequent builds run without the project's
+   * existing build cache.
    *
    * @example
    * ```ts
@@ -256,7 +259,7 @@ export interface Deployment {
   environment: 'preview' | 'production';
 
   /**
-   * If the deployment has been skipped.
+   * Whether the deployment was skipped.
    */
   is_skipped: boolean;
 
@@ -276,7 +279,8 @@ export interface Deployment {
   project_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;
 
@@ -310,6 +314,7 @@ export interface Deployment {
     | 'path_config'
     | 'branch_config'
     | 'pages_to_workers_conversion'
+    | 'superseded_queued_build'
     | null;
 
   /**
@@ -546,7 +551,8 @@ export interface Project {
   latest_deployment: Deployment | null;
 
   /**
-   * 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.
    */
   name: string;
 
@@ -1317,7 +1323,7 @@ export interface Stage {
   /**
    * State of the current stage.
    */
-  status: 'success' | 'idle' | 'active' | 'failure' | 'canceled';
+  status: 'success' | 'idle' | 'active' | 'failure' | 'canceled' | 'skipped';
 }
 
 export type ProjectDeleteResponse = unknown;
@@ -1338,7 +1344,8 @@ export interface ProjectCreateParams {
   account_id: string;
 
   /**
-   * Body param: Name of the project.
+   * Body param: Name for the Pages project. Must begin with a lowercase letter or
+   * digit and contain only lowercase letters, digits, and hyphens.
    */
   name: string;
 
@@ -2099,7 +2106,8 @@ export interface ProjectEditParams {
   deployment_configs?: ProjectEditParams.DeploymentConfigs;
 
   /**
-   * Body param: Name of the project.
+   * Body param: Name for the Pages project. Must begin with a lowercase letter or
+   * digit and contain only lowercase letters, digits, and hyphens.
    */
   name?: string;
 

package/src/resources/pipelines/sinks.ts

@@ -122,7 +122,7 @@ export interface SinkCreateResponse {
   /**
    * Specifies the type of sink.
    */
-  type: 'r2' | 'r2_data_catalog';
+  type: 'r2' | 'r2_data_catalog' | 'basin_catalog';
 
   /**
    * R2 Data Catalog Sink
@@ -356,7 +356,7 @@ export interface SinkListResponse {
   /**
    * Specifies the type of sink.
    */
-  type: 'r2' | 'r2_data_catalog';
+  type: 'r2' | 'r2_data_catalog' | 'basin_catalog';
 
   /**
    * Defines the configuration of the R2 Sink.
@@ -576,7 +576,7 @@ export interface SinkGetResponse {
   /**
    * Specifies the type of sink.
    */
-  type: 'r2' | 'r2_data_catalog';
+  type: 'r2' | 'r2_data_catalog' | 'basin_catalog';
 
   /**
    * Defines the configuration of the R2 Sink.
@@ -790,7 +790,7 @@ export interface SinkCreateParams {
   /**
    * Body param: Specifies the type of sink.
    */
-  type: 'r2' | 'r2_data_catalog';
+  type: 'r2' | 'r2_data_catalog' | 'basin_catalog';
 
   /**
    * Body param: Defines the configuration of the R2 Sink.