cloudflare 7.2.0 → 7.3.0

package/src/resources/containers/applications/versions.ts

@@ -0,0 +1,177 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { PagePromise, SinglePage } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class BaseVersions extends APIResource {
+  static override readonly _key: readonly ['containers', 'applications', 'versions'] = Object.freeze([
+    'containers',
+    'applications',
+    'versions',
+  ] as const);
+
+  /**
+   * Returns all versions for a scheduler-backed application with
+   * `scheduling_policy: "default"`. Versions and rollouts do not apply to
+   * applications with `scheduling_policy: "durable_object"`.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const versionListResponse of client.containers.applications.versions.list(
+   *   'application_id',
+   *   { account_id: 'account-123' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    applicationID: string,
+    params: VersionListParams,
+    options?: RequestOptions,
+  ): PagePromise<VersionListResponsesSinglePage, VersionListResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      path`/accounts/${account_id}/containers/applications/${applicationID}/versions`,
+      SinglePage<VersionListResponse>,
+      options,
+    );
+  }
+}
+export class Versions extends BaseVersions {}
+
+export type VersionListResponsesSinglePage = SinglePage<VersionListResponse>;
+
+/**
+ * An application with the configuration of its version.
+ */
+export interface VersionListResponse {
+  /**
+   * User-specified container configuration changes.
+   */
+  configuration: VersionListResponse.Configuration;
+
+  percentage: number;
+
+  version: number;
+}
+
+export namespace VersionListResponse {
+  /**
+   * User-specified container configuration changes.
+   */
+  export interface Configuration {
+    authorized_keys?: Array<Configuration.AuthorizedKey>;
+
+    /**
+     * The command that runs when the container starts, passed to the entrypoint. You
+     * can override this at run-time. If you override only the command, it gets passed
+     * to the default entrypoint specified in the image.
+     */
+    command?: Array<string>;
+
+    /**
+     * The entry point for the container, specifying the executable to run when the
+     * container starts. You can override this at run-time. If you do, the default
+     * command from the image is ignored. Specify both entrypoint and command at
+     * run-time to completely replace the image defaults.
+     */
+    entrypoint?: Array<string>;
+
+    /**
+     * Container environment variables.
+     */
+    environment_variables?: Array<Configuration.EnvironmentVariable>;
+
+    /**
+     * Image url.
+     */
+    image?: string;
+
+    /**
+     * The instance type configures vCPU, memory, and disk.
+     *
+     * - "lite": 1/16 vCPU, 256 MiB memory, 2 GB disk
+     * - "basic": 1/4 vCPU, 1 GiB memory, 4 GB disk
+     * - "standard-1": 1/2 vCPU, 4 GiB memory, 8 GB disk
+     * - "standard-2": 1 vCPU, 6 GiB memory, 12 GB disk
+     * - "standard-3": 2 vCPU, 8 GiB memory, 16 GB disk
+     * - "standard-4": 4 vCPU, 12 GiB memory, 20 GB disk
+     */
+    instance_type?: 'lite' | 'basic' | 'standard-1' | 'standard-2' | 'standard-3' | 'standard-4';
+
+    /**
+     * Settings for deployment observability such as logging.
+     */
+    observability?: Configuration.Observability;
+  }
+
+  export namespace Configuration {
+    /**
+     * User-provided SSH public key.
+     */
+    export interface AuthorizedKey {
+      /**
+       * An SSH public key.
+       */
+      public_key: string;
+
+      /**
+       * Optional human readable name for this key.
+       */
+      name?: string;
+    }
+
+    /**
+     * An environment variable with a value set.
+     */
+    export interface EnvironmentVariable {
+      /**
+       * An environment variable name.
+       */
+      name: string;
+
+      /**
+       * An environment variable value.
+       */
+      value: string;
+    }
+
+    /**
+     * Settings for deployment observability such as logging.
+     */
+    export interface Observability {
+      /**
+       * Observability logging settings.
+       */
+      logs?: Observability.Logs;
+    }
+
+    export namespace Observability {
+      /**
+       * Observability logging settings.
+       */
+      export interface Logs {
+        enabled?: boolean;
+      }
+    }
+  }
+}
+
+export interface VersionListParams {
+  /**
+   * Account identifier.
+   */
+  account_id: string;
+}
+
+export declare namespace Versions {
+  export {
+    type VersionListResponse as VersionListResponse,
+    type VersionListResponsesSinglePage as VersionListResponsesSinglePage,
+    type VersionListParams as VersionListParams,
+  };
+}

package/src/resources/containers/applications.ts

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

package/src/resources/containers/containers.ts

@@ -0,0 +1,86 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ImagesAPI from './images';
+import { BaseImages, ImagePrepareParams, ImagePrepareResponse, Images } from './images';
+import * as ApplicationsAPI from './applications/applications';
+import {
+  ApplicationCreateParams,
+  ApplicationCreateResponse,
+  ApplicationDeleteParams,
+  ApplicationDeleteResponse,
+  ApplicationEditParams,
+  ApplicationEditResponse,
+  ApplicationGetParams,
+  ApplicationGetResponse,
+  ApplicationListParams,
+  ApplicationListResponse,
+  ApplicationListResponsesPageTokenPagination,
+  Applications,
+  BaseApplications,
+} from './applications/applications';
+import * as RegistriesAPI from './registries/registries';
+import {
+  BaseRegistries,
+  Registries,
+  RegistryCreateParams,
+  RegistryCreateResponse,
+  RegistryDeleteParams,
+  RegistryDeleteResponse,
+  RegistryListParams,
+  RegistryListResponse,
+  RegistryListResponsesSinglePage,
+} from './registries/registries';
+
+export class BaseContainers extends APIResource {
+  static override readonly _key: readonly ['containers'] = Object.freeze(['containers'] as const);
+}
+export class Containers extends BaseContainers {
+  applications: ApplicationsAPI.Applications = new ApplicationsAPI.Applications(this._client);
+  images: ImagesAPI.Images = new ImagesAPI.Images(this._client);
+  registries: RegistriesAPI.Registries = new RegistriesAPI.Registries(this._client);
+}
+
+Containers.Applications = Applications;
+Containers.BaseApplications = BaseApplications;
+Containers.Images = Images;
+Containers.BaseImages = BaseImages;
+Containers.Registries = Registries;
+Containers.BaseRegistries = BaseRegistries;
+
+export declare namespace Containers {
+  export {
+    Applications as Applications,
+    BaseApplications as BaseApplications,
+    type ApplicationCreateResponse as ApplicationCreateResponse,
+    type ApplicationListResponse as ApplicationListResponse,
+    type ApplicationDeleteResponse as ApplicationDeleteResponse,
+    type ApplicationEditResponse as ApplicationEditResponse,
+    type ApplicationGetResponse as ApplicationGetResponse,
+    type ApplicationListResponsesPageTokenPagination as ApplicationListResponsesPageTokenPagination,
+    type ApplicationCreateParams as ApplicationCreateParams,
+    type ApplicationListParams as ApplicationListParams,
+    type ApplicationDeleteParams as ApplicationDeleteParams,
+    type ApplicationEditParams as ApplicationEditParams,
+    type ApplicationGetParams as ApplicationGetParams,
+  };
+
+  export {
+    Images as Images,
+    BaseImages as BaseImages,
+    type ImagePrepareResponse as ImagePrepareResponse,
+    type ImagePrepareParams as ImagePrepareParams,
+  };
+
+  export {
+    Registries as Registries,
+    BaseRegistries as BaseRegistries,
+    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,
+  };
+}

package/src/resources/containers/images.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class BaseImages extends APIResource {
+  static override readonly _key: readonly ['containers', 'images'] = Object.freeze([
+    'containers',
+    'images',
+  ] as const);
+
+  /**
+   * Idempotently starts or observes preparation of the runtime artifacts required to
+   * run one digest-pinned managed container image on Cloudflare's network. Returns
+   * 202 while durable preparation continues and 200 when the image is ready or
+   * preparation has reached a terminal error.
+   *
+   * @example
+   * ```ts
+   * const response = await client.containers.images.prepare({
+   *   account_id: 'account-123',
+   *   image: 'image',
+   * });
+   * ```
+   */
+  prepare(params: ImagePrepareParams, options?: RequestOptions): APIPromise<ImagePrepareResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(path`/accounts/${account_id}/containers/image-preparations`, {
+        body,
+        ...options,
+      }) as APIPromise<{ result: ImagePrepareResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+export class Images extends BaseImages {}
+
+/**
+ * Durable preparation state for a container image.
+ */
+export interface ImagePrepareResponse {
+  /**
+   * Image url.
+   */
+  image: string;
+
+  /**
+   * Current durable preparation state for a container image.
+   */
+  status: 'pending' | 'ready' | 'error';
+
+  /**
+   * Digest of the prepared runtime artifact when status is ready.
+   */
+  artifact_digest?: string;
+
+  /**
+   * Human-readable pending or terminal error detail.
+   */
+  reason?: string;
+}
+
+export interface ImagePrepareParams {
+  /**
+   * Path param: Account identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: Image url.
+   */
+  image: string;
+}
+
+export declare namespace Images {
+  export { type ImagePrepareResponse as ImagePrepareResponse, type ImagePrepareParams as ImagePrepareParams };
+}

package/src/resources/containers/index.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Applications,
+  BaseApplications,
+  type ApplicationCreateResponse,
+  type ApplicationListResponse,
+  type ApplicationDeleteResponse,
+  type ApplicationEditResponse,
+  type ApplicationGetResponse,
+  type ApplicationCreateParams,
+  type ApplicationListParams,
+  type ApplicationDeleteParams,
+  type ApplicationEditParams,
+  type ApplicationGetParams,
+  type ApplicationListResponsesPageTokenPagination,
+} from './applications/index';
+export { Containers, BaseContainers } from './containers';
+export { Images, BaseImages, type ImagePrepareResponse, type ImagePrepareParams } from './images';
+export {
+  Registries,
+  BaseRegistries,
+  type RegistryCreateResponse,
+  type RegistryListResponse,
+  type RegistryDeleteResponse,
+  type RegistryCreateParams,
+  type RegistryListParams,
+  type RegistryDeleteParams,
+  type RegistryListResponsesSinglePage,
+} from './registries/index';

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

@@ -0,0 +1,95 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class BaseCredentials extends APIResource {
+  static override readonly _key: readonly ['containers', 'registries', 'credentials'] = Object.freeze([
+    'containers',
+    'registries',
+    'credentials',
+  ] as const);
+
+  /**
+   * Generates credentials for accessing a configured container image registry.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.containers.registries.credentials.generate(
+   *     'registry.cloudflare.com',
+   *     { account_id: 'account-123' },
+   *   );
+   * ```
+   */
+  generate(
+    domain: string,
+    params: CredentialGenerateParams,
+    options?: RequestOptions,
+  ): APIPromise<CredentialGenerateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(path`/accounts/${account_id}/containers/registries/${domain}/credentials`, {
+        body,
+        ...options,
+      }) as APIPromise<{ result: CredentialGenerateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+export class Credentials extends BaseCredentials {}
+
+/**
+ * Credentials returned for an authenticated registry configured on a Containers
+ * account.
+ */
+export interface CredentialGenerateResponse {
+  /**
+   * A unique identifier for the user's account.
+   */
+  account_id: string;
+
+  /**
+   * The password to use when authenticating to the image registry.
+   */
+  password: string;
+
+  /**
+   * The domain of the image registry these credentials target.
+   */
+  registry_host: string;
+
+  /**
+   * The username to use when authenticating to the image registry.
+   */
+  username: string;
+}
+
+export interface CredentialGenerateParams {
+  /**
+   * Path param: Account identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The number of minutes Cloudflare managed registry credentials stay
+   * valid. Required for managed registries and must remain positive. Cloudflare
+   * ignores this value for external registries.
+   */
+  expiration_minutes?: number;
+
+  /**
+   * Body param: The permissions for Cloudflare managed registry credentials.
+   * Required for managed registries. Cloudflare ignores this value for external
+   * registries.
+   */
+  permissions?: Array<'pull' | 'push' | 'list'>;
+}
+
+export declare namespace Credentials {
+  export {
+    type CredentialGenerateResponse as CredentialGenerateResponse,
+    type CredentialGenerateParams as CredentialGenerateParams,
+  };
+}

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

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Credentials,
+  BaseCredentials,
+  type CredentialGenerateResponse,
+  type CredentialGenerateParams,
+} from './credentials';
+export {
+  Registries,
+  BaseRegistries,
+  type RegistryCreateResponse,
+  type RegistryListResponse,
+  type RegistryDeleteResponse,
+  type RegistryCreateParams,
+  type RegistryListParams,
+  type RegistryDeleteParams,
+  type RegistryListResponsesSinglePage,
+} from './registries';