cloudflare 7.2.0 → 7.3.0

package/src/resources/containers/registries/registries.ts

@@ -0,0 +1,298 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as CredentialsAPI from './credentials';
+import {
+  BaseCredentials,
+  CredentialGenerateParams,
+  CredentialGenerateResponse,
+  Credentials,
+} from './credentials';
+import { APIPromise } from '../../../core/api-promise';
+import { PagePromise, SinglePage } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class BaseRegistries extends APIResource {
+  static override readonly _key: readonly ['containers', 'registries'] = Object.freeze([
+    'containers',
+    'registries',
+  ] as const);
+
+  /**
+   * Registers credentials for a supported private external image registry so
+   * Containers can pull images from it. This endpoint does not create a registry or
+   * upload an image. Public Docker Hub images and images in the Cloudflare managed
+   * registry do not require this configuration.
+   *
+   * Refer to
+   * [Image management](https://developers.cloudflare.com/containers/platform-details/image-management/)
+   * for supported registries and instructions for storing registry credentials.
+   *
+   * @example
+   * ```ts
+   * const registry = await client.containers.registries.create({
+   *   account_id: 'account-123',
+   *   auth: {
+   *     private_credential: {
+   *       secret_name: 'API_KEY',
+   *       store_id: '14758f1afd44c09b7992073ccf00b43d',
+   *     },
+   *     public_credential: 'example-user',
+   *   },
+   *   domain: 'docker.io',
+   *   kind: 'ECR',
+   * });
+   * ```
+   */
+  create(params: RegistryCreateParams, options?: RequestOptions): APIPromise<RegistryCreateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(path`/accounts/${account_id}/containers/registries`, {
+        body,
+        ...options,
+      }) as APIPromise<{ result: RegistryCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Get the list of configured registries in the account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const registryListResponse of client.containers.registries.list(
+   *   { account_id: 'account-123' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: RegistryListParams,
+    options?: RequestOptions,
+  ): PagePromise<RegistryListResponsesSinglePage, RegistryListResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      path`/accounts/${account_id}/containers/registries`,
+      SinglePage<RegistryListResponse>,
+      options,
+    );
+  }
+
+  /**
+   * Delete a registry from the account, this will prevent Containers from pulling
+   * images from the registry.
+   *
+   * @example
+   * ```ts
+   * const registry = await client.containers.registries.delete(
+   *   'domain',
+   *   { account_id: 'account-123' },
+   * );
+   * ```
+   */
+  delete(
+    domain: string,
+    params: RegistryDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<RegistryDeleteResponse> {
+    const { account_id } = params;
+    return (
+      this._client.delete(
+        path`/accounts/${account_id}/containers/registries/${domain}`,
+        options,
+      ) as APIPromise<{ result: RegistryDeleteResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+export class Registries extends BaseRegistries {
+  credentials: CredentialsAPI.Credentials = new CredentialsAPI.Credentials(this._client);
+}
+
+export type RegistryListResponsesSinglePage = SinglePage<RegistryListResponse>;
+
+/**
+ * An image registry added in a customer account.
+ */
+export interface RegistryCreateResponse {
+  /**
+   * UTC timestamp string in ISO 8601 format.
+   */
+  created_at: string;
+
+  /**
+   * A string representation of a domain name. See RFC-1034
+   * (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name
+   * is min 3 and max 253 ASCII characters.
+   */
+  domain: string;
+
+  /**
+   * The type of registry that is being configured.
+   */
+  kind?: 'ECR' | 'DockerHub' | 'GAR' | 'default';
+
+  /**
+   * Public component of the registry credentials. For managed registries this is a
+   * base64-encoded public key; for external registries the format depends on the
+   * registry provider.
+   */
+  public_key?: string;
+}
+
+/**
+ * An image registry added in a customer account.
+ */
+export interface RegistryListResponse {
+  /**
+   * UTC timestamp string in ISO 8601 format.
+   */
+  created_at: string;
+
+  /**
+   * A string representation of a domain name. See RFC-1034
+   * (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name
+   * is min 3 and max 253 ASCII characters.
+   */
+  domain: string;
+
+  /**
+   * The type of registry that is being configured.
+   */
+  kind?: 'ECR' | 'DockerHub' | 'GAR' | 'default';
+
+  /**
+   * Public component of the registry credentials. For managed registries this is a
+   * base64-encoded public key; for external registries the format depends on the
+   * registry provider.
+   */
+  public_key?: string;
+}
+
+/**
+ * Result of deleting an image registry from a Containers account.
+ */
+export interface RegistryDeleteResponse {
+  /**
+   * A string representation of a domain name. See RFC-1034
+   * (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name
+   * is min 3 and max 253 ASCII characters.
+   */
+  domain: string;
+}
+
+export interface RegistryCreateParams {
+  /**
+   * Path param: Account identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: Credentials for authenticating to a private external image registry.
+   * Store the private credential in
+   * [Secrets Store](https://developers.cloudflare.com/secrets-store/) before calling
+   * the API. Refer to
+   * [Image management](https://developers.cloudflare.com/containers/platform-details/image-management/)
+   * for the credential required by each supported registry provider.
+   */
+  auth: RegistryCreateParams.Auth;
+
+  /**
+   * Body param: Hostname of the private registry, without a scheme or image path.
+   * Supported hostnames are `docker.io`, AWS ECR hostnames, and Google Artifact
+   * Registry `*-docker.pkg.dev` hostnames.
+   */
+  domain: string;
+
+  /**
+   * Body param: Registry provider. This must match `domain`: `DockerHub` for
+   * `docker.io`, `ECR` for AWS ECR, or `GAR` for Google Artifact Registry.
+   */
+  kind: 'ECR' | 'DockerHub' | 'GAR';
+
+  /**
+   * Body param: Omit this field or set it to `false`. Public Docker Hub images do
+   * not require registry configuration and cannot be added with this endpoint.
+   */
+  is_public?: false;
+}
+
+export namespace RegistryCreateParams {
+  /**
+   * Credentials for authenticating to a private external image registry. Store the
+   * private credential in
+   * [Secrets Store](https://developers.cloudflare.com/secrets-store/) before calling
+   * the API. Refer to
+   * [Image management](https://developers.cloudflare.com/containers/platform-details/image-management/)
+   * for the credential required by each supported registry provider.
+   */
+  export interface Auth {
+    /**
+     * A reference to the private registry credential in Secrets Store. The referenced
+     * secret must have the `containers` scope. Raw secret values are not accepted.
+     */
+    private_credential: Auth.PrivateCredential;
+
+    /**
+     * The non-secret part of the registry credential: an AWS access key ID for ECR, a
+     * username for Docker Hub, or a service account email for Google Artifact
+     * Registry.
+     */
+    public_credential: string;
+  }
+
+  export namespace Auth {
+    /**
+     * A reference to the private registry credential in Secrets Store. The referenced
+     * secret must have the `containers` scope. Raw secret values are not accepted.
+     */
+    export interface PrivateCredential {
+      /**
+       * Name of the secret within the store.
+       */
+      secret_name: string;
+
+      /**
+       * Identifier of the Secrets Store containing the secret.
+       */
+      store_id: string;
+    }
+  }
+}
+
+export interface RegistryListParams {
+  /**
+   * Account identifier.
+   */
+  account_id: string;
+}
+
+export interface RegistryDeleteParams {
+  /**
+   * Account identifier.
+   */
+  account_id: string;
+}
+
+Registries.Credentials = Credentials;
+Registries.BaseCredentials = BaseCredentials;
+
+export declare namespace Registries {
+  export {
+    type RegistryCreateResponse as RegistryCreateResponse,
+    type RegistryListResponse as RegistryListResponse,
+    type RegistryDeleteResponse as RegistryDeleteResponse,
+    type RegistryListResponsesSinglePage as RegistryListResponsesSinglePage,
+    type RegistryCreateParams as RegistryCreateParams,
+    type RegistryListParams as RegistryListParams,
+    type RegistryDeleteParams as RegistryDeleteParams,
+  };
+
+  export {
+    Credentials as Credentials,
+    BaseCredentials as BaseCredentials,
+    type CredentialGenerateResponse as CredentialGenerateResponse,
+    type CredentialGenerateParams as CredentialGenerateParams,
+  };
+}

package/src/resources/containers/registries.ts

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

package/src/resources/containers.ts

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

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

@@ -76,7 +76,7 @@ export class BaseCustomCertificates extends APIResource {
    * ```ts
    * const customCertificate =
    *   await client.customCertificates.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -104,7 +104,7 @@ export class BaseCustomCertificates extends APIResource {
    * ```ts
    * const customCertificate =
    *   await client.customCertificates.edit(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -132,7 +132,7 @@ export class BaseCustomCertificates extends APIResource {
    * ```ts
    * const customCertificate =
    *   await client.customCertificates.get(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '2458ce5a-0c35-4c7f-82c7-8e9487d3ff60',
    *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -161,7 +161,7 @@ export type CustomCertificatesSinglePage = SinglePage<CustomCertificate>;
 
 export interface CustomCertificate {
   /**
-   * Identifier.
+   * Custom certificate identifier tag.
    */
   id: string;
 
@@ -276,7 +276,7 @@ export interface GeoRestrictionsParam {
 
 export interface CustomCertificateDeleteResponse {
   /**
-   * Identifier.
+   * Custom certificate identifier tag.
    */
   id?: string;
 }

package/src/resources/custom-certificates/prioritize.ts

@@ -60,7 +60,7 @@ export interface PrioritizeUpdateParams {
 export namespace PrioritizeUpdateParams {
   export interface Certificate {
     /**
-     * Identifier.
+     * Custom certificate identifier tag.
      */
     id?: string;
 

package/src/resources/custom-hostnames/certificate-pack/certificates.ts

@@ -21,13 +21,13 @@ export class BaseCertificates extends APIResource {
    * ```ts
    * const certificate =
    *   await client.customHostnames.certificatePack.certificates.update(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *     {
    *       zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       custom_hostname_id:
-   *         '023e105f4ecef8ad9ca31a8372d0c353',
+   *         '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *       certificate_pack_id:
-   *         '023e105f4ecef8ad9ca31a8372d0c353',
+   *         '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *       custom_certificate:
    *         '-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n',
    *       custom_key:
@@ -60,13 +60,13 @@ export class BaseCertificates extends APIResource {
    * ```ts
    * const certificate =
    *   await client.customHostnames.certificatePack.certificates.delete(
-   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *     {
    *       zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       custom_hostname_id:
-   *         '023e105f4ecef8ad9ca31a8372d0c353',
+   *         '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *       certificate_pack_id:
-   *         '023e105f4ecef8ad9ca31a8372d0c353',
+   *         '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *     },
    *   );
    * ```
@@ -87,7 +87,7 @@ export class Certificates extends BaseCertificates {}
 
 export interface CertificateUpdateResponse {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id: string;
 
@@ -454,7 +454,7 @@ export namespace CertificateUpdateResponse {
 
 export interface CertificateDeleteResponse {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id?: string;
 }
@@ -466,12 +466,12 @@ export interface CertificateUpdateParams {
   zone_id: string;
 
   /**
-   * Path param: Identifier.
+   * Path param: Custom hostname identifier tag.
    */
   custom_hostname_id: string;
 
   /**
-   * Path param: Identifier.
+   * Path param: Custom hostname identifier tag.
    */
   certificate_pack_id: string;
 
@@ -493,12 +493,12 @@ export interface CertificateDeleteParams {
   zone_id: string;
 
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   custom_hostname_id: string;
 
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   certificate_pack_id: string;
 }

package/src/resources/custom-hostnames/custom-hostnames.ts

@@ -90,7 +90,7 @@ export class BaseCustomHostnames extends APIResource {
    * @example
    * ```ts
    * const customHostname = await client.customHostnames.delete(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -116,7 +116,7 @@ export class BaseCustomHostnames extends APIResource {
    * @example
    * ```ts
    * const response = await client.customHostnames.edit(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -142,7 +142,7 @@ export class BaseCustomHostnames extends APIResource {
    * @example
    * ```ts
    * const customHostname = await client.customHostnames.get(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   '0d89c70d-ad9f-4843-b99f-6cc0252067e9',
    *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -187,7 +187,7 @@ export type BundleMethodParam = 'ubiquitous' | 'optimal' | 'force';
 
 export interface CustomHostname {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id: string;
 
@@ -576,7 +576,7 @@ export type DomainValidationTypeParam = 'dv';
 
 export interface CustomHostnameCreateResponse {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id: string;
 
@@ -943,7 +943,7 @@ export namespace CustomHostnameCreateResponse {
 
 export interface CustomHostnameListResponse {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id: string;
 
@@ -1310,14 +1310,14 @@ export namespace CustomHostnameListResponse {
 
 export interface CustomHostnameDeleteResponse {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id?: string;
 }
 
 export interface CustomHostnameEditResponse {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id: string;
 
@@ -1684,7 +1684,7 @@ export namespace CustomHostnameEditResponse {
 
 export interface CustomHostnameGetResponse {
   /**
-   * Identifier.
+   * Custom hostname identifier tag.
    */
   id: string;
 

package/src/resources/dns/settings/zone.ts

@@ -79,9 +79,12 @@ export interface ZoneEditResponse {
   multi_provider: boolean;
 
   /**
-   * Settings determining the nameservers through which the zone should be available.
+   * Controls the nameservers through which the zone is available.
    */
-  nameservers: ZoneEditResponse.Nameservers;
+  nameservers:
+    | ZoneEditResponse.DNSSettingsZoneNameserversCloudflare
+    | ZoneEditResponse.DNSSettingsZoneNameserversCustomExisting
+    | ZoneEditResponse.DNSSettingsZoneNameserversCustomSet;
 
   /**
    * The time to live (TTL) of the zone's nameserver (NS) records.
@@ -116,21 +119,37 @@ export namespace ZoneEditResponse {
     reference_zone_id?: string;
   }
 
-  /**
-   * Settings determining the nameservers through which the zone should be available.
-   */
-  export interface Nameservers {
+  export interface DNSSettingsZoneNameserversCloudflare {
+    /**
+     * Nameserver type.
+     */
+    type: 'cloudflare.standard' | 'cloudflare.advanced';
+  }
+
+  export interface DNSSettingsZoneNameserversCustomExisting {
     /**
-     * Nameserver type
+     * Nameserver type.
      */
-    type: 'cloudflare.standard' | 'cloudflare.advanced' | 'custom.account' | 'custom.tenant' | 'custom.zone';
+    type: 'custom.account' | 'custom.tenant' | 'custom.zone';
 
     /**
-     * Configured nameserver set to be used for this zone
+     * Configured nameserver set number to use for this zone.
      */
     ns_set?: number;
   }
 
+  export interface DNSSettingsZoneNameserversCustomSet {
+    /**
+     * Identifier of the account-owned Custom Nameserver Set to use for this zone.
+     */
+    nameserver_set_id: string;
+
+    /**
+     * Nameserver type.
+     */
+    type: 'custom';
+  }
+
   /**
    * Components of the zone's SOA record.
    */
@@ -204,9 +223,12 @@ export interface ZoneGetResponse {
   multi_provider: boolean;
 
   /**
-   * Settings determining the nameservers through which the zone should be available.
+   * Controls the nameservers through which the zone is available.
    */
-  nameservers: ZoneGetResponse.Nameservers;
+  nameservers:
+    | ZoneGetResponse.DNSSettingsZoneNameserversCloudflare
+    | ZoneGetResponse.DNSSettingsZoneNameserversCustomExisting
+    | ZoneGetResponse.DNSSettingsZoneNameserversCustomSet;
 
   /**
    * The time to live (TTL) of the zone's nameserver (NS) records.
@@ -241,21 +263,37 @@ export namespace ZoneGetResponse {
     reference_zone_id?: string;
   }
 
-  /**
-   * Settings determining the nameservers through which the zone should be available.
-   */
-  export interface Nameservers {
+  export interface DNSSettingsZoneNameserversCloudflare {
     /**
-     * Nameserver type
+     * Nameserver type.
      */
-    type: 'cloudflare.standard' | 'cloudflare.advanced' | 'custom.account' | 'custom.tenant' | 'custom.zone';
+    type: 'cloudflare.standard' | 'cloudflare.advanced';
+  }
 
+  export interface DNSSettingsZoneNameserversCustomExisting {
     /**
-     * Configured nameserver set to be used for this zone
+     * Nameserver type.
+     */
+    type: 'custom.account' | 'custom.tenant' | 'custom.zone';
+
+    /**
+     * Configured nameserver set number to use for this zone.
      */
     ns_set?: number;
   }
 
+  export interface DNSSettingsZoneNameserversCustomSet {
+    /**
+     * Identifier of the account-owned Custom Nameserver Set to use for this zone.
+     */
+    nameserver_set_id: string;
+
+    /**
+     * Nameserver type.
+     */
+    type: 'custom';
+  }
+
   /**
    * Components of the zone's SOA record.
    */
@@ -334,10 +372,12 @@ export interface ZoneEditParams {
   multi_provider?: boolean;
 
   /**
-   * Body param: Settings determining the nameservers through which the zone should
-   * be available.
+   * Body param: Controls the nameservers through which the zone is available.
    */
-  nameservers?: ZoneEditParams.Nameservers;
+  nameservers?:
+    | ZoneEditParams.DNSSettingsZoneNameserversCloudflare
+    | ZoneEditParams.DNSSettingsZoneNameserversCustomExisting
+    | ZoneEditParams.DNSSettingsZoneNameserversCustomSet;
 
   /**
    * Body param: The time to live (TTL) of the zone's nameserver (NS) records.
@@ -372,19 +412,35 @@ export namespace ZoneEditParams {
     reference_zone_id?: string;
   }
 
-  /**
-   * Settings determining the nameservers through which the zone should be available.
-   */
-  export interface Nameservers {
+  export interface DNSSettingsZoneNameserversCloudflare {
     /**
-     * Configured nameserver set to be used for this zone
+     * Nameserver type.
+     */
+    type: 'cloudflare.standard' | 'cloudflare.advanced';
+  }
+
+  export interface DNSSettingsZoneNameserversCustomExisting {
+    /**
+     * Nameserver type.
+     */
+    type: 'custom.account' | 'custom.tenant' | 'custom.zone';
+
+    /**
+     * Configured nameserver set number to use for this zone.
      */
     ns_set?: number;
+  }
+
+  export interface DNSSettingsZoneNameserversCustomSet {
+    /**
+     * Identifier of the account-owned Custom Nameserver Set to use for this zone.
+     */
+    nameserver_set_id: string;
 
     /**
-     * Nameserver type
+     * Nameserver type.
      */
-    type?: 'cloudflare.standard' | 'cloudflare.advanced' | 'custom.account' | 'custom.tenant' | 'custom.zone';
+    type: 'custom';
   }
 
   /**