@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,1209 @@
|
|
|
1
|
+
// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/openapi.json). Do not edit.
|
|
2
|
+
import * as S from "@distilled.cloud/core/schema";
|
|
3
|
+
import * as API from "@distilled.cloud/core/api";
|
|
4
|
+
import * as C from "@distilled.cloud/core/category";
|
|
5
|
+
import * as T from "../traits.ts";
|
|
6
|
+
import {
|
|
7
|
+
VercelProtocol,
|
|
8
|
+
type VercelOpError,
|
|
9
|
+
type VercelOpContext,
|
|
10
|
+
} from "../protocol.ts";
|
|
11
|
+
import * as Retry from "../retry.ts";
|
|
12
|
+
|
|
13
|
+
export type { VercelOpError, VercelOpContext };
|
|
14
|
+
|
|
15
|
+
export class BadRequest
|
|
16
|
+
extends /*@__PURE__*/ T.applyErrorMatchers(
|
|
17
|
+
/*@__PURE__*/ S.TaggedError<BadRequest>()("BadRequest", {
|
|
18
|
+
code: S.Number,
|
|
19
|
+
message: S.String,
|
|
20
|
+
}).pipe(C.withBadRequestError),
|
|
21
|
+
[{ status: 400 }],
|
|
22
|
+
) {}
|
|
23
|
+
|
|
24
|
+
export class Conflict
|
|
25
|
+
extends /*@__PURE__*/ T.applyErrorMatchers(
|
|
26
|
+
/*@__PURE__*/ S.TaggedError<Conflict>()("Conflict", {
|
|
27
|
+
code: S.Number,
|
|
28
|
+
message: S.String,
|
|
29
|
+
}).pipe(C.withConflictError),
|
|
30
|
+
[{ status: 409 }],
|
|
31
|
+
) {}
|
|
32
|
+
|
|
33
|
+
export class Forbidden
|
|
34
|
+
extends /*@__PURE__*/ T.applyErrorMatchers(
|
|
35
|
+
/*@__PURE__*/ S.TaggedError<Forbidden>()("Forbidden", {
|
|
36
|
+
code: S.Number,
|
|
37
|
+
message: S.String,
|
|
38
|
+
}).pipe(C.withAuthError),
|
|
39
|
+
[{ status: 403 }],
|
|
40
|
+
) {}
|
|
41
|
+
|
|
42
|
+
export class NotFound
|
|
43
|
+
extends /*@__PURE__*/ T.applyErrorMatchers(
|
|
44
|
+
/*@__PURE__*/ S.TaggedError<NotFound>()("NotFound", {
|
|
45
|
+
code: S.Number,
|
|
46
|
+
message: S.String,
|
|
47
|
+
}).pipe(C.withBadRequestError),
|
|
48
|
+
[{ status: 404 }],
|
|
49
|
+
) {}
|
|
50
|
+
|
|
51
|
+
export class PaymentRequired
|
|
52
|
+
extends /*@__PURE__*/ T.applyErrorMatchers(
|
|
53
|
+
/*@__PURE__*/ S.TaggedError<PaymentRequired>()("PaymentRequired", {
|
|
54
|
+
code: S.Number,
|
|
55
|
+
message: S.String,
|
|
56
|
+
}).pipe(C.withQuotaError),
|
|
57
|
+
[{ status: 402 }],
|
|
58
|
+
) {}
|
|
59
|
+
|
|
60
|
+
export interface ClaimDomainOwnershipRequest {
|
|
61
|
+
/** The domain name to claim ownership of */
|
|
62
|
+
domain: string;
|
|
63
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
64
|
+
teamId?: string;
|
|
65
|
+
/** The Team slug to perform the request on behalf of. */
|
|
66
|
+
slug?: string;
|
|
67
|
+
}
|
|
68
|
+
export const ClaimDomainOwnershipRequest = /*@__PURE__*/ S.suspend(() =>
|
|
69
|
+
S.Struct({
|
|
70
|
+
domain: S.String.pipe(T.Label()),
|
|
71
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
72
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
73
|
+
}).pipe(
|
|
74
|
+
T.Http({ method: "POST", uri: "/v9/domains/{domain}/claim", code: 200 }),
|
|
75
|
+
),
|
|
76
|
+
).annotate({
|
|
77
|
+
identifier: "ClaimDomainOwnershipRequest",
|
|
78
|
+
}) as any as S.Schema<ClaimDomainOwnershipRequest>;
|
|
79
|
+
|
|
80
|
+
/** A list of the current nameservers of the domain. */
|
|
81
|
+
export type ClaimDomainOwnershipResponseDomainNameserversList = Array<string>;
|
|
82
|
+
export const ClaimDomainOwnershipResponseDomainNameserversList =
|
|
83
|
+
/*@__PURE__*/ S.Array(
|
|
84
|
+
S.String,
|
|
85
|
+
) as any as S.Schema<ClaimDomainOwnershipResponseDomainNameserversList>;
|
|
86
|
+
|
|
87
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
88
|
+
export type ClaimDomainOwnershipResponseDomainIntendedNameserversList =
|
|
89
|
+
Array<string>;
|
|
90
|
+
export const ClaimDomainOwnershipResponseDomainIntendedNameserversList =
|
|
91
|
+
/*@__PURE__*/ S.Array(
|
|
92
|
+
S.String,
|
|
93
|
+
) as any as S.Schema<ClaimDomainOwnershipResponseDomainIntendedNameserversList>;
|
|
94
|
+
|
|
95
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
96
|
+
export type ClaimDomainOwnershipResponseDomainCustomNameserversList =
|
|
97
|
+
Array<string>;
|
|
98
|
+
export const ClaimDomainOwnershipResponseDomainCustomNameserversList =
|
|
99
|
+
/*@__PURE__*/ S.Array(
|
|
100
|
+
S.String,
|
|
101
|
+
) as any as S.Schema<ClaimDomainOwnershipResponseDomainCustomNameserversList>;
|
|
102
|
+
|
|
103
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
104
|
+
export interface ClaimDomainOwnershipResponseDomainCreator {
|
|
105
|
+
username: string;
|
|
106
|
+
email: string;
|
|
107
|
+
customerId?: string | null;
|
|
108
|
+
isDomainReseller?: boolean;
|
|
109
|
+
id: string;
|
|
110
|
+
}
|
|
111
|
+
export const ClaimDomainOwnershipResponseDomainCreator =
|
|
112
|
+
/*@__PURE__*/ S.suspend(() =>
|
|
113
|
+
S.Struct({
|
|
114
|
+
username: S.String,
|
|
115
|
+
email: S.String,
|
|
116
|
+
customerId: S.optional(S.NullOr(S.String)),
|
|
117
|
+
isDomainReseller: S.optional(S.Boolean),
|
|
118
|
+
id: S.String,
|
|
119
|
+
}),
|
|
120
|
+
).annotate({
|
|
121
|
+
identifier: "ClaimDomainOwnershipResponseDomainCreator",
|
|
122
|
+
}) as any as S.Schema<ClaimDomainOwnershipResponseDomainCreator>;
|
|
123
|
+
|
|
124
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
125
|
+
export type ClaimDomainOwnershipResponseDomainServiceType =
|
|
126
|
+
| "external"
|
|
127
|
+
| "na"
|
|
128
|
+
| "zeit.world";
|
|
129
|
+
export const ClaimDomainOwnershipResponseDomainServiceType =
|
|
130
|
+
/*@__PURE__*/ S.String;
|
|
131
|
+
|
|
132
|
+
export interface ClaimDomainOwnershipResponseDomain {
|
|
133
|
+
/** Timestamp in milliseconds at which the domain is set to expire. null if not bought with Vercel. */
|
|
134
|
+
expiresAt: number | null;
|
|
135
|
+
/** If the domain has the ownership verified. */
|
|
136
|
+
verified: boolean;
|
|
137
|
+
/** A list of the current nameservers of the domain. */
|
|
138
|
+
nameservers: ClaimDomainOwnershipResponseDomainNameserversList;
|
|
139
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
140
|
+
intendedNameservers: ClaimDomainOwnershipResponseDomainIntendedNameserversList;
|
|
141
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
142
|
+
customNameservers?: ClaimDomainOwnershipResponseDomainCustomNameserversList;
|
|
143
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
144
|
+
creator: ClaimDomainOwnershipResponseDomainCreator;
|
|
145
|
+
/** The domain name. */
|
|
146
|
+
name: string;
|
|
147
|
+
teamId: string | null;
|
|
148
|
+
/** If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. */
|
|
149
|
+
boughtAt: number | null;
|
|
150
|
+
/** Timestamp in milliseconds when the domain was created in the registry. */
|
|
151
|
+
createdAt: number;
|
|
152
|
+
/** The unique identifier of the domain. */
|
|
153
|
+
id: string;
|
|
154
|
+
/** Indicates whether the domain is set to automatically renew. */
|
|
155
|
+
renew?: boolean;
|
|
156
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
157
|
+
serviceType: ClaimDomainOwnershipResponseDomainServiceType;
|
|
158
|
+
/** Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. */
|
|
159
|
+
transferredAt?: number | null;
|
|
160
|
+
/** If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. */
|
|
161
|
+
transferStartedAt?: number;
|
|
162
|
+
userId: string;
|
|
163
|
+
}
|
|
164
|
+
export const ClaimDomainOwnershipResponseDomain = /*@__PURE__*/ S.suspend(() =>
|
|
165
|
+
S.Struct({
|
|
166
|
+
expiresAt: S.NullOr(S.Number),
|
|
167
|
+
verified: S.Boolean,
|
|
168
|
+
nameservers: ClaimDomainOwnershipResponseDomainNameserversList,
|
|
169
|
+
intendedNameservers:
|
|
170
|
+
ClaimDomainOwnershipResponseDomainIntendedNameserversList,
|
|
171
|
+
customNameservers: S.optional(
|
|
172
|
+
ClaimDomainOwnershipResponseDomainCustomNameserversList,
|
|
173
|
+
),
|
|
174
|
+
creator: ClaimDomainOwnershipResponseDomainCreator,
|
|
175
|
+
name: S.String,
|
|
176
|
+
teamId: S.NullOr(S.String),
|
|
177
|
+
boughtAt: S.NullOr(S.Number),
|
|
178
|
+
createdAt: S.Number,
|
|
179
|
+
id: S.String,
|
|
180
|
+
renew: S.optional(S.Boolean),
|
|
181
|
+
serviceType: ClaimDomainOwnershipResponseDomainServiceType,
|
|
182
|
+
transferredAt: S.optional(S.NullOr(S.Number)),
|
|
183
|
+
transferStartedAt: S.optional(S.Number),
|
|
184
|
+
userId: S.String,
|
|
185
|
+
}),
|
|
186
|
+
).annotate({
|
|
187
|
+
identifier: "ClaimDomainOwnershipResponseDomain",
|
|
188
|
+
}) as any as S.Schema<ClaimDomainOwnershipResponseDomain>;
|
|
189
|
+
|
|
190
|
+
export interface ClaimDomainOwnershipResponse {
|
|
191
|
+
domain: ClaimDomainOwnershipResponseDomain;
|
|
192
|
+
}
|
|
193
|
+
export const ClaimDomainOwnershipResponse = /*@__PURE__*/ S.suspend(() =>
|
|
194
|
+
S.Struct({
|
|
195
|
+
domain: ClaimDomainOwnershipResponseDomain,
|
|
196
|
+
}),
|
|
197
|
+
).annotate({
|
|
198
|
+
identifier: "ClaimDomainOwnershipResponse",
|
|
199
|
+
}) as any as S.Schema<ClaimDomainOwnershipResponse>;
|
|
200
|
+
|
|
201
|
+
export interface CreateOrTransferDomainRequest {
|
|
202
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
203
|
+
teamId?: string;
|
|
204
|
+
/** The Team slug to perform the request on behalf of. */
|
|
205
|
+
slug?: string;
|
|
206
|
+
/** The domain operation to perform. It can be either `add` or `move-in`. */
|
|
207
|
+
method?: string;
|
|
208
|
+
}
|
|
209
|
+
export const CreateOrTransferDomainRequest = /*@__PURE__*/ S.suspend(() =>
|
|
210
|
+
S.Struct({
|
|
211
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
212
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
213
|
+
method: S.optional(S.String),
|
|
214
|
+
}).pipe(T.Http({ method: "POST", uri: "/v7/domains", code: 200 })),
|
|
215
|
+
).annotate({
|
|
216
|
+
identifier: "CreateOrTransferDomainRequest",
|
|
217
|
+
}) as any as S.Schema<CreateOrTransferDomainRequest>;
|
|
218
|
+
|
|
219
|
+
/** A list of the current nameservers of the domain. */
|
|
220
|
+
export type CreateOrTransferDomainResponseDomainNameserversList = Array<string>;
|
|
221
|
+
export const CreateOrTransferDomainResponseDomainNameserversList =
|
|
222
|
+
/*@__PURE__*/ S.Array(
|
|
223
|
+
S.String,
|
|
224
|
+
) as any as S.Schema<CreateOrTransferDomainResponseDomainNameserversList>;
|
|
225
|
+
|
|
226
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
227
|
+
export type CreateOrTransferDomainResponseDomainIntendedNameserversList =
|
|
228
|
+
Array<string>;
|
|
229
|
+
export const CreateOrTransferDomainResponseDomainIntendedNameserversList =
|
|
230
|
+
/*@__PURE__*/ S.Array(
|
|
231
|
+
S.String,
|
|
232
|
+
) as any as S.Schema<CreateOrTransferDomainResponseDomainIntendedNameserversList>;
|
|
233
|
+
|
|
234
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
235
|
+
export type CreateOrTransferDomainResponseDomainCustomNameserversList =
|
|
236
|
+
Array<string>;
|
|
237
|
+
export const CreateOrTransferDomainResponseDomainCustomNameserversList =
|
|
238
|
+
/*@__PURE__*/ S.Array(
|
|
239
|
+
S.String,
|
|
240
|
+
) as any as S.Schema<CreateOrTransferDomainResponseDomainCustomNameserversList>;
|
|
241
|
+
|
|
242
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
243
|
+
export type CreateOrTransferDomainResponseDomainCreator =
|
|
244
|
+
ClaimDomainOwnershipResponseDomainCreator;
|
|
245
|
+
export const CreateOrTransferDomainResponseDomainCreator =
|
|
246
|
+
ClaimDomainOwnershipResponseDomainCreator;
|
|
247
|
+
|
|
248
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
249
|
+
export type CreateOrTransferDomainResponseDomainServiceType =
|
|
250
|
+
| "external"
|
|
251
|
+
| "na"
|
|
252
|
+
| "zeit.world";
|
|
253
|
+
export const CreateOrTransferDomainResponseDomainServiceType =
|
|
254
|
+
/*@__PURE__*/ S.String;
|
|
255
|
+
|
|
256
|
+
export interface CreateOrTransferDomainResponseDomain {
|
|
257
|
+
/** Timestamp in milliseconds at which the domain is set to expire. null if not bought with Vercel. */
|
|
258
|
+
expiresAt: number | null;
|
|
259
|
+
/** If the domain has the ownership verified. */
|
|
260
|
+
verified: boolean;
|
|
261
|
+
/** A list of the current nameservers of the domain. */
|
|
262
|
+
nameservers: CreateOrTransferDomainResponseDomainNameserversList;
|
|
263
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
264
|
+
intendedNameservers: CreateOrTransferDomainResponseDomainIntendedNameserversList;
|
|
265
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
266
|
+
customNameservers?: CreateOrTransferDomainResponseDomainCustomNameserversList;
|
|
267
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
268
|
+
creator: ClaimDomainOwnershipResponseDomainCreator;
|
|
269
|
+
/** The domain name. */
|
|
270
|
+
name: string;
|
|
271
|
+
teamId: string | null;
|
|
272
|
+
/** If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. */
|
|
273
|
+
boughtAt: number | null;
|
|
274
|
+
/** Timestamp in milliseconds when the domain was created in the registry. */
|
|
275
|
+
createdAt: number;
|
|
276
|
+
/** The unique identifier of the domain. */
|
|
277
|
+
id: string;
|
|
278
|
+
/** Indicates whether the domain is set to automatically renew. */
|
|
279
|
+
renew?: boolean;
|
|
280
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
281
|
+
serviceType: CreateOrTransferDomainResponseDomainServiceType;
|
|
282
|
+
/** Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. */
|
|
283
|
+
transferredAt?: number | null;
|
|
284
|
+
/** If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. */
|
|
285
|
+
transferStartedAt?: number;
|
|
286
|
+
userId: string;
|
|
287
|
+
}
|
|
288
|
+
export const CreateOrTransferDomainResponseDomain = /*@__PURE__*/ S.suspend(
|
|
289
|
+
() =>
|
|
290
|
+
S.Struct({
|
|
291
|
+
expiresAt: S.NullOr(S.Number),
|
|
292
|
+
verified: S.Boolean,
|
|
293
|
+
nameservers: CreateOrTransferDomainResponseDomainNameserversList,
|
|
294
|
+
intendedNameservers:
|
|
295
|
+
CreateOrTransferDomainResponseDomainIntendedNameserversList,
|
|
296
|
+
customNameservers: S.optional(
|
|
297
|
+
CreateOrTransferDomainResponseDomainCustomNameserversList,
|
|
298
|
+
),
|
|
299
|
+
creator: ClaimDomainOwnershipResponseDomainCreator,
|
|
300
|
+
name: S.String,
|
|
301
|
+
teamId: S.NullOr(S.String),
|
|
302
|
+
boughtAt: S.NullOr(S.Number),
|
|
303
|
+
createdAt: S.Number,
|
|
304
|
+
id: S.String,
|
|
305
|
+
renew: S.optional(S.Boolean),
|
|
306
|
+
serviceType: CreateOrTransferDomainResponseDomainServiceType,
|
|
307
|
+
transferredAt: S.optional(S.NullOr(S.Number)),
|
|
308
|
+
transferStartedAt: S.optional(S.Number),
|
|
309
|
+
userId: S.String,
|
|
310
|
+
}),
|
|
311
|
+
).annotate({
|
|
312
|
+
identifier: "CreateOrTransferDomainResponseDomain",
|
|
313
|
+
}) as any as S.Schema<CreateOrTransferDomainResponseDomain>;
|
|
314
|
+
|
|
315
|
+
export interface CreateOrTransferDomainResponse {
|
|
316
|
+
domain: CreateOrTransferDomainResponseDomain;
|
|
317
|
+
}
|
|
318
|
+
export const CreateOrTransferDomainResponse = /*@__PURE__*/ S.suspend(() =>
|
|
319
|
+
S.Struct({
|
|
320
|
+
domain: CreateOrTransferDomainResponseDomain,
|
|
321
|
+
}),
|
|
322
|
+
).annotate({
|
|
323
|
+
identifier: "CreateOrTransferDomainResponse",
|
|
324
|
+
}) as any as S.Schema<CreateOrTransferDomainResponse>;
|
|
325
|
+
|
|
326
|
+
export interface DeleteDomainRequest {
|
|
327
|
+
/** The name of the domain. */
|
|
328
|
+
domain: string;
|
|
329
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
330
|
+
teamId?: string;
|
|
331
|
+
/** The Team slug to perform the request on behalf of. */
|
|
332
|
+
slug?: string;
|
|
333
|
+
}
|
|
334
|
+
export const DeleteDomainRequest = /*@__PURE__*/ S.suspend(() =>
|
|
335
|
+
S.Struct({
|
|
336
|
+
domain: S.String.pipe(T.Label()),
|
|
337
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
338
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
339
|
+
}).pipe(T.Http({ method: "DELETE", uri: "/v6/domains/{domain}", code: 200 })),
|
|
340
|
+
).annotate({
|
|
341
|
+
identifier: "DeleteDomainRequest",
|
|
342
|
+
}) as any as S.Schema<DeleteDomainRequest>;
|
|
343
|
+
|
|
344
|
+
export interface DeleteDomainResponse {
|
|
345
|
+
uid: string;
|
|
346
|
+
}
|
|
347
|
+
export const DeleteDomainResponse = /*@__PURE__*/ S.suspend(() =>
|
|
348
|
+
S.Struct({
|
|
349
|
+
uid: S.String,
|
|
350
|
+
}),
|
|
351
|
+
).annotate({
|
|
352
|
+
identifier: "DeleteDomainResponse",
|
|
353
|
+
}) as any as S.Schema<DeleteDomainResponse>;
|
|
354
|
+
|
|
355
|
+
export interface GetDomainRequest {
|
|
356
|
+
/** The name of the domain. */
|
|
357
|
+
domain: string;
|
|
358
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
359
|
+
teamId?: string;
|
|
360
|
+
/** The Team slug to perform the request on behalf of. */
|
|
361
|
+
slug?: string;
|
|
362
|
+
}
|
|
363
|
+
export const GetDomainRequest = /*@__PURE__*/ S.suspend(() =>
|
|
364
|
+
S.Struct({
|
|
365
|
+
domain: S.String.pipe(T.Label()),
|
|
366
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
367
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
368
|
+
}).pipe(T.Http({ method: "GET", uri: "/v5/domains/{domain}", code: 200 })),
|
|
369
|
+
).annotate({
|
|
370
|
+
identifier: "GetDomainRequest",
|
|
371
|
+
}) as any as S.Schema<GetDomainRequest>;
|
|
372
|
+
|
|
373
|
+
/** A list of the current nameservers of the domain. */
|
|
374
|
+
export type GetDomainResponseDomainNameserversList = Array<string>;
|
|
375
|
+
export const GetDomainResponseDomainNameserversList = /*@__PURE__*/ S.Array(
|
|
376
|
+
S.String,
|
|
377
|
+
) as any as S.Schema<GetDomainResponseDomainNameserversList>;
|
|
378
|
+
|
|
379
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
380
|
+
export type GetDomainResponseDomainIntendedNameserversList = Array<string>;
|
|
381
|
+
export const GetDomainResponseDomainIntendedNameserversList =
|
|
382
|
+
/*@__PURE__*/ S.Array(
|
|
383
|
+
S.String,
|
|
384
|
+
) as any as S.Schema<GetDomainResponseDomainIntendedNameserversList>;
|
|
385
|
+
|
|
386
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
387
|
+
export type GetDomainResponseDomainCustomNameserversList = Array<string>;
|
|
388
|
+
export const GetDomainResponseDomainCustomNameserversList =
|
|
389
|
+
/*@__PURE__*/ S.Array(
|
|
390
|
+
S.String,
|
|
391
|
+
) as any as S.Schema<GetDomainResponseDomainCustomNameserversList>;
|
|
392
|
+
|
|
393
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
394
|
+
export type GetDomainResponseDomainCreator =
|
|
395
|
+
ClaimDomainOwnershipResponseDomainCreator;
|
|
396
|
+
export const GetDomainResponseDomainCreator =
|
|
397
|
+
ClaimDomainOwnershipResponseDomainCreator;
|
|
398
|
+
|
|
399
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
400
|
+
export type GetDomainResponseDomainServiceType =
|
|
401
|
+
| "external"
|
|
402
|
+
| "na"
|
|
403
|
+
| "zeit.world";
|
|
404
|
+
export const GetDomainResponseDomainServiceType = /*@__PURE__*/ S.String;
|
|
405
|
+
|
|
406
|
+
export interface GetDomainResponseDomain {
|
|
407
|
+
suffix: boolean;
|
|
408
|
+
/** Timestamp in milliseconds at which the domain is set to expire. null if not bought with Vercel. */
|
|
409
|
+
expiresAt: number | null;
|
|
410
|
+
/** If the domain has the ownership verified. */
|
|
411
|
+
verified: boolean;
|
|
412
|
+
/** A list of the current nameservers of the domain. */
|
|
413
|
+
nameservers: GetDomainResponseDomainNameserversList;
|
|
414
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
415
|
+
intendedNameservers: GetDomainResponseDomainIntendedNameserversList;
|
|
416
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
417
|
+
customNameservers?: GetDomainResponseDomainCustomNameserversList;
|
|
418
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
419
|
+
creator: ClaimDomainOwnershipResponseDomainCreator;
|
|
420
|
+
/** The domain name. */
|
|
421
|
+
name: string;
|
|
422
|
+
teamId: string | null;
|
|
423
|
+
/** If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. */
|
|
424
|
+
boughtAt: number | null;
|
|
425
|
+
/** Timestamp in milliseconds when the domain was created in the registry. */
|
|
426
|
+
createdAt: number;
|
|
427
|
+
/** The unique identifier of the domain. */
|
|
428
|
+
id: string;
|
|
429
|
+
/** Indicates whether the domain is set to automatically renew. */
|
|
430
|
+
renew?: boolean;
|
|
431
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
432
|
+
serviceType: GetDomainResponseDomainServiceType;
|
|
433
|
+
/** Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. */
|
|
434
|
+
transferredAt?: number | null;
|
|
435
|
+
/** If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. */
|
|
436
|
+
transferStartedAt?: number;
|
|
437
|
+
userId: string;
|
|
438
|
+
}
|
|
439
|
+
export const GetDomainResponseDomain = /*@__PURE__*/ S.suspend(() =>
|
|
440
|
+
S.Struct({
|
|
441
|
+
suffix: S.Boolean,
|
|
442
|
+
expiresAt: S.NullOr(S.Number),
|
|
443
|
+
verified: S.Boolean,
|
|
444
|
+
nameservers: GetDomainResponseDomainNameserversList,
|
|
445
|
+
intendedNameservers: GetDomainResponseDomainIntendedNameserversList,
|
|
446
|
+
customNameservers: S.optional(GetDomainResponseDomainCustomNameserversList),
|
|
447
|
+
creator: ClaimDomainOwnershipResponseDomainCreator,
|
|
448
|
+
name: S.String,
|
|
449
|
+
teamId: S.NullOr(S.String),
|
|
450
|
+
boughtAt: S.NullOr(S.Number),
|
|
451
|
+
createdAt: S.Number,
|
|
452
|
+
id: S.String,
|
|
453
|
+
renew: S.optional(S.Boolean),
|
|
454
|
+
serviceType: GetDomainResponseDomainServiceType,
|
|
455
|
+
transferredAt: S.optional(S.NullOr(S.Number)),
|
|
456
|
+
transferStartedAt: S.optional(S.Number),
|
|
457
|
+
userId: S.String,
|
|
458
|
+
}),
|
|
459
|
+
).annotate({
|
|
460
|
+
identifier: "GetDomainResponseDomain",
|
|
461
|
+
}) as any as S.Schema<GetDomainResponseDomain>;
|
|
462
|
+
|
|
463
|
+
export interface GetDomainResponse {
|
|
464
|
+
domain: GetDomainResponseDomain;
|
|
465
|
+
}
|
|
466
|
+
export const GetDomainResponse = /*@__PURE__*/ S.suspend(() =>
|
|
467
|
+
S.Struct({
|
|
468
|
+
domain: GetDomainResponseDomain,
|
|
469
|
+
}),
|
|
470
|
+
).annotate({
|
|
471
|
+
identifier: "GetDomainResponse",
|
|
472
|
+
}) as any as S.Schema<GetDomainResponse>;
|
|
473
|
+
|
|
474
|
+
/** When true, the response will only include the nameservers assigned directly to the specified domain. When false and there are no nameservers assigned directly to the specified domain, the response will include the nameservers of the domain's parent zone. */
|
|
475
|
+
export type GetDomainConfigRequestStrict = "true" | "false";
|
|
476
|
+
export const GetDomainConfigRequestStrict = /*@__PURE__*/ S.String;
|
|
477
|
+
|
|
478
|
+
export interface GetDomainConfigRequest {
|
|
479
|
+
/** The name of the domain. */
|
|
480
|
+
domain: string;
|
|
481
|
+
/** The project id or name that will be associated with the domain. Use this when the domain is not yet associated with a project. */
|
|
482
|
+
projectIdOrName?: string;
|
|
483
|
+
/** When true, the response will only include the nameservers assigned directly to the specified domain. When false and there are no nameservers assigned directly to the specified domain, the response will include the nameservers of the domain's parent zone. */
|
|
484
|
+
strict?: GetDomainConfigRequestStrict | (string & {});
|
|
485
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
486
|
+
teamId?: string;
|
|
487
|
+
/** The Team slug to perform the request on behalf of. */
|
|
488
|
+
slug?: string;
|
|
489
|
+
}
|
|
490
|
+
export const GetDomainConfigRequest = /*@__PURE__*/ S.suspend(() =>
|
|
491
|
+
S.Struct({
|
|
492
|
+
domain: S.String.pipe(T.Label()),
|
|
493
|
+
projectIdOrName: S.optional(S.String.pipe(T.Query())),
|
|
494
|
+
strict: S.optional(GetDomainConfigRequestStrict.pipe(T.Query())),
|
|
495
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
496
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
497
|
+
}).pipe(
|
|
498
|
+
T.Http({ method: "GET", uri: "/v6/domains/{domain}/config", code: 200 }),
|
|
499
|
+
),
|
|
500
|
+
).annotate({
|
|
501
|
+
identifier: "GetDomainConfigRequest",
|
|
502
|
+
}) as any as S.Schema<GetDomainConfigRequest>;
|
|
503
|
+
|
|
504
|
+
/** How we see the domain's configuration. - `CNAME`: Domain has a CNAME pointing to Vercel. - `A`: Domain's A record is resolving to Vercel. - `http`: Domain is resolving to Vercel but may be behind a Proxy. - `dns-01`: Domain is not resolving to Vercel but dns-01 challenge is enabled. - `null`: Domain is not resolving to Vercel. */
|
|
505
|
+
export type GetDomainConfigResponseConfiguredBy =
|
|
506
|
+
| "A"
|
|
507
|
+
| "CNAME"
|
|
508
|
+
| "dns-01"
|
|
509
|
+
| "http";
|
|
510
|
+
export const GetDomainConfigResponseConfiguredBy = /*@__PURE__*/ S.String;
|
|
511
|
+
|
|
512
|
+
/** Which challenge types the domain can use for issuing certs. */
|
|
513
|
+
export type GetDomainConfigResponseAcceptedChallengesItem =
|
|
514
|
+
| "dns-01"
|
|
515
|
+
| "http-01";
|
|
516
|
+
export const GetDomainConfigResponseAcceptedChallengesItem =
|
|
517
|
+
/*@__PURE__*/ S.String;
|
|
518
|
+
|
|
519
|
+
/** Which challenge types the domain can use for issuing certs. */
|
|
520
|
+
export type GetDomainConfigResponseAcceptedChallengesList =
|
|
521
|
+
Array<GetDomainConfigResponseAcceptedChallengesItem>;
|
|
522
|
+
export const GetDomainConfigResponseAcceptedChallengesList =
|
|
523
|
+
/*@__PURE__*/ S.Array(
|
|
524
|
+
GetDomainConfigResponseAcceptedChallengesItem,
|
|
525
|
+
) as any as S.Schema<GetDomainConfigResponseAcceptedChallengesList>;
|
|
526
|
+
|
|
527
|
+
export type GetDomainConfigResponseRecommendedIPv4ItemValueList = Array<string>;
|
|
528
|
+
export const GetDomainConfigResponseRecommendedIPv4ItemValueList =
|
|
529
|
+
/*@__PURE__*/ S.Array(
|
|
530
|
+
S.String,
|
|
531
|
+
) as any as S.Schema<GetDomainConfigResponseRecommendedIPv4ItemValueList>;
|
|
532
|
+
|
|
533
|
+
/** Recommended IPv4s for the domain. rank=1 is the preferred value(s) to use. Only using 1 ip value is acceptable. */
|
|
534
|
+
export interface GetDomainConfigResponseRecommendedIPv4Item {
|
|
535
|
+
rank: number;
|
|
536
|
+
value: GetDomainConfigResponseRecommendedIPv4ItemValueList;
|
|
537
|
+
}
|
|
538
|
+
export const GetDomainConfigResponseRecommendedIPv4Item =
|
|
539
|
+
/*@__PURE__*/ S.suspend(() =>
|
|
540
|
+
S.Struct({
|
|
541
|
+
rank: S.Number,
|
|
542
|
+
value: GetDomainConfigResponseRecommendedIPv4ItemValueList,
|
|
543
|
+
}),
|
|
544
|
+
).annotate({
|
|
545
|
+
identifier: "GetDomainConfigResponseRecommendedIPv4Item",
|
|
546
|
+
}) as any as S.Schema<GetDomainConfigResponseRecommendedIPv4Item>;
|
|
547
|
+
|
|
548
|
+
/** Recommended IPv4s for the domain. rank=1 is the preferred value(s) to use. Only using 1 ip value is acceptable. */
|
|
549
|
+
export type GetDomainConfigResponseRecommendedIPv4List =
|
|
550
|
+
Array<GetDomainConfigResponseRecommendedIPv4Item>;
|
|
551
|
+
export const GetDomainConfigResponseRecommendedIPv4List = /*@__PURE__*/ S.Array(
|
|
552
|
+
GetDomainConfigResponseRecommendedIPv4Item,
|
|
553
|
+
) as any as S.Schema<GetDomainConfigResponseRecommendedIPv4List>;
|
|
554
|
+
|
|
555
|
+
/** Recommended CNAMEs for the domain. rank=1 is the preferred value to use. */
|
|
556
|
+
export interface GetDomainConfigResponseRecommendedCNAMEItem {
|
|
557
|
+
rank: number;
|
|
558
|
+
value: string;
|
|
559
|
+
}
|
|
560
|
+
export const GetDomainConfigResponseRecommendedCNAMEItem =
|
|
561
|
+
/*@__PURE__*/ S.suspend(() =>
|
|
562
|
+
S.Struct({
|
|
563
|
+
rank: S.Number,
|
|
564
|
+
value: S.String,
|
|
565
|
+
}),
|
|
566
|
+
).annotate({
|
|
567
|
+
identifier: "GetDomainConfigResponseRecommendedCNAMEItem",
|
|
568
|
+
}) as any as S.Schema<GetDomainConfigResponseRecommendedCNAMEItem>;
|
|
569
|
+
|
|
570
|
+
/** Recommended CNAMEs for the domain. rank=1 is the preferred value to use. */
|
|
571
|
+
export type GetDomainConfigResponseRecommendedCNAMEList =
|
|
572
|
+
Array<GetDomainConfigResponseRecommendedCNAMEItem>;
|
|
573
|
+
export const GetDomainConfigResponseRecommendedCNAMEList =
|
|
574
|
+
/*@__PURE__*/ S.Array(
|
|
575
|
+
GetDomainConfigResponseRecommendedCNAMEItem,
|
|
576
|
+
) as any as S.Schema<GetDomainConfigResponseRecommendedCNAMEList>;
|
|
577
|
+
|
|
578
|
+
export interface GetDomainConfigResponse {
|
|
579
|
+
/** How we see the domain's configuration. - `CNAME`: Domain has a CNAME pointing to Vercel. - `A`: Domain's A record is resolving to Vercel. - `http`: Domain is resolving to Vercel but may be behind a Proxy. - `dns-01`: Domain is not resolving to Vercel but dns-01 challenge is enabled. - `null`: Domain is not resolving to Vercel. */
|
|
580
|
+
configuredBy: GetDomainConfigResponseConfiguredBy | null;
|
|
581
|
+
/** Which challenge types the domain can use for issuing certs. */
|
|
582
|
+
acceptedChallenges: GetDomainConfigResponseAcceptedChallengesList;
|
|
583
|
+
/** Recommended IPv4s for the domain. rank=1 is the preferred value(s) to use. Only using 1 ip value is acceptable. */
|
|
584
|
+
recommendedIPv4: GetDomainConfigResponseRecommendedIPv4List;
|
|
585
|
+
/** Recommended CNAMEs for the domain. rank=1 is the preferred value to use. */
|
|
586
|
+
recommendedCNAME: GetDomainConfigResponseRecommendedCNAMEList;
|
|
587
|
+
/** Whether or not the domain is configured AND we can automatically generate a TLS certificate. */
|
|
588
|
+
misconfigured: boolean;
|
|
589
|
+
}
|
|
590
|
+
export const GetDomainConfigResponse = /*@__PURE__*/ S.suspend(() =>
|
|
591
|
+
S.Struct({
|
|
592
|
+
configuredBy: S.NullOr(GetDomainConfigResponseConfiguredBy),
|
|
593
|
+
acceptedChallenges: GetDomainConfigResponseAcceptedChallengesList,
|
|
594
|
+
recommendedIPv4: GetDomainConfigResponseRecommendedIPv4List,
|
|
595
|
+
recommendedCNAME: GetDomainConfigResponseRecommendedCNAMEList,
|
|
596
|
+
misconfigured: S.Boolean,
|
|
597
|
+
}),
|
|
598
|
+
).annotate({
|
|
599
|
+
identifier: "GetDomainConfigResponse",
|
|
600
|
+
}) as any as S.Schema<GetDomainConfigResponse>;
|
|
601
|
+
|
|
602
|
+
export interface GetDomainProjectDomainsRequest {
|
|
603
|
+
/** The apex domain name. */
|
|
604
|
+
domain: string;
|
|
605
|
+
/** Maximum number of project domains to list from a request. */
|
|
606
|
+
limit?: number;
|
|
607
|
+
/** Get project domains created after this JavaScript timestamp. */
|
|
608
|
+
since?: number;
|
|
609
|
+
/** Get project domains created before this JavaScript timestamp. */
|
|
610
|
+
until?: number;
|
|
611
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
612
|
+
teamId?: string;
|
|
613
|
+
/** The Team slug to perform the request on behalf of. */
|
|
614
|
+
slug?: string;
|
|
615
|
+
}
|
|
616
|
+
export const GetDomainProjectDomainsRequest = /*@__PURE__*/ S.suspend(() =>
|
|
617
|
+
S.Struct({
|
|
618
|
+
domain: S.String.pipe(T.Label()),
|
|
619
|
+
limit: S.optional(S.Number.pipe(T.Query())),
|
|
620
|
+
since: S.optional(S.Number.pipe(T.Query())),
|
|
621
|
+
until: S.optional(S.Number.pipe(T.Query())),
|
|
622
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
623
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
624
|
+
}).pipe(
|
|
625
|
+
T.Http({
|
|
626
|
+
method: "GET",
|
|
627
|
+
uri: "/v1/domains/{domain}/project-domains",
|
|
628
|
+
code: 200,
|
|
629
|
+
}),
|
|
630
|
+
),
|
|
631
|
+
).annotate({
|
|
632
|
+
identifier: "GetDomainProjectDomainsRequest",
|
|
633
|
+
}) as any as S.Schema<GetDomainProjectDomainsRequest>;
|
|
634
|
+
|
|
635
|
+
export type GetDomainProjectDomainsResponseProjectDomainsItemRedirectStatusCode =
|
|
636
|
+
301 | 302 | 307 | 308;
|
|
637
|
+
export const GetDomainProjectDomainsResponseProjectDomainsItemRedirectStatusCode =
|
|
638
|
+
/*@__PURE__*/ S.Number;
|
|
639
|
+
|
|
640
|
+
/** 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`. */
|
|
641
|
+
export interface GetDomainProjectDomainsResponseProjectDomainsItemVerificationItem {
|
|
642
|
+
type: string;
|
|
643
|
+
domain: string;
|
|
644
|
+
value: string;
|
|
645
|
+
reason: string;
|
|
646
|
+
}
|
|
647
|
+
export const GetDomainProjectDomainsResponseProjectDomainsItemVerificationItem =
|
|
648
|
+
/*@__PURE__*/ S.suspend(() =>
|
|
649
|
+
S.Struct({
|
|
650
|
+
type: S.String,
|
|
651
|
+
domain: S.String,
|
|
652
|
+
value: S.String,
|
|
653
|
+
reason: S.String,
|
|
654
|
+
}),
|
|
655
|
+
).annotate({
|
|
656
|
+
identifier:
|
|
657
|
+
"GetDomainProjectDomainsResponseProjectDomainsItemVerificationItem",
|
|
658
|
+
}) as any as S.Schema<GetDomainProjectDomainsResponseProjectDomainsItemVerificationItem>;
|
|
659
|
+
|
|
660
|
+
/** 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`. */
|
|
661
|
+
export type GetDomainProjectDomainsResponseProjectDomainsItemVerificationList =
|
|
662
|
+
Array<GetDomainProjectDomainsResponseProjectDomainsItemVerificationItem>;
|
|
663
|
+
export const GetDomainProjectDomainsResponseProjectDomainsItemVerificationList =
|
|
664
|
+
/*@__PURE__*/ S.Array(
|
|
665
|
+
GetDomainProjectDomainsResponseProjectDomainsItemVerificationItem,
|
|
666
|
+
) as any as S.Schema<GetDomainProjectDomainsResponseProjectDomainsItemVerificationList>;
|
|
667
|
+
|
|
668
|
+
export interface GetDomainProjectDomainsResponseProjectDomainsItem {
|
|
669
|
+
name: string;
|
|
670
|
+
apexName: string;
|
|
671
|
+
projectId: string;
|
|
672
|
+
redirect?: string | null;
|
|
673
|
+
redirectStatusCode?: GetDomainProjectDomainsResponseProjectDomainsItemRedirectStatusCode | null;
|
|
674
|
+
gitBranch?: string | null;
|
|
675
|
+
customEnvironmentId?: string | null;
|
|
676
|
+
updatedAt?: number;
|
|
677
|
+
createdAt?: number;
|
|
678
|
+
/** `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. */
|
|
679
|
+
verified: boolean;
|
|
680
|
+
/** 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`. */
|
|
681
|
+
verification?: GetDomainProjectDomainsResponseProjectDomainsItemVerificationList;
|
|
682
|
+
}
|
|
683
|
+
export const GetDomainProjectDomainsResponseProjectDomainsItem =
|
|
684
|
+
/*@__PURE__*/ S.suspend(() =>
|
|
685
|
+
S.Struct({
|
|
686
|
+
name: S.String,
|
|
687
|
+
apexName: S.String,
|
|
688
|
+
projectId: S.String,
|
|
689
|
+
redirect: S.optional(S.NullOr(S.String)),
|
|
690
|
+
redirectStatusCode: S.optional(
|
|
691
|
+
S.NullOr(
|
|
692
|
+
GetDomainProjectDomainsResponseProjectDomainsItemRedirectStatusCode,
|
|
693
|
+
),
|
|
694
|
+
),
|
|
695
|
+
gitBranch: S.optional(S.NullOr(S.String)),
|
|
696
|
+
customEnvironmentId: S.optional(S.NullOr(S.String)),
|
|
697
|
+
updatedAt: S.optional(S.Number),
|
|
698
|
+
createdAt: S.optional(S.Number),
|
|
699
|
+
verified: S.Boolean,
|
|
700
|
+
verification: S.optional(
|
|
701
|
+
GetDomainProjectDomainsResponseProjectDomainsItemVerificationList,
|
|
702
|
+
),
|
|
703
|
+
}),
|
|
704
|
+
).annotate({
|
|
705
|
+
identifier: "GetDomainProjectDomainsResponseProjectDomainsItem",
|
|
706
|
+
}) as any as S.Schema<GetDomainProjectDomainsResponseProjectDomainsItem>;
|
|
707
|
+
|
|
708
|
+
export type GetDomainProjectDomainsResponseProjectDomainsList =
|
|
709
|
+
Array<GetDomainProjectDomainsResponseProjectDomainsItem>;
|
|
710
|
+
export const GetDomainProjectDomainsResponseProjectDomainsList =
|
|
711
|
+
/*@__PURE__*/ S.Array(
|
|
712
|
+
GetDomainProjectDomainsResponseProjectDomainsItem,
|
|
713
|
+
) as any as S.Schema<GetDomainProjectDomainsResponseProjectDomainsList>;
|
|
714
|
+
|
|
715
|
+
/** 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. */
|
|
716
|
+
export interface Pagination {
|
|
717
|
+
/** Amount of items in the current page. */
|
|
718
|
+
count: number;
|
|
719
|
+
/** Timestamp that must be used to request the next page. */
|
|
720
|
+
next: number | null;
|
|
721
|
+
/** Timestamp that must be used to request the previous page. */
|
|
722
|
+
prev: number | null;
|
|
723
|
+
}
|
|
724
|
+
export const Pagination = /*@__PURE__*/ S.suspend(() =>
|
|
725
|
+
S.Struct({
|
|
726
|
+
count: S.Number,
|
|
727
|
+
next: S.NullOr(S.Number),
|
|
728
|
+
prev: S.NullOr(S.Number),
|
|
729
|
+
}),
|
|
730
|
+
).annotate({ identifier: "Pagination" }) as any as S.Schema<Pagination>;
|
|
731
|
+
|
|
732
|
+
export interface GetDomainProjectDomainsResponse {
|
|
733
|
+
projectDomains: GetDomainProjectDomainsResponseProjectDomainsList;
|
|
734
|
+
pagination: Pagination;
|
|
735
|
+
}
|
|
736
|
+
export const GetDomainProjectDomainsResponse = /*@__PURE__*/ S.suspend(() =>
|
|
737
|
+
S.Struct({
|
|
738
|
+
projectDomains: GetDomainProjectDomainsResponseProjectDomainsList,
|
|
739
|
+
pagination: Pagination,
|
|
740
|
+
}),
|
|
741
|
+
).annotate({
|
|
742
|
+
identifier: "GetDomainProjectDomainsResponse",
|
|
743
|
+
}) as any as S.Schema<GetDomainProjectDomainsResponse>;
|
|
744
|
+
|
|
745
|
+
export interface GetDomainsRequest {
|
|
746
|
+
/** Maximum number of domains to list from a request. */
|
|
747
|
+
limit?: number;
|
|
748
|
+
/** Get domains created after this JavaScript timestamp. */
|
|
749
|
+
since?: number;
|
|
750
|
+
/** Get domains created before this JavaScript timestamp. */
|
|
751
|
+
until?: number;
|
|
752
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
753
|
+
teamId?: string;
|
|
754
|
+
/** The Team slug to perform the request on behalf of. */
|
|
755
|
+
slug?: string;
|
|
756
|
+
}
|
|
757
|
+
export const GetDomainsRequest = /*@__PURE__*/ S.suspend(() =>
|
|
758
|
+
S.Struct({
|
|
759
|
+
limit: S.optional(S.Number.pipe(T.Query())),
|
|
760
|
+
since: S.optional(S.Number.pipe(T.Query())),
|
|
761
|
+
until: S.optional(S.Number.pipe(T.Query())),
|
|
762
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
763
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
764
|
+
}).pipe(T.Http({ method: "GET", uri: "/v5/domains", code: 200 })),
|
|
765
|
+
).annotate({
|
|
766
|
+
identifier: "GetDomainsRequest",
|
|
767
|
+
}) as any as S.Schema<GetDomainsRequest>;
|
|
768
|
+
|
|
769
|
+
/** A list of the current nameservers of the domain. */
|
|
770
|
+
export type GetDomainsResponseDomainsItemNameserversList = Array<string>;
|
|
771
|
+
export const GetDomainsResponseDomainsItemNameserversList =
|
|
772
|
+
/*@__PURE__*/ S.Array(
|
|
773
|
+
S.String,
|
|
774
|
+
) as any as S.Schema<GetDomainsResponseDomainsItemNameserversList>;
|
|
775
|
+
|
|
776
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
777
|
+
export type GetDomainsResponseDomainsItemIntendedNameserversList =
|
|
778
|
+
Array<string>;
|
|
779
|
+
export const GetDomainsResponseDomainsItemIntendedNameserversList =
|
|
780
|
+
/*@__PURE__*/ S.Array(
|
|
781
|
+
S.String,
|
|
782
|
+
) as any as S.Schema<GetDomainsResponseDomainsItemIntendedNameserversList>;
|
|
783
|
+
|
|
784
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
785
|
+
export type GetDomainsResponseDomainsItemCustomNameserversList = Array<string>;
|
|
786
|
+
export const GetDomainsResponseDomainsItemCustomNameserversList =
|
|
787
|
+
/*@__PURE__*/ S.Array(
|
|
788
|
+
S.String,
|
|
789
|
+
) as any as S.Schema<GetDomainsResponseDomainsItemCustomNameserversList>;
|
|
790
|
+
|
|
791
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
792
|
+
export type GetDomainsResponseDomainsItemCreator =
|
|
793
|
+
ClaimDomainOwnershipResponseDomainCreator;
|
|
794
|
+
export const GetDomainsResponseDomainsItemCreator =
|
|
795
|
+
ClaimDomainOwnershipResponseDomainCreator;
|
|
796
|
+
|
|
797
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
798
|
+
export type GetDomainsResponseDomainsItemServiceType =
|
|
799
|
+
| "external"
|
|
800
|
+
| "na"
|
|
801
|
+
| "zeit.world";
|
|
802
|
+
export const GetDomainsResponseDomainsItemServiceType = /*@__PURE__*/ S.String;
|
|
803
|
+
|
|
804
|
+
export interface GetDomainsResponseDomainsItem {
|
|
805
|
+
/** Timestamp in milliseconds at which the domain is set to expire. null if not bought with Vercel. */
|
|
806
|
+
expiresAt: number | null;
|
|
807
|
+
/** If the domain has the ownership verified. */
|
|
808
|
+
verified: boolean;
|
|
809
|
+
/** A list of the current nameservers of the domain. */
|
|
810
|
+
nameservers: GetDomainsResponseDomainsItemNameserversList;
|
|
811
|
+
/** A list of the intended nameservers for the domain to point to Vercel DNS. */
|
|
812
|
+
intendedNameservers: GetDomainsResponseDomainsItemIntendedNameserversList;
|
|
813
|
+
/** A list of custom nameservers for the domain to point to. Only applies to domains purchased with Vercel. */
|
|
814
|
+
customNameservers?: GetDomainsResponseDomainsItemCustomNameserversList;
|
|
815
|
+
/** An object containing information of the domain creator, including the user's id, username, and email. */
|
|
816
|
+
creator: ClaimDomainOwnershipResponseDomainCreator;
|
|
817
|
+
/** The domain name. */
|
|
818
|
+
name: string;
|
|
819
|
+
teamId: string | null;
|
|
820
|
+
/** If it was purchased through Vercel, the timestamp in milliseconds when it was purchased. */
|
|
821
|
+
boughtAt: number | null;
|
|
822
|
+
/** Timestamp in milliseconds when the domain was created in the registry. */
|
|
823
|
+
createdAt: number;
|
|
824
|
+
/** The unique identifier of the domain. */
|
|
825
|
+
id: string;
|
|
826
|
+
/** Indicates whether the domain is set to automatically renew. */
|
|
827
|
+
renew?: boolean;
|
|
828
|
+
/** The type of service the domain is handled by. `external` if the DNS is externally handled, `zeit.world` if handled with Vercel, or `na` if the service is not available. */
|
|
829
|
+
serviceType: GetDomainsResponseDomainsItemServiceType;
|
|
830
|
+
/** Timestamp in milliseconds at which the domain was successfully transferred into Vercel. `null` if the transfer is still processing or was never transferred in. */
|
|
831
|
+
transferredAt?: number | null;
|
|
832
|
+
/** If transferred into Vercel, timestamp in milliseconds when the domain transfer was initiated. */
|
|
833
|
+
transferStartedAt?: number;
|
|
834
|
+
userId: string;
|
|
835
|
+
}
|
|
836
|
+
export const GetDomainsResponseDomainsItem = /*@__PURE__*/ S.suspend(() =>
|
|
837
|
+
S.Struct({
|
|
838
|
+
expiresAt: S.NullOr(S.Number),
|
|
839
|
+
verified: S.Boolean,
|
|
840
|
+
nameservers: GetDomainsResponseDomainsItemNameserversList,
|
|
841
|
+
intendedNameservers: GetDomainsResponseDomainsItemIntendedNameserversList,
|
|
842
|
+
customNameservers: S.optional(
|
|
843
|
+
GetDomainsResponseDomainsItemCustomNameserversList,
|
|
844
|
+
),
|
|
845
|
+
creator: ClaimDomainOwnershipResponseDomainCreator,
|
|
846
|
+
name: S.String,
|
|
847
|
+
teamId: S.NullOr(S.String),
|
|
848
|
+
boughtAt: S.NullOr(S.Number),
|
|
849
|
+
createdAt: S.Number,
|
|
850
|
+
id: S.String,
|
|
851
|
+
renew: S.optional(S.Boolean),
|
|
852
|
+
serviceType: GetDomainsResponseDomainsItemServiceType,
|
|
853
|
+
transferredAt: S.optional(S.NullOr(S.Number)),
|
|
854
|
+
transferStartedAt: S.optional(S.Number),
|
|
855
|
+
userId: S.String,
|
|
856
|
+
}),
|
|
857
|
+
).annotate({
|
|
858
|
+
identifier: "GetDomainsResponseDomainsItem",
|
|
859
|
+
}) as any as S.Schema<GetDomainsResponseDomainsItem>;
|
|
860
|
+
|
|
861
|
+
export type GetDomainsResponseDomainsList =
|
|
862
|
+
Array<GetDomainsResponseDomainsItem>;
|
|
863
|
+
export const GetDomainsResponseDomainsList = /*@__PURE__*/ S.Array(
|
|
864
|
+
GetDomainsResponseDomainsItem,
|
|
865
|
+
) as any as S.Schema<GetDomainsResponseDomainsList>;
|
|
866
|
+
|
|
867
|
+
export interface GetDomainsResponse {
|
|
868
|
+
domains: GetDomainsResponseDomainsList;
|
|
869
|
+
pagination: Pagination;
|
|
870
|
+
}
|
|
871
|
+
export const GetDomainsResponse = /*@__PURE__*/ S.suspend(() =>
|
|
872
|
+
S.Struct({
|
|
873
|
+
domains: GetDomainsResponseDomainsList,
|
|
874
|
+
pagination: Pagination,
|
|
875
|
+
}),
|
|
876
|
+
).annotate({
|
|
877
|
+
identifier: "GetDomainsResponse",
|
|
878
|
+
}) as any as S.Schema<GetDomainsResponse>;
|
|
879
|
+
|
|
880
|
+
export interface GetDomainVerificationRecordRequest {
|
|
881
|
+
/** The domain name to get the verification record for */
|
|
882
|
+
domain: string;
|
|
883
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
884
|
+
teamId?: string;
|
|
885
|
+
/** The Team slug to perform the request on behalf of. */
|
|
886
|
+
slug?: string;
|
|
887
|
+
}
|
|
888
|
+
export const GetDomainVerificationRecordRequest = /*@__PURE__*/ S.suspend(() =>
|
|
889
|
+
S.Struct({
|
|
890
|
+
domain: S.String.pipe(T.Label()),
|
|
891
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
892
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
893
|
+
}).pipe(
|
|
894
|
+
T.Http({
|
|
895
|
+
method: "GET",
|
|
896
|
+
uri: "/v9/domains/{domain}/verification",
|
|
897
|
+
code: 200,
|
|
898
|
+
}),
|
|
899
|
+
),
|
|
900
|
+
).annotate({
|
|
901
|
+
identifier: "GetDomainVerificationRecordRequest",
|
|
902
|
+
}) as any as S.Schema<GetDomainVerificationRecordRequest>;
|
|
903
|
+
|
|
904
|
+
export interface GetDomainVerificationRecordResponse {
|
|
905
|
+
txtRecord: string;
|
|
906
|
+
verificationDomain: string;
|
|
907
|
+
}
|
|
908
|
+
export const GetDomainVerificationRecordResponse = /*@__PURE__*/ S.suspend(() =>
|
|
909
|
+
S.Struct({
|
|
910
|
+
txtRecord: S.String,
|
|
911
|
+
verificationDomain: S.String,
|
|
912
|
+
}),
|
|
913
|
+
).annotate({
|
|
914
|
+
identifier: "GetDomainVerificationRecordResponse",
|
|
915
|
+
}) as any as S.Schema<GetDomainVerificationRecordResponse>;
|
|
916
|
+
|
|
917
|
+
/** This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/nameservers instead. */
|
|
918
|
+
export type PatchDomainRequestBodyCase0CustomNameserversList = Array<string>;
|
|
919
|
+
export const PatchDomainRequestBodyCase0CustomNameserversList =
|
|
920
|
+
/*@__PURE__*/ S.Array(
|
|
921
|
+
S.String,
|
|
922
|
+
) as any as S.Schema<PatchDomainRequestBodyCase0CustomNameserversList>;
|
|
923
|
+
|
|
924
|
+
/** update */
|
|
925
|
+
export interface PatchDomainRequestBodyCase0 {
|
|
926
|
+
op?: string;
|
|
927
|
+
/** This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/auto-renew instead. */
|
|
928
|
+
renew?: boolean;
|
|
929
|
+
/** This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/nameservers instead. */
|
|
930
|
+
customNameservers?: PatchDomainRequestBodyCase0CustomNameserversList;
|
|
931
|
+
/** Specifies whether this is a DNS zone that intends to use Vercel's nameservers. */
|
|
932
|
+
zone?: boolean;
|
|
933
|
+
}
|
|
934
|
+
export const PatchDomainRequestBodyCase0 = /*@__PURE__*/ S.suspend(() =>
|
|
935
|
+
S.Struct({
|
|
936
|
+
op: S.optional(S.String),
|
|
937
|
+
renew: S.optional(S.Boolean),
|
|
938
|
+
customNameservers: S.optional(
|
|
939
|
+
PatchDomainRequestBodyCase0CustomNameserversList,
|
|
940
|
+
),
|
|
941
|
+
zone: S.optional(S.Boolean),
|
|
942
|
+
}),
|
|
943
|
+
).annotate({
|
|
944
|
+
identifier: "PatchDomainRequestBodyCase0",
|
|
945
|
+
}) as any as S.Schema<PatchDomainRequestBodyCase0>;
|
|
946
|
+
|
|
947
|
+
/** move-out */
|
|
948
|
+
export interface PatchDomainRequestBodyCase1 {
|
|
949
|
+
op?: string;
|
|
950
|
+
/** User or team to move domain to */
|
|
951
|
+
destination?: string;
|
|
952
|
+
}
|
|
953
|
+
export const PatchDomainRequestBodyCase1 = /*@__PURE__*/ S.suspend(() =>
|
|
954
|
+
S.Struct({
|
|
955
|
+
op: S.optional(S.String),
|
|
956
|
+
destination: S.optional(S.String),
|
|
957
|
+
}),
|
|
958
|
+
).annotate({
|
|
959
|
+
identifier: "PatchDomainRequestBodyCase1",
|
|
960
|
+
}) as any as S.Schema<PatchDomainRequestBodyCase1>;
|
|
961
|
+
|
|
962
|
+
export type PatchDomainRequestBody =
|
|
963
|
+
| PatchDomainRequestBodyCase0
|
|
964
|
+
| PatchDomainRequestBodyCase1;
|
|
965
|
+
export const PatchDomainRequestBody =
|
|
966
|
+
/*@__PURE__*/ S.Unknown as any as S.Schema<PatchDomainRequestBody>;
|
|
967
|
+
|
|
968
|
+
export interface PatchDomainRequest {
|
|
969
|
+
domain: string;
|
|
970
|
+
/** The Team identifier to perform the request on behalf of. */
|
|
971
|
+
teamId?: string;
|
|
972
|
+
/** The Team slug to perform the request on behalf of. */
|
|
973
|
+
slug?: string;
|
|
974
|
+
body: PatchDomainRequestBody;
|
|
975
|
+
}
|
|
976
|
+
export const PatchDomainRequest = /*@__PURE__*/ S.suspend(() =>
|
|
977
|
+
S.Struct({
|
|
978
|
+
domain: S.String.pipe(T.Label()),
|
|
979
|
+
teamId: S.optional(S.String.pipe(T.Query())),
|
|
980
|
+
slug: S.optional(S.String.pipe(T.Query())),
|
|
981
|
+
body: PatchDomainRequestBody.pipe(T.HttpBody()),
|
|
982
|
+
}).pipe(T.Http({ method: "PATCH", uri: "/v3/domains/{domain}", code: 200 })),
|
|
983
|
+
).annotate({
|
|
984
|
+
identifier: "PatchDomainRequest",
|
|
985
|
+
}) as any as S.Schema<PatchDomainRequest>;
|
|
986
|
+
|
|
987
|
+
export interface PatchDomainResponseBodyCase0 {
|
|
988
|
+
moved: boolean;
|
|
989
|
+
}
|
|
990
|
+
export const PatchDomainResponseBodyCase0 = /*@__PURE__*/ S.suspend(() =>
|
|
991
|
+
S.Struct({
|
|
992
|
+
moved: S.Boolean,
|
|
993
|
+
}),
|
|
994
|
+
).annotate({
|
|
995
|
+
identifier: "PatchDomainResponseBodyCase0",
|
|
996
|
+
}) as any as S.Schema<PatchDomainResponseBodyCase0>;
|
|
997
|
+
|
|
998
|
+
export interface PatchDomainResponseBodyCase1 {
|
|
999
|
+
moved: boolean;
|
|
1000
|
+
token: string;
|
|
1001
|
+
}
|
|
1002
|
+
export const PatchDomainResponseBodyCase1 = /*@__PURE__*/ S.suspend(() =>
|
|
1003
|
+
S.Struct({
|
|
1004
|
+
moved: S.Boolean,
|
|
1005
|
+
token: S.String,
|
|
1006
|
+
}),
|
|
1007
|
+
).annotate({
|
|
1008
|
+
identifier: "PatchDomainResponseBodyCase1",
|
|
1009
|
+
}) as any as S.Schema<PatchDomainResponseBodyCase1>;
|
|
1010
|
+
|
|
1011
|
+
export type PatchDomainResponseBodyCase2CustomNameserversList = Array<string>;
|
|
1012
|
+
export const PatchDomainResponseBodyCase2CustomNameserversList =
|
|
1013
|
+
/*@__PURE__*/ S.Array(
|
|
1014
|
+
S.String,
|
|
1015
|
+
) as any as S.Schema<PatchDomainResponseBodyCase2CustomNameserversList>;
|
|
1016
|
+
|
|
1017
|
+
export interface PatchDomainResponseBodyCase2 {
|
|
1018
|
+
renew?: boolean;
|
|
1019
|
+
customNameservers?: PatchDomainResponseBodyCase2CustomNameserversList;
|
|
1020
|
+
zone?: boolean;
|
|
1021
|
+
}
|
|
1022
|
+
export const PatchDomainResponseBodyCase2 = /*@__PURE__*/ S.suspend(() =>
|
|
1023
|
+
S.Struct({
|
|
1024
|
+
renew: S.optional(S.Boolean),
|
|
1025
|
+
customNameservers: S.optional(
|
|
1026
|
+
PatchDomainResponseBodyCase2CustomNameserversList,
|
|
1027
|
+
),
|
|
1028
|
+
zone: S.optional(S.Boolean),
|
|
1029
|
+
}),
|
|
1030
|
+
).annotate({
|
|
1031
|
+
identifier: "PatchDomainResponseBodyCase2",
|
|
1032
|
+
}) as any as S.Schema<PatchDomainResponseBodyCase2>;
|
|
1033
|
+
|
|
1034
|
+
export type PatchDomainResponseBody =
|
|
1035
|
+
| PatchDomainResponseBodyCase0
|
|
1036
|
+
| PatchDomainResponseBodyCase1
|
|
1037
|
+
| PatchDomainResponseBodyCase2;
|
|
1038
|
+
export const PatchDomainResponseBody =
|
|
1039
|
+
/*@__PURE__*/ S.Unknown as any as S.Schema<PatchDomainResponseBody>;
|
|
1040
|
+
|
|
1041
|
+
export type PatchDomainResponse = PatchDomainResponseBody;
|
|
1042
|
+
export const PatchDomainResponse = /*@__PURE__*/ S.suspend(() =>
|
|
1043
|
+
PatchDomainResponseBody.pipe(T.RawResponseRoot()),
|
|
1044
|
+
).annotate({
|
|
1045
|
+
identifier: "PatchDomainResponse",
|
|
1046
|
+
}) as any as S.Schema<PatchDomainResponse>;
|
|
1047
|
+
|
|
1048
|
+
export type ClaimDomainOwnershipError =
|
|
1049
|
+
| BadRequest
|
|
1050
|
+
| Forbidden
|
|
1051
|
+
| NotFound
|
|
1052
|
+
| VercelOpError;
|
|
1053
|
+
/** Claim Domain Ownership Claim ownership of a domain for the authenticated team by verifying a TXT record. The caller must first add a TXT record to `_vercel.{domain}` (obtained from GET /domains/:domain/verification), then call this endpoint to complete the ownership transfer. If the TXT record is verified, the domain ownership will be transferred to the caller's team, even if the domain is currently owned by another user or team. */
|
|
1054
|
+
export const claimDomainOwnership: API.OperationMethod<
|
|
1055
|
+
ClaimDomainOwnershipRequest,
|
|
1056
|
+
ClaimDomainOwnershipResponse,
|
|
1057
|
+
ClaimDomainOwnershipError,
|
|
1058
|
+
VercelOpContext
|
|
1059
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1060
|
+
input: ClaimDomainOwnershipRequest,
|
|
1061
|
+
output: ClaimDomainOwnershipResponse,
|
|
1062
|
+
errors: [BadRequest, Forbidden, NotFound],
|
|
1063
|
+
protocol: VercelProtocol,
|
|
1064
|
+
retry: Retry.Retry,
|
|
1065
|
+
}));
|
|
1066
|
+
|
|
1067
|
+
export type CreateOrTransferDomainError =
|
|
1068
|
+
| BadRequest
|
|
1069
|
+
| PaymentRequired
|
|
1070
|
+
| Forbidden
|
|
1071
|
+
| NotFound
|
|
1072
|
+
| Conflict
|
|
1073
|
+
| VercelOpError;
|
|
1074
|
+
/** Add an existing domain to the Vercel platform This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Note: This endpoint is no longer used for initiating domain transfers from external registrars to Vercel. For this, please use the endpoint [Transfer-in a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/transfer-in-a-domain). */
|
|
1075
|
+
export const createOrTransferDomain: API.OperationMethod<
|
|
1076
|
+
CreateOrTransferDomainRequest,
|
|
1077
|
+
CreateOrTransferDomainResponse,
|
|
1078
|
+
CreateOrTransferDomainError,
|
|
1079
|
+
VercelOpContext
|
|
1080
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1081
|
+
input: CreateOrTransferDomainRequest,
|
|
1082
|
+
output: CreateOrTransferDomainResponse,
|
|
1083
|
+
errors: [BadRequest, PaymentRequired, Forbidden, NotFound, Conflict],
|
|
1084
|
+
protocol: VercelProtocol,
|
|
1085
|
+
retry: Retry.Retry,
|
|
1086
|
+
}));
|
|
1087
|
+
|
|
1088
|
+
export type DeleteDomainError =
|
|
1089
|
+
| BadRequest
|
|
1090
|
+
| Forbidden
|
|
1091
|
+
| NotFound
|
|
1092
|
+
| Conflict
|
|
1093
|
+
| VercelOpError;
|
|
1094
|
+
/** Remove a domain by name Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases. */
|
|
1095
|
+
export const deleteDomain: API.OperationMethod<
|
|
1096
|
+
DeleteDomainRequest,
|
|
1097
|
+
DeleteDomainResponse,
|
|
1098
|
+
DeleteDomainError,
|
|
1099
|
+
VercelOpContext
|
|
1100
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1101
|
+
input: DeleteDomainRequest,
|
|
1102
|
+
output: DeleteDomainResponse,
|
|
1103
|
+
errors: [BadRequest, Forbidden, NotFound, Conflict],
|
|
1104
|
+
protocol: VercelProtocol,
|
|
1105
|
+
retry: Retry.Retry,
|
|
1106
|
+
}));
|
|
1107
|
+
|
|
1108
|
+
export type GetDomainError = BadRequest | Forbidden | NotFound | VercelOpError;
|
|
1109
|
+
/** Get Information for a Single Domain Get information for a single domain in an account or team. */
|
|
1110
|
+
export const getDomain: API.OperationMethod<
|
|
1111
|
+
GetDomainRequest,
|
|
1112
|
+
GetDomainResponse,
|
|
1113
|
+
GetDomainError,
|
|
1114
|
+
VercelOpContext
|
|
1115
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1116
|
+
input: GetDomainRequest,
|
|
1117
|
+
output: GetDomainResponse,
|
|
1118
|
+
errors: [BadRequest, Forbidden, NotFound],
|
|
1119
|
+
protocol: VercelProtocol,
|
|
1120
|
+
retry: Retry.Retry,
|
|
1121
|
+
}));
|
|
1122
|
+
|
|
1123
|
+
export type GetDomainConfigError = BadRequest | Forbidden | VercelOpError;
|
|
1124
|
+
/** Get a Domain's configuration Get a Domain's configuration. */
|
|
1125
|
+
export const getDomainConfig: API.OperationMethod<
|
|
1126
|
+
GetDomainConfigRequest,
|
|
1127
|
+
GetDomainConfigResponse,
|
|
1128
|
+
GetDomainConfigError,
|
|
1129
|
+
VercelOpContext
|
|
1130
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1131
|
+
input: GetDomainConfigRequest,
|
|
1132
|
+
output: GetDomainConfigResponse,
|
|
1133
|
+
errors: [BadRequest, Forbidden],
|
|
1134
|
+
protocol: VercelProtocol,
|
|
1135
|
+
retry: Retry.Retry,
|
|
1136
|
+
}));
|
|
1137
|
+
|
|
1138
|
+
export type GetDomainProjectDomainsError =
|
|
1139
|
+
| BadRequest
|
|
1140
|
+
| Forbidden
|
|
1141
|
+
| NotFound
|
|
1142
|
+
| VercelOpError;
|
|
1143
|
+
/** List Project Domains by Apex Domain List all project domains associated with an apex domain owned by the authenticated account. */
|
|
1144
|
+
export const getDomainProjectDomains: API.OperationMethod<
|
|
1145
|
+
GetDomainProjectDomainsRequest,
|
|
1146
|
+
GetDomainProjectDomainsResponse,
|
|
1147
|
+
GetDomainProjectDomainsError,
|
|
1148
|
+
VercelOpContext
|
|
1149
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1150
|
+
input: GetDomainProjectDomainsRequest,
|
|
1151
|
+
output: GetDomainProjectDomainsResponse,
|
|
1152
|
+
errors: [BadRequest, Forbidden, NotFound],
|
|
1153
|
+
protocol: VercelProtocol,
|
|
1154
|
+
retry: Retry.Retry,
|
|
1155
|
+
}));
|
|
1156
|
+
|
|
1157
|
+
export type GetDomainsError = BadRequest | Forbidden | Conflict | VercelOpError;
|
|
1158
|
+
/** List all the domains Retrieves a list of domains registered for the authenticated user or team. By default it returns the last 20 domains if no limit is provided. */
|
|
1159
|
+
export const getDomains: API.OperationMethod<
|
|
1160
|
+
GetDomainsRequest,
|
|
1161
|
+
GetDomainsResponse,
|
|
1162
|
+
GetDomainsError,
|
|
1163
|
+
VercelOpContext
|
|
1164
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1165
|
+
input: GetDomainsRequest,
|
|
1166
|
+
output: GetDomainsResponse,
|
|
1167
|
+
errors: [BadRequest, Forbidden, Conflict],
|
|
1168
|
+
protocol: VercelProtocol,
|
|
1169
|
+
retry: Retry.Retry,
|
|
1170
|
+
}));
|
|
1171
|
+
|
|
1172
|
+
export type GetDomainVerificationRecordError =
|
|
1173
|
+
| BadRequest
|
|
1174
|
+
| Forbidden
|
|
1175
|
+
| NotFound
|
|
1176
|
+
| VercelOpError;
|
|
1177
|
+
/** Get Domain Verification Record Get the TXT verification record needed to claim ownership of a domain for the authenticated team. The caller must add this TXT record to `_vercel.{domain}` in their DNS configuration, then call POST /domains/:domain/claim to complete the ownership transfer. */
|
|
1178
|
+
export const getDomainVerificationRecord: API.OperationMethod<
|
|
1179
|
+
GetDomainVerificationRecordRequest,
|
|
1180
|
+
GetDomainVerificationRecordResponse,
|
|
1181
|
+
GetDomainVerificationRecordError,
|
|
1182
|
+
VercelOpContext
|
|
1183
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1184
|
+
input: GetDomainVerificationRecordRequest,
|
|
1185
|
+
output: GetDomainVerificationRecordResponse,
|
|
1186
|
+
errors: [BadRequest, Forbidden, NotFound],
|
|
1187
|
+
protocol: VercelProtocol,
|
|
1188
|
+
retry: Retry.Retry,
|
|
1189
|
+
}));
|
|
1190
|
+
|
|
1191
|
+
export type PatchDomainError =
|
|
1192
|
+
| BadRequest
|
|
1193
|
+
| Forbidden
|
|
1194
|
+
| NotFound
|
|
1195
|
+
| Conflict
|
|
1196
|
+
| VercelOpError;
|
|
1197
|
+
/** Update or move apex domain Update or move apex domain. Note: This endpoint is no longer used for updating auto-renew or nameservers. For this, please use the endpoints [Update auto-renew for a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/update-auto-renew-for-a-domain) and [Update nameservers for a domain](https://vercel.com/docs/rest-api/reference/endpoints/domains-registrar/update-nameservers-for-a-domain). */
|
|
1198
|
+
export const patchDomain: API.OperationMethod<
|
|
1199
|
+
PatchDomainRequest,
|
|
1200
|
+
PatchDomainResponse,
|
|
1201
|
+
PatchDomainError,
|
|
1202
|
+
VercelOpContext
|
|
1203
|
+
> = /*@__PURE__*/ API.make(() => ({
|
|
1204
|
+
input: PatchDomainRequest,
|
|
1205
|
+
output: PatchDomainResponse,
|
|
1206
|
+
errors: [BadRequest, Forbidden, NotFound, Conflict],
|
|
1207
|
+
protocol: VercelProtocol,
|
|
1208
|
+
retry: Retry.Retry,
|
|
1209
|
+
}));
|