cloudflare
Version:
The official TypeScript library for the Cloudflare API
104 lines • 3.26 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as DeploymentsAPI from "./deployments.js";
export declare class Deployments extends APIResource {
/**
* Deployments configure how
* [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions)
* are deployed to traffic. A deployment can consist of one or two versions of a
* Worker.
*/
create(scriptName: string, params: DeploymentCreateParams, options?: Core.RequestOptions): Core.APIPromise<DeploymentCreateResponse>;
/**
* List of Worker Deployments. The first deployment in the list is the latest
* deployment actively serving traffic.
*/
get(scriptName: string, params: DeploymentGetParams, options?: Core.RequestOptions): Core.APIPromise<DeploymentGetResponse>;
}
export interface Deployment {
/**
* Human-readable message about the deployment. Truncated to 100 bytes.
*/
'workers/message'?: string;
}
export interface DeploymentParam {
/**
* Human-readable message about the deployment. Truncated to 100 bytes.
*/
'workers/message'?: string;
}
export interface DeploymentCreateResponse {
strategy: 'percentage';
versions: Array<DeploymentCreateResponse.Version>;
id?: string;
annotations?: Deployment;
author_email?: string;
created_on?: string;
source?: string;
}
export declare namespace DeploymentCreateResponse {
interface Version {
percentage: number;
version_id: string;
}
}
export interface DeploymentGetResponse {
deployments?: Array<DeploymentGetResponse.Deployment>;
}
export declare namespace DeploymentGetResponse {
interface Deployment {
strategy: 'percentage';
versions: Array<Deployment.Version>;
id?: string;
annotations?: DeploymentsAPI.Deployment;
author_email?: string;
created_on?: string;
source?: string;
}
namespace Deployment {
interface Version {
percentage: number;
version_id: string;
}
}
}
export interface DeploymentCreateParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Body param:
*/
strategy: 'percentage';
/**
* Body param:
*/
versions: Array<DeploymentCreateParams.Version>;
/**
* Query param: If set to true, the deployment will be created even if normally
* blocked by something such rolling back to an older version when a secret has
* changed.
*/
force?: boolean;
/**
* Body param:
*/
annotations?: DeploymentParam;
}
export declare namespace DeploymentCreateParams {
interface Version {
percentage: number;
version_id: string;
}
}
export interface DeploymentGetParams {
/**
* Identifier
*/
account_id: string;
}
export declare namespace Deployments {
export { type Deployment as Deployment, type DeploymentCreateResponse as DeploymentCreateResponse, type DeploymentGetResponse as DeploymentGetResponse, type DeploymentCreateParams as DeploymentCreateParams, type DeploymentGetParams as DeploymentGetParams, };
}
//# sourceMappingURL=deployments.d.ts.map