@distilled.cloud/vercel 0.0.0 → 1.0.0-rc.4
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,1020 @@
|
|
|
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 Forbidden_base: S.Class<Forbidden, S.TaggedStruct<"Forbidden", {
|
|
16
|
+
readonly code: any;
|
|
17
|
+
readonly message: any;
|
|
18
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
19
|
+
"@distilled.cloud/error/categories": {
|
|
20
|
+
AuthError: true;
|
|
21
|
+
};
|
|
22
|
+
});
|
|
23
|
+
export declare class Forbidden extends /*@__PURE__*/ Forbidden_base {
|
|
24
|
+
}
|
|
25
|
+
declare const NotFound_base: S.Class<NotFound, S.TaggedStruct<"NotFound", {
|
|
26
|
+
readonly code: any;
|
|
27
|
+
readonly message: any;
|
|
28
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
29
|
+
"@distilled.cloud/error/categories": {
|
|
30
|
+
BadRequestError: true;
|
|
31
|
+
};
|
|
32
|
+
});
|
|
33
|
+
export declare class NotFound extends /*@__PURE__*/ NotFound_base {
|
|
34
|
+
}
|
|
35
|
+
declare const PaymentRequired_base: S.Class<PaymentRequired, S.TaggedStruct<"PaymentRequired", {
|
|
36
|
+
readonly code: any;
|
|
37
|
+
readonly message: any;
|
|
38
|
+
}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
|
|
39
|
+
"@distilled.cloud/error/categories": {
|
|
40
|
+
QuotaError: true;
|
|
41
|
+
};
|
|
42
|
+
});
|
|
43
|
+
export declare class PaymentRequired extends /*@__PURE__*/ PaymentRequired_base {
|
|
44
|
+
}
|
|
45
|
+
/** Type of matcher. One of "equals", "startsWith", or "endsWith". */
|
|
46
|
+
export type CreateCustomEnvironmentRequestBranchMatcherType = "equals" | "startsWith" | "endsWith";
|
|
47
|
+
export declare const CreateCustomEnvironmentRequestBranchMatcherType: any;
|
|
48
|
+
/** How we want to determine a matching branch. This is optional. */
|
|
49
|
+
export interface CreateCustomEnvironmentRequestBranchMatcher {
|
|
50
|
+
/** Type of matcher. One of "equals", "startsWith", or "endsWith". */
|
|
51
|
+
type: CreateCustomEnvironmentRequestBranchMatcherType | (string & {});
|
|
52
|
+
/** Git branch name or portion thereof. */
|
|
53
|
+
pattern: string;
|
|
54
|
+
}
|
|
55
|
+
export declare const CreateCustomEnvironmentRequestBranchMatcher: S.Schema<CreateCustomEnvironmentRequestBranchMatcher>;
|
|
56
|
+
export interface CreateCustomEnvironmentRequest {
|
|
57
|
+
/** The unique project identifier or the project name */
|
|
58
|
+
idOrName: string;
|
|
59
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
60
|
+
teamId?: string;
|
|
61
|
+
/** The Team slug to perform the request on behalf of. */
|
|
62
|
+
slug?: string;
|
|
63
|
+
/** Description of the custom environment. This is optional. */
|
|
64
|
+
description?: string;
|
|
65
|
+
/** How we want to determine a matching branch. This is optional. */
|
|
66
|
+
branchMatcher?: CreateCustomEnvironmentRequestBranchMatcher;
|
|
67
|
+
/** Where to copy environment variables from. This is optional. */
|
|
68
|
+
copyEnvVarsFrom?: string;
|
|
69
|
+
}
|
|
70
|
+
export declare const CreateCustomEnvironmentRequest: S.Schema<CreateCustomEnvironmentRequest>;
|
|
71
|
+
/** The type of environment (production, preview, or development) */
|
|
72
|
+
export type CreateCustomEnvironmentResponseType = "development" | "preview" | "production";
|
|
73
|
+
export declare const CreateCustomEnvironmentResponseType: any;
|
|
74
|
+
/** The type of matching to perform */
|
|
75
|
+
export type CreateCustomEnvironmentResponseBranchMatcherType = "endsWith" | "equals" | "startsWith";
|
|
76
|
+
export declare const CreateCustomEnvironmentResponseBranchMatcherType: any;
|
|
77
|
+
/** Configuration for matching git branches to this environment */
|
|
78
|
+
export interface CreateCustomEnvironmentResponseBranchMatcher {
|
|
79
|
+
/** The type of matching to perform */
|
|
80
|
+
type: CreateCustomEnvironmentResponseBranchMatcherType;
|
|
81
|
+
/** The pattern to match against branch names */
|
|
82
|
+
pattern: string;
|
|
83
|
+
}
|
|
84
|
+
export declare const CreateCustomEnvironmentResponseBranchMatcher: S.Schema<CreateCustomEnvironmentResponseBranchMatcher>;
|
|
85
|
+
export type CreateCustomEnvironmentResponseDomainsItemRedirectStatusCode = 301 | 302 | 307 | 308;
|
|
86
|
+
export declare const CreateCustomEnvironmentResponseDomainsItemRedirectStatusCode: any;
|
|
87
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
88
|
+
export interface CreateCustomEnvironmentResponseDomainsItemVerificationItem {
|
|
89
|
+
type: string;
|
|
90
|
+
domain: string;
|
|
91
|
+
value: string;
|
|
92
|
+
reason: string;
|
|
93
|
+
}
|
|
94
|
+
export declare const CreateCustomEnvironmentResponseDomainsItemVerificationItem: S.Schema<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
95
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
96
|
+
export type CreateCustomEnvironmentResponseDomainsItemVerificationList = Array<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
97
|
+
export declare const CreateCustomEnvironmentResponseDomainsItemVerificationList: S.Schema<CreateCustomEnvironmentResponseDomainsItemVerificationList>;
|
|
98
|
+
/** List of domains associated with this environment */
|
|
99
|
+
export interface CreateCustomEnvironmentResponseDomainsItem {
|
|
100
|
+
name: string;
|
|
101
|
+
apexName: string;
|
|
102
|
+
projectId: string;
|
|
103
|
+
redirect?: string | null;
|
|
104
|
+
redirectStatusCode?: CreateCustomEnvironmentResponseDomainsItemRedirectStatusCode | null;
|
|
105
|
+
gitBranch?: string | null;
|
|
106
|
+
customEnvironmentId?: string | null;
|
|
107
|
+
updatedAt?: number;
|
|
108
|
+
createdAt?: number;
|
|
109
|
+
/** `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed. */
|
|
110
|
+
verified: boolean;
|
|
111
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
112
|
+
verification?: CreateCustomEnvironmentResponseDomainsItemVerificationList;
|
|
113
|
+
}
|
|
114
|
+
export declare const CreateCustomEnvironmentResponseDomainsItem: S.Schema<CreateCustomEnvironmentResponseDomainsItem>;
|
|
115
|
+
/** List of domains associated with this environment */
|
|
116
|
+
export type CreateCustomEnvironmentResponseDomainsList = Array<CreateCustomEnvironmentResponseDomainsItem>;
|
|
117
|
+
export declare const CreateCustomEnvironmentResponseDomainsList: S.Schema<CreateCustomEnvironmentResponseDomainsList>;
|
|
118
|
+
/** List of aliases for the current deployment */
|
|
119
|
+
export type CreateCustomEnvironmentResponseCurrentDeploymentAliasesList = Array<string>;
|
|
120
|
+
export declare const CreateCustomEnvironmentResponseCurrentDeploymentAliasesList: S.Schema<CreateCustomEnvironmentResponseCurrentDeploymentAliasesList>;
|
|
121
|
+
export interface CreateCustomEnvironmentResponse {
|
|
122
|
+
/** Unique identifier for the custom environment (format: env_*) */
|
|
123
|
+
id: string;
|
|
124
|
+
/** URL-friendly name of the environment */
|
|
125
|
+
slug: string;
|
|
126
|
+
/** The type of environment (production, preview, or development) */
|
|
127
|
+
type: CreateCustomEnvironmentResponseType;
|
|
128
|
+
/** Optional description of the environment's purpose */
|
|
129
|
+
description?: string;
|
|
130
|
+
/** Configuration for matching git branches to this environment */
|
|
131
|
+
branchMatcher?: CreateCustomEnvironmentResponseBranchMatcher;
|
|
132
|
+
/** List of domains associated with this environment */
|
|
133
|
+
domains?: CreateCustomEnvironmentResponseDomainsList;
|
|
134
|
+
/** List of aliases for the current deployment */
|
|
135
|
+
currentDeploymentAliases?: CreateCustomEnvironmentResponseCurrentDeploymentAliasesList;
|
|
136
|
+
/** Timestamp when the environment was created */
|
|
137
|
+
createdAt: number;
|
|
138
|
+
/** Timestamp when the environment was last updated */
|
|
139
|
+
updatedAt: number;
|
|
140
|
+
}
|
|
141
|
+
export declare const CreateCustomEnvironmentResponse: S.Schema<CreateCustomEnvironmentResponse>;
|
|
142
|
+
export interface CreateSharedEnvVariableRequestEvsItem {
|
|
143
|
+
/** The name of the Shared Environment Variable */
|
|
144
|
+
key: string;
|
|
145
|
+
/** The value of the Shared Environment Variable */
|
|
146
|
+
value: string;
|
|
147
|
+
/** A comment to add context on what this Shared Environment Variable is for */
|
|
148
|
+
comment?: string;
|
|
149
|
+
}
|
|
150
|
+
export declare const CreateSharedEnvVariableRequestEvsItem: S.Schema<CreateSharedEnvVariableRequestEvsItem>;
|
|
151
|
+
export type CreateSharedEnvVariableRequestEvsList = Array<CreateSharedEnvVariableRequestEvsItem>;
|
|
152
|
+
export declare const CreateSharedEnvVariableRequestEvsList: S.Schema<CreateSharedEnvVariableRequestEvsList>;
|
|
153
|
+
/** The type of environment variable */
|
|
154
|
+
export type CreateSharedEnvVariableRequestType = "encrypted" | "sensitive";
|
|
155
|
+
export declare const CreateSharedEnvVariableRequestType: any;
|
|
156
|
+
export type CreateSharedEnvVariableRequestTargetItem = "production" | "preview" | "development";
|
|
157
|
+
export declare const CreateSharedEnvVariableRequestTargetItem: any;
|
|
158
|
+
/** The target environment of the Shared Environment Variable */
|
|
159
|
+
export type CreateSharedEnvVariableRequestTargetList = Array<CreateSharedEnvVariableRequestTargetItem | (string & {})>;
|
|
160
|
+
export declare const CreateSharedEnvVariableRequestTargetList: S.Schema<CreateSharedEnvVariableRequestTargetList>;
|
|
161
|
+
/** Associate a Shared Environment Variable to projects. */
|
|
162
|
+
export type CreateSharedEnvVariableRequestProjectIdList = Array<string>;
|
|
163
|
+
export declare const CreateSharedEnvVariableRequestProjectIdList: S.Schema<CreateSharedEnvVariableRequestProjectIdList>;
|
|
164
|
+
export interface CreateSharedEnvVariableRequest {
|
|
165
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
166
|
+
teamId?: string;
|
|
167
|
+
/** The Team slug to perform the request on behalf of. */
|
|
168
|
+
slug?: string;
|
|
169
|
+
evs: CreateSharedEnvVariableRequestEvsList;
|
|
170
|
+
/** The type of environment variable */
|
|
171
|
+
type?: CreateSharedEnvVariableRequestType | (string & {});
|
|
172
|
+
/** The target environment of the Shared Environment Variable */
|
|
173
|
+
target?: CreateSharedEnvVariableRequestTargetList;
|
|
174
|
+
/** Associate a Shared Environment Variable to projects. */
|
|
175
|
+
projectId?: CreateSharedEnvVariableRequestProjectIdList;
|
|
176
|
+
}
|
|
177
|
+
export declare const CreateSharedEnvVariableRequest: S.Schema<CreateSharedEnvVariableRequest>;
|
|
178
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
179
|
+
export type CreateSharedEnvVariableResponseCreatedItemProjectIdList = Array<string>;
|
|
180
|
+
export declare const CreateSharedEnvVariableResponseCreatedItemProjectIdList: S.Schema<CreateSharedEnvVariableResponseCreatedItemProjectIdList>;
|
|
181
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
182
|
+
export type CreateSharedEnvVariableResponseCreatedItemType = "encrypted" | "plain" | "sensitive" | "system";
|
|
183
|
+
export declare const CreateSharedEnvVariableResponseCreatedItemType: any;
|
|
184
|
+
/** environments this env variable targets */
|
|
185
|
+
export type CreateSharedEnvVariableResponseCreatedItemTargetItem = "development" | "preview" | "production";
|
|
186
|
+
export declare const CreateSharedEnvVariableResponseCreatedItemTargetItem: any;
|
|
187
|
+
/** environments this env variable targets */
|
|
188
|
+
export type CreateSharedEnvVariableResponseCreatedItemTargetList = Array<CreateSharedEnvVariableResponseCreatedItemTargetItem>;
|
|
189
|
+
export declare const CreateSharedEnvVariableResponseCreatedItemTargetList: S.Schema<CreateSharedEnvVariableResponseCreatedItemTargetList>;
|
|
190
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
191
|
+
export type CreateSharedEnvVariableResponseCreatedItemCustomEnvironmentIdsList = Array<string>;
|
|
192
|
+
export declare const CreateSharedEnvVariableResponseCreatedItemCustomEnvironmentIdsList: S.Schema<CreateSharedEnvVariableResponseCreatedItemCustomEnvironmentIdsList>;
|
|
193
|
+
export interface CreateSharedEnvVariableResponseCreatedItem {
|
|
194
|
+
/** The date when the Shared Env Var was created. */
|
|
195
|
+
created?: string;
|
|
196
|
+
/** The name of the Shared Env Var. */
|
|
197
|
+
key?: string;
|
|
198
|
+
/** The unique identifier of the owner (team) the Shared Env Var was created for. */
|
|
199
|
+
ownerId?: string | null;
|
|
200
|
+
/** The unique identifier of the Shared Env Var. */
|
|
201
|
+
id?: string;
|
|
202
|
+
/** The unique identifier of the user who created the Shared Env Var. */
|
|
203
|
+
createdBy?: string | null;
|
|
204
|
+
/** The unique identifier of the user who deleted the Shared Env Var. */
|
|
205
|
+
deletedBy?: string | null;
|
|
206
|
+
/** The unique identifier of the user who last updated the Shared Env Var. */
|
|
207
|
+
updatedBy?: string | null;
|
|
208
|
+
/** Timestamp for when the Shared Env Var was created. */
|
|
209
|
+
createdAt?: number;
|
|
210
|
+
/** Timestamp for when the Shared Env Var was (soft) deleted. */
|
|
211
|
+
deletedAt?: number;
|
|
212
|
+
/** Timestamp for when the Shared Env Var was last updated. */
|
|
213
|
+
updatedAt?: number;
|
|
214
|
+
/** The value of the Shared Env Var. */
|
|
215
|
+
value?: string;
|
|
216
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
217
|
+
projectId?: CreateSharedEnvVariableResponseCreatedItemProjectIdList;
|
|
218
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
219
|
+
type?: CreateSharedEnvVariableResponseCreatedItemType;
|
|
220
|
+
/** environments this env variable targets */
|
|
221
|
+
target?: CreateSharedEnvVariableResponseCreatedItemTargetList;
|
|
222
|
+
/** whether or not this env varible applies to custom environments */
|
|
223
|
+
applyToAllCustomEnvironments?: boolean;
|
|
224
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
225
|
+
customEnvironmentIds?: CreateSharedEnvVariableResponseCreatedItemCustomEnvironmentIdsList;
|
|
226
|
+
/** whether or not this env variable is decrypted */
|
|
227
|
+
decrypted?: boolean;
|
|
228
|
+
/** A user provided comment that describes what this Shared Env Var is for. */
|
|
229
|
+
comment?: string;
|
|
230
|
+
/** The last editor full name or username. */
|
|
231
|
+
lastEditedByDisplayName?: string;
|
|
232
|
+
}
|
|
233
|
+
export declare const CreateSharedEnvVariableResponseCreatedItem: S.Schema<CreateSharedEnvVariableResponseCreatedItem>;
|
|
234
|
+
export type CreateSharedEnvVariableResponseCreatedList = Array<CreateSharedEnvVariableResponseCreatedItem>;
|
|
235
|
+
export declare const CreateSharedEnvVariableResponseCreatedList: S.Schema<CreateSharedEnvVariableResponseCreatedList>;
|
|
236
|
+
export type CreateSharedEnvVariableResponseFailedItemErrorValueCase1Item = "development" | "development" | "preview" | "preview" | "production";
|
|
237
|
+
export declare const CreateSharedEnvVariableResponseFailedItemErrorValueCase1Item: any;
|
|
238
|
+
export type CreateSharedEnvVariableResponseFailedItemErrorValueCase1List = Array<CreateSharedEnvVariableResponseFailedItemErrorValueCase1Item>;
|
|
239
|
+
export declare const CreateSharedEnvVariableResponseFailedItemErrorValueCase1List: S.Schema<CreateSharedEnvVariableResponseFailedItemErrorValueCase1List>;
|
|
240
|
+
export type CreateSharedEnvVariableResponseFailedItemErrorValue = string | CreateSharedEnvVariableResponseFailedItemErrorValueCase1List;
|
|
241
|
+
export declare const CreateSharedEnvVariableResponseFailedItemErrorValue: S.Schema<CreateSharedEnvVariableResponseFailedItemErrorValue>;
|
|
242
|
+
export type CreateSharedEnvVariableResponseFailedItemErrorTargetCase0Item = "development" | "development" | "preview" | "preview" | "production";
|
|
243
|
+
export declare const CreateSharedEnvVariableResponseFailedItemErrorTargetCase0Item: any;
|
|
244
|
+
export type CreateSharedEnvVariableResponseFailedItemErrorTargetCase0List = Array<CreateSharedEnvVariableResponseFailedItemErrorTargetCase0Item>;
|
|
245
|
+
export declare const CreateSharedEnvVariableResponseFailedItemErrorTargetCase0List: S.Schema<CreateSharedEnvVariableResponseFailedItemErrorTargetCase0List>;
|
|
246
|
+
export type CreateSharedEnvVariableResponseFailedItemErrorTargetCase1 = "development" | "development" | "preview" | "preview" | "production";
|
|
247
|
+
export declare const CreateSharedEnvVariableResponseFailedItemErrorTargetCase1: any;
|
|
248
|
+
export type CreateSharedEnvVariableResponseFailedItemErrorTarget = CreateSharedEnvVariableResponseFailedItemErrorTargetCase0List | CreateSharedEnvVariableResponseFailedItemErrorTargetCase1;
|
|
249
|
+
export declare const CreateSharedEnvVariableResponseFailedItemErrorTarget: S.Schema<CreateSharedEnvVariableResponseFailedItemErrorTarget>;
|
|
250
|
+
export interface CreateSharedEnvVariableResponseFailedItemError {
|
|
251
|
+
code: string;
|
|
252
|
+
message: string;
|
|
253
|
+
key?: string;
|
|
254
|
+
envVarId?: string;
|
|
255
|
+
envVarKey?: string;
|
|
256
|
+
action?: string;
|
|
257
|
+
link?: string;
|
|
258
|
+
value?: CreateSharedEnvVariableResponseFailedItemErrorValue;
|
|
259
|
+
gitBranch?: string;
|
|
260
|
+
target?: CreateSharedEnvVariableResponseFailedItemErrorTarget;
|
|
261
|
+
project?: string;
|
|
262
|
+
}
|
|
263
|
+
export declare const CreateSharedEnvVariableResponseFailedItemError: S.Schema<CreateSharedEnvVariableResponseFailedItemError>;
|
|
264
|
+
export interface CreateSharedEnvVariableResponseFailedItem {
|
|
265
|
+
error: CreateSharedEnvVariableResponseFailedItemError;
|
|
266
|
+
}
|
|
267
|
+
export declare const CreateSharedEnvVariableResponseFailedItem: S.Schema<CreateSharedEnvVariableResponseFailedItem>;
|
|
268
|
+
export type CreateSharedEnvVariableResponseFailedList = Array<CreateSharedEnvVariableResponseFailedItem>;
|
|
269
|
+
export declare const CreateSharedEnvVariableResponseFailedList: S.Schema<CreateSharedEnvVariableResponseFailedList>;
|
|
270
|
+
export interface CreateSharedEnvVariableResponse {
|
|
271
|
+
created: CreateSharedEnvVariableResponseCreatedList;
|
|
272
|
+
failed: CreateSharedEnvVariableResponseFailedList;
|
|
273
|
+
}
|
|
274
|
+
export declare const CreateSharedEnvVariableResponse: S.Schema<CreateSharedEnvVariableResponse>;
|
|
275
|
+
/** IDs of the Shared Environment Variables to delete */
|
|
276
|
+
export type DeleteSharedEnvVariableRequestIdsList = Array<string>;
|
|
277
|
+
export declare const DeleteSharedEnvVariableRequestIdsList: S.Schema<DeleteSharedEnvVariableRequestIdsList>;
|
|
278
|
+
export interface DeleteSharedEnvVariableRequest {
|
|
279
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
280
|
+
teamId?: string;
|
|
281
|
+
/** The Team slug to perform the request on behalf of. */
|
|
282
|
+
slug?: string;
|
|
283
|
+
/** IDs of the Shared Environment Variables to delete */
|
|
284
|
+
ids: DeleteSharedEnvVariableRequestIdsList;
|
|
285
|
+
}
|
|
286
|
+
export declare const DeleteSharedEnvVariableRequest: S.Schema<DeleteSharedEnvVariableRequest>;
|
|
287
|
+
export type DeleteSharedEnvVariableResponseDeletedList = Array<string>;
|
|
288
|
+
export declare const DeleteSharedEnvVariableResponseDeletedList: S.Schema<DeleteSharedEnvVariableResponseDeletedList>;
|
|
289
|
+
export type DeleteSharedEnvVariableResponseFailedItemErrorValueCase1Item = "development" | "development" | "preview" | "preview" | "production";
|
|
290
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemErrorValueCase1Item: any;
|
|
291
|
+
export type DeleteSharedEnvVariableResponseFailedItemErrorValueCase1List = Array<DeleteSharedEnvVariableResponseFailedItemErrorValueCase1Item>;
|
|
292
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemErrorValueCase1List: S.Schema<DeleteSharedEnvVariableResponseFailedItemErrorValueCase1List>;
|
|
293
|
+
export type DeleteSharedEnvVariableResponseFailedItemErrorValue = string | DeleteSharedEnvVariableResponseFailedItemErrorValueCase1List;
|
|
294
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemErrorValue: S.Schema<DeleteSharedEnvVariableResponseFailedItemErrorValue>;
|
|
295
|
+
export type DeleteSharedEnvVariableResponseFailedItemErrorTargetCase0Item = "development" | "development" | "preview" | "preview" | "production";
|
|
296
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemErrorTargetCase0Item: any;
|
|
297
|
+
export type DeleteSharedEnvVariableResponseFailedItemErrorTargetCase0List = Array<DeleteSharedEnvVariableResponseFailedItemErrorTargetCase0Item>;
|
|
298
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemErrorTargetCase0List: S.Schema<DeleteSharedEnvVariableResponseFailedItemErrorTargetCase0List>;
|
|
299
|
+
export type DeleteSharedEnvVariableResponseFailedItemErrorTargetCase1 = "development" | "development" | "preview" | "preview" | "production";
|
|
300
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemErrorTargetCase1: any;
|
|
301
|
+
export type DeleteSharedEnvVariableResponseFailedItemErrorTarget = DeleteSharedEnvVariableResponseFailedItemErrorTargetCase0List | DeleteSharedEnvVariableResponseFailedItemErrorTargetCase1;
|
|
302
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemErrorTarget: S.Schema<DeleteSharedEnvVariableResponseFailedItemErrorTarget>;
|
|
303
|
+
export interface DeleteSharedEnvVariableResponseFailedItemError {
|
|
304
|
+
code: string;
|
|
305
|
+
message: string;
|
|
306
|
+
key?: string;
|
|
307
|
+
envVarId?: string;
|
|
308
|
+
envVarKey?: string;
|
|
309
|
+
action?: string;
|
|
310
|
+
link?: string;
|
|
311
|
+
value?: DeleteSharedEnvVariableResponseFailedItemErrorValue;
|
|
312
|
+
gitBranch?: string;
|
|
313
|
+
target?: DeleteSharedEnvVariableResponseFailedItemErrorTarget;
|
|
314
|
+
project?: string;
|
|
315
|
+
}
|
|
316
|
+
export declare const DeleteSharedEnvVariableResponseFailedItemError: S.Schema<DeleteSharedEnvVariableResponseFailedItemError>;
|
|
317
|
+
export interface DeleteSharedEnvVariableResponseFailedItem {
|
|
318
|
+
error: DeleteSharedEnvVariableResponseFailedItemError;
|
|
319
|
+
}
|
|
320
|
+
export declare const DeleteSharedEnvVariableResponseFailedItem: S.Schema<DeleteSharedEnvVariableResponseFailedItem>;
|
|
321
|
+
export type DeleteSharedEnvVariableResponseFailedList = Array<DeleteSharedEnvVariableResponseFailedItem>;
|
|
322
|
+
export declare const DeleteSharedEnvVariableResponseFailedList: S.Schema<DeleteSharedEnvVariableResponseFailedList>;
|
|
323
|
+
export interface DeleteSharedEnvVariableResponse {
|
|
324
|
+
deleted: DeleteSharedEnvVariableResponseDeletedList;
|
|
325
|
+
failed: DeleteSharedEnvVariableResponseFailedList;
|
|
326
|
+
}
|
|
327
|
+
export declare const DeleteSharedEnvVariableResponse: S.Schema<DeleteSharedEnvVariableResponse>;
|
|
328
|
+
export interface GetCustomEnvironmentRequest {
|
|
329
|
+
/** The unique project identifier or the project name */
|
|
330
|
+
idOrName: string;
|
|
331
|
+
/** The unique custom environment identifier within the project */
|
|
332
|
+
environmentSlugOrId: 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 GetCustomEnvironmentRequest: S.Schema<GetCustomEnvironmentRequest>;
|
|
339
|
+
/** The type of environment (production, preview, or development) */
|
|
340
|
+
export type GetCustomEnvironmentResponseType = "development" | "preview" | "production";
|
|
341
|
+
export declare const GetCustomEnvironmentResponseType: any;
|
|
342
|
+
/** The type of matching to perform */
|
|
343
|
+
export type GetCustomEnvironmentResponseBranchMatcherType = "endsWith" | "equals" | "startsWith";
|
|
344
|
+
export declare const GetCustomEnvironmentResponseBranchMatcherType: any;
|
|
345
|
+
/** Configuration for matching git branches to this environment */
|
|
346
|
+
export interface GetCustomEnvironmentResponseBranchMatcher {
|
|
347
|
+
/** The type of matching to perform */
|
|
348
|
+
type: GetCustomEnvironmentResponseBranchMatcherType;
|
|
349
|
+
/** The pattern to match against branch names */
|
|
350
|
+
pattern: string;
|
|
351
|
+
}
|
|
352
|
+
export declare const GetCustomEnvironmentResponseBranchMatcher: S.Schema<GetCustomEnvironmentResponseBranchMatcher>;
|
|
353
|
+
export type GetCustomEnvironmentResponseDomainsItemRedirectStatusCode = 301 | 302 | 307 | 308;
|
|
354
|
+
export declare const GetCustomEnvironmentResponseDomainsItemRedirectStatusCode: any;
|
|
355
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
356
|
+
export type GetCustomEnvironmentResponseDomainsItemVerificationItem = CreateCustomEnvironmentResponseDomainsItemVerificationItem;
|
|
357
|
+
export declare const GetCustomEnvironmentResponseDomainsItemVerificationItem: S.Schema<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
358
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
359
|
+
export type GetCustomEnvironmentResponseDomainsItemVerificationList = Array<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
360
|
+
export declare const GetCustomEnvironmentResponseDomainsItemVerificationList: S.Schema<GetCustomEnvironmentResponseDomainsItemVerificationList>;
|
|
361
|
+
/** List of domains associated with this environment */
|
|
362
|
+
export interface GetCustomEnvironmentResponseDomainsItem {
|
|
363
|
+
name: string;
|
|
364
|
+
apexName: string;
|
|
365
|
+
projectId: string;
|
|
366
|
+
redirect?: string | null;
|
|
367
|
+
redirectStatusCode?: GetCustomEnvironmentResponseDomainsItemRedirectStatusCode | null;
|
|
368
|
+
gitBranch?: string | null;
|
|
369
|
+
customEnvironmentId?: string | null;
|
|
370
|
+
updatedAt?: number;
|
|
371
|
+
createdAt?: number;
|
|
372
|
+
/** `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed. */
|
|
373
|
+
verified: boolean;
|
|
374
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
375
|
+
verification?: GetCustomEnvironmentResponseDomainsItemVerificationList;
|
|
376
|
+
}
|
|
377
|
+
export declare const GetCustomEnvironmentResponseDomainsItem: S.Schema<GetCustomEnvironmentResponseDomainsItem>;
|
|
378
|
+
/** List of domains associated with this environment */
|
|
379
|
+
export type GetCustomEnvironmentResponseDomainsList = Array<GetCustomEnvironmentResponseDomainsItem>;
|
|
380
|
+
export declare const GetCustomEnvironmentResponseDomainsList: S.Schema<GetCustomEnvironmentResponseDomainsList>;
|
|
381
|
+
/** List of aliases for the current deployment */
|
|
382
|
+
export type GetCustomEnvironmentResponseCurrentDeploymentAliasesList = Array<string>;
|
|
383
|
+
export declare const GetCustomEnvironmentResponseCurrentDeploymentAliasesList: S.Schema<GetCustomEnvironmentResponseCurrentDeploymentAliasesList>;
|
|
384
|
+
export interface GetCustomEnvironmentResponse {
|
|
385
|
+
/** Unique identifier for the custom environment (format: env_*) */
|
|
386
|
+
id: string;
|
|
387
|
+
/** URL-friendly name of the environment */
|
|
388
|
+
slug: string;
|
|
389
|
+
/** The type of environment (production, preview, or development) */
|
|
390
|
+
type: GetCustomEnvironmentResponseType;
|
|
391
|
+
/** Optional description of the environment's purpose */
|
|
392
|
+
description?: string;
|
|
393
|
+
/** Configuration for matching git branches to this environment */
|
|
394
|
+
branchMatcher?: GetCustomEnvironmentResponseBranchMatcher;
|
|
395
|
+
/** List of domains associated with this environment */
|
|
396
|
+
domains?: GetCustomEnvironmentResponseDomainsList;
|
|
397
|
+
/** List of aliases for the current deployment */
|
|
398
|
+
currentDeploymentAliases?: GetCustomEnvironmentResponseCurrentDeploymentAliasesList;
|
|
399
|
+
/** Timestamp when the environment was created */
|
|
400
|
+
createdAt: number;
|
|
401
|
+
/** Timestamp when the environment was last updated */
|
|
402
|
+
updatedAt: number;
|
|
403
|
+
}
|
|
404
|
+
export declare const GetCustomEnvironmentResponse: S.Schema<GetCustomEnvironmentResponse>;
|
|
405
|
+
export interface GetProjectsByIdOrNameCustomEnvironmentsRequest {
|
|
406
|
+
/** The unique project identifier or the project name */
|
|
407
|
+
idOrName: string;
|
|
408
|
+
/** Fetch custom environments for a specific git branch */
|
|
409
|
+
gitBranch?: string;
|
|
410
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
411
|
+
teamId?: string;
|
|
412
|
+
/** The Team slug to perform the request on behalf of. */
|
|
413
|
+
slug?: string;
|
|
414
|
+
}
|
|
415
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsRequest: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsRequest>;
|
|
416
|
+
/** The maximum number of custom environments allowed either by the team's plan type or a custom override. */
|
|
417
|
+
export interface GetProjectsByIdOrNameCustomEnvironmentsResponseAccountLimit {
|
|
418
|
+
total: number;
|
|
419
|
+
}
|
|
420
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseAccountLimit: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseAccountLimit>;
|
|
421
|
+
/** The type of environment (production, preview, or development) */
|
|
422
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemType = "development" | "preview" | "production";
|
|
423
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemType: any;
|
|
424
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemRedirectStatusCode = 301 | 302 | 307 | 308;
|
|
425
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemRedirectStatusCode: any;
|
|
426
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
427
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemVerificationItem = CreateCustomEnvironmentResponseDomainsItemVerificationItem;
|
|
428
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemVerificationItem: S.Schema<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
429
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
430
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemVerificationList = Array<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
431
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemVerificationList: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemVerificationList>;
|
|
432
|
+
/** List of domains associated with this environment */
|
|
433
|
+
export interface GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItem {
|
|
434
|
+
name: string;
|
|
435
|
+
apexName: string;
|
|
436
|
+
projectId: string;
|
|
437
|
+
redirect?: string | null;
|
|
438
|
+
redirectStatusCode?: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemRedirectStatusCode | null;
|
|
439
|
+
gitBranch?: string | null;
|
|
440
|
+
customEnvironmentId?: string | null;
|
|
441
|
+
updatedAt?: number;
|
|
442
|
+
createdAt?: number;
|
|
443
|
+
/** `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed. */
|
|
444
|
+
verified: boolean;
|
|
445
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
446
|
+
verification?: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItemVerificationList;
|
|
447
|
+
}
|
|
448
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItem: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItem>;
|
|
449
|
+
/** List of domains associated with this environment */
|
|
450
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsList = Array<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsItem>;
|
|
451
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsList: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsList>;
|
|
452
|
+
/** The type of matching to perform */
|
|
453
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemBranchMatcherType = "endsWith" | "equals" | "startsWith";
|
|
454
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemBranchMatcherType: any;
|
|
455
|
+
/** Configuration for matching git branches to this environment */
|
|
456
|
+
export interface GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemBranchMatcher {
|
|
457
|
+
/** The type of matching to perform */
|
|
458
|
+
type: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemBranchMatcherType;
|
|
459
|
+
/** The pattern to match against branch names */
|
|
460
|
+
pattern: string;
|
|
461
|
+
}
|
|
462
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemBranchMatcher: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemBranchMatcher>;
|
|
463
|
+
/** List of aliases for the current deployment */
|
|
464
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemCurrentDeploymentAliasesList = Array<string>;
|
|
465
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemCurrentDeploymentAliasesList: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemCurrentDeploymentAliasesList>;
|
|
466
|
+
export interface GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItem {
|
|
467
|
+
/** The type of environment (production, preview, or development) */
|
|
468
|
+
type: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemType;
|
|
469
|
+
/** Optional description of the environment's purpose */
|
|
470
|
+
description?: string;
|
|
471
|
+
/** Timestamp when the environment was created */
|
|
472
|
+
createdAt: number;
|
|
473
|
+
/** Timestamp when the environment was last updated */
|
|
474
|
+
updatedAt: number;
|
|
475
|
+
/** URL-friendly name of the environment */
|
|
476
|
+
slug: string;
|
|
477
|
+
/** Unique identifier for the custom environment (format: env_*) */
|
|
478
|
+
id: string;
|
|
479
|
+
/** List of domains associated with this environment */
|
|
480
|
+
domains?: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemDomainsList;
|
|
481
|
+
/** Configuration for matching git branches to this environment */
|
|
482
|
+
branchMatcher?: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemBranchMatcher;
|
|
483
|
+
/** List of aliases for the current deployment */
|
|
484
|
+
currentDeploymentAliases?: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItemCurrentDeploymentAliasesList;
|
|
485
|
+
}
|
|
486
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItem: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItem>;
|
|
487
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsList = Array<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsItem>;
|
|
488
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsList: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsList>;
|
|
489
|
+
export interface GetProjectsByIdOrNameCustomEnvironmentsResponse {
|
|
490
|
+
/** The maximum number of custom environments allowed either by the team's plan type or a custom override. */
|
|
491
|
+
accountLimit: GetProjectsByIdOrNameCustomEnvironmentsResponseAccountLimit;
|
|
492
|
+
environments: GetProjectsByIdOrNameCustomEnvironmentsResponseEnvironmentsList;
|
|
493
|
+
}
|
|
494
|
+
export declare const GetProjectsByIdOrNameCustomEnvironmentsResponse: S.Schema<GetProjectsByIdOrNameCustomEnvironmentsResponse>;
|
|
495
|
+
export interface GetSharedEnvVarRequest {
|
|
496
|
+
/** The unique ID for the Shared Environment Variable to get the decrypted value. */
|
|
497
|
+
id: string;
|
|
498
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
499
|
+
teamId?: string;
|
|
500
|
+
/** The Team slug to perform the request on behalf of. */
|
|
501
|
+
slug?: string;
|
|
502
|
+
}
|
|
503
|
+
export declare const GetSharedEnvVarRequest: S.Schema<GetSharedEnvVarRequest>;
|
|
504
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
505
|
+
export type GetSharedEnvVarResponseProjectIdList = Array<string>;
|
|
506
|
+
export declare const GetSharedEnvVarResponseProjectIdList: S.Schema<GetSharedEnvVarResponseProjectIdList>;
|
|
507
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
508
|
+
export type GetSharedEnvVarResponseType = "encrypted" | "plain" | "sensitive" | "system";
|
|
509
|
+
export declare const GetSharedEnvVarResponseType: any;
|
|
510
|
+
/** environments this env variable targets */
|
|
511
|
+
export type GetSharedEnvVarResponseTargetItem = "development" | "preview" | "production";
|
|
512
|
+
export declare const GetSharedEnvVarResponseTargetItem: any;
|
|
513
|
+
/** environments this env variable targets */
|
|
514
|
+
export type GetSharedEnvVarResponseTargetList = Array<GetSharedEnvVarResponseTargetItem>;
|
|
515
|
+
export declare const GetSharedEnvVarResponseTargetList: S.Schema<GetSharedEnvVarResponseTargetList>;
|
|
516
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
517
|
+
export type GetSharedEnvVarResponseCustomEnvironmentIdsList = Array<string>;
|
|
518
|
+
export declare const GetSharedEnvVarResponseCustomEnvironmentIdsList: S.Schema<GetSharedEnvVarResponseCustomEnvironmentIdsList>;
|
|
519
|
+
export interface GetSharedEnvVarResponse {
|
|
520
|
+
/** The date when the Shared Env Var was created. */
|
|
521
|
+
created?: string;
|
|
522
|
+
/** The name of the Shared Env Var. */
|
|
523
|
+
key?: string;
|
|
524
|
+
/** The unique identifier of the owner (team) the Shared Env Var was created for. */
|
|
525
|
+
ownerId?: string | null;
|
|
526
|
+
/** The unique identifier of the Shared Env Var. */
|
|
527
|
+
id?: string;
|
|
528
|
+
/** The unique identifier of the user who created the Shared Env Var. */
|
|
529
|
+
createdBy?: string | null;
|
|
530
|
+
/** The unique identifier of the user who deleted the Shared Env Var. */
|
|
531
|
+
deletedBy?: string | null;
|
|
532
|
+
/** The unique identifier of the user who last updated the Shared Env Var. */
|
|
533
|
+
updatedBy?: string | null;
|
|
534
|
+
/** Timestamp for when the Shared Env Var was created. */
|
|
535
|
+
createdAt?: number;
|
|
536
|
+
/** Timestamp for when the Shared Env Var was (soft) deleted. */
|
|
537
|
+
deletedAt?: number;
|
|
538
|
+
/** Timestamp for when the Shared Env Var was last updated. */
|
|
539
|
+
updatedAt?: number;
|
|
540
|
+
/** The value of the Shared Env Var. */
|
|
541
|
+
value?: string;
|
|
542
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
543
|
+
projectId?: GetSharedEnvVarResponseProjectIdList;
|
|
544
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
545
|
+
type?: GetSharedEnvVarResponseType;
|
|
546
|
+
/** environments this env variable targets */
|
|
547
|
+
target?: GetSharedEnvVarResponseTargetList;
|
|
548
|
+
/** whether or not this env varible applies to custom environments */
|
|
549
|
+
applyToAllCustomEnvironments?: boolean;
|
|
550
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
551
|
+
customEnvironmentIds?: GetSharedEnvVarResponseCustomEnvironmentIdsList;
|
|
552
|
+
/** whether or not this env variable is decrypted */
|
|
553
|
+
decrypted?: boolean;
|
|
554
|
+
/** A user provided comment that describes what this Shared Env Var is for. */
|
|
555
|
+
comment?: string;
|
|
556
|
+
/** The last editor full name or username. */
|
|
557
|
+
lastEditedByDisplayName?: string;
|
|
558
|
+
}
|
|
559
|
+
export declare const GetSharedEnvVarResponse: S.Schema<GetSharedEnvVarResponse>;
|
|
560
|
+
export interface ListSharedEnvVariableRequest {
|
|
561
|
+
search?: string;
|
|
562
|
+
/** Filter SharedEnvVariables that belong to a project */
|
|
563
|
+
projectId?: string;
|
|
564
|
+
/** Filter SharedEnvVariables based on comma separated ids */
|
|
565
|
+
ids?: string;
|
|
566
|
+
/** Filter SharedEnvVariables based on comma separated ids */
|
|
567
|
+
exclude_ids?: string;
|
|
568
|
+
/** Filter SharedEnvVariables that belong to a project */
|
|
569
|
+
exclude_projectId?: string;
|
|
570
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
571
|
+
teamId?: string;
|
|
572
|
+
/** The Team slug to perform the request on behalf of. */
|
|
573
|
+
slug?: string;
|
|
574
|
+
}
|
|
575
|
+
export declare const ListSharedEnvVariableRequest: S.Schema<ListSharedEnvVariableRequest>;
|
|
576
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
577
|
+
export type ListSharedEnvVariableResponseDataItemProjectIdList = Array<string>;
|
|
578
|
+
export declare const ListSharedEnvVariableResponseDataItemProjectIdList: S.Schema<ListSharedEnvVariableResponseDataItemProjectIdList>;
|
|
579
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
580
|
+
export type ListSharedEnvVariableResponseDataItemType = "encrypted" | "plain" | "sensitive" | "system";
|
|
581
|
+
export declare const ListSharedEnvVariableResponseDataItemType: any;
|
|
582
|
+
/** environments this env variable targets */
|
|
583
|
+
export type ListSharedEnvVariableResponseDataItemTargetItem = "development" | "preview" | "production";
|
|
584
|
+
export declare const ListSharedEnvVariableResponseDataItemTargetItem: any;
|
|
585
|
+
/** environments this env variable targets */
|
|
586
|
+
export type ListSharedEnvVariableResponseDataItemTargetList = Array<ListSharedEnvVariableResponseDataItemTargetItem>;
|
|
587
|
+
export declare const ListSharedEnvVariableResponseDataItemTargetList: S.Schema<ListSharedEnvVariableResponseDataItemTargetList>;
|
|
588
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
589
|
+
export type ListSharedEnvVariableResponseDataItemCustomEnvironmentIdsList = Array<string>;
|
|
590
|
+
export declare const ListSharedEnvVariableResponseDataItemCustomEnvironmentIdsList: S.Schema<ListSharedEnvVariableResponseDataItemCustomEnvironmentIdsList>;
|
|
591
|
+
export interface ListSharedEnvVariableResponseDataItem {
|
|
592
|
+
/** The date when the Shared Env Var was created. */
|
|
593
|
+
created?: string;
|
|
594
|
+
/** The name of the Shared Env Var. */
|
|
595
|
+
key?: string;
|
|
596
|
+
/** The unique identifier of the owner (team) the Shared Env Var was created for. */
|
|
597
|
+
ownerId?: string | null;
|
|
598
|
+
/** The unique identifier of the Shared Env Var. */
|
|
599
|
+
id?: string;
|
|
600
|
+
/** The unique identifier of the user who created the Shared Env Var. */
|
|
601
|
+
createdBy?: string | null;
|
|
602
|
+
/** The unique identifier of the user who deleted the Shared Env Var. */
|
|
603
|
+
deletedBy?: string | null;
|
|
604
|
+
/** The unique identifier of the user who last updated the Shared Env Var. */
|
|
605
|
+
updatedBy?: string | null;
|
|
606
|
+
/** Timestamp for when the Shared Env Var was created. */
|
|
607
|
+
createdAt?: number;
|
|
608
|
+
/** Timestamp for when the Shared Env Var was (soft) deleted. */
|
|
609
|
+
deletedAt?: number;
|
|
610
|
+
/** Timestamp for when the Shared Env Var was last updated. */
|
|
611
|
+
updatedAt?: number;
|
|
612
|
+
/** The value of the Shared Env Var. */
|
|
613
|
+
value?: string;
|
|
614
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
615
|
+
projectId?: ListSharedEnvVariableResponseDataItemProjectIdList;
|
|
616
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
617
|
+
type?: ListSharedEnvVariableResponseDataItemType;
|
|
618
|
+
/** environments this env variable targets */
|
|
619
|
+
target?: ListSharedEnvVariableResponseDataItemTargetList;
|
|
620
|
+
/** whether or not this env varible applies to custom environments */
|
|
621
|
+
applyToAllCustomEnvironments?: boolean;
|
|
622
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
623
|
+
customEnvironmentIds?: ListSharedEnvVariableResponseDataItemCustomEnvironmentIdsList;
|
|
624
|
+
/** whether or not this env variable is decrypted */
|
|
625
|
+
decrypted?: boolean;
|
|
626
|
+
/** A user provided comment that describes what this Shared Env Var is for. */
|
|
627
|
+
comment?: string;
|
|
628
|
+
/** The last editor full name or username. */
|
|
629
|
+
lastEditedByDisplayName?: string;
|
|
630
|
+
}
|
|
631
|
+
export declare const ListSharedEnvVariableResponseDataItem: S.Schema<ListSharedEnvVariableResponseDataItem>;
|
|
632
|
+
export type ListSharedEnvVariableResponseDataList = Array<ListSharedEnvVariableResponseDataItem>;
|
|
633
|
+
export declare const ListSharedEnvVariableResponseDataList: S.Schema<ListSharedEnvVariableResponseDataList>;
|
|
634
|
+
/** This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data. */
|
|
635
|
+
export interface Pagination {
|
|
636
|
+
/** Amount of items in the current page. */
|
|
637
|
+
count: number;
|
|
638
|
+
/** Timestamp that must be used to request the next page. */
|
|
639
|
+
next: number | null;
|
|
640
|
+
/** Timestamp that must be used to request the previous page. */
|
|
641
|
+
prev: number | null;
|
|
642
|
+
}
|
|
643
|
+
export declare const Pagination: S.Schema<Pagination>;
|
|
644
|
+
export interface ListSharedEnvVariableResponse {
|
|
645
|
+
data: ListSharedEnvVariableResponseDataList;
|
|
646
|
+
pagination: Pagination;
|
|
647
|
+
}
|
|
648
|
+
export declare const ListSharedEnvVariableResponse: S.Schema<ListSharedEnvVariableResponse>;
|
|
649
|
+
export interface RemoveCustomEnvironmentRequest {
|
|
650
|
+
/** The unique project identifier or the project name */
|
|
651
|
+
idOrName: string;
|
|
652
|
+
/** The unique custom environment identifier within the project */
|
|
653
|
+
environmentSlugOrId: string;
|
|
654
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
655
|
+
teamId?: string;
|
|
656
|
+
/** The Team slug to perform the request on behalf of. */
|
|
657
|
+
slug?: string;
|
|
658
|
+
/** Delete Environment Variables that are not assigned to any environments. */
|
|
659
|
+
deleteUnassignedEnvironmentVariables?: boolean;
|
|
660
|
+
}
|
|
661
|
+
export declare const RemoveCustomEnvironmentRequest: S.Schema<RemoveCustomEnvironmentRequest>;
|
|
662
|
+
/** The type of environment (production, preview, or development) */
|
|
663
|
+
export type RemoveCustomEnvironmentResponseType = "development" | "preview" | "production";
|
|
664
|
+
export declare const RemoveCustomEnvironmentResponseType: any;
|
|
665
|
+
/** The type of matching to perform */
|
|
666
|
+
export type RemoveCustomEnvironmentResponseBranchMatcherType = "endsWith" | "equals" | "startsWith";
|
|
667
|
+
export declare const RemoveCustomEnvironmentResponseBranchMatcherType: any;
|
|
668
|
+
/** Configuration for matching git branches to this environment */
|
|
669
|
+
export interface RemoveCustomEnvironmentResponseBranchMatcher {
|
|
670
|
+
/** The type of matching to perform */
|
|
671
|
+
type: RemoveCustomEnvironmentResponseBranchMatcherType;
|
|
672
|
+
/** The pattern to match against branch names */
|
|
673
|
+
pattern: string;
|
|
674
|
+
}
|
|
675
|
+
export declare const RemoveCustomEnvironmentResponseBranchMatcher: S.Schema<RemoveCustomEnvironmentResponseBranchMatcher>;
|
|
676
|
+
export type RemoveCustomEnvironmentResponseDomainsItemRedirectStatusCode = 301 | 302 | 307 | 308;
|
|
677
|
+
export declare const RemoveCustomEnvironmentResponseDomainsItemRedirectStatusCode: any;
|
|
678
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
679
|
+
export type RemoveCustomEnvironmentResponseDomainsItemVerificationItem = CreateCustomEnvironmentResponseDomainsItemVerificationItem;
|
|
680
|
+
export declare const RemoveCustomEnvironmentResponseDomainsItemVerificationItem: S.Schema<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
681
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
682
|
+
export type RemoveCustomEnvironmentResponseDomainsItemVerificationList = Array<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
683
|
+
export declare const RemoveCustomEnvironmentResponseDomainsItemVerificationList: S.Schema<RemoveCustomEnvironmentResponseDomainsItemVerificationList>;
|
|
684
|
+
/** List of domains associated with this environment */
|
|
685
|
+
export interface RemoveCustomEnvironmentResponseDomainsItem {
|
|
686
|
+
name: string;
|
|
687
|
+
apexName: string;
|
|
688
|
+
projectId: string;
|
|
689
|
+
redirect?: string | null;
|
|
690
|
+
redirectStatusCode?: RemoveCustomEnvironmentResponseDomainsItemRedirectStatusCode | null;
|
|
691
|
+
gitBranch?: string | null;
|
|
692
|
+
customEnvironmentId?: string | null;
|
|
693
|
+
updatedAt?: number;
|
|
694
|
+
createdAt?: number;
|
|
695
|
+
/** `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed. */
|
|
696
|
+
verified: boolean;
|
|
697
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
698
|
+
verification?: RemoveCustomEnvironmentResponseDomainsItemVerificationList;
|
|
699
|
+
}
|
|
700
|
+
export declare const RemoveCustomEnvironmentResponseDomainsItem: S.Schema<RemoveCustomEnvironmentResponseDomainsItem>;
|
|
701
|
+
/** List of domains associated with this environment */
|
|
702
|
+
export type RemoveCustomEnvironmentResponseDomainsList = Array<RemoveCustomEnvironmentResponseDomainsItem>;
|
|
703
|
+
export declare const RemoveCustomEnvironmentResponseDomainsList: S.Schema<RemoveCustomEnvironmentResponseDomainsList>;
|
|
704
|
+
/** List of aliases for the current deployment */
|
|
705
|
+
export type RemoveCustomEnvironmentResponseCurrentDeploymentAliasesList = Array<string>;
|
|
706
|
+
export declare const RemoveCustomEnvironmentResponseCurrentDeploymentAliasesList: S.Schema<RemoveCustomEnvironmentResponseCurrentDeploymentAliasesList>;
|
|
707
|
+
export interface RemoveCustomEnvironmentResponse {
|
|
708
|
+
/** Unique identifier for the custom environment (format: env_*) */
|
|
709
|
+
id: string;
|
|
710
|
+
/** URL-friendly name of the environment */
|
|
711
|
+
slug: string;
|
|
712
|
+
/** The type of environment (production, preview, or development) */
|
|
713
|
+
type: RemoveCustomEnvironmentResponseType;
|
|
714
|
+
/** Optional description of the environment's purpose */
|
|
715
|
+
description?: string;
|
|
716
|
+
/** Configuration for matching git branches to this environment */
|
|
717
|
+
branchMatcher?: RemoveCustomEnvironmentResponseBranchMatcher;
|
|
718
|
+
/** List of domains associated with this environment */
|
|
719
|
+
domains?: RemoveCustomEnvironmentResponseDomainsList;
|
|
720
|
+
/** List of aliases for the current deployment */
|
|
721
|
+
currentDeploymentAliases?: RemoveCustomEnvironmentResponseCurrentDeploymentAliasesList;
|
|
722
|
+
/** Timestamp when the environment was created */
|
|
723
|
+
createdAt: number;
|
|
724
|
+
/** Timestamp when the environment was last updated */
|
|
725
|
+
updatedAt: number;
|
|
726
|
+
}
|
|
727
|
+
export declare const RemoveCustomEnvironmentResponse: S.Schema<RemoveCustomEnvironmentResponse>;
|
|
728
|
+
export interface UnlinkSharedEnvVariableRequest {
|
|
729
|
+
/** The unique ID for the Shared Environment Variable to unlink from the project. */
|
|
730
|
+
id: string;
|
|
731
|
+
projectId: string;
|
|
732
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
733
|
+
teamId?: string;
|
|
734
|
+
/** The Team slug to perform the request on behalf of. */
|
|
735
|
+
slug?: string;
|
|
736
|
+
}
|
|
737
|
+
export declare const UnlinkSharedEnvVariableRequest: S.Schema<UnlinkSharedEnvVariableRequest>;
|
|
738
|
+
export interface UnlinkSharedEnvVariableResponse {
|
|
739
|
+
id: string;
|
|
740
|
+
}
|
|
741
|
+
export declare const UnlinkSharedEnvVariableResponse: S.Schema<UnlinkSharedEnvVariableResponse>;
|
|
742
|
+
/** Type of matcher. One of "equals", "startsWith", or "endsWith". */
|
|
743
|
+
export type UpdateCustomEnvironmentRequestBranchMatcherType = "equals" | "startsWith" | "endsWith";
|
|
744
|
+
export declare const UpdateCustomEnvironmentRequestBranchMatcherType: any;
|
|
745
|
+
/** How we want to determine a matching branch. This is optional. */
|
|
746
|
+
export interface UpdateCustomEnvironmentRequestBranchMatcher {
|
|
747
|
+
/** Type of matcher. One of "equals", "startsWith", or "endsWith". */
|
|
748
|
+
type: UpdateCustomEnvironmentRequestBranchMatcherType | (string & {});
|
|
749
|
+
/** Git branch name or portion thereof. */
|
|
750
|
+
pattern: string;
|
|
751
|
+
}
|
|
752
|
+
export declare const UpdateCustomEnvironmentRequestBranchMatcher: S.Schema<UpdateCustomEnvironmentRequestBranchMatcher>;
|
|
753
|
+
export interface UpdateCustomEnvironmentRequest {
|
|
754
|
+
/** The unique project identifier or the project name */
|
|
755
|
+
idOrName: string;
|
|
756
|
+
/** The unique custom environment identifier within the project */
|
|
757
|
+
environmentSlugOrId: string;
|
|
758
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
759
|
+
teamId?: string;
|
|
760
|
+
/** The Team slug to perform the request on behalf of. */
|
|
761
|
+
slug?: string;
|
|
762
|
+
/** Description of the custom environment. This is optional. */
|
|
763
|
+
description?: string;
|
|
764
|
+
/** How we want to determine a matching branch. This is optional. */
|
|
765
|
+
branchMatcher?: UpdateCustomEnvironmentRequestBranchMatcher | null;
|
|
766
|
+
}
|
|
767
|
+
export declare const UpdateCustomEnvironmentRequest: S.Schema<UpdateCustomEnvironmentRequest>;
|
|
768
|
+
/** The type of environment (production, preview, or development) */
|
|
769
|
+
export type UpdateCustomEnvironmentResponseType = "development" | "preview" | "production";
|
|
770
|
+
export declare const UpdateCustomEnvironmentResponseType: any;
|
|
771
|
+
/** The type of matching to perform */
|
|
772
|
+
export type UpdateCustomEnvironmentResponseBranchMatcherType = "endsWith" | "equals" | "startsWith";
|
|
773
|
+
export declare const UpdateCustomEnvironmentResponseBranchMatcherType: any;
|
|
774
|
+
/** Configuration for matching git branches to this environment */
|
|
775
|
+
export interface UpdateCustomEnvironmentResponseBranchMatcher {
|
|
776
|
+
/** The type of matching to perform */
|
|
777
|
+
type: UpdateCustomEnvironmentResponseBranchMatcherType;
|
|
778
|
+
/** The pattern to match against branch names */
|
|
779
|
+
pattern: string;
|
|
780
|
+
}
|
|
781
|
+
export declare const UpdateCustomEnvironmentResponseBranchMatcher: S.Schema<UpdateCustomEnvironmentResponseBranchMatcher>;
|
|
782
|
+
export type UpdateCustomEnvironmentResponseDomainsItemRedirectStatusCode = 301 | 302 | 307 | 308;
|
|
783
|
+
export declare const UpdateCustomEnvironmentResponseDomainsItemRedirectStatusCode: any;
|
|
784
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
785
|
+
export type UpdateCustomEnvironmentResponseDomainsItemVerificationItem = CreateCustomEnvironmentResponseDomainsItemVerificationItem;
|
|
786
|
+
export declare const UpdateCustomEnvironmentResponseDomainsItemVerificationItem: S.Schema<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
787
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
788
|
+
export type UpdateCustomEnvironmentResponseDomainsItemVerificationList = Array<CreateCustomEnvironmentResponseDomainsItemVerificationItem>;
|
|
789
|
+
export declare const UpdateCustomEnvironmentResponseDomainsItemVerificationList: S.Schema<UpdateCustomEnvironmentResponseDomainsItemVerificationList>;
|
|
790
|
+
/** List of domains associated with this environment */
|
|
791
|
+
export interface UpdateCustomEnvironmentResponseDomainsItem {
|
|
792
|
+
name: string;
|
|
793
|
+
apexName: string;
|
|
794
|
+
projectId: string;
|
|
795
|
+
redirect?: string | null;
|
|
796
|
+
redirectStatusCode?: UpdateCustomEnvironmentResponseDomainsItemRedirectStatusCode | null;
|
|
797
|
+
gitBranch?: string | null;
|
|
798
|
+
customEnvironmentId?: string | null;
|
|
799
|
+
updatedAt?: number;
|
|
800
|
+
createdAt?: number;
|
|
801
|
+
/** `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed. */
|
|
802
|
+
verified: boolean;
|
|
803
|
+
/** A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`. */
|
|
804
|
+
verification?: UpdateCustomEnvironmentResponseDomainsItemVerificationList;
|
|
805
|
+
}
|
|
806
|
+
export declare const UpdateCustomEnvironmentResponseDomainsItem: S.Schema<UpdateCustomEnvironmentResponseDomainsItem>;
|
|
807
|
+
/** List of domains associated with this environment */
|
|
808
|
+
export type UpdateCustomEnvironmentResponseDomainsList = Array<UpdateCustomEnvironmentResponseDomainsItem>;
|
|
809
|
+
export declare const UpdateCustomEnvironmentResponseDomainsList: S.Schema<UpdateCustomEnvironmentResponseDomainsList>;
|
|
810
|
+
/** List of aliases for the current deployment */
|
|
811
|
+
export type UpdateCustomEnvironmentResponseCurrentDeploymentAliasesList = Array<string>;
|
|
812
|
+
export declare const UpdateCustomEnvironmentResponseCurrentDeploymentAliasesList: S.Schema<UpdateCustomEnvironmentResponseCurrentDeploymentAliasesList>;
|
|
813
|
+
export interface UpdateCustomEnvironmentResponse {
|
|
814
|
+
/** Unique identifier for the custom environment (format: env_*) */
|
|
815
|
+
id: string;
|
|
816
|
+
/** URL-friendly name of the environment */
|
|
817
|
+
slug: string;
|
|
818
|
+
/** The type of environment (production, preview, or development) */
|
|
819
|
+
type: UpdateCustomEnvironmentResponseType;
|
|
820
|
+
/** Optional description of the environment's purpose */
|
|
821
|
+
description?: string;
|
|
822
|
+
/** Configuration for matching git branches to this environment */
|
|
823
|
+
branchMatcher?: UpdateCustomEnvironmentResponseBranchMatcher;
|
|
824
|
+
/** List of domains associated with this environment */
|
|
825
|
+
domains?: UpdateCustomEnvironmentResponseDomainsList;
|
|
826
|
+
/** List of aliases for the current deployment */
|
|
827
|
+
currentDeploymentAliases?: UpdateCustomEnvironmentResponseCurrentDeploymentAliasesList;
|
|
828
|
+
/** Timestamp when the environment was created */
|
|
829
|
+
createdAt: number;
|
|
830
|
+
/** Timestamp when the environment was last updated */
|
|
831
|
+
updatedAt: number;
|
|
832
|
+
}
|
|
833
|
+
export declare const UpdateCustomEnvironmentResponse: S.Schema<UpdateCustomEnvironmentResponse>;
|
|
834
|
+
export type UpdateSharedEnvVariableRequestUpdatesValueTargetItem = "production" | "preview" | "development";
|
|
835
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValueTargetItem: any;
|
|
836
|
+
/** The target environment of the Shared Environment Variable */
|
|
837
|
+
export type UpdateSharedEnvVariableRequestUpdatesValueTargetList = Array<UpdateSharedEnvVariableRequestUpdatesValueTargetItem | (string & {})>;
|
|
838
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValueTargetList: S.Schema<UpdateSharedEnvVariableRequestUpdatesValueTargetList>;
|
|
839
|
+
/** Associate a Shared Environment Variable to projects. */
|
|
840
|
+
export type UpdateSharedEnvVariableRequestUpdatesValueProjectIdList = Array<string>;
|
|
841
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValueProjectIdList: S.Schema<UpdateSharedEnvVariableRequestUpdatesValueProjectIdList>;
|
|
842
|
+
/** Project IDs to add to this environment variable */
|
|
843
|
+
export type UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesLinkList = Array<string>;
|
|
844
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesLinkList: S.Schema<UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesLinkList>;
|
|
845
|
+
/** Project IDs to remove from this environment variable */
|
|
846
|
+
export type UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesUnlinkList = Array<string>;
|
|
847
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesUnlinkList: S.Schema<UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesUnlinkList>;
|
|
848
|
+
/** Incrementally update project linking without specifying the full list */
|
|
849
|
+
export interface UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdates {
|
|
850
|
+
/** Project IDs to add to this environment variable */
|
|
851
|
+
link?: UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesLinkList;
|
|
852
|
+
/** Project IDs to remove from this environment variable */
|
|
853
|
+
unlink?: UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdatesUnlinkList;
|
|
854
|
+
}
|
|
855
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdates: S.Schema<UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdates>;
|
|
856
|
+
/** The new type of the Shared Environment Variable */
|
|
857
|
+
export type UpdateSharedEnvVariableRequestUpdatesValueType = "encrypted" | "sensitive";
|
|
858
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValueType: any;
|
|
859
|
+
export interface UpdateSharedEnvVariableRequestUpdatesValue {
|
|
860
|
+
/** The name of the Shared Environment Variable */
|
|
861
|
+
key?: string;
|
|
862
|
+
/** The value of the Shared Environment Variable */
|
|
863
|
+
value?: string;
|
|
864
|
+
/** The target environment of the Shared Environment Variable */
|
|
865
|
+
target?: UpdateSharedEnvVariableRequestUpdatesValueTargetList;
|
|
866
|
+
/** Associate a Shared Environment Variable to projects. */
|
|
867
|
+
projectId?: UpdateSharedEnvVariableRequestUpdatesValueProjectIdList;
|
|
868
|
+
/** Incrementally update project linking without specifying the full list */
|
|
869
|
+
projectIdUpdates?: UpdateSharedEnvVariableRequestUpdatesValueProjectIdUpdates;
|
|
870
|
+
/** The new type of the Shared Environment Variable */
|
|
871
|
+
type?: UpdateSharedEnvVariableRequestUpdatesValueType | (string & {});
|
|
872
|
+
/** A comment to add context on what this Shared Environment Variable is for */
|
|
873
|
+
comment?: string;
|
|
874
|
+
}
|
|
875
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesValue: S.Schema<UpdateSharedEnvVariableRequestUpdatesValue>;
|
|
876
|
+
/** An object where each key is an environment variable ID (not the key name) and the value is the update to apply */
|
|
877
|
+
export type UpdateSharedEnvVariableRequestUpdatesMap = {
|
|
878
|
+
[key: string]: UpdateSharedEnvVariableRequestUpdatesValue | undefined;
|
|
879
|
+
};
|
|
880
|
+
export declare const UpdateSharedEnvVariableRequestUpdatesMap: S.Schema<UpdateSharedEnvVariableRequestUpdatesMap>;
|
|
881
|
+
export interface UpdateSharedEnvVariableRequest {
|
|
882
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
883
|
+
teamId?: string;
|
|
884
|
+
/** The Team slug to perform the request on behalf of. */
|
|
885
|
+
slug?: string;
|
|
886
|
+
/** An object where each key is an environment variable ID (not the key name) and the value is the update to apply */
|
|
887
|
+
updates: UpdateSharedEnvVariableRequestUpdatesMap;
|
|
888
|
+
}
|
|
889
|
+
export declare const UpdateSharedEnvVariableRequest: S.Schema<UpdateSharedEnvVariableRequest>;
|
|
890
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
891
|
+
export type UpdateSharedEnvVariableResponseUpdatedItemProjectIdList = Array<string>;
|
|
892
|
+
export declare const UpdateSharedEnvVariableResponseUpdatedItemProjectIdList: S.Schema<UpdateSharedEnvVariableResponseUpdatedItemProjectIdList>;
|
|
893
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
894
|
+
export type UpdateSharedEnvVariableResponseUpdatedItemType = "encrypted" | "plain" | "sensitive" | "system";
|
|
895
|
+
export declare const UpdateSharedEnvVariableResponseUpdatedItemType: any;
|
|
896
|
+
/** environments this env variable targets */
|
|
897
|
+
export type UpdateSharedEnvVariableResponseUpdatedItemTargetItem = "development" | "preview" | "production";
|
|
898
|
+
export declare const UpdateSharedEnvVariableResponseUpdatedItemTargetItem: any;
|
|
899
|
+
/** environments this env variable targets */
|
|
900
|
+
export type UpdateSharedEnvVariableResponseUpdatedItemTargetList = Array<UpdateSharedEnvVariableResponseUpdatedItemTargetItem>;
|
|
901
|
+
export declare const UpdateSharedEnvVariableResponseUpdatedItemTargetList: S.Schema<UpdateSharedEnvVariableResponseUpdatedItemTargetList>;
|
|
902
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
903
|
+
export type UpdateSharedEnvVariableResponseUpdatedItemCustomEnvironmentIdsList = Array<string>;
|
|
904
|
+
export declare const UpdateSharedEnvVariableResponseUpdatedItemCustomEnvironmentIdsList: S.Schema<UpdateSharedEnvVariableResponseUpdatedItemCustomEnvironmentIdsList>;
|
|
905
|
+
export interface UpdateSharedEnvVariableResponseUpdatedItem {
|
|
906
|
+
/** The date when the Shared Env Var was created. */
|
|
907
|
+
created?: string;
|
|
908
|
+
/** The name of the Shared Env Var. */
|
|
909
|
+
key?: string;
|
|
910
|
+
/** The unique identifier of the owner (team) the Shared Env Var was created for. */
|
|
911
|
+
ownerId?: string | null;
|
|
912
|
+
/** The unique identifier of the Shared Env Var. */
|
|
913
|
+
id?: string;
|
|
914
|
+
/** The unique identifier of the user who created the Shared Env Var. */
|
|
915
|
+
createdBy?: string | null;
|
|
916
|
+
/** The unique identifier of the user who deleted the Shared Env Var. */
|
|
917
|
+
deletedBy?: string | null;
|
|
918
|
+
/** The unique identifier of the user who last updated the Shared Env Var. */
|
|
919
|
+
updatedBy?: string | null;
|
|
920
|
+
/** Timestamp for when the Shared Env Var was created. */
|
|
921
|
+
createdAt?: number;
|
|
922
|
+
/** Timestamp for when the Shared Env Var was (soft) deleted. */
|
|
923
|
+
deletedAt?: number;
|
|
924
|
+
/** Timestamp for when the Shared Env Var was last updated. */
|
|
925
|
+
updatedAt?: number;
|
|
926
|
+
/** The value of the Shared Env Var. */
|
|
927
|
+
value?: string;
|
|
928
|
+
/** The unique identifiers of the projects which the Shared Env Var is linked to. */
|
|
929
|
+
projectId?: UpdateSharedEnvVariableResponseUpdatedItemProjectIdList;
|
|
930
|
+
/** The type of this cosmos doc instance, if blank, assume secret. */
|
|
931
|
+
type?: UpdateSharedEnvVariableResponseUpdatedItemType;
|
|
932
|
+
/** environments this env variable targets */
|
|
933
|
+
target?: UpdateSharedEnvVariableResponseUpdatedItemTargetList;
|
|
934
|
+
/** whether or not this env varible applies to custom environments */
|
|
935
|
+
applyToAllCustomEnvironments?: boolean;
|
|
936
|
+
/** The custom environment IDs that this Shared Env Var is scoped to. */
|
|
937
|
+
customEnvironmentIds?: UpdateSharedEnvVariableResponseUpdatedItemCustomEnvironmentIdsList;
|
|
938
|
+
/** whether or not this env variable is decrypted */
|
|
939
|
+
decrypted?: boolean;
|
|
940
|
+
/** A user provided comment that describes what this Shared Env Var is for. */
|
|
941
|
+
comment?: string;
|
|
942
|
+
/** The last editor full name or username. */
|
|
943
|
+
lastEditedByDisplayName?: string;
|
|
944
|
+
}
|
|
945
|
+
export declare const UpdateSharedEnvVariableResponseUpdatedItem: S.Schema<UpdateSharedEnvVariableResponseUpdatedItem>;
|
|
946
|
+
export type UpdateSharedEnvVariableResponseUpdatedList = Array<UpdateSharedEnvVariableResponseUpdatedItem>;
|
|
947
|
+
export declare const UpdateSharedEnvVariableResponseUpdatedList: S.Schema<UpdateSharedEnvVariableResponseUpdatedList>;
|
|
948
|
+
export type UpdateSharedEnvVariableResponseFailedItemErrorValueCase1Item = "development" | "development" | "preview" | "preview" | "production";
|
|
949
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemErrorValueCase1Item: any;
|
|
950
|
+
export type UpdateSharedEnvVariableResponseFailedItemErrorValueCase1List = Array<UpdateSharedEnvVariableResponseFailedItemErrorValueCase1Item>;
|
|
951
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemErrorValueCase1List: S.Schema<UpdateSharedEnvVariableResponseFailedItemErrorValueCase1List>;
|
|
952
|
+
export type UpdateSharedEnvVariableResponseFailedItemErrorValue = string | UpdateSharedEnvVariableResponseFailedItemErrorValueCase1List;
|
|
953
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemErrorValue: S.Schema<UpdateSharedEnvVariableResponseFailedItemErrorValue>;
|
|
954
|
+
export type UpdateSharedEnvVariableResponseFailedItemErrorTargetCase0Item = "development" | "development" | "preview" | "preview" | "production";
|
|
955
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemErrorTargetCase0Item: any;
|
|
956
|
+
export type UpdateSharedEnvVariableResponseFailedItemErrorTargetCase0List = Array<UpdateSharedEnvVariableResponseFailedItemErrorTargetCase0Item>;
|
|
957
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemErrorTargetCase0List: S.Schema<UpdateSharedEnvVariableResponseFailedItemErrorTargetCase0List>;
|
|
958
|
+
export type UpdateSharedEnvVariableResponseFailedItemErrorTargetCase1 = "development" | "development" | "preview" | "preview" | "production";
|
|
959
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemErrorTargetCase1: any;
|
|
960
|
+
export type UpdateSharedEnvVariableResponseFailedItemErrorTarget = UpdateSharedEnvVariableResponseFailedItemErrorTargetCase0List | UpdateSharedEnvVariableResponseFailedItemErrorTargetCase1;
|
|
961
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemErrorTarget: S.Schema<UpdateSharedEnvVariableResponseFailedItemErrorTarget>;
|
|
962
|
+
export interface UpdateSharedEnvVariableResponseFailedItemError {
|
|
963
|
+
code: string;
|
|
964
|
+
message: string;
|
|
965
|
+
key?: string;
|
|
966
|
+
envVarId?: string;
|
|
967
|
+
envVarKey?: string;
|
|
968
|
+
action?: string;
|
|
969
|
+
link?: string;
|
|
970
|
+
value?: UpdateSharedEnvVariableResponseFailedItemErrorValue;
|
|
971
|
+
gitBranch?: string;
|
|
972
|
+
target?: UpdateSharedEnvVariableResponseFailedItemErrorTarget;
|
|
973
|
+
project?: string;
|
|
974
|
+
}
|
|
975
|
+
export declare const UpdateSharedEnvVariableResponseFailedItemError: S.Schema<UpdateSharedEnvVariableResponseFailedItemError>;
|
|
976
|
+
export interface UpdateSharedEnvVariableResponseFailedItem {
|
|
977
|
+
error: UpdateSharedEnvVariableResponseFailedItemError;
|
|
978
|
+
}
|
|
979
|
+
export declare const UpdateSharedEnvVariableResponseFailedItem: S.Schema<UpdateSharedEnvVariableResponseFailedItem>;
|
|
980
|
+
export type UpdateSharedEnvVariableResponseFailedList = Array<UpdateSharedEnvVariableResponseFailedItem>;
|
|
981
|
+
export declare const UpdateSharedEnvVariableResponseFailedList: S.Schema<UpdateSharedEnvVariableResponseFailedList>;
|
|
982
|
+
export interface UpdateSharedEnvVariableResponse {
|
|
983
|
+
updated: UpdateSharedEnvVariableResponseUpdatedList;
|
|
984
|
+
failed: UpdateSharedEnvVariableResponseFailedList;
|
|
985
|
+
}
|
|
986
|
+
export declare const UpdateSharedEnvVariableResponse: S.Schema<UpdateSharedEnvVariableResponse>;
|
|
987
|
+
export type CreateCustomEnvironmentError = BadRequest | PaymentRequired | Forbidden | VercelOpError;
|
|
988
|
+
/** Create a custom environment for the current project. Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'. */
|
|
989
|
+
export declare const createCustomEnvironment: API.OperationMethod<CreateCustomEnvironmentRequest, CreateCustomEnvironmentResponse, CreateCustomEnvironmentError, VercelOpContext>;
|
|
990
|
+
export type CreateSharedEnvVariableError = BadRequest | PaymentRequired | Forbidden | VercelOpError;
|
|
991
|
+
/** Create one or more shared environment variables Creates shared environment variable(s) for a team. */
|
|
992
|
+
export declare const createSharedEnvVariable: API.OperationMethod<CreateSharedEnvVariableRequest, CreateSharedEnvVariableResponse, CreateSharedEnvVariableError, VercelOpContext>;
|
|
993
|
+
export type DeleteSharedEnvVariableError = BadRequest | PaymentRequired | Forbidden | VercelOpError;
|
|
994
|
+
/** Delete one or more Env Var Deletes one or many Shared Environment Variables for a given team. */
|
|
995
|
+
export declare const deleteSharedEnvVariable: API.OperationMethod<DeleteSharedEnvVariableRequest, DeleteSharedEnvVariableResponse, DeleteSharedEnvVariableError, VercelOpContext>;
|
|
996
|
+
export type GetCustomEnvironmentError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
997
|
+
/** Retrieve a custom environment Retrieve a custom environment for the project. Must not be named 'Production' or 'Preview'. */
|
|
998
|
+
export declare const getCustomEnvironment: API.OperationMethod<GetCustomEnvironmentRequest, GetCustomEnvironmentResponse, GetCustomEnvironmentError, VercelOpContext>;
|
|
999
|
+
export type GetProjectsByIdOrNameCustomEnvironmentsError = BadRequest | Forbidden | VercelOpError;
|
|
1000
|
+
/** Retrieve custom environments Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'. */
|
|
1001
|
+
export declare const getProjectsByIdOrNameCustomEnvironments: API.OperationMethod<GetProjectsByIdOrNameCustomEnvironmentsRequest, GetProjectsByIdOrNameCustomEnvironmentsResponse, GetProjectsByIdOrNameCustomEnvironmentsError, VercelOpContext>;
|
|
1002
|
+
export type GetSharedEnvVarError = BadRequest | Forbidden | VercelOpError;
|
|
1003
|
+
/** Retrieve the decrypted value of a Shared Environment Variable by id. Retrieve the decrypted value of a Shared Environment Variable by id. */
|
|
1004
|
+
export declare const getSharedEnvVar: API.OperationMethod<GetSharedEnvVarRequest, GetSharedEnvVarResponse, GetSharedEnvVarError, VercelOpContext>;
|
|
1005
|
+
export type ListSharedEnvVariableError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
1006
|
+
/** Lists all Shared Environment Variables for a team Lists all Shared Environment Variables for a team, taking into account optional filters. */
|
|
1007
|
+
export declare const listSharedEnvVariable: API.OperationMethod<ListSharedEnvVariableRequest, ListSharedEnvVariableResponse, ListSharedEnvVariableError, VercelOpContext>;
|
|
1008
|
+
export type RemoveCustomEnvironmentError = BadRequest | Forbidden | VercelOpError;
|
|
1009
|
+
/** Remove a custom environment Remove a custom environment for the project. Must not be named 'Production' or 'Preview'. */
|
|
1010
|
+
export declare const removeCustomEnvironment: API.OperationMethod<RemoveCustomEnvironmentRequest, RemoveCustomEnvironmentResponse, RemoveCustomEnvironmentError, VercelOpContext>;
|
|
1011
|
+
export type UnlinkSharedEnvVariableError = BadRequest | Forbidden | VercelOpError;
|
|
1012
|
+
/** Disconnects a shared environment variable for a given project Disconnects a shared environment variable for a given project */
|
|
1013
|
+
export declare const unlinkSharedEnvVariable: API.OperationMethod<UnlinkSharedEnvVariableRequest, UnlinkSharedEnvVariableResponse, UnlinkSharedEnvVariableError, VercelOpContext>;
|
|
1014
|
+
export type UpdateCustomEnvironmentError = BadRequest | PaymentRequired | Forbidden | VercelOpError;
|
|
1015
|
+
/** Update a custom environment Update a custom environment for the project. Must not be named 'Production' or 'Preview'. */
|
|
1016
|
+
export declare const updateCustomEnvironment: API.OperationMethod<UpdateCustomEnvironmentRequest, UpdateCustomEnvironmentResponse, UpdateCustomEnvironmentError, VercelOpContext>;
|
|
1017
|
+
export type UpdateSharedEnvVariableError = BadRequest | PaymentRequired | Forbidden | VercelOpError;
|
|
1018
|
+
/** Updates one or more shared environment variables Updates a given Shared Environment Variable for a Team. */
|
|
1019
|
+
export declare const updateSharedEnvVariable: API.OperationMethod<UpdateSharedEnvVariableRequest, UpdateSharedEnvVariableResponse, UpdateSharedEnvVariableError, VercelOpContext>;
|
|
1020
|
+
//# sourceMappingURL=environment.d.ts.map
|