@distilled.cloud/vercel 0.0.0 → 1.0.0-rc.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/credentials.d.ts +21 -0
- package/lib/credentials.d.ts.map +1 -0
- package/lib/credentials.js +40 -0
- package/lib/credentials.js.map +1 -0
- package/lib/errors.d.ts +80 -0
- package/lib/errors.d.ts.map +1 -0
- package/lib/errors.js +50 -0
- package/lib/errors.js.map +1 -0
- package/lib/index.d.ts +15 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +15 -0
- package/lib/index.js.map +1 -0
- package/lib/protocol.d.ts +18 -0
- package/lib/protocol.d.ts.map +1 -0
- package/lib/protocol.js +69 -0
- package/lib/protocol.js.map +1 -0
- package/lib/retry.d.ts +54 -0
- package/lib/retry.d.ts.map +1 -0
- package/lib/retry.js +47 -0
- package/lib/retry.js.map +1 -0
- package/lib/services/access_groups.d.ts +459 -0
- package/lib/services/access_groups.d.ts.map +1 -0
- package/lib/services/access_groups.js +453 -0
- package/lib/services/access_groups.js.map +1 -0
- package/lib/services/ai_gateway.d.ts +124 -0
- package/lib/services/ai_gateway.d.ts.map +1 -0
- package/lib/services/ai_gateway.js +126 -0
- package/lib/services/ai_gateway.js.map +1 -0
- package/lib/services/aliases.d.ts +591 -0
- package/lib/services/aliases.d.ts.map +1 -0
- package/lib/services/aliases.js +508 -0
- package/lib/services/aliases.js.map +1 -0
- package/lib/services/artifacts.d.ts +228 -0
- package/lib/services/artifacts.d.ts.map +1 -0
- package/lib/services/artifacts.js +216 -0
- package/lib/services/artifacts.js.map +1 -0
- package/lib/services/authentication.d.ts +373 -0
- package/lib/services/authentication.d.ts.map +1 -0
- package/lib/services/authentication.js +310 -0
- package/lib/services/authentication.js.map +1 -0
- package/lib/services/billing.d.ts +792 -0
- package/lib/services/billing.d.ts.map +1 -0
- package/lib/services/billing.js +616 -0
- package/lib/services/billing.js.map +1 -0
- package/lib/services/bulk_redirects.d.ts +308 -0
- package/lib/services/bulk_redirects.d.ts.map +1 -0
- package/lib/services/bulk_redirects.js +306 -0
- package/lib/services/bulk_redirects.js.map +1 -0
- package/lib/services/certs.d.ts +171 -0
- package/lib/services/certs.d.ts.map +1 -0
- package/lib/services/certs.js +165 -0
- package/lib/services/certs.js.map +1 -0
- package/lib/services/checks_v2.d.ts +1162 -0
- package/lib/services/checks_v2.d.ts.map +1 -0
- package/lib/services/checks_v2.js +1252 -0
- package/lib/services/checks_v2.js.map +1 -0
- package/lib/services/connect.d.ts +1034 -0
- package/lib/services/connect.d.ts.map +1 -0
- package/lib/services/connect.js +993 -0
- package/lib/services/connect.js.map +1 -0
- package/lib/services/deployments.d.ts +9111 -0
- package/lib/services/deployments.d.ts.map +1 -0
- package/lib/services/deployments.js +8664 -0
- package/lib/services/deployments.js.map +1 -0
- package/lib/services/dns.d.ts +279 -0
- package/lib/services/dns.d.ts.map +1 -0
- package/lib/services/dns.js +282 -0
- package/lib/services/dns.js.map +1 -0
- package/lib/services/domains.d.ts +539 -0
- package/lib/services/domains.d.ts.map +1 -0
- package/lib/services/domains.js +464 -0
- package/lib/services/domains.js.map +1 -0
- package/lib/services/domains_registrar.d.ts +798 -0
- package/lib/services/domains_registrar.d.ts.map +1 -0
- package/lib/services/domains_registrar.js +968 -0
- package/lib/services/domains_registrar.js.map +1 -0
- package/lib/services/drains.d.ts +2263 -0
- package/lib/services/drains.d.ts.map +1 -0
- package/lib/services/drains.js +2406 -0
- package/lib/services/drains.js.map +1 -0
- package/lib/services/edge_cache.d.ts +125 -0
- package/lib/services/edge_cache.d.ts.map +1 -0
- package/lib/services/edge_cache.js +140 -0
- package/lib/services/edge_cache.js.map +1 -0
- package/lib/services/environment.d.ts +1020 -0
- package/lib/services/environment.d.ts.map +1 -0
- package/lib/services/environment.js +842 -0
- package/lib/services/environment.js.map +1 -0
- package/lib/services/feature_flags.d.ts +3109 -0
- package/lib/services/feature_flags.d.ts.map +1 -0
- package/lib/services/feature_flags.js +3074 -0
- package/lib/services/feature_flags.js.map +1 -0
- package/lib/services/global_config.d.ts +618 -0
- package/lib/services/global_config.d.ts.map +1 -0
- package/lib/services/global_config.js +716 -0
- package/lib/services/global_config.js.map +1 -0
- package/lib/services/index.d.ts +39 -0
- package/lib/services/index.d.ts.map +1 -0
- package/lib/services/index.js +40 -0
- package/lib/services/index.js.map +1 -0
- package/lib/services/integrations.d.ts +2987 -0
- package/lib/services/integrations.d.ts.map +1 -0
- package/lib/services/integrations.js +2903 -0
- package/lib/services/integrations.js.map +1 -0
- package/lib/services/log_drains.d.ts +848 -0
- package/lib/services/log_drains.d.ts.map +1 -0
- package/lib/services/log_drains.js +866 -0
- package/lib/services/log_drains.js.map +1 -0
- package/lib/services/logs.d.ts +40 -0
- package/lib/services/logs.d.ts.map +1 -0
- package/lib/services/logs.js +43 -0
- package/lib/services/logs.js.map +1 -0
- package/lib/services/marketplace.d.ts +991 -0
- package/lib/services/marketplace.d.ts.map +1 -0
- package/lib/services/marketplace.js +1044 -0
- package/lib/services/marketplace.js.map +1 -0
- package/lib/services/microfrontends.d.ts +3210 -0
- package/lib/services/microfrontends.d.ts.map +1 -0
- package/lib/services/microfrontends.js +3300 -0
- package/lib/services/microfrontends.js.map +1 -0
- package/lib/services/networking.d.ts +239 -0
- package/lib/services/networking.d.ts.map +1 -0
- package/lib/services/networking.js +224 -0
- package/lib/services/networking.js.map +1 -0
- package/lib/services/observability.d.ts +168 -0
- package/lib/services/observability.d.ts.map +1 -0
- package/lib/services/observability.js +191 -0
- package/lib/services/observability.js.map +1 -0
- package/lib/services/project_members.d.ts +142 -0
- package/lib/services/project_members.d.ts.map +1 -0
- package/lib/services/project_members.js +139 -0
- package/lib/services/project_members.js.map +1 -0
- package/lib/services/project_routes.d.ts +1990 -0
- package/lib/services/project_routes.d.ts.map +1 -0
- package/lib/services/project_routes.js +2026 -0
- package/lib/services/project_routes.js.map +1 -0
- package/lib/services/projects.d.ts +23449 -0
- package/lib/services/projects.d.ts.map +1 -0
- package/lib/services/projects.js +23570 -0
- package/lib/services/projects.js.map +1 -0
- package/lib/services/rolling_release.d.ts +764 -0
- package/lib/services/rolling_release.d.ts.map +1 -0
- package/lib/services/rolling_release.js +630 -0
- package/lib/services/rolling_release.js.map +1 -0
- package/lib/services/sandboxes.d.ts +2183 -0
- package/lib/services/sandboxes.d.ts.map +1 -0
- package/lib/services/sandboxes.js +1756 -0
- package/lib/services/sandboxes.js.map +1 -0
- package/lib/services/security.d.ts +3932 -0
- package/lib/services/security.d.ts.map +1 -0
- package/lib/services/security.js +4411 -0
- package/lib/services/security.js.map +1 -0
- package/lib/services/storage.d.ts +251 -0
- package/lib/services/storage.d.ts.map +1 -0
- package/lib/services/storage.js +270 -0
- package/lib/services/storage.js.map +1 -0
- package/lib/services/teams.d.ts +1577 -0
- package/lib/services/teams.d.ts.map +1 -0
- package/lib/services/teams.js +1359 -0
- package/lib/services/teams.js.map +1 -0
- package/lib/services/user.d.ts +7972 -0
- package/lib/services/user.d.ts.map +1 -0
- package/lib/services/user.js +7093 -0
- package/lib/services/user.js.map +1 -0
- package/lib/services/vcr.d.ts +793 -0
- package/lib/services/vcr.d.ts.map +1 -0
- package/lib/services/vcr.js +882 -0
- package/lib/services/vcr.js.map +1 -0
- package/lib/services/web_analytics.d.ts +694 -0
- package/lib/services/web_analytics.d.ts.map +1 -0
- package/lib/services/web_analytics.js +695 -0
- package/lib/services/web_analytics.js.map +1 -0
- package/lib/services/webhooks.d.ts +207 -0
- package/lib/services/webhooks.d.ts.map +1 -0
- package/lib/services/webhooks.js +171 -0
- package/lib/services/webhooks.js.map +1 -0
- package/lib/traits.d.ts +10 -0
- package/lib/traits.d.ts.map +1 -0
- package/lib/traits.js +11 -0
- package/lib/traits.js.map +1 -0
- package/package.json +77 -7
- package/src/credentials.ts +70 -0
- package/src/errors.ts +93 -0
- package/src/index.ts +18 -0
- package/src/protocol.ts +98 -0
- package/src/retry.ts +78 -0
- package/src/services/access_groups.ts +1165 -0
- package/src/services/ai_gateway.ts +272 -0
- package/src/services/aliases.ts +1323 -0
- package/src/services/artifacts.ts +542 -0
- package/src/services/authentication.ts +829 -0
- package/src/services/billing.ts +1776 -0
- package/src/services/bulk_redirects.ts +748 -0
- package/src/services/certs.ts +377 -0
- package/src/services/checks_v2.ts +3136 -0
- package/src/services/connect.ts +2607 -0
- package/src/services/deployments.ts +23682 -0
- package/src/services/dns.ts +718 -0
- package/src/services/domains.ts +1209 -0
- package/src/services/domains_registrar.ts +2290 -0
- package/src/services/drains.ts +5989 -0
- package/src/services/edge_cache.ts +303 -0
- package/src/services/environment.ts +2388 -0
- package/src/services/feature_flags.ts +8302 -0
- package/src/services/global_config.ts +1668 -0
- package/src/services/index.ts +39 -0
- package/src/services/integrations.ts +8846 -0
- package/src/services/log_drains.ts +2413 -0
- package/src/services/logs.ts +78 -0
- package/src/services/marketplace.ts +2626 -0
- package/src/services/microfrontends.ts +9650 -0
- package/src/services/networking.ts +530 -0
- package/src/services/observability.ts +436 -0
- package/src/services/project_members.ts +328 -0
- package/src/services/project_routes.ts +5259 -0
- package/src/services/projects.ts +67377 -0
- package/src/services/rolling_release.ts +1869 -0
- package/src/services/sandboxes.ts +5259 -0
- package/src/services/security.ts +12408 -0
- package/src/services/storage.ts +849 -0
- package/src/services/teams.ts +3995 -0
- package/src/services/user.ts +21687 -0
- package/src/services/vcr.ts +2165 -0
- package/src/services/web_analytics.ts +1570 -0
- package/src/services/webhooks.ts +1073 -0
- package/src/traits.ts +44 -0
- package/README.md +0 -15
- package/bun.lock +0 -26
- package/index.ts +0 -1
- package/tsconfig.json +0 -29
|
@@ -0,0 +1,764 @@
|
|
|
1
|
+
import * as S from "@distilled.cloud/core/schema";
|
|
2
|
+
import * as API from "@distilled.cloud/core/api";
|
|
3
|
+
import { type VercelOpError, type VercelOpContext } from "../protocol.ts";
|
|
4
|
+
export type { VercelOpError, VercelOpContext };
|
|
5
|
+
declare const BadRequest_base: S.Class<BadRequest, S.TaggedStruct<"BadRequest", {
|
|
6
|
+
readonly code: any;
|
|
7
|
+
readonly message: any;
|
|
8
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
9
|
+
"@distilled.cloud/error/categories": {
|
|
10
|
+
BadRequestError: true;
|
|
11
|
+
};
|
|
12
|
+
});
|
|
13
|
+
export declare class BadRequest extends /*@__PURE__*/ BadRequest_base {
|
|
14
|
+
}
|
|
15
|
+
declare const Conflict_base: S.Class<Conflict, S.TaggedStruct<"Conflict", {
|
|
16
|
+
readonly code: any;
|
|
17
|
+
readonly message: any;
|
|
18
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
19
|
+
"@distilled.cloud/error/categories": {
|
|
20
|
+
ConflictError: true;
|
|
21
|
+
};
|
|
22
|
+
});
|
|
23
|
+
export declare class Conflict extends /*@__PURE__*/ Conflict_base {
|
|
24
|
+
}
|
|
25
|
+
declare const Forbidden_base: S.Class<Forbidden, S.TaggedStruct<"Forbidden", {
|
|
26
|
+
readonly code: any;
|
|
27
|
+
readonly message: any;
|
|
28
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
29
|
+
"@distilled.cloud/error/categories": {
|
|
30
|
+
AuthError: true;
|
|
31
|
+
};
|
|
32
|
+
});
|
|
33
|
+
export declare class Forbidden extends /*@__PURE__*/ Forbidden_base {
|
|
34
|
+
}
|
|
35
|
+
declare const NotFound_base: S.Class<NotFound, S.TaggedStruct<"NotFound", {
|
|
36
|
+
readonly code: any;
|
|
37
|
+
readonly message: any;
|
|
38
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
39
|
+
"@distilled.cloud/error/categories": {
|
|
40
|
+
BadRequestError: true;
|
|
41
|
+
};
|
|
42
|
+
});
|
|
43
|
+
export declare class NotFound extends /*@__PURE__*/ NotFound_base {
|
|
44
|
+
}
|
|
45
|
+
declare const UnprocessableEntity_base: S.Class<UnprocessableEntity, S.TaggedStruct<"UnprocessableEntity", {
|
|
46
|
+
readonly code: any;
|
|
47
|
+
readonly message: any;
|
|
48
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
49
|
+
"@distilled.cloud/error/categories": {
|
|
50
|
+
BadRequestError: true;
|
|
51
|
+
};
|
|
52
|
+
});
|
|
53
|
+
export declare class UnprocessableEntity extends /*@__PURE__*/ UnprocessableEntity_base {
|
|
54
|
+
}
|
|
55
|
+
export interface ApproveRollingReleaseStageRequest {
|
|
56
|
+
/** Project ID or project name (URL-encoded) */
|
|
57
|
+
idOrName: string;
|
|
58
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
59
|
+
teamId?: string;
|
|
60
|
+
/** The Team slug to perform the request on behalf of. */
|
|
61
|
+
slug?: string;
|
|
62
|
+
/** The index of the stage to transition to */
|
|
63
|
+
nextStageIndex: number;
|
|
64
|
+
/** The id of the canary deployment to approve for the next stage */
|
|
65
|
+
canaryDeploymentId: string;
|
|
66
|
+
}
|
|
67
|
+
export declare const ApproveRollingReleaseStageRequest: S.Schema<ApproveRollingReleaseStageRequest>;
|
|
68
|
+
/** The current state of the rolling release */
|
|
69
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseState = "ABORTED" | "ACTIVE" | "COMPLETE";
|
|
70
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseState: any;
|
|
71
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
72
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseSubstate = "PAUSED";
|
|
73
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseSubstate: any;
|
|
74
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
75
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
76
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentReadyState: any;
|
|
77
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
78
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentTarget = "production" | "staging";
|
|
79
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentTarget: any;
|
|
80
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
81
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
82
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentSource: any;
|
|
83
|
+
/** The current deployment receiving production traffic */
|
|
84
|
+
export interface ApproveRollingReleaseStageResponseRollingReleaseCurrentDeployment {
|
|
85
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
86
|
+
name: string;
|
|
87
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
88
|
+
createdAt: number;
|
|
89
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
90
|
+
readyState: ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentReadyState;
|
|
91
|
+
/** A string holding the unique ID of the deployment */
|
|
92
|
+
id: string;
|
|
93
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
94
|
+
target?: ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentTarget | null;
|
|
95
|
+
readyStateAt?: number;
|
|
96
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
97
|
+
source?: ApproveRollingReleaseStageResponseRollingReleaseCurrentDeploymentSource;
|
|
98
|
+
/** A string with the unique URL of the deployment */
|
|
99
|
+
url: string;
|
|
100
|
+
}
|
|
101
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCurrentDeployment: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseCurrentDeployment>;
|
|
102
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
103
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
104
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentReadyState: any;
|
|
105
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
106
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentTarget = "production" | "staging";
|
|
107
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentTarget: any;
|
|
108
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
109
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
110
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentSource: any;
|
|
111
|
+
/** The canary deployment being rolled out */
|
|
112
|
+
export interface ApproveRollingReleaseStageResponseRollingReleaseCanaryDeployment {
|
|
113
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
114
|
+
name: string;
|
|
115
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
116
|
+
createdAt: number;
|
|
117
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
118
|
+
readyState: ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentReadyState;
|
|
119
|
+
/** A string holding the unique ID of the deployment */
|
|
120
|
+
id: string;
|
|
121
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
122
|
+
target?: ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentTarget | null;
|
|
123
|
+
readyStateAt?: number;
|
|
124
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
125
|
+
source?: ApproveRollingReleaseStageResponseRollingReleaseCanaryDeploymentSource;
|
|
126
|
+
/** A string with the unique URL of the deployment */
|
|
127
|
+
url: string;
|
|
128
|
+
}
|
|
129
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseCanaryDeployment: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseCanaryDeployment>;
|
|
130
|
+
/** The advancement type of the rolling release */
|
|
131
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseAdvancementType = "automatic" | "manual-approval";
|
|
132
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseAdvancementType: any;
|
|
133
|
+
/** All stages configured for this rolling release */
|
|
134
|
+
export interface ApproveRollingReleaseStageResponseRollingReleaseStagesItem {
|
|
135
|
+
/** The zero-based index of the stage */
|
|
136
|
+
index: number;
|
|
137
|
+
/** Whether or not this stage is the final stage (targetPercentage === 100) */
|
|
138
|
+
isFinalStage: boolean;
|
|
139
|
+
/** The percentage of traffic to serve to the canary deployment (0-100) */
|
|
140
|
+
targetPercentage: number;
|
|
141
|
+
/** Whether or not this stage requires manual approval to proceed */
|
|
142
|
+
requireApproval: boolean;
|
|
143
|
+
/** Duration in seconds for automatic advancement, null for manual stages or the final stage */
|
|
144
|
+
duration: number | null;
|
|
145
|
+
/** Whether to linearly shift traffic over the duration of this stage */
|
|
146
|
+
linearShift?: boolean;
|
|
147
|
+
}
|
|
148
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseStagesItem: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
149
|
+
/** All stages configured for this rolling release */
|
|
150
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseStagesList = Array<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
151
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseStagesList: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesList>;
|
|
152
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
153
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseActiveStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
154
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseActiveStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
155
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
156
|
+
export type ApproveRollingReleaseStageResponseRollingReleaseNextStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
157
|
+
export declare const ApproveRollingReleaseStageResponseRollingReleaseNextStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
158
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
159
|
+
export interface ApproveRollingReleaseStageResponseRollingRelease {
|
|
160
|
+
/** The current state of the rolling release */
|
|
161
|
+
state: ApproveRollingReleaseStageResponseRollingReleaseState;
|
|
162
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
163
|
+
substate: ApproveRollingReleaseStageResponseRollingReleaseSubstate | null;
|
|
164
|
+
/** The current deployment receiving production traffic */
|
|
165
|
+
currentDeployment: ApproveRollingReleaseStageResponseRollingReleaseCurrentDeployment | null;
|
|
166
|
+
/** The canary deployment being rolled out */
|
|
167
|
+
canaryDeployment: ApproveRollingReleaseStageResponseRollingReleaseCanaryDeployment | null;
|
|
168
|
+
/** The ID of a deployment queued for the next rolling release */
|
|
169
|
+
queuedDeploymentId: string | null;
|
|
170
|
+
/** The advancement type of the rolling release */
|
|
171
|
+
advancementType: ApproveRollingReleaseStageResponseRollingReleaseAdvancementType;
|
|
172
|
+
/** All stages configured for this rolling release */
|
|
173
|
+
stages: ApproveRollingReleaseStageResponseRollingReleaseStagesList;
|
|
174
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
175
|
+
activeStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
176
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
177
|
+
nextStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
178
|
+
/** Unix timestamp in milliseconds when the rolling release started */
|
|
179
|
+
startedAt: number;
|
|
180
|
+
/** Unix timestamp in milliseconds when the rolling release was last updated */
|
|
181
|
+
updatedAt: number;
|
|
182
|
+
/** When set (for example while {@link substate} is `PAUSED`), the canary traffic percentage persisted on the rollout document — use for dashboard display when linear shift is active. */
|
|
183
|
+
currentCanaryPercentage?: number;
|
|
184
|
+
}
|
|
185
|
+
export declare const ApproveRollingReleaseStageResponseRollingRelease: S.Schema<ApproveRollingReleaseStageResponseRollingRelease>;
|
|
186
|
+
export interface ApproveRollingReleaseStageResponse {
|
|
187
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
188
|
+
rollingRelease: ApproveRollingReleaseStageResponseRollingRelease | null;
|
|
189
|
+
}
|
|
190
|
+
export declare const ApproveRollingReleaseStageResponse: S.Schema<ApproveRollingReleaseStageResponse>;
|
|
191
|
+
export interface CompleteRollingReleaseRequest {
|
|
192
|
+
/** Project ID or project name (URL-encoded) */
|
|
193
|
+
idOrName: string;
|
|
194
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
195
|
+
teamId?: string;
|
|
196
|
+
/** The Team slug to perform the request on behalf of. */
|
|
197
|
+
slug?: string;
|
|
198
|
+
/** The ID of the canary deployment to complete */
|
|
199
|
+
canaryDeploymentId: string;
|
|
200
|
+
}
|
|
201
|
+
export declare const CompleteRollingReleaseRequest: S.Schema<CompleteRollingReleaseRequest>;
|
|
202
|
+
/** The current state of the rolling release */
|
|
203
|
+
export type CompleteRollingReleaseResponseRollingReleaseState = "ABORTED" | "ACTIVE" | "COMPLETE";
|
|
204
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseState: any;
|
|
205
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
206
|
+
export type CompleteRollingReleaseResponseRollingReleaseSubstate = "PAUSED";
|
|
207
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseSubstate: any;
|
|
208
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
209
|
+
export type CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
210
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState: any;
|
|
211
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
212
|
+
export type CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentTarget = "production" | "staging";
|
|
213
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentTarget: any;
|
|
214
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
215
|
+
export type CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
216
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentSource: any;
|
|
217
|
+
/** The current deployment receiving production traffic */
|
|
218
|
+
export interface CompleteRollingReleaseResponseRollingReleaseCurrentDeployment {
|
|
219
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
220
|
+
name: string;
|
|
221
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
222
|
+
createdAt: number;
|
|
223
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
224
|
+
readyState: CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState;
|
|
225
|
+
/** A string holding the unique ID of the deployment */
|
|
226
|
+
id: string;
|
|
227
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
228
|
+
target?: CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentTarget | null;
|
|
229
|
+
readyStateAt?: number;
|
|
230
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
231
|
+
source?: CompleteRollingReleaseResponseRollingReleaseCurrentDeploymentSource;
|
|
232
|
+
/** A string with the unique URL of the deployment */
|
|
233
|
+
url: string;
|
|
234
|
+
}
|
|
235
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCurrentDeployment: S.Schema<CompleteRollingReleaseResponseRollingReleaseCurrentDeployment>;
|
|
236
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
237
|
+
export type CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
238
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState: any;
|
|
239
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
240
|
+
export type CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentTarget = "production" | "staging";
|
|
241
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentTarget: any;
|
|
242
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
243
|
+
export type CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
244
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentSource: any;
|
|
245
|
+
/** The canary deployment being rolled out */
|
|
246
|
+
export interface CompleteRollingReleaseResponseRollingReleaseCanaryDeployment {
|
|
247
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
248
|
+
name: string;
|
|
249
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
250
|
+
createdAt: number;
|
|
251
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
252
|
+
readyState: CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState;
|
|
253
|
+
/** A string holding the unique ID of the deployment */
|
|
254
|
+
id: string;
|
|
255
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
256
|
+
target?: CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentTarget | null;
|
|
257
|
+
readyStateAt?: number;
|
|
258
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
259
|
+
source?: CompleteRollingReleaseResponseRollingReleaseCanaryDeploymentSource;
|
|
260
|
+
/** A string with the unique URL of the deployment */
|
|
261
|
+
url: string;
|
|
262
|
+
}
|
|
263
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseCanaryDeployment: S.Schema<CompleteRollingReleaseResponseRollingReleaseCanaryDeployment>;
|
|
264
|
+
/** The advancement type of the rolling release */
|
|
265
|
+
export type CompleteRollingReleaseResponseRollingReleaseAdvancementType = "automatic" | "manual-approval";
|
|
266
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseAdvancementType: any;
|
|
267
|
+
/** All stages configured for this rolling release */
|
|
268
|
+
export type CompleteRollingReleaseResponseRollingReleaseStagesItem = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
269
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseStagesItem: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
270
|
+
/** All stages configured for this rolling release */
|
|
271
|
+
export type CompleteRollingReleaseResponseRollingReleaseStagesList = Array<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
272
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseStagesList: S.Schema<CompleteRollingReleaseResponseRollingReleaseStagesList>;
|
|
273
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
274
|
+
export type CompleteRollingReleaseResponseRollingReleaseActiveStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
275
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseActiveStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
276
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
277
|
+
export type CompleteRollingReleaseResponseRollingReleaseNextStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
278
|
+
export declare const CompleteRollingReleaseResponseRollingReleaseNextStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
279
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
280
|
+
export interface CompleteRollingReleaseResponseRollingRelease {
|
|
281
|
+
/** The current state of the rolling release */
|
|
282
|
+
state: CompleteRollingReleaseResponseRollingReleaseState;
|
|
283
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
284
|
+
substate: CompleteRollingReleaseResponseRollingReleaseSubstate | null;
|
|
285
|
+
/** The current deployment receiving production traffic */
|
|
286
|
+
currentDeployment: CompleteRollingReleaseResponseRollingReleaseCurrentDeployment | null;
|
|
287
|
+
/** The canary deployment being rolled out */
|
|
288
|
+
canaryDeployment: CompleteRollingReleaseResponseRollingReleaseCanaryDeployment | null;
|
|
289
|
+
/** The ID of a deployment queued for the next rolling release */
|
|
290
|
+
queuedDeploymentId: string | null;
|
|
291
|
+
/** The advancement type of the rolling release */
|
|
292
|
+
advancementType: CompleteRollingReleaseResponseRollingReleaseAdvancementType;
|
|
293
|
+
/** All stages configured for this rolling release */
|
|
294
|
+
stages: CompleteRollingReleaseResponseRollingReleaseStagesList;
|
|
295
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
296
|
+
activeStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
297
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
298
|
+
nextStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
299
|
+
/** Unix timestamp in milliseconds when the rolling release started */
|
|
300
|
+
startedAt: number;
|
|
301
|
+
/** Unix timestamp in milliseconds when the rolling release was last updated */
|
|
302
|
+
updatedAt: number;
|
|
303
|
+
/** When set (for example while {@link substate} is `PAUSED`), the canary traffic percentage persisted on the rollout document — use for dashboard display when linear shift is active. */
|
|
304
|
+
currentCanaryPercentage?: number;
|
|
305
|
+
}
|
|
306
|
+
export declare const CompleteRollingReleaseResponseRollingRelease: S.Schema<CompleteRollingReleaseResponseRollingRelease>;
|
|
307
|
+
export interface CompleteRollingReleaseResponse {
|
|
308
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
309
|
+
rollingRelease: CompleteRollingReleaseResponseRollingRelease | null;
|
|
310
|
+
}
|
|
311
|
+
export declare const CompleteRollingReleaseResponse: S.Schema<CompleteRollingReleaseResponse>;
|
|
312
|
+
export interface DeleteRollingReleaseConfigRequest {
|
|
313
|
+
/** Project ID or project name (URL-encoded) */
|
|
314
|
+
idOrName: string;
|
|
315
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
316
|
+
teamId?: string;
|
|
317
|
+
/** The Team slug to perform the request on behalf of. */
|
|
318
|
+
slug?: string;
|
|
319
|
+
}
|
|
320
|
+
export declare const DeleteRollingReleaseConfigRequest: S.Schema<DeleteRollingReleaseConfigRequest>;
|
|
321
|
+
export interface DeleteRollingReleaseConfigResponse {
|
|
322
|
+
rollingRelease: unknown | null;
|
|
323
|
+
}
|
|
324
|
+
export declare const DeleteRollingReleaseConfigResponse: S.Schema<DeleteRollingReleaseConfigResponse>;
|
|
325
|
+
/** Filter by rolling release state */
|
|
326
|
+
export type GetRollingReleaseRequestState = "ACTIVE" | "COMPLETE" | "ABORTED";
|
|
327
|
+
export declare const GetRollingReleaseRequestState: any;
|
|
328
|
+
export interface GetRollingReleaseRequest {
|
|
329
|
+
/** Project ID or project name (URL-encoded) */
|
|
330
|
+
idOrName: string;
|
|
331
|
+
/** Filter by rolling release state */
|
|
332
|
+
state?: GetRollingReleaseRequestState | (string & {});
|
|
333
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
334
|
+
teamId?: string;
|
|
335
|
+
/** The Team slug to perform the request on behalf of. */
|
|
336
|
+
slug?: string;
|
|
337
|
+
}
|
|
338
|
+
export declare const GetRollingReleaseRequest: S.Schema<GetRollingReleaseRequest>;
|
|
339
|
+
/** The current state of the rolling release */
|
|
340
|
+
export type GetRollingReleaseResponseRollingReleaseState = "ABORTED" | "ACTIVE" | "COMPLETE";
|
|
341
|
+
export declare const GetRollingReleaseResponseRollingReleaseState: any;
|
|
342
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
343
|
+
export type GetRollingReleaseResponseRollingReleaseSubstate = "PAUSED";
|
|
344
|
+
export declare const GetRollingReleaseResponseRollingReleaseSubstate: any;
|
|
345
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
346
|
+
export type GetRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
347
|
+
export declare const GetRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState: any;
|
|
348
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
349
|
+
export type GetRollingReleaseResponseRollingReleaseCurrentDeploymentTarget = "production" | "staging";
|
|
350
|
+
export declare const GetRollingReleaseResponseRollingReleaseCurrentDeploymentTarget: any;
|
|
351
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
352
|
+
export type GetRollingReleaseResponseRollingReleaseCurrentDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
353
|
+
export declare const GetRollingReleaseResponseRollingReleaseCurrentDeploymentSource: any;
|
|
354
|
+
/** The current deployment receiving production traffic */
|
|
355
|
+
export interface GetRollingReleaseResponseRollingReleaseCurrentDeployment {
|
|
356
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
357
|
+
name: string;
|
|
358
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
359
|
+
createdAt: number;
|
|
360
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
361
|
+
readyState: GetRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState;
|
|
362
|
+
/** A string holding the unique ID of the deployment */
|
|
363
|
+
id: string;
|
|
364
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
365
|
+
target?: GetRollingReleaseResponseRollingReleaseCurrentDeploymentTarget | null;
|
|
366
|
+
readyStateAt?: number;
|
|
367
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
368
|
+
source?: GetRollingReleaseResponseRollingReleaseCurrentDeploymentSource;
|
|
369
|
+
/** A string with the unique URL of the deployment */
|
|
370
|
+
url: string;
|
|
371
|
+
}
|
|
372
|
+
export declare const GetRollingReleaseResponseRollingReleaseCurrentDeployment: S.Schema<GetRollingReleaseResponseRollingReleaseCurrentDeployment>;
|
|
373
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
374
|
+
export type GetRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
375
|
+
export declare const GetRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState: any;
|
|
376
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
377
|
+
export type GetRollingReleaseResponseRollingReleaseCanaryDeploymentTarget = "production" | "staging";
|
|
378
|
+
export declare const GetRollingReleaseResponseRollingReleaseCanaryDeploymentTarget: any;
|
|
379
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
380
|
+
export type GetRollingReleaseResponseRollingReleaseCanaryDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
381
|
+
export declare const GetRollingReleaseResponseRollingReleaseCanaryDeploymentSource: any;
|
|
382
|
+
/** The canary deployment being rolled out */
|
|
383
|
+
export interface GetRollingReleaseResponseRollingReleaseCanaryDeployment {
|
|
384
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
385
|
+
name: string;
|
|
386
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
387
|
+
createdAt: number;
|
|
388
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
389
|
+
readyState: GetRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState;
|
|
390
|
+
/** A string holding the unique ID of the deployment */
|
|
391
|
+
id: string;
|
|
392
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
393
|
+
target?: GetRollingReleaseResponseRollingReleaseCanaryDeploymentTarget | null;
|
|
394
|
+
readyStateAt?: number;
|
|
395
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
396
|
+
source?: GetRollingReleaseResponseRollingReleaseCanaryDeploymentSource;
|
|
397
|
+
/** A string with the unique URL of the deployment */
|
|
398
|
+
url: string;
|
|
399
|
+
}
|
|
400
|
+
export declare const GetRollingReleaseResponseRollingReleaseCanaryDeployment: S.Schema<GetRollingReleaseResponseRollingReleaseCanaryDeployment>;
|
|
401
|
+
/** The advancement type of the rolling release */
|
|
402
|
+
export type GetRollingReleaseResponseRollingReleaseAdvancementType = "automatic" | "manual-approval";
|
|
403
|
+
export declare const GetRollingReleaseResponseRollingReleaseAdvancementType: any;
|
|
404
|
+
/** All stages configured for this rolling release */
|
|
405
|
+
export type GetRollingReleaseResponseRollingReleaseStagesItem = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
406
|
+
export declare const GetRollingReleaseResponseRollingReleaseStagesItem: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
407
|
+
/** All stages configured for this rolling release */
|
|
408
|
+
export type GetRollingReleaseResponseRollingReleaseStagesList = Array<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
409
|
+
export declare const GetRollingReleaseResponseRollingReleaseStagesList: S.Schema<GetRollingReleaseResponseRollingReleaseStagesList>;
|
|
410
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
411
|
+
export type GetRollingReleaseResponseRollingReleaseActiveStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
412
|
+
export declare const GetRollingReleaseResponseRollingReleaseActiveStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
413
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
414
|
+
export type GetRollingReleaseResponseRollingReleaseNextStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
415
|
+
export declare const GetRollingReleaseResponseRollingReleaseNextStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
416
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
417
|
+
export interface GetRollingReleaseResponseRollingRelease {
|
|
418
|
+
/** The current state of the rolling release */
|
|
419
|
+
state: GetRollingReleaseResponseRollingReleaseState;
|
|
420
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
421
|
+
substate: GetRollingReleaseResponseRollingReleaseSubstate | null;
|
|
422
|
+
/** The current deployment receiving production traffic */
|
|
423
|
+
currentDeployment: GetRollingReleaseResponseRollingReleaseCurrentDeployment | null;
|
|
424
|
+
/** The canary deployment being rolled out */
|
|
425
|
+
canaryDeployment: GetRollingReleaseResponseRollingReleaseCanaryDeployment | null;
|
|
426
|
+
/** The ID of a deployment queued for the next rolling release */
|
|
427
|
+
queuedDeploymentId: string | null;
|
|
428
|
+
/** The advancement type of the rolling release */
|
|
429
|
+
advancementType: GetRollingReleaseResponseRollingReleaseAdvancementType;
|
|
430
|
+
/** All stages configured for this rolling release */
|
|
431
|
+
stages: GetRollingReleaseResponseRollingReleaseStagesList;
|
|
432
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
433
|
+
activeStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
434
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
435
|
+
nextStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
436
|
+
/** Unix timestamp in milliseconds when the rolling release started */
|
|
437
|
+
startedAt: number;
|
|
438
|
+
/** Unix timestamp in milliseconds when the rolling release was last updated */
|
|
439
|
+
updatedAt: number;
|
|
440
|
+
/** When set (for example while {@link substate} is `PAUSED`), the canary traffic percentage persisted on the rollout document — use for dashboard display when linear shift is active. */
|
|
441
|
+
currentCanaryPercentage?: number;
|
|
442
|
+
}
|
|
443
|
+
export declare const GetRollingReleaseResponseRollingRelease: S.Schema<GetRollingReleaseResponseRollingRelease>;
|
|
444
|
+
export interface GetRollingReleaseResponse {
|
|
445
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
446
|
+
rollingRelease: GetRollingReleaseResponseRollingRelease | null;
|
|
447
|
+
}
|
|
448
|
+
export declare const GetRollingReleaseResponse: S.Schema<GetRollingReleaseResponse>;
|
|
449
|
+
export interface GetRollingReleaseBillingStatusRequest {
|
|
450
|
+
/** Project ID or project name (URL-encoded) */
|
|
451
|
+
idOrName: string;
|
|
452
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
453
|
+
teamId?: string;
|
|
454
|
+
/** The Team slug to perform the request on behalf of. */
|
|
455
|
+
slug?: string;
|
|
456
|
+
}
|
|
457
|
+
export declare const GetRollingReleaseBillingStatusRequest: S.Schema<GetRollingReleaseBillingStatusRequest>;
|
|
458
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase0AvailableSlots = 0;
|
|
459
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase0AvailableSlots: any;
|
|
460
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase0Reason = "plan_not_supported";
|
|
461
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase0Reason: any;
|
|
462
|
+
export interface GetRollingReleaseBillingStatusResponseBodyCase0 {
|
|
463
|
+
availableSlots: GetRollingReleaseBillingStatusResponseBodyCase0AvailableSlots;
|
|
464
|
+
reason: GetRollingReleaseBillingStatusResponseBodyCase0Reason;
|
|
465
|
+
message: string;
|
|
466
|
+
}
|
|
467
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase0: S.Schema<GetRollingReleaseBillingStatusResponseBodyCase0>;
|
|
468
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase1AvailableSlots = "unlimited";
|
|
469
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase1AvailableSlots: any;
|
|
470
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase1Reason = "unlimited_slots";
|
|
471
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase1Reason: any;
|
|
472
|
+
export interface GetRollingReleaseBillingStatusResponseBodyCase1 {
|
|
473
|
+
availableSlots: GetRollingReleaseBillingStatusResponseBodyCase1AvailableSlots;
|
|
474
|
+
reason: GetRollingReleaseBillingStatusResponseBodyCase1Reason;
|
|
475
|
+
message: string;
|
|
476
|
+
}
|
|
477
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase1: S.Schema<GetRollingReleaseBillingStatusResponseBodyCase1>;
|
|
478
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase2AvailableSlots = 0;
|
|
479
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase2AvailableSlots: any;
|
|
480
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase2Reason = "no_available_slots";
|
|
481
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase2Reason: any;
|
|
482
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase2EnabledProjectsList = Array<string>;
|
|
483
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase2EnabledProjectsList: S.Schema<GetRollingReleaseBillingStatusResponseBodyCase2EnabledProjectsList>;
|
|
484
|
+
export interface GetRollingReleaseBillingStatusResponseBodyCase2 {
|
|
485
|
+
availableSlots: GetRollingReleaseBillingStatusResponseBodyCase2AvailableSlots;
|
|
486
|
+
reason: GetRollingReleaseBillingStatusResponseBodyCase2Reason;
|
|
487
|
+
message: string;
|
|
488
|
+
enabledProjects: GetRollingReleaseBillingStatusResponseBodyCase2EnabledProjectsList;
|
|
489
|
+
}
|
|
490
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase2: S.Schema<GetRollingReleaseBillingStatusResponseBodyCase2>;
|
|
491
|
+
export type GetRollingReleaseBillingStatusResponseBodyCase3Reason = "available_slots";
|
|
492
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase3Reason: any;
|
|
493
|
+
export interface GetRollingReleaseBillingStatusResponseBodyCase3 {
|
|
494
|
+
availableSlots: number;
|
|
495
|
+
reason: GetRollingReleaseBillingStatusResponseBodyCase3Reason;
|
|
496
|
+
message: string;
|
|
497
|
+
}
|
|
498
|
+
export declare const GetRollingReleaseBillingStatusResponseBodyCase3: S.Schema<GetRollingReleaseBillingStatusResponseBodyCase3>;
|
|
499
|
+
export type GetRollingReleaseBillingStatusResponseBody = GetRollingReleaseBillingStatusResponseBodyCase0 | GetRollingReleaseBillingStatusResponseBodyCase1 | GetRollingReleaseBillingStatusResponseBodyCase2 | GetRollingReleaseBillingStatusResponseBodyCase3;
|
|
500
|
+
export declare const GetRollingReleaseBillingStatusResponseBody: S.Schema<GetRollingReleaseBillingStatusResponseBody>;
|
|
501
|
+
export type GetRollingReleaseBillingStatusResponse = GetRollingReleaseBillingStatusResponseBody;
|
|
502
|
+
export declare const GetRollingReleaseBillingStatusResponse: S.Schema<GetRollingReleaseBillingStatusResponse>;
|
|
503
|
+
export interface GetRollingReleaseConfigRequest {
|
|
504
|
+
/** Project ID or project name (URL-encoded) */
|
|
505
|
+
idOrName: string;
|
|
506
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
507
|
+
teamId?: string;
|
|
508
|
+
/** The Team slug to perform the request on behalf of. */
|
|
509
|
+
slug?: string;
|
|
510
|
+
}
|
|
511
|
+
export declare const GetRollingReleaseConfigRequest: S.Schema<GetRollingReleaseConfigRequest>;
|
|
512
|
+
/** An array of all the stages required during a deployment release. Each stage defines a target percentage and advancement rules. The final stage must always have targetPercentage: 100. */
|
|
513
|
+
export interface GetRollingReleaseConfigResponseRollingReleaseStagesItem {
|
|
514
|
+
/** The percentage of traffic to serve to the canary deployment (0-100) */
|
|
515
|
+
targetPercentage: number;
|
|
516
|
+
/** Whether or not this stage requires manual approval to proceed */
|
|
517
|
+
requireApproval?: boolean;
|
|
518
|
+
/** Duration in minutes for automatic advancement to the next stage */
|
|
519
|
+
duration?: number;
|
|
520
|
+
/** Whether to linearly shift traffic over the duration of this stage */
|
|
521
|
+
linearShift?: boolean;
|
|
522
|
+
}
|
|
523
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseStagesItem: S.Schema<GetRollingReleaseConfigResponseRollingReleaseStagesItem>;
|
|
524
|
+
/** An array of all the stages required during a deployment release. Each stage defines a target percentage and advancement rules. The final stage must always have targetPercentage: 100. */
|
|
525
|
+
export type GetRollingReleaseConfigResponseRollingReleaseStagesList = Array<GetRollingReleaseConfigResponseRollingReleaseStagesItem>;
|
|
526
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseStagesList: S.Schema<GetRollingReleaseConfigResponseRollingReleaseStagesList>;
|
|
527
|
+
/** The metric this check evaluates. */
|
|
528
|
+
export type GetRollingReleaseConfigResponseRollingReleaseGateChecksItemType = "error-rate-5xx";
|
|
529
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseGateChecksItemType: any;
|
|
530
|
+
/** Response status codes to ignore entirely — dropped from both the numerator (errors) and the denominator (total requests). Defaults to `[]` when omitted. */
|
|
531
|
+
export type GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludeStatusCodesList = Array<number>;
|
|
532
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludeStatusCodesList: S.Schema<GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludeStatusCodesList>;
|
|
533
|
+
/** Request paths to ignore entirely — dropped from both the numerator (errors) and the denominator (total requests). Defaults to `[]` when omitted. */
|
|
534
|
+
export type GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludePathsList = Array<string>;
|
|
535
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludePathsList: S.Schema<GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludePathsList>;
|
|
536
|
+
/** The checks to evaluate. An empty array means nothing is evaluated. */
|
|
537
|
+
export interface GetRollingReleaseConfigResponseRollingReleaseGateChecksItem {
|
|
538
|
+
/** The metric this check evaluates. */
|
|
539
|
+
type: GetRollingReleaseConfigResponseRollingReleaseGateChecksItemType;
|
|
540
|
+
/** Minimum number of requests required in the window before the check can fail. Below this, the check is inconclusive rather than failing, so low-traffic stages don't gate on noise. Defaults to `100` when omitted. */
|
|
541
|
+
minSampleSize?: number;
|
|
542
|
+
/** Response status codes to ignore entirely — dropped from both the numerator (errors) and the denominator (total requests). Defaults to `[]` when omitted. */
|
|
543
|
+
excludeStatusCodes?: GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludeStatusCodesList;
|
|
544
|
+
/** Request paths to ignore entirely — dropped from both the numerator (errors) and the denominator (total requests). Defaults to `[]` when omitted. */
|
|
545
|
+
excludePaths?: GetRollingReleaseConfigResponseRollingReleaseGateChecksItemExcludePathsList;
|
|
546
|
+
/** Seconds of ingest lag to allow for: the query's upper bound is `now() - this value`, so the check never reads a window that is still filling. Defaults to `30` when omitted. */
|
|
547
|
+
ingestWatermarkSeconds?: number;
|
|
548
|
+
}
|
|
549
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseGateChecksItem: S.Schema<GetRollingReleaseConfigResponseRollingReleaseGateChecksItem>;
|
|
550
|
+
/** The checks to evaluate. An empty array means nothing is evaluated. */
|
|
551
|
+
export type GetRollingReleaseConfigResponseRollingReleaseGateChecksList = Array<GetRollingReleaseConfigResponseRollingReleaseGateChecksItem>;
|
|
552
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseGateChecksList: S.Schema<GetRollingReleaseConfigResponseRollingReleaseGateChecksList>;
|
|
553
|
+
/** What to do when the gate trips: pause the rollout, or roll it back. */
|
|
554
|
+
export type GetRollingReleaseConfigResponseRollingReleaseGateAction = "pause" | "rollback";
|
|
555
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseGateAction: any;
|
|
556
|
+
/** Automated gating configuration. Omitted (the default) means no gating is configured, which is equivalent to `enabled: false`. */
|
|
557
|
+
export interface GetRollingReleaseConfigResponseRollingReleaseGate {
|
|
558
|
+
/** Whether automated gating is enabled for this project's rollouts. */
|
|
559
|
+
enabled: boolean;
|
|
560
|
+
/** The checks to evaluate. An empty array means nothing is evaluated. */
|
|
561
|
+
checks: GetRollingReleaseConfigResponseRollingReleaseGateChecksList;
|
|
562
|
+
/** How many failing evaluations within {@link windowSize} trip the gate. Defaults to `3` when omitted. */
|
|
563
|
+
failureThreshold?: number;
|
|
564
|
+
/** How many of the most recent evaluations {@link failureThreshold} is counted against. Defaults to `5` when omitted. */
|
|
565
|
+
windowSize?: number;
|
|
566
|
+
/** What to do when the gate trips: pause the rollout, or roll it back. */
|
|
567
|
+
action: GetRollingReleaseConfigResponseRollingReleaseGateAction;
|
|
568
|
+
/** When true, a tripped gate is only reported — {@link action} is not taken. */
|
|
569
|
+
dryRun: boolean;
|
|
570
|
+
}
|
|
571
|
+
export declare const GetRollingReleaseConfigResponseRollingReleaseGate: S.Schema<GetRollingReleaseConfigResponseRollingReleaseGate>;
|
|
572
|
+
/** Project-level rolling release configuration that defines how deployments should be gradually rolled out */
|
|
573
|
+
export interface GetRollingReleaseConfigResponseRollingRelease {
|
|
574
|
+
/** The environment that the release targets, currently only supports production. Adding in case we want to configure with alias groups or custom environments. */
|
|
575
|
+
target: string;
|
|
576
|
+
/** An array of all the stages required during a deployment release. Each stage defines a target percentage and advancement rules. The final stage must always have targetPercentage: 100. */
|
|
577
|
+
stages?: GetRollingReleaseConfigResponseRollingReleaseStagesList | null;
|
|
578
|
+
/** Whether the request served by a canary deployment should return a header indicating a canary was served. Defaults to `false` when omitted. */
|
|
579
|
+
canaryResponseHeader?: boolean;
|
|
580
|
+
/** Automated gating configuration. Omitted (the default) means no gating is configured, which is equivalent to `enabled: false`. */
|
|
581
|
+
gate?: GetRollingReleaseConfigResponseRollingReleaseGate;
|
|
582
|
+
}
|
|
583
|
+
export declare const GetRollingReleaseConfigResponseRollingRelease: S.Schema<GetRollingReleaseConfigResponseRollingRelease>;
|
|
584
|
+
export interface GetRollingReleaseConfigResponse {
|
|
585
|
+
/** Project-level rolling release configuration that defines how deployments should be gradually rolled out */
|
|
586
|
+
rollingRelease: GetRollingReleaseConfigResponseRollingRelease | null;
|
|
587
|
+
}
|
|
588
|
+
export declare const GetRollingReleaseConfigResponse: S.Schema<GetRollingReleaseConfigResponse>;
|
|
589
|
+
export interface StartRollingReleaseRequest {
|
|
590
|
+
/** Project ID or project name (URL-encoded) */
|
|
591
|
+
idOrName: string;
|
|
592
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
593
|
+
teamId?: string;
|
|
594
|
+
/** The Team slug to perform the request on behalf of. */
|
|
595
|
+
slug?: string;
|
|
596
|
+
/** The ID of the canary deployment to start the rolling release for */
|
|
597
|
+
canaryDeploymentId: string;
|
|
598
|
+
}
|
|
599
|
+
export declare const StartRollingReleaseRequest: S.Schema<StartRollingReleaseRequest>;
|
|
600
|
+
/** The current state of the rolling release */
|
|
601
|
+
export type StartRollingReleaseResponseRollingReleaseState = "ABORTED" | "ACTIVE" | "COMPLETE";
|
|
602
|
+
export declare const StartRollingReleaseResponseRollingReleaseState: any;
|
|
603
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
604
|
+
export type StartRollingReleaseResponseRollingReleaseSubstate = "PAUSED";
|
|
605
|
+
export declare const StartRollingReleaseResponseRollingReleaseSubstate: any;
|
|
606
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
607
|
+
export type StartRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
608
|
+
export declare const StartRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState: any;
|
|
609
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
610
|
+
export type StartRollingReleaseResponseRollingReleaseCurrentDeploymentTarget = "production" | "staging";
|
|
611
|
+
export declare const StartRollingReleaseResponseRollingReleaseCurrentDeploymentTarget: any;
|
|
612
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
613
|
+
export type StartRollingReleaseResponseRollingReleaseCurrentDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
614
|
+
export declare const StartRollingReleaseResponseRollingReleaseCurrentDeploymentSource: any;
|
|
615
|
+
/** The current deployment receiving production traffic */
|
|
616
|
+
export interface StartRollingReleaseResponseRollingReleaseCurrentDeployment {
|
|
617
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
618
|
+
name: string;
|
|
619
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
620
|
+
createdAt: number;
|
|
621
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
622
|
+
readyState: StartRollingReleaseResponseRollingReleaseCurrentDeploymentReadyState;
|
|
623
|
+
/** A string holding the unique ID of the deployment */
|
|
624
|
+
id: string;
|
|
625
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
626
|
+
target?: StartRollingReleaseResponseRollingReleaseCurrentDeploymentTarget | null;
|
|
627
|
+
readyStateAt?: number;
|
|
628
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
629
|
+
source?: StartRollingReleaseResponseRollingReleaseCurrentDeploymentSource;
|
|
630
|
+
/** A string with the unique URL of the deployment */
|
|
631
|
+
url: string;
|
|
632
|
+
}
|
|
633
|
+
export declare const StartRollingReleaseResponseRollingReleaseCurrentDeployment: S.Schema<StartRollingReleaseResponseRollingReleaseCurrentDeployment>;
|
|
634
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
635
|
+
export type StartRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState = "BLOCKED" | "BUILDING" | "CANCELED" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY";
|
|
636
|
+
export declare const StartRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState: any;
|
|
637
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
638
|
+
export type StartRollingReleaseResponseRollingReleaseCanaryDeploymentTarget = "production" | "staging";
|
|
639
|
+
export declare const StartRollingReleaseResponseRollingReleaseCanaryDeploymentTarget: any;
|
|
640
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
641
|
+
export type StartRollingReleaseResponseRollingReleaseCanaryDeploymentSource = "api-trigger-git-deploy" | "cli" | "clone/repo" | "drop" | "git" | "git-deploy-hook" | "import" | "import/repo" | "redeploy" | "v0-web";
|
|
642
|
+
export declare const StartRollingReleaseResponseRollingReleaseCanaryDeploymentSource: any;
|
|
643
|
+
/** The canary deployment being rolled out */
|
|
644
|
+
export interface StartRollingReleaseResponseRollingReleaseCanaryDeployment {
|
|
645
|
+
/** The name of the project associated with the deployment at the time that the deployment was created */
|
|
646
|
+
name: string;
|
|
647
|
+
/** A number containing the date when the deployment was created in milliseconds */
|
|
648
|
+
createdAt: number;
|
|
649
|
+
/** The state of the deployment depending on the process of deploying, or if it is ready or in an error state */
|
|
650
|
+
readyState: StartRollingReleaseResponseRollingReleaseCanaryDeploymentReadyState;
|
|
651
|
+
/** A string holding the unique ID of the deployment */
|
|
652
|
+
id: string;
|
|
653
|
+
/** If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment. */
|
|
654
|
+
target?: StartRollingReleaseResponseRollingReleaseCanaryDeploymentTarget | null;
|
|
655
|
+
readyStateAt?: number;
|
|
656
|
+
/** Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it. */
|
|
657
|
+
source?: StartRollingReleaseResponseRollingReleaseCanaryDeploymentSource;
|
|
658
|
+
/** A string with the unique URL of the deployment */
|
|
659
|
+
url: string;
|
|
660
|
+
}
|
|
661
|
+
export declare const StartRollingReleaseResponseRollingReleaseCanaryDeployment: S.Schema<StartRollingReleaseResponseRollingReleaseCanaryDeployment>;
|
|
662
|
+
/** The advancement type of the rolling release */
|
|
663
|
+
export type StartRollingReleaseResponseRollingReleaseAdvancementType = "automatic" | "manual-approval";
|
|
664
|
+
export declare const StartRollingReleaseResponseRollingReleaseAdvancementType: any;
|
|
665
|
+
/** All stages configured for this rolling release */
|
|
666
|
+
export type StartRollingReleaseResponseRollingReleaseStagesItem = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
667
|
+
export declare const StartRollingReleaseResponseRollingReleaseStagesItem: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
668
|
+
/** All stages configured for this rolling release */
|
|
669
|
+
export type StartRollingReleaseResponseRollingReleaseStagesList = Array<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
670
|
+
export declare const StartRollingReleaseResponseRollingReleaseStagesList: S.Schema<StartRollingReleaseResponseRollingReleaseStagesList>;
|
|
671
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
672
|
+
export type StartRollingReleaseResponseRollingReleaseActiveStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
673
|
+
export declare const StartRollingReleaseResponseRollingReleaseActiveStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
674
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
675
|
+
export type StartRollingReleaseResponseRollingReleaseNextStage = ApproveRollingReleaseStageResponseRollingReleaseStagesItem;
|
|
676
|
+
export declare const StartRollingReleaseResponseRollingReleaseNextStage: S.Schema<ApproveRollingReleaseStageResponseRollingReleaseStagesItem>;
|
|
677
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
678
|
+
export interface StartRollingReleaseResponseRollingRelease {
|
|
679
|
+
/** The current state of the rolling release */
|
|
680
|
+
state: StartRollingReleaseResponseRollingReleaseState;
|
|
681
|
+
/** When set to `PAUSED`, the rollout is frozen at the current percentage until continued. */
|
|
682
|
+
substate: StartRollingReleaseResponseRollingReleaseSubstate | null;
|
|
683
|
+
/** The current deployment receiving production traffic */
|
|
684
|
+
currentDeployment: StartRollingReleaseResponseRollingReleaseCurrentDeployment | null;
|
|
685
|
+
/** The canary deployment being rolled out */
|
|
686
|
+
canaryDeployment: StartRollingReleaseResponseRollingReleaseCanaryDeployment | null;
|
|
687
|
+
/** The ID of a deployment queued for the next rolling release */
|
|
688
|
+
queuedDeploymentId: string | null;
|
|
689
|
+
/** The advancement type of the rolling release */
|
|
690
|
+
advancementType: StartRollingReleaseResponseRollingReleaseAdvancementType;
|
|
691
|
+
/** All stages configured for this rolling release */
|
|
692
|
+
stages: StartRollingReleaseResponseRollingReleaseStagesList;
|
|
693
|
+
/** The currently active stage, null if the rollout is aborted */
|
|
694
|
+
activeStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
695
|
+
/** The next stage to be activated, null if not in ACTIVE state */
|
|
696
|
+
nextStage: ApproveRollingReleaseStageResponseRollingReleaseStagesItem | null;
|
|
697
|
+
/** Unix timestamp in milliseconds when the rolling release started */
|
|
698
|
+
startedAt: number;
|
|
699
|
+
/** Unix timestamp in milliseconds when the rolling release was last updated */
|
|
700
|
+
updatedAt: number;
|
|
701
|
+
/** When set (for example while {@link substate} is `PAUSED`), the canary traffic percentage persisted on the rollout document — use for dashboard display when linear shift is active. */
|
|
702
|
+
currentCanaryPercentage?: number;
|
|
703
|
+
}
|
|
704
|
+
export declare const StartRollingReleaseResponseRollingRelease: S.Schema<StartRollingReleaseResponseRollingRelease>;
|
|
705
|
+
export interface StartRollingReleaseResponse {
|
|
706
|
+
/** Rolling release information including configuration and document details, or null if no rolling release exists */
|
|
707
|
+
rollingRelease: StartRollingReleaseResponseRollingRelease | null;
|
|
708
|
+
}
|
|
709
|
+
export declare const StartRollingReleaseResponse: S.Schema<StartRollingReleaseResponse>;
|
|
710
|
+
export interface UpdateRollingReleaseConfigRequest {
|
|
711
|
+
/** Project ID or project name (URL-encoded) */
|
|
712
|
+
idOrName: string;
|
|
713
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
714
|
+
teamId?: string;
|
|
715
|
+
/** The Team slug to perform the request on behalf of. */
|
|
716
|
+
slug?: string;
|
|
717
|
+
}
|
|
718
|
+
export declare const UpdateRollingReleaseConfigRequest: S.Schema<UpdateRollingReleaseConfigRequest>;
|
|
719
|
+
export interface UpdateRollingReleaseConfigResponseBodyCase0 {
|
|
720
|
+
rollingRelease: unknown | null;
|
|
721
|
+
}
|
|
722
|
+
export declare const UpdateRollingReleaseConfigResponseBodyCase0: S.Schema<UpdateRollingReleaseConfigResponseBodyCase0>;
|
|
723
|
+
/** A stage object configured for a rolling release once a new deployment is triggered the first stage will be read in the proxy for first time visitors, and if a RNG < targetPercentage then it will serve the new deployment. Upon approval the next stage will be read, etc. */
|
|
724
|
+
export type UpdateRollingReleaseConfigResponseBodyCase1RollingReleaseStagesItem = GetRollingReleaseConfigResponseRollingReleaseStagesItem;
|
|
725
|
+
export declare const UpdateRollingReleaseConfigResponseBodyCase1RollingReleaseStagesItem: S.Schema<GetRollingReleaseConfigResponseRollingReleaseStagesItem>;
|
|
726
|
+
export type UpdateRollingReleaseConfigResponseBodyCase1RollingReleaseStagesList = Array<GetRollingReleaseConfigResponseRollingReleaseStagesItem>;
|
|
727
|
+
export declare const UpdateRollingReleaseConfigResponseBodyCase1RollingReleaseStagesList: S.Schema<UpdateRollingReleaseConfigResponseBodyCase1RollingReleaseStagesList>;
|
|
728
|
+
export interface UpdateRollingReleaseConfigResponseBodyCase1RollingRelease {
|
|
729
|
+
stages?: UpdateRollingReleaseConfigResponseBodyCase1RollingReleaseStagesList | null;
|
|
730
|
+
}
|
|
731
|
+
export declare const UpdateRollingReleaseConfigResponseBodyCase1RollingRelease: S.Schema<UpdateRollingReleaseConfigResponseBodyCase1RollingRelease>;
|
|
732
|
+
export interface UpdateRollingReleaseConfigResponseBodyCase1 {
|
|
733
|
+
rollingRelease: UpdateRollingReleaseConfigResponseBodyCase1RollingRelease | null;
|
|
734
|
+
}
|
|
735
|
+
export declare const UpdateRollingReleaseConfigResponseBodyCase1: S.Schema<UpdateRollingReleaseConfigResponseBodyCase1>;
|
|
736
|
+
export type UpdateRollingReleaseConfigResponseBody = UpdateRollingReleaseConfigResponseBodyCase0 | UpdateRollingReleaseConfigResponseBodyCase1;
|
|
737
|
+
export declare const UpdateRollingReleaseConfigResponseBody: S.Schema<UpdateRollingReleaseConfigResponseBody>;
|
|
738
|
+
export type UpdateRollingReleaseConfigResponse = UpdateRollingReleaseConfigResponseBody;
|
|
739
|
+
export declare const UpdateRollingReleaseConfigResponse: S.Schema<UpdateRollingReleaseConfigResponse>;
|
|
740
|
+
export type ApproveRollingReleaseStageError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
741
|
+
/** Update the active rolling release to the next stage for a project Advance a rollout to the next stage. This is only needed when rolling releases is configured to require manual approval. */
|
|
742
|
+
export declare const approveRollingReleaseStage: API.OperationMethod<ApproveRollingReleaseStageRequest, ApproveRollingReleaseStageResponse, ApproveRollingReleaseStageError, VercelOpContext>;
|
|
743
|
+
export type CompleteRollingReleaseError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
744
|
+
/** Complete the rolling release for the project Force-complete a Rolling Release. The canary deployment will begin serving 100% of the traffic. */
|
|
745
|
+
export declare const completeRollingRelease: API.OperationMethod<CompleteRollingReleaseRequest, CompleteRollingReleaseResponse, CompleteRollingReleaseError, VercelOpContext>;
|
|
746
|
+
export type DeleteRollingReleaseConfigError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
747
|
+
/** Delete rolling release configuration Disable Rolling Releases for a project means that future deployments will not undergo a rolling release. Changing the config never alters a rollout that's already in-flight—it only affects the next production deployment. If you want to also stop the current rollout, call this endpoint to disable the feature, and then call either the /complete or /abort endpoint. */
|
|
748
|
+
export declare const deleteRollingReleaseConfig: API.OperationMethod<DeleteRollingReleaseConfigRequest, DeleteRollingReleaseConfigResponse, DeleteRollingReleaseConfigError, VercelOpContext>;
|
|
749
|
+
export type GetRollingReleaseError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
750
|
+
/** Get the active rolling release information for a project Return the Rolling Release for a project, regardless of whether the rollout is active, aborted, or completed. If the feature is enabled but no deployment has occurred yet, null will be returned. */
|
|
751
|
+
export declare const getRollingRelease: API.OperationMethod<GetRollingReleaseRequest, GetRollingReleaseResponse, GetRollingReleaseError, VercelOpContext>;
|
|
752
|
+
export type GetRollingReleaseBillingStatusError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
753
|
+
/** Get rolling release billing status Get the Rolling Releases billing status for a project. The team level billing status is used to determine if the project can be configured for rolling releases. */
|
|
754
|
+
export declare const getRollingReleaseBillingStatus: API.OperationMethod<GetRollingReleaseBillingStatusRequest, GetRollingReleaseBillingStatusResponse, GetRollingReleaseBillingStatusError, VercelOpContext>;
|
|
755
|
+
export type GetRollingReleaseConfigError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
756
|
+
/** Get rolling release configuration Get the Rolling Releases configuration for a project. The project-level config is simply a template that will be used for any future rolling release, and not the configuration for any active rolling release. */
|
|
757
|
+
export declare const getRollingReleaseConfig: API.OperationMethod<GetRollingReleaseConfigRequest, GetRollingReleaseConfigResponse, GetRollingReleaseConfigError, VercelOpContext>;
|
|
758
|
+
export type StartRollingReleaseError = BadRequest | Forbidden | NotFound | Conflict | UnprocessableEntity | VercelOpError;
|
|
759
|
+
/** Start a rolling release for the project Start a rolling release for a deployment. If a rolling release is already active for the same canary deployment, returns the current state without side effects. */
|
|
760
|
+
export declare const startRollingRelease: API.OperationMethod<StartRollingReleaseRequest, StartRollingReleaseResponse, StartRollingReleaseError, VercelOpContext>;
|
|
761
|
+
export type UpdateRollingReleaseConfigError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
762
|
+
/** Update the rolling release settings for the project Update (or disable) Rolling Releases for a project. When disabling with the resolve-on-disable feature flag enabled, any active rolling release document is resolved using the disableRolloutAction parameter: "abort" to roll back (default), or "complete" to promote the canary to production. When enabling or updating config, changes only affect the next production deployment and do not alter a rollout that's already in-flight. Note: Enabling Rolling Releases automatically enables skew protection on the project with the default value if it wasn't configured already. */
|
|
763
|
+
export declare const updateRollingReleaseConfig: API.OperationMethod<UpdateRollingReleaseConfigRequest, UpdateRollingReleaseConfigResponse, UpdateRollingReleaseConfigError, VercelOpContext>;
|
|
764
|
+
//# sourceMappingURL=rolling_release.d.ts.map
|