cloudflare
Version:
The official TypeScript library for the Cloudflare API
737 lines • 33.1 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as WorkersAPI from "../workers.js";
import * as ContentAPI from "./content.js";
import { Content, ContentGetParams, ContentUpdateParams } from "./content.js";
import * as DeploymentsAPI from "./deployments.js";
import { Deployment, DeploymentCreateParams, DeploymentCreateResponse, DeploymentGetParams, DeploymentGetResponse, Deployments } from "./deployments.js";
import * as SchedulesAPI from "./schedules.js";
import { Schedule, ScheduleGetParams, ScheduleGetResponse, ScheduleUpdateParams, ScheduleUpdateResponse, Schedules } from "./schedules.js";
import * as SecretsAPI from "./secrets.js";
import { SecretDeleteParams, SecretDeleteResponse, SecretGetParams, SecretGetResponse, SecretListParams, SecretListResponse, SecretListResponsesSinglePage, SecretUpdateParams, SecretUpdateResponse, Secrets } from "./secrets.js";
import * as SettingsAPI from "./settings.js";
import { SettingEditParams, SettingGetParams, Settings } from "./settings.js";
import * as SubdomainAPI from "./subdomain.js";
import { Subdomain, SubdomainCreateParams, SubdomainCreateResponse, SubdomainGetParams, SubdomainGetResponse } from "./subdomain.js";
import * as TailAPI from "./tail.js";
import { ConsumerScript, Tail, TailCreateParams, TailCreateResponse, TailDeleteParams, TailDeleteResponse, TailGetParams, TailGetResponse } from "./tail.js";
import * as VersionsAPI from "./versions.js";
import { VersionCreateParams, VersionCreateResponse, VersionGetParams, VersionGetResponse, VersionListParams, VersionListResponse, VersionListResponsesV4PagePagination, Versions } from "./versions.js";
import * as AssetsAPI from "./assets/assets.js";
import { Assets as AssetsAPIAssets } from "./assets/assets.js";
import { SinglePage } from "../../../pagination.js";
export declare class Scripts extends APIResource {
assets: AssetsAPI.Assets;
subdomain: SubdomainAPI.Subdomain;
schedules: SchedulesAPI.Schedules;
tail: TailAPI.Tail;
content: ContentAPI.Content;
settings: SettingsAPI.Settings;
deployments: DeploymentsAPI.Deployments;
versions: VersionsAPI.Versions;
secrets: SecretsAPI.Secrets;
/**
* Upload a worker module. You can find more about the multipart metadata on our
* docs:
* https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.
*/
update(scriptName: string, params: ScriptUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ScriptUpdateResponse>;
/**
* Fetch a list of uploaded workers.
*/
list(params: ScriptListParams, options?: Core.RequestOptions): Core.PagePromise<ScriptsSinglePage, Script>;
/**
* Delete your worker. This call has no response body on a successful delete.
*/
delete(scriptName: string, params: ScriptDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void>;
/**
* Fetch raw script content for your worker. Note this is the original script
* content, not JSON encoded.
*/
get(scriptName: string, params: ScriptGetParams, options?: Core.RequestOptions): Core.APIPromise<string>;
}
export declare class ScriptsSinglePage extends SinglePage<Script> {
}
export interface Script {
/**
* The id of the script in the Workers system. Usually the script name.
*/
id?: string;
/**
* When the script was created.
*/
created_on?: string;
/**
* Hashed script content, can be used in a If-None-Match header when updating.
*/
etag?: string;
/**
* Whether a Worker contains assets.
*/
has_assets?: boolean;
/**
* Whether a Worker contains modules.
*/
has_modules?: boolean;
/**
* Whether Logpush is turned on for the Worker.
*/
logpush?: boolean;
/**
* When the script was last modified.
*/
modified_on?: string;
/**
* Configuration for
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
placement?: Script.Placement;
/**
* @deprecated Enables
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
placement_mode?: 'smart';
/**
* @deprecated Status of
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
placement_status?: 'SUCCESS' | 'UNSUPPORTED_APPLICATION' | 'INSUFFICIENT_INVOCATIONS';
/**
* List of Workers that will consume logs from the attached Worker.
*/
tail_consumers?: Array<TailAPI.ConsumerScript>;
/**
* Usage model for the Worker invocations.
*/
usage_model?: 'standard';
}
export declare namespace Script {
/**
* Configuration for
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
interface Placement {
/**
* Enables
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
mode?: 'smart';
/**
* Status of
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
status?: 'SUCCESS' | 'UNSUPPORTED_APPLICATION' | 'INSUFFICIENT_INVOCATIONS';
}
}
export interface ScriptSetting {
/**
* Whether Logpush is turned on for the Worker.
*/
logpush?: boolean;
/**
* Observability settings for the Worker.
*/
observability?: ScriptSetting.Observability;
/**
* List of Workers that will consume logs from the attached Worker.
*/
tail_consumers?: Array<TailAPI.ConsumerScript>;
}
export declare namespace ScriptSetting {
/**
* Observability settings for the Worker.
*/
interface Observability {
/**
* Whether observability is enabled for the Worker.
*/
enabled: boolean;
/**
* The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
* Default is 1.
*/
head_sampling_rate?: number | null;
}
}
export interface ScriptUpdateResponse {
/**
* The id of the script in the Workers system. Usually the script name.
*/
id?: string;
/**
* When the script was created.
*/
created_on?: string;
/**
* Hashed script content, can be used in a If-None-Match header when updating.
*/
etag?: string;
/**
* Whether a Worker contains assets.
*/
has_assets?: boolean;
/**
* Whether a Worker contains modules.
*/
has_modules?: boolean;
/**
* Whether Logpush is turned on for the Worker.
*/
logpush?: boolean;
/**
* When the script was last modified.
*/
modified_on?: string;
/**
* Configuration for
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
placement?: ScriptUpdateResponse.Placement;
/**
* @deprecated Enables
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
placement_mode?: 'smart';
/**
* @deprecated Status of
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
placement_status?: 'SUCCESS' | 'UNSUPPORTED_APPLICATION' | 'INSUFFICIENT_INVOCATIONS';
startup_time_ms?: number;
/**
* List of Workers that will consume logs from the attached Worker.
*/
tail_consumers?: Array<TailAPI.ConsumerScript>;
/**
* Usage model for the Worker invocations.
*/
usage_model?: 'standard';
}
export declare namespace ScriptUpdateResponse {
/**
* Configuration for
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
interface Placement {
/**
* Enables
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
mode?: 'smart';
/**
* Status of
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
status?: 'SUCCESS' | 'UNSUPPORTED_APPLICATION' | 'INSUFFICIENT_INVOCATIONS';
}
}
export type ScriptGetResponse = string;
export interface ScriptUpdateParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Body param: JSON encoded metadata about the uploaded parts and Worker
* configuration.
*/
metadata: ScriptUpdateParams.Metadata;
}
export declare namespace ScriptUpdateParams {
/**
* JSON encoded metadata about the uploaded parts and Worker configuration.
*/
interface Metadata {
/**
* Configuration for assets within a Worker
*/
assets?: Metadata.Assets;
/**
* List of bindings attached to a Worker. You can find more about bindings on our
* docs:
* https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
*/
bindings?: Array<Metadata.WorkersBindingKindAI | Metadata.WorkersBindingKindAnalyticsEngine | Metadata.WorkersBindingKindAssets | Metadata.WorkersBindingKindBrowserRendering | Metadata.WorkersBindingKindD1 | Metadata.WorkersBindingKindDispatchNamespace | Metadata.WorkersBindingKindDurableObjectNamespace | Metadata.WorkersBindingKindHyperdrive | Metadata.WorkersBindingKindJson | Metadata.WorkersBindingKindKVNamespace | Metadata.WorkersBindingKindMTLSCertificate | Metadata.WorkersBindingKindPlainText | Metadata.WorkersBindingKindQueue | Metadata.WorkersBindingKindR2Bucket | Metadata.WorkersBindingKindSecretText | Metadata.WorkersBindingKindService | Metadata.WorkersBindingKindTailConsumer | Metadata.WorkersBindingKindVectorize | Metadata.WorkersBindingKindVersionMetadata>;
/**
* Name of the part in the multipart request that contains the script (e.g. the
* file adding a listener to the `fetch` event). Indicates a
* `service worker syntax` Worker.
*/
body_part?: string;
/**
* Date indicating targeted support in the Workers runtime. Backwards incompatible
* fixes to the runtime following this date will not affect this Worker.
*/
compatibility_date?: string;
/**
* Flags that enable or disable certain features in the Workers runtime. Used to
* enable upcoming features or opt in or out of specific changes not included in a
* `compatibility_date`.
*/
compatibility_flags?: Array<string>;
/**
* Retain assets which exist for a previously uploaded Worker version; used in lieu
* of providing a completion token.
*/
keep_assets?: boolean;
/**
* List of binding types to keep from previous_upload.
*/
keep_bindings?: Array<string>;
/**
* Whether Logpush is turned on for the Worker.
*/
logpush?: boolean;
/**
* Name of the part in the multipart request that contains the main module (e.g.
* the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
*/
main_module?: string;
/**
* Migrations to apply for Durable Objects associated with this Worker.
*/
migrations?: WorkersAPI.SingleStepMigrationParam | Metadata.WorkersMultipleStepMigrations;
/**
* Observability settings for the Worker.
*/
observability?: Metadata.Observability;
/**
* Configuration for
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
placement?: Metadata.Placement;
/**
* List of strings to use as tags for this Worker.
*/
tags?: Array<string>;
/**
* List of Workers that will consume logs from the attached Worker.
*/
tail_consumers?: Array<TailAPI.ConsumerScriptParam>;
/**
* Usage model for the Worker invocations.
*/
usage_model?: 'standard';
}
namespace Metadata {
/**
* Configuration for assets within a Worker
*/
interface Assets {
/**
* Configuration for assets within a Worker.
*/
config?: Assets.Config;
/**
* Token provided upon successful upload of all files from a registered manifest.
*/
jwt?: string;
}
namespace Assets {
/**
* Configuration for assets within a Worker.
*/
interface Config {
/**
* Determines the redirects and rewrites of requests for HTML content.
*/
html_handling?: 'auto-trailing-slash' | 'force-trailing-slash' | 'drop-trailing-slash' | 'none';
/**
* Determines the response when a request does not match a static asset, and there
* is no Worker script.
*/
not_found_handling?: 'none' | '404-page' | 'single-page-application';
/**
* When true, requests will always invoke the Worker script. Otherwise, attempt to
* serve an asset matching the request, falling back to the Worker script.
*/
run_worker_first?: boolean;
/**
* @deprecated When true and the incoming request matches an asset, that will be
* served instead of invoking the Worker script. When false, requests will always
* invoke the Worker script.
*/
serve_directly?: boolean;
}
}
interface WorkersBindingKindAI {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindAnalyticsEngine {
/**
* The name of the dataset to bind to.
*/
dataset: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindAssets {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindBrowserRendering {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindD1 {
/**
* Identifier of the D1 database to bind to.
*/
id: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindDispatchNamespace {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* Namespace to bind to.
*/
namespace: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
/**
* Outbound worker.
*/
outbound?: WorkersBindingKindDispatchNamespace.Outbound;
}
namespace WorkersBindingKindDispatchNamespace {
/**
* Outbound worker.
*/
interface Outbound {
/**
* Pass information from the Dispatch Worker to the Outbound Worker through the
* parameters.
*/
params?: Array<string>;
/**
* Outbound worker.
*/
worker?: Outbound.Worker;
}
namespace Outbound {
/**
* Outbound worker.
*/
interface Worker {
/**
* Environment of the outbound worker.
*/
environment?: string;
/**
* Name of the outbound worker.
*/
service?: string;
}
}
}
interface WorkersBindingKindDurableObjectNamespace {
/**
* The exported class name of the Durable Object.
*/
class_name: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
/**
* The environment of the script_name to bind to.
*/
environment?: string;
/**
* Namespace identifier tag.
*/
namespace_id?: string;
/**
* The script where the Durable Object is defined, if it is external to this
* Worker.
*/
script_name?: string;
}
interface WorkersBindingKindHyperdrive {
/**
* Identifier of the Hyperdrive connection to bind to.
*/
id: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindJson {
/**
* JSON data to use.
*/
json: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindKVNamespace {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* Namespace identifier tag.
*/
namespace_id: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindMTLSCertificate {
/**
* Identifier of the certificate to bind to.
*/
certificate_id: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindPlainText {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The text value to use.
*/
text: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindQueue {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* Name of the Queue to bind to.
*/
queue_name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindR2Bucket {
/**
* R2 bucket to bind to.
*/
bucket_name: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindSecretText {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The secret value to use.
*/
text: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindService {
/**
* Optional environment if the Worker utilizes one.
*/
environment: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* Name of Worker to bind to.
*/
service: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindTailConsumer {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* Name of Tail Worker to bind to.
*/
service: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindVectorize {
/**
* Name of the Vectorize index to bind to.
*/
index_name: string;
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersBindingKindVersionMetadata {
/**
* A JavaScript variable name for the binding.
*/
name: string;
/**
* The kind of resource that the binding provides.
*/
type: 'ai' | 'analytics_engine' | 'assets' | 'browser_rendering' | 'd1' | 'dispatch_namespace' | 'durable_object_namespace' | 'hyperdrive' | 'json' | 'kv_namespace' | 'mtls_certificate' | 'plain_text' | 'queue' | 'r2_bucket' | 'secret_text' | 'service' | 'tail_consumer' | 'vectorize' | 'version_metadata';
}
interface WorkersMultipleStepMigrations {
/**
* Tag to set as the latest migration tag.
*/
new_tag?: string;
/**
* Tag used to verify against the latest migration tag for this Worker. If they
* don't match, the upload is rejected.
*/
old_tag?: string;
/**
* Migrations to apply in order.
*/
steps?: Array<WorkersAPI.MigrationStepParam>;
}
/**
* Observability settings for the Worker.
*/
interface Observability {
/**
* Whether observability is enabled for the Worker.
*/
enabled: boolean;
/**
* The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
* Default is 1.
*/
head_sampling_rate?: number | null;
}
/**
* Configuration for
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
interface Placement {
/**
* Enables
* [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
*/
mode?: 'smart';
}
}
}
export interface ScriptListParams {
/**
* Identifier
*/
account_id: string;
}
export interface ScriptDeleteParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Query param: If set to true, delete will not be stopped by associated service
* binding, durable object, or other binding. Any of these associated
* bindings/durable objects will be deleted along with the script.
*/
force?: boolean;
}
export interface ScriptGetParams {
/**
* Identifier
*/
account_id: string;
}
export declare namespace Scripts {
export { type Script as Script, type ScriptSetting as ScriptSetting, type ScriptUpdateResponse as ScriptUpdateResponse, type ScriptGetResponse as ScriptGetResponse, ScriptsSinglePage as ScriptsSinglePage, type ScriptUpdateParams as ScriptUpdateParams, type ScriptListParams as ScriptListParams, type ScriptDeleteParams as ScriptDeleteParams, type ScriptGetParams as ScriptGetParams, };
export { AssetsAPIAssets as Assets };
export { Subdomain as Subdomain, type SubdomainCreateResponse as SubdomainCreateResponse, type SubdomainGetResponse as SubdomainGetResponse, type SubdomainCreateParams as SubdomainCreateParams, type SubdomainGetParams as SubdomainGetParams, };
export { Schedules as Schedules, type Schedule as Schedule, type ScheduleUpdateResponse as ScheduleUpdateResponse, type ScheduleGetResponse as ScheduleGetResponse, type ScheduleUpdateParams as ScheduleUpdateParams, type ScheduleGetParams as ScheduleGetParams, };
export { Tail as Tail, type ConsumerScript as ConsumerScript, type TailCreateResponse as TailCreateResponse, type TailDeleteResponse as TailDeleteResponse, type TailGetResponse as TailGetResponse, type TailCreateParams as TailCreateParams, type TailDeleteParams as TailDeleteParams, type TailGetParams as TailGetParams, };
export { Content as Content, type ContentUpdateParams as ContentUpdateParams, type ContentGetParams as ContentGetParams, };
export { Settings as Settings, type SettingEditParams as SettingEditParams, type SettingGetParams as SettingGetParams, };
export { Deployments as Deployments, type Deployment as Deployment, type DeploymentCreateResponse as DeploymentCreateResponse, type DeploymentGetResponse as DeploymentGetResponse, type DeploymentCreateParams as DeploymentCreateParams, type DeploymentGetParams as DeploymentGetParams, };
export { Versions as Versions, type VersionCreateResponse as VersionCreateResponse, type VersionListResponse as VersionListResponse, type VersionGetResponse as VersionGetResponse, VersionListResponsesV4PagePagination as VersionListResponsesV4PagePagination, type VersionCreateParams as VersionCreateParams, type VersionListParams as VersionListParams, type VersionGetParams as VersionGetParams, };
export { Secrets as Secrets, type SecretUpdateResponse as SecretUpdateResponse, type SecretListResponse as SecretListResponse, type SecretDeleteResponse as SecretDeleteResponse, type SecretGetResponse as SecretGetResponse, SecretListResponsesSinglePage as SecretListResponsesSinglePage, type SecretUpdateParams as SecretUpdateParams, type SecretListParams as SecretListParams, type SecretDeleteParams as SecretDeleteParams, type SecretGetParams as SecretGetParams, };
}
//# sourceMappingURL=scripts.d.ts.map