@wix/domains 1.0.17 → 1.0.19
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/package.json +8 -8
- package/type-bundles/context.bundle.d.ts +1948 -20
- package/type-bundles/index.bundle.d.ts +23 -83
- package/type-bundles/meta.bundle.d.ts +28 -28
|
@@ -1,3 +1,339 @@
|
|
|
1
|
+
/** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
|
|
2
|
+
interface ConnectedDomain {
|
|
3
|
+
/**
|
|
4
|
+
* ID of the connected domain. Identical to the domain name including TLD.
|
|
5
|
+
* @readonly
|
|
6
|
+
*/
|
|
7
|
+
_id?: string;
|
|
8
|
+
/**
|
|
9
|
+
* Domain name including TLD.
|
|
10
|
+
* Both root domains and subdomains are supported.
|
|
11
|
+
*/
|
|
12
|
+
domain?: string;
|
|
13
|
+
/**
|
|
14
|
+
* How the domain is connected to the Wix site.
|
|
15
|
+
*
|
|
16
|
+
* + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
|
|
17
|
+
* + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
|
|
18
|
+
* + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
|
|
19
|
+
* + `"HIDDEN"`: The domain isn't visible to site visitors.
|
|
20
|
+
*/
|
|
21
|
+
connectionType?: ConnectionType$1;
|
|
22
|
+
/**
|
|
23
|
+
* Information about the site to which the domain is assigned, and whether
|
|
24
|
+
* it's the primary domain or a redirect.
|
|
25
|
+
*/
|
|
26
|
+
siteInfo?: SiteInfo$1;
|
|
27
|
+
/**
|
|
28
|
+
* Whether the site owner receives standard email notifications from Wix about
|
|
29
|
+
* the connected domain.
|
|
30
|
+
*
|
|
31
|
+
* Default: `false`
|
|
32
|
+
*/
|
|
33
|
+
suppressNotifications?: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* DNS propagation status.
|
|
36
|
+
*
|
|
37
|
+
* + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
|
|
38
|
+
* + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
|
|
39
|
+
* + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
|
|
40
|
+
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
41
|
+
* @readonly
|
|
42
|
+
*/
|
|
43
|
+
dnsPropagationStatus?: DnsPropagationStatus$1;
|
|
44
|
+
}
|
|
45
|
+
declare enum ConnectionType$1 {
|
|
46
|
+
/** Used by sub domain */
|
|
47
|
+
UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
|
|
48
|
+
POINTING = "POINTING",
|
|
49
|
+
NAMESERVERS = "NAMESERVERS",
|
|
50
|
+
/**
|
|
51
|
+
* internal used by photography company.
|
|
52
|
+
* when a customer creates a photo album, each album has its sub domain and this sub domain
|
|
53
|
+
* is not visible in my domains page.
|
|
54
|
+
*/
|
|
55
|
+
HIDDEN = "HIDDEN"
|
|
56
|
+
}
|
|
57
|
+
interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
|
|
58
|
+
/**
|
|
59
|
+
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
60
|
+
* @readonly
|
|
61
|
+
*/
|
|
62
|
+
redirectInfo?: RedirectAssignmentInfo$1;
|
|
63
|
+
/**
|
|
64
|
+
* ID of the site to which the domain is assigned.
|
|
65
|
+
* @readonly
|
|
66
|
+
*/
|
|
67
|
+
_id?: string | null;
|
|
68
|
+
/**
|
|
69
|
+
* The relationship assigned for this domain to the site:
|
|
70
|
+
* + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
|
|
71
|
+
* + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
|
|
72
|
+
* + `"REDIRECT"`: A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain.
|
|
73
|
+
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
74
|
+
*/
|
|
75
|
+
assignmentType?: AssignmentType$1;
|
|
76
|
+
}
|
|
77
|
+
/** @oneof */
|
|
78
|
+
interface SiteInfoAssignmentInfoOneOf$1 {
|
|
79
|
+
/**
|
|
80
|
+
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
81
|
+
* @readonly
|
|
82
|
+
*/
|
|
83
|
+
redirectInfo?: RedirectAssignmentInfo$1;
|
|
84
|
+
}
|
|
85
|
+
declare enum AssignmentType$1 {
|
|
86
|
+
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
87
|
+
PRIMARY = "PRIMARY",
|
|
88
|
+
REDIRECT = "REDIRECT"
|
|
89
|
+
}
|
|
90
|
+
interface RedirectAssignmentInfo$1 {
|
|
91
|
+
/**
|
|
92
|
+
* Primary domain to which this domain will redirect.
|
|
93
|
+
* @readonly
|
|
94
|
+
*/
|
|
95
|
+
primaryDomain?: string;
|
|
96
|
+
}
|
|
97
|
+
declare enum DnsPropagationStatus$1 {
|
|
98
|
+
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
99
|
+
COMPLETED = "COMPLETED",
|
|
100
|
+
FAILED = "FAILED",
|
|
101
|
+
IN_PROGRESS = "IN_PROGRESS"
|
|
102
|
+
}
|
|
103
|
+
interface DomainRemovedEvent$1 {
|
|
104
|
+
/**
|
|
105
|
+
* Domain name including TLD.
|
|
106
|
+
* Both root domains and subdomains are supported.
|
|
107
|
+
*/
|
|
108
|
+
domain?: string;
|
|
109
|
+
}
|
|
110
|
+
interface CreateConnectedDomainRequest {
|
|
111
|
+
/** Domain to connect. */
|
|
112
|
+
connectedDomain: ConnectedDomain;
|
|
113
|
+
}
|
|
114
|
+
interface CreateConnectedDomainResponse {
|
|
115
|
+
/** Connected domain. */
|
|
116
|
+
connectedDomain?: ConnectedDomain;
|
|
117
|
+
}
|
|
118
|
+
interface GetConnectedDomainRequest {
|
|
119
|
+
/** ID of the connected domain. Identical to the domain name including TLD. */
|
|
120
|
+
connectedDomainId: string;
|
|
121
|
+
}
|
|
122
|
+
interface GetConnectedDomainResponse {
|
|
123
|
+
/** Retrieved connected domain. */
|
|
124
|
+
connectedDomain?: ConnectedDomain;
|
|
125
|
+
}
|
|
126
|
+
interface DeleteConnectedDomainRequest {
|
|
127
|
+
/** ID of the connected domain to delete. Identical to the domain name including TLD. */
|
|
128
|
+
connectedDomainId: string;
|
|
129
|
+
}
|
|
130
|
+
interface DeleteConnectedDomainResponse {
|
|
131
|
+
}
|
|
132
|
+
interface ListConnectedDomainsRequest {
|
|
133
|
+
/** Cursor paging options. */
|
|
134
|
+
paging?: CursorPaging$2;
|
|
135
|
+
}
|
|
136
|
+
interface CursorPaging$2 {
|
|
137
|
+
/**
|
|
138
|
+
* Number of domains to load.
|
|
139
|
+
*
|
|
140
|
+
* Min: `0`
|
|
141
|
+
* Max: `100`
|
|
142
|
+
*/
|
|
143
|
+
limit?: number | null;
|
|
144
|
+
/**
|
|
145
|
+
* Pointer to the next or previous page in the list of results.
|
|
146
|
+
*
|
|
147
|
+
* You can get the relevant cursor token
|
|
148
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
149
|
+
* Not relevant for the first request.
|
|
150
|
+
*/
|
|
151
|
+
cursor?: string | null;
|
|
152
|
+
}
|
|
153
|
+
interface ListConnectedDomainsResponse {
|
|
154
|
+
/** Metadata about the returned list of connected domains. */
|
|
155
|
+
pagingMetadata?: CursorPagingMetadata$2;
|
|
156
|
+
/** Retrieved connected domains. */
|
|
157
|
+
connectedDomains?: ConnectedDomain[];
|
|
158
|
+
}
|
|
159
|
+
interface CursorPagingMetadata$2 {
|
|
160
|
+
/** Number of domains returned in the response. */
|
|
161
|
+
count?: number | null;
|
|
162
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
163
|
+
cursors?: Cursors$2;
|
|
164
|
+
/**
|
|
165
|
+
* Indicates if there are more results after the current page.
|
|
166
|
+
* If `true`, another page of results can be retrieved.
|
|
167
|
+
* If `false`, this is the last page.
|
|
168
|
+
*/
|
|
169
|
+
hasNext?: boolean | null;
|
|
170
|
+
}
|
|
171
|
+
interface Cursors$2 {
|
|
172
|
+
/** Cursor pointing to next page in the list of results. */
|
|
173
|
+
next?: string | null;
|
|
174
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
175
|
+
prev?: string | null;
|
|
176
|
+
}
|
|
177
|
+
interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
|
|
178
|
+
createdEvent?: EntityCreatedEvent$2;
|
|
179
|
+
updatedEvent?: EntityUpdatedEvent$2;
|
|
180
|
+
deletedEvent?: EntityDeletedEvent$2;
|
|
181
|
+
actionEvent?: ActionEvent$2;
|
|
182
|
+
/**
|
|
183
|
+
* Unique event ID.
|
|
184
|
+
* Allows clients to ignore duplicate webhooks.
|
|
185
|
+
*/
|
|
186
|
+
_id?: string;
|
|
187
|
+
/**
|
|
188
|
+
* Assumes actions are also always typed to an entity_type
|
|
189
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
190
|
+
*/
|
|
191
|
+
entityFqdn?: string;
|
|
192
|
+
/**
|
|
193
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
194
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
195
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
196
|
+
*/
|
|
197
|
+
slug?: string;
|
|
198
|
+
/** ID of the entity associated with the event. */
|
|
199
|
+
entityId?: string;
|
|
200
|
+
/** Event timestamp. */
|
|
201
|
+
eventTime?: Date;
|
|
202
|
+
/**
|
|
203
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
204
|
+
* (for example, GDPR).
|
|
205
|
+
*/
|
|
206
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
207
|
+
/** If present, indicates the action that triggered the event. */
|
|
208
|
+
originatedFrom?: string | null;
|
|
209
|
+
/**
|
|
210
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
211
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
212
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
213
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
214
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
215
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
216
|
+
*/
|
|
217
|
+
entityEventSequence?: string | null;
|
|
218
|
+
}
|
|
219
|
+
/** @oneof */
|
|
220
|
+
interface DomainEventBodyOneOf$2 {
|
|
221
|
+
createdEvent?: EntityCreatedEvent$2;
|
|
222
|
+
updatedEvent?: EntityUpdatedEvent$2;
|
|
223
|
+
deletedEvent?: EntityDeletedEvent$2;
|
|
224
|
+
actionEvent?: ActionEvent$2;
|
|
225
|
+
}
|
|
226
|
+
interface EntityCreatedEvent$2 {
|
|
227
|
+
entity?: string;
|
|
228
|
+
}
|
|
229
|
+
interface RestoreInfo$1 {
|
|
230
|
+
deletedDate?: Date;
|
|
231
|
+
}
|
|
232
|
+
interface EntityUpdatedEvent$2 {
|
|
233
|
+
/**
|
|
234
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
235
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
236
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
237
|
+
*/
|
|
238
|
+
currentEntity?: string;
|
|
239
|
+
}
|
|
240
|
+
interface EntityDeletedEvent$2 {
|
|
241
|
+
/** Entity that was deleted */
|
|
242
|
+
deletedEntity?: string | null;
|
|
243
|
+
}
|
|
244
|
+
interface ActionEvent$2 {
|
|
245
|
+
body?: string;
|
|
246
|
+
}
|
|
247
|
+
interface MessageEnvelope$2 {
|
|
248
|
+
/** App instance ID. */
|
|
249
|
+
instanceId?: string | null;
|
|
250
|
+
/** Event type. */
|
|
251
|
+
eventType?: string;
|
|
252
|
+
/** The identification type and identity data. */
|
|
253
|
+
identity?: IdentificationData$2;
|
|
254
|
+
/** Stringify payload. */
|
|
255
|
+
data?: string;
|
|
256
|
+
}
|
|
257
|
+
interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
|
|
258
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
259
|
+
anonymousVisitorId?: string;
|
|
260
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
261
|
+
memberId?: string;
|
|
262
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
263
|
+
wixUserId?: string;
|
|
264
|
+
/** ID of an app. */
|
|
265
|
+
appId?: string;
|
|
266
|
+
/** @readonly */
|
|
267
|
+
identityType?: WebhookIdentityType$2;
|
|
268
|
+
}
|
|
269
|
+
/** @oneof */
|
|
270
|
+
interface IdentificationDataIdOneOf$2 {
|
|
271
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
272
|
+
anonymousVisitorId?: string;
|
|
273
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
274
|
+
memberId?: string;
|
|
275
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
276
|
+
wixUserId?: string;
|
|
277
|
+
/** ID of an app. */
|
|
278
|
+
appId?: string;
|
|
279
|
+
}
|
|
280
|
+
declare enum WebhookIdentityType$2 {
|
|
281
|
+
UNKNOWN = "UNKNOWN",
|
|
282
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
283
|
+
MEMBER = "MEMBER",
|
|
284
|
+
WIX_USER = "WIX_USER",
|
|
285
|
+
APP = "APP"
|
|
286
|
+
}
|
|
287
|
+
interface CreateConnectedDomainResponseNonNullableFields {
|
|
288
|
+
connectedDomain?: {
|
|
289
|
+
_id: string;
|
|
290
|
+
domain: string;
|
|
291
|
+
connectionType: ConnectionType$1;
|
|
292
|
+
siteInfo?: {
|
|
293
|
+
redirectInfo?: {
|
|
294
|
+
primaryDomain: string;
|
|
295
|
+
};
|
|
296
|
+
assignmentType: AssignmentType$1;
|
|
297
|
+
};
|
|
298
|
+
suppressNotifications: boolean;
|
|
299
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
300
|
+
};
|
|
301
|
+
}
|
|
302
|
+
interface GetConnectedDomainResponseNonNullableFields {
|
|
303
|
+
connectedDomain?: {
|
|
304
|
+
_id: string;
|
|
305
|
+
domain: string;
|
|
306
|
+
connectionType: ConnectionType$1;
|
|
307
|
+
siteInfo?: {
|
|
308
|
+
redirectInfo?: {
|
|
309
|
+
primaryDomain: string;
|
|
310
|
+
};
|
|
311
|
+
assignmentType: AssignmentType$1;
|
|
312
|
+
};
|
|
313
|
+
suppressNotifications: boolean;
|
|
314
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
315
|
+
};
|
|
316
|
+
}
|
|
317
|
+
interface ListConnectedDomainsResponseNonNullableFields {
|
|
318
|
+
connectedDomains: {
|
|
319
|
+
_id: string;
|
|
320
|
+
domain: string;
|
|
321
|
+
connectionType: ConnectionType$1;
|
|
322
|
+
siteInfo?: {
|
|
323
|
+
redirectInfo?: {
|
|
324
|
+
primaryDomain: string;
|
|
325
|
+
};
|
|
326
|
+
assignmentType: AssignmentType$1;
|
|
327
|
+
};
|
|
328
|
+
suppressNotifications: boolean;
|
|
329
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
330
|
+
}[];
|
|
331
|
+
}
|
|
332
|
+
interface ListConnectedDomainsOptions {
|
|
333
|
+
/** Cursor paging options. */
|
|
334
|
+
paging?: CursorPaging$2;
|
|
335
|
+
}
|
|
336
|
+
|
|
1
337
|
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
338
|
interface HttpClient {
|
|
3
339
|
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
@@ -24,16 +360,6 @@ type APIMetadata = {
|
|
|
24
360
|
packageName?: string;
|
|
25
361
|
};
|
|
26
362
|
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
28
|
-
__type: 'event-definition';
|
|
29
|
-
type: Type;
|
|
30
|
-
isDomainEvent?: boolean;
|
|
31
|
-
transformations?: (envelope: unknown) => Payload;
|
|
32
|
-
__payload: Payload;
|
|
33
|
-
};
|
|
34
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
35
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
36
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
37
363
|
|
|
38
364
|
declare global {
|
|
39
365
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
@@ -44,30 +370,565 @@ declare global {
|
|
|
44
370
|
|
|
45
371
|
declare function createRESTModule$5<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
46
372
|
|
|
47
|
-
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
48
|
-
|
|
49
373
|
declare const createConnectedDomain: ReturnType<typeof createRESTModule$5<typeof publicCreateConnectedDomain>>;
|
|
50
374
|
declare const getConnectedDomain: ReturnType<typeof createRESTModule$5<typeof publicGetConnectedDomain>>;
|
|
51
375
|
declare const deleteConnectedDomain: ReturnType<typeof createRESTModule$5<typeof publicDeleteConnectedDomain>>;
|
|
52
376
|
declare const listConnectedDomains: ReturnType<typeof createRESTModule$5<typeof publicListConnectedDomains>>;
|
|
53
|
-
declare const onConnectedDomainRemoved: ReturnType<typeof createEventModule<typeof publicOnConnectedDomainRemoved>>;
|
|
54
377
|
|
|
378
|
+
type context$5_ConnectedDomain = ConnectedDomain;
|
|
379
|
+
type context$5_CreateConnectedDomainRequest = CreateConnectedDomainRequest;
|
|
380
|
+
type context$5_CreateConnectedDomainResponse = CreateConnectedDomainResponse;
|
|
381
|
+
type context$5_CreateConnectedDomainResponseNonNullableFields = CreateConnectedDomainResponseNonNullableFields;
|
|
382
|
+
type context$5_DeleteConnectedDomainRequest = DeleteConnectedDomainRequest;
|
|
383
|
+
type context$5_DeleteConnectedDomainResponse = DeleteConnectedDomainResponse;
|
|
384
|
+
type context$5_GetConnectedDomainRequest = GetConnectedDomainRequest;
|
|
385
|
+
type context$5_GetConnectedDomainResponse = GetConnectedDomainResponse;
|
|
386
|
+
type context$5_GetConnectedDomainResponseNonNullableFields = GetConnectedDomainResponseNonNullableFields;
|
|
387
|
+
type context$5_ListConnectedDomainsOptions = ListConnectedDomainsOptions;
|
|
388
|
+
type context$5_ListConnectedDomainsRequest = ListConnectedDomainsRequest;
|
|
389
|
+
type context$5_ListConnectedDomainsResponse = ListConnectedDomainsResponse;
|
|
390
|
+
type context$5_ListConnectedDomainsResponseNonNullableFields = ListConnectedDomainsResponseNonNullableFields;
|
|
55
391
|
declare const context$5_createConnectedDomain: typeof createConnectedDomain;
|
|
56
392
|
declare const context$5_deleteConnectedDomain: typeof deleteConnectedDomain;
|
|
57
393
|
declare const context$5_getConnectedDomain: typeof getConnectedDomain;
|
|
58
394
|
declare const context$5_listConnectedDomains: typeof listConnectedDomains;
|
|
59
|
-
declare const context$5_onConnectedDomainRemoved: typeof onConnectedDomainRemoved;
|
|
60
395
|
declare namespace context$5 {
|
|
61
|
-
export { context$5_createConnectedDomain as createConnectedDomain, context$5_deleteConnectedDomain as deleteConnectedDomain, context$5_getConnectedDomain as getConnectedDomain, context$5_listConnectedDomains as listConnectedDomains
|
|
396
|
+
export { type ActionEvent$2 as ActionEvent, AssignmentType$1 as AssignmentType, type context$5_ConnectedDomain as ConnectedDomain, ConnectionType$1 as ConnectionType, type context$5_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type context$5_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type context$5_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type Cursors$2 as Cursors, type context$5_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type context$5_DeleteConnectedDomainResponse as DeleteConnectedDomainResponse, DnsPropagationStatus$1 as DnsPropagationStatus, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type DomainRemovedEvent$1 as DomainRemovedEvent, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type context$5_GetConnectedDomainRequest as GetConnectedDomainRequest, type context$5_GetConnectedDomainResponse as GetConnectedDomainResponse, type context$5_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type context$5_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type context$5_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type context$5_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type context$5_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type RedirectAssignmentInfo$1 as RedirectAssignmentInfo, type RestoreInfo$1 as RestoreInfo, type SiteInfo$1 as SiteInfo, type SiteInfoAssignmentInfoOneOf$1 as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$2 as WebhookIdentityType, context$5_createConnectedDomain as createConnectedDomain, context$5_deleteConnectedDomain as deleteConnectedDomain, context$5_getConnectedDomain as getConnectedDomain, context$5_listConnectedDomains as listConnectedDomains };
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* A `connectedDomainSetupInfo` object holds information the connected domain's
|
|
401
|
+
* external registrar and some DNS records. You can use this information to guide
|
|
402
|
+
* the site owner through the domain's setup process.
|
|
403
|
+
*/
|
|
404
|
+
interface ConnectedDomainSetupInfo extends ConnectedDomainSetupInfoDnsRecordsOneOf {
|
|
405
|
+
/**
|
|
406
|
+
* Information about domains connected using nameservers. Available only for
|
|
407
|
+
* `{"connectionType": "NAMESERVERS"}`.
|
|
408
|
+
*/
|
|
409
|
+
nameserverRecord?: NameserverRecord;
|
|
410
|
+
/**
|
|
411
|
+
* Information about domains connected by pointing. Available only for
|
|
412
|
+
* `{"connectionType": "POINTING"}`.
|
|
413
|
+
* @readonly
|
|
414
|
+
*/
|
|
415
|
+
pointingRecords?: PointingRecords;
|
|
416
|
+
/**
|
|
417
|
+
* Information about subdomains. Available only for subdomains.
|
|
418
|
+
* @readonly
|
|
419
|
+
*/
|
|
420
|
+
subdomainRecords?: SubdomainRecords;
|
|
421
|
+
/** ID of the connected domain. Identical to the domain name including TLD. */
|
|
422
|
+
connectedDomainId?: string;
|
|
423
|
+
/**
|
|
424
|
+
* Information about the external domain registrar including current name
|
|
425
|
+
* servers.
|
|
426
|
+
*/
|
|
427
|
+
registrar?: Registrar;
|
|
428
|
+
}
|
|
429
|
+
/** @oneof */
|
|
430
|
+
interface ConnectedDomainSetupInfoDnsRecordsOneOf {
|
|
431
|
+
/**
|
|
432
|
+
* Information about domains connected using nameservers. Available only for
|
|
433
|
+
* `{"connectionType": "NAMESERVERS"}`.
|
|
434
|
+
*/
|
|
435
|
+
nameserverRecord?: NameserverRecord;
|
|
436
|
+
/**
|
|
437
|
+
* Information about domains connected by pointing. Available only for
|
|
438
|
+
* `{"connectionType": "POINTING"}`.
|
|
439
|
+
* @readonly
|
|
440
|
+
*/
|
|
441
|
+
pointingRecords?: PointingRecords;
|
|
442
|
+
/**
|
|
443
|
+
* Information about subdomains. Available only for subdomains.
|
|
444
|
+
* @readonly
|
|
445
|
+
*/
|
|
446
|
+
subdomainRecords?: SubdomainRecords;
|
|
447
|
+
}
|
|
448
|
+
interface Registrar {
|
|
449
|
+
/**
|
|
450
|
+
* Name of the external domain registrar. For subdomains it's the registrar of the root domain.
|
|
451
|
+
* @readonly
|
|
452
|
+
*/
|
|
453
|
+
name?: string | null;
|
|
454
|
+
/**
|
|
455
|
+
* Values of the current name server records. In case you connect an external
|
|
456
|
+
* domain using name servers, site owners must replace these current name servers
|
|
457
|
+
* with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
|
|
458
|
+
* during the initial domain setup.
|
|
459
|
+
* The replacement can't be performed through Wix APIs, you must use the
|
|
460
|
+
* infrastructure of the external domain registrar. Read more about
|
|
461
|
+
* [connecting domains using nameservers](https://dev.wix.com/api/rest/account-level-apis/connected-domains/sample-flows#account-level-apis_connected-domains_sample-flows_connect-an-external-domain-using-nameservers).
|
|
462
|
+
* @readonly
|
|
463
|
+
*/
|
|
464
|
+
nameServers?: string[];
|
|
465
|
+
}
|
|
466
|
+
/** Information about domains connected by nameservers. */
|
|
467
|
+
interface NameserverRecord {
|
|
468
|
+
/**
|
|
469
|
+
* Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
|
|
470
|
+
* @readonly
|
|
471
|
+
*/
|
|
472
|
+
nsRecord?: NsRecord;
|
|
473
|
+
}
|
|
474
|
+
interface NsRecord {
|
|
475
|
+
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
476
|
+
hostName?: string;
|
|
477
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
478
|
+
ttl?: number;
|
|
479
|
+
/** DNS record values. */
|
|
480
|
+
values?: string[];
|
|
481
|
+
}
|
|
482
|
+
/** Information about domains connected by pointing. */
|
|
483
|
+
interface PointingRecords {
|
|
484
|
+
/**
|
|
485
|
+
* [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).
|
|
486
|
+
* @readonly
|
|
487
|
+
*/
|
|
488
|
+
aRecord?: ARecord;
|
|
489
|
+
/**
|
|
490
|
+
* [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).
|
|
491
|
+
* @readonly
|
|
492
|
+
*/
|
|
493
|
+
cnameRecord?: CnameRecord;
|
|
494
|
+
}
|
|
495
|
+
interface ARecord {
|
|
496
|
+
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
497
|
+
hostName?: string;
|
|
498
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
499
|
+
ttl?: number;
|
|
500
|
+
/** DNS record values. */
|
|
501
|
+
values?: string[];
|
|
502
|
+
}
|
|
503
|
+
interface CnameRecord {
|
|
504
|
+
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
505
|
+
hostName?: string;
|
|
506
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
507
|
+
ttl?: number;
|
|
508
|
+
/** DNS record value. */
|
|
509
|
+
value?: string;
|
|
510
|
+
}
|
|
511
|
+
/** Information about subdomains. */
|
|
512
|
+
interface SubdomainRecords {
|
|
513
|
+
/**
|
|
514
|
+
* [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
|
|
515
|
+
* @readonly
|
|
516
|
+
*/
|
|
517
|
+
cnameRecords?: CnameRecord[];
|
|
518
|
+
}
|
|
519
|
+
interface GetSetupInfoRequest {
|
|
520
|
+
/** Domain name including TLD */
|
|
521
|
+
domain?: string;
|
|
522
|
+
/**
|
|
523
|
+
* How the domain should be to connected the Wix site.
|
|
524
|
+
*
|
|
525
|
+
* + `"UNKNOWN_CONNECTION_TYPE"`: supported only for subdomain.
|
|
526
|
+
* + `"POINTING"`: Get domain or subdomain setup by pointing
|
|
527
|
+
* + `"NAMESERVERS"`: Get domain setup by nameservers
|
|
528
|
+
* + `"HIDDEN"`: supported only for subdomain.
|
|
529
|
+
*/
|
|
530
|
+
connectionType?: ConnectionType;
|
|
531
|
+
/** Whether to return registrar information or not. Default is false. */
|
|
532
|
+
includeRegistrar?: boolean;
|
|
533
|
+
}
|
|
534
|
+
declare enum ConnectionType {
|
|
535
|
+
/** Used by sub domain */
|
|
536
|
+
UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
|
|
537
|
+
POINTING = "POINTING",
|
|
538
|
+
NAMESERVERS = "NAMESERVERS",
|
|
539
|
+
/**
|
|
540
|
+
* internal used by photography company.
|
|
541
|
+
* when a customer creates a photo album, each album has its sub domain and this sub domain
|
|
542
|
+
* is not visible in my domains page.
|
|
543
|
+
*/
|
|
544
|
+
HIDDEN = "HIDDEN"
|
|
545
|
+
}
|
|
546
|
+
interface GetSetupInfoResponse {
|
|
547
|
+
/** Retrieved setup information. */
|
|
548
|
+
domainSetupInfo?: ConnectedDomainSetupInfo;
|
|
549
|
+
}
|
|
550
|
+
interface GetConnectedDomainSetupInfoRequest {
|
|
551
|
+
/**
|
|
552
|
+
* ID of the connected domain to retrieve setup information for.
|
|
553
|
+
* Identical to the domain name including TLD.
|
|
554
|
+
*/
|
|
555
|
+
connectedDomainId: string;
|
|
556
|
+
}
|
|
557
|
+
interface GetConnectedDomainSetupInfoResponse {
|
|
558
|
+
/** Retrieved setup information. */
|
|
559
|
+
connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
|
|
560
|
+
}
|
|
561
|
+
interface GetConnectedDomainSetupInfoResponseNonNullableFields {
|
|
562
|
+
connectedDomainSetupInfo?: {
|
|
563
|
+
nameserverRecord?: {
|
|
564
|
+
nsRecord?: {
|
|
565
|
+
hostName: string;
|
|
566
|
+
ttl: number;
|
|
567
|
+
values: string[];
|
|
568
|
+
};
|
|
569
|
+
};
|
|
570
|
+
pointingRecords?: {
|
|
571
|
+
aRecord?: {
|
|
572
|
+
hostName: string;
|
|
573
|
+
ttl: number;
|
|
574
|
+
values: string[];
|
|
575
|
+
};
|
|
576
|
+
cnameRecord?: {
|
|
577
|
+
hostName: string;
|
|
578
|
+
ttl: number;
|
|
579
|
+
value: string;
|
|
580
|
+
};
|
|
581
|
+
};
|
|
582
|
+
subdomainRecords?: {
|
|
583
|
+
cnameRecords: {
|
|
584
|
+
hostName: string;
|
|
585
|
+
ttl: number;
|
|
586
|
+
value: string;
|
|
587
|
+
}[];
|
|
588
|
+
};
|
|
589
|
+
connectedDomainId: string;
|
|
590
|
+
registrar?: {
|
|
591
|
+
nameServers: string[];
|
|
592
|
+
};
|
|
593
|
+
};
|
|
62
594
|
}
|
|
63
595
|
|
|
64
596
|
declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
65
597
|
|
|
66
598
|
declare const getConnectedDomainSetupInfo: ReturnType<typeof createRESTModule$4<typeof publicGetConnectedDomainSetupInfo>>;
|
|
67
599
|
|
|
600
|
+
type context$4_ARecord = ARecord;
|
|
601
|
+
type context$4_CnameRecord = CnameRecord;
|
|
602
|
+
type context$4_ConnectedDomainSetupInfo = ConnectedDomainSetupInfo;
|
|
603
|
+
type context$4_ConnectedDomainSetupInfoDnsRecordsOneOf = ConnectedDomainSetupInfoDnsRecordsOneOf;
|
|
604
|
+
type context$4_ConnectionType = ConnectionType;
|
|
605
|
+
declare const context$4_ConnectionType: typeof ConnectionType;
|
|
606
|
+
type context$4_GetConnectedDomainSetupInfoRequest = GetConnectedDomainSetupInfoRequest;
|
|
607
|
+
type context$4_GetConnectedDomainSetupInfoResponse = GetConnectedDomainSetupInfoResponse;
|
|
608
|
+
type context$4_GetConnectedDomainSetupInfoResponseNonNullableFields = GetConnectedDomainSetupInfoResponseNonNullableFields;
|
|
609
|
+
type context$4_GetSetupInfoRequest = GetSetupInfoRequest;
|
|
610
|
+
type context$4_GetSetupInfoResponse = GetSetupInfoResponse;
|
|
611
|
+
type context$4_NameserverRecord = NameserverRecord;
|
|
612
|
+
type context$4_NsRecord = NsRecord;
|
|
613
|
+
type context$4_PointingRecords = PointingRecords;
|
|
614
|
+
type context$4_Registrar = Registrar;
|
|
615
|
+
type context$4_SubdomainRecords = SubdomainRecords;
|
|
68
616
|
declare const context$4_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
|
|
69
617
|
declare namespace context$4 {
|
|
70
|
-
export { context$4_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
618
|
+
export { type context$4_ARecord as ARecord, type context$4_CnameRecord as CnameRecord, type context$4_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type context$4_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, context$4_ConnectionType as ConnectionType, type context$4_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type context$4_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type context$4_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type context$4_GetSetupInfoRequest as GetSetupInfoRequest, type context$4_GetSetupInfoResponse as GetSetupInfoResponse, type context$4_NameserverRecord as NameserverRecord, type context$4_NsRecord as NsRecord, type context$4_PointingRecords as PointingRecords, type context$4_Registrar as Registrar, type context$4_SubdomainRecords as SubdomainRecords, context$4_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
/** DNS zones hold information about the records that map a domain's URL to an IP address. */
|
|
622
|
+
interface DnsZone {
|
|
623
|
+
/** Domain name including the TLD. Both root domains and subdomains are supported. */
|
|
624
|
+
domainName?: string;
|
|
625
|
+
/**
|
|
626
|
+
* DNS records. You can only set up a single `record` object per DNS record
|
|
627
|
+
* type. If you want to specify multiple values for the same record type, you
|
|
628
|
+
* must save them in the `values` for the relevant type.
|
|
629
|
+
*
|
|
630
|
+
* Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
|
|
631
|
+
* Max: 5000 DNS records
|
|
632
|
+
*/
|
|
633
|
+
records?: DnsRecord[];
|
|
634
|
+
/**
|
|
635
|
+
* ID of the Dns Zone. Identical to the domain name including TLD.
|
|
636
|
+
* @readonly
|
|
637
|
+
*/
|
|
638
|
+
_id?: string;
|
|
639
|
+
/**
|
|
640
|
+
* Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) are enabled.
|
|
641
|
+
*
|
|
642
|
+
* Default: `false`
|
|
643
|
+
*/
|
|
644
|
+
dnssecEnabled?: boolean;
|
|
645
|
+
}
|
|
646
|
+
interface DnsRecord {
|
|
647
|
+
/**
|
|
648
|
+
* [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
|
|
649
|
+
*
|
|
650
|
+
* + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
|
|
651
|
+
* + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
|
|
652
|
+
* + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
|
|
653
|
+
* + `NS`: Name server record. Describes which server contains the actual DNS record.
|
|
654
|
+
* + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
|
|
655
|
+
* + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
|
|
656
|
+
* + `MX`: MX record. Directs emails to mail servers.
|
|
657
|
+
* + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
|
|
658
|
+
* + `SPF`: SPF record. Used for email authentication.
|
|
659
|
+
* + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
|
|
660
|
+
* + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
|
|
661
|
+
* + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
|
|
662
|
+
*/
|
|
663
|
+
type?: RecordType;
|
|
664
|
+
/**
|
|
665
|
+
* Host name. Can be a subdomain. For example, `domain.com` or
|
|
666
|
+
* `mail.domain.com`. Equal to the domain name, except for `CNAME` records.
|
|
667
|
+
*/
|
|
668
|
+
hostName?: string;
|
|
669
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
670
|
+
ttl?: number;
|
|
671
|
+
/**
|
|
672
|
+
* DNS record values. Wix limits DNS records to 50 values per type. External
|
|
673
|
+
* providers may support a different maximum number of DNS records for a
|
|
674
|
+
* specific type, Wix doesn't validate that you don't exceed these external
|
|
675
|
+
* limits.
|
|
676
|
+
*
|
|
677
|
+
* Max: 50 records
|
|
678
|
+
*/
|
|
679
|
+
values?: string[];
|
|
680
|
+
}
|
|
681
|
+
declare enum RecordType {
|
|
682
|
+
UNKNOWN = "UNKNOWN",
|
|
683
|
+
A = "A",
|
|
684
|
+
AAAA = "AAAA",
|
|
685
|
+
NS = "NS",
|
|
686
|
+
SOA = "SOA",
|
|
687
|
+
CNAME = "CNAME",
|
|
688
|
+
MX = "MX",
|
|
689
|
+
TXT = "TXT",
|
|
690
|
+
SPF = "SPF",
|
|
691
|
+
SRV = "SRV",
|
|
692
|
+
PTR = "PTR",
|
|
693
|
+
NAPTR = "NAPTR"
|
|
694
|
+
}
|
|
695
|
+
interface DomainRemovedEvent {
|
|
696
|
+
/**
|
|
697
|
+
* Domain name including TLD.
|
|
698
|
+
* Both root domains and subdomains are supported.
|
|
699
|
+
*/
|
|
700
|
+
domain?: string;
|
|
701
|
+
}
|
|
702
|
+
interface CreateDnsZoneRequest {
|
|
703
|
+
/** DNS zone to create. */
|
|
704
|
+
dnsZone: DnsZone;
|
|
705
|
+
}
|
|
706
|
+
interface CreateDnsZoneResponse {
|
|
707
|
+
/** Created DNS zone. */
|
|
708
|
+
dnsZone?: DnsZone;
|
|
709
|
+
}
|
|
710
|
+
interface GetDnsZoneRequest {
|
|
711
|
+
/** Domain to retrieve the DNS zone for. */
|
|
712
|
+
domainName: string;
|
|
713
|
+
}
|
|
714
|
+
interface GetDnsZoneResponse {
|
|
715
|
+
/** Retrieved DNS zone. */
|
|
716
|
+
dnsZone?: DnsZone;
|
|
717
|
+
}
|
|
718
|
+
interface UpdateDnsZoneRequest {
|
|
719
|
+
/** Domain to update the DNS zone for. Must include the TLD. */
|
|
720
|
+
domainName: string;
|
|
721
|
+
/**
|
|
722
|
+
* DNS records to add to the DNS zone.
|
|
723
|
+
*
|
|
724
|
+
* Max: 10 additions
|
|
725
|
+
*/
|
|
726
|
+
additions?: DnsRecord[];
|
|
727
|
+
/**
|
|
728
|
+
* DNS records to remove from the DNS zone.
|
|
729
|
+
*
|
|
730
|
+
* Max: 10 deletions
|
|
731
|
+
*/
|
|
732
|
+
deletions?: DnsRecord[];
|
|
733
|
+
/** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
|
|
734
|
+
dnssecEnabled?: boolean | null;
|
|
735
|
+
}
|
|
736
|
+
interface UpdateDnsZoneResponse {
|
|
737
|
+
/** Updated DNS zone. */
|
|
738
|
+
dnsZone?: DnsZone;
|
|
739
|
+
}
|
|
740
|
+
interface DeleteDnsZoneRequest {
|
|
741
|
+
/** Domain name to delete the DNS zone for. */
|
|
742
|
+
domainName: string;
|
|
743
|
+
}
|
|
744
|
+
interface DeleteDnsZoneResponse {
|
|
745
|
+
}
|
|
746
|
+
interface PreviewDnsZoneRequest {
|
|
747
|
+
/** Domain name to generate a DNS zone preview for. */
|
|
748
|
+
domainName: string;
|
|
749
|
+
}
|
|
750
|
+
interface PreviewDnsZoneResponse {
|
|
751
|
+
/**
|
|
752
|
+
* DNS zone preview.
|
|
753
|
+
*
|
|
754
|
+
* Includes calculated `A`, `CNAME`, `NS` and `SOA` records.
|
|
755
|
+
*/
|
|
756
|
+
dnsZone?: DnsZone;
|
|
757
|
+
}
|
|
758
|
+
interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
|
|
759
|
+
createdEvent?: EntityCreatedEvent$1;
|
|
760
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
|
761
|
+
deletedEvent?: EntityDeletedEvent$1;
|
|
762
|
+
actionEvent?: ActionEvent$1;
|
|
763
|
+
/**
|
|
764
|
+
* Unique event ID.
|
|
765
|
+
* Allows clients to ignore duplicate webhooks.
|
|
766
|
+
*/
|
|
767
|
+
_id?: string;
|
|
768
|
+
/**
|
|
769
|
+
* Assumes actions are also always typed to an entity_type
|
|
770
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
771
|
+
*/
|
|
772
|
+
entityFqdn?: string;
|
|
773
|
+
/**
|
|
774
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
775
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
776
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
777
|
+
*/
|
|
778
|
+
slug?: string;
|
|
779
|
+
/** ID of the entity associated with the event. */
|
|
780
|
+
entityId?: string;
|
|
781
|
+
/** Event timestamp. */
|
|
782
|
+
eventTime?: Date;
|
|
783
|
+
/**
|
|
784
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
785
|
+
* (for example, GDPR).
|
|
786
|
+
*/
|
|
787
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
788
|
+
/** If present, indicates the action that triggered the event. */
|
|
789
|
+
originatedFrom?: string | null;
|
|
790
|
+
/**
|
|
791
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
792
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
793
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
794
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
795
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
796
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
797
|
+
*/
|
|
798
|
+
entityEventSequence?: string | null;
|
|
799
|
+
}
|
|
800
|
+
/** @oneof */
|
|
801
|
+
interface DomainEventBodyOneOf$1 {
|
|
802
|
+
createdEvent?: EntityCreatedEvent$1;
|
|
803
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
|
804
|
+
deletedEvent?: EntityDeletedEvent$1;
|
|
805
|
+
actionEvent?: ActionEvent$1;
|
|
806
|
+
}
|
|
807
|
+
interface EntityCreatedEvent$1 {
|
|
808
|
+
entity?: string;
|
|
809
|
+
}
|
|
810
|
+
interface EntityUpdatedEvent$1 {
|
|
811
|
+
/**
|
|
812
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
813
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
814
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
815
|
+
*/
|
|
816
|
+
currentEntity?: string;
|
|
817
|
+
}
|
|
818
|
+
interface EntityDeletedEvent$1 {
|
|
819
|
+
/** Entity that was deleted */
|
|
820
|
+
deletedEntity?: string | null;
|
|
821
|
+
}
|
|
822
|
+
interface ActionEvent$1 {
|
|
823
|
+
body?: string;
|
|
824
|
+
}
|
|
825
|
+
interface MessageEnvelope$1 {
|
|
826
|
+
/** App instance ID. */
|
|
827
|
+
instanceId?: string | null;
|
|
828
|
+
/** Event type. */
|
|
829
|
+
eventType?: string;
|
|
830
|
+
/** The identification type and identity data. */
|
|
831
|
+
identity?: IdentificationData$1;
|
|
832
|
+
/** Stringify payload. */
|
|
833
|
+
data?: string;
|
|
834
|
+
}
|
|
835
|
+
interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
|
|
836
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
837
|
+
anonymousVisitorId?: string;
|
|
838
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
839
|
+
memberId?: string;
|
|
840
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
841
|
+
wixUserId?: string;
|
|
842
|
+
/** ID of an app. */
|
|
843
|
+
appId?: string;
|
|
844
|
+
/** @readonly */
|
|
845
|
+
identityType?: WebhookIdentityType$1;
|
|
846
|
+
}
|
|
847
|
+
/** @oneof */
|
|
848
|
+
interface IdentificationDataIdOneOf$1 {
|
|
849
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
850
|
+
anonymousVisitorId?: string;
|
|
851
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
852
|
+
memberId?: string;
|
|
853
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
854
|
+
wixUserId?: string;
|
|
855
|
+
/** ID of an app. */
|
|
856
|
+
appId?: string;
|
|
857
|
+
}
|
|
858
|
+
declare enum WebhookIdentityType$1 {
|
|
859
|
+
UNKNOWN = "UNKNOWN",
|
|
860
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
861
|
+
MEMBER = "MEMBER",
|
|
862
|
+
WIX_USER = "WIX_USER",
|
|
863
|
+
APP = "APP"
|
|
864
|
+
}
|
|
865
|
+
interface CreateDnsZoneResponseNonNullableFields {
|
|
866
|
+
dnsZone?: {
|
|
867
|
+
domainName: string;
|
|
868
|
+
records: {
|
|
869
|
+
type: RecordType;
|
|
870
|
+
hostName: string;
|
|
871
|
+
ttl: number;
|
|
872
|
+
values: string[];
|
|
873
|
+
}[];
|
|
874
|
+
_id: string;
|
|
875
|
+
dnssecEnabled: boolean;
|
|
876
|
+
};
|
|
877
|
+
}
|
|
878
|
+
interface GetDnsZoneResponseNonNullableFields {
|
|
879
|
+
dnsZone?: {
|
|
880
|
+
domainName: string;
|
|
881
|
+
records: {
|
|
882
|
+
type: RecordType;
|
|
883
|
+
hostName: string;
|
|
884
|
+
ttl: number;
|
|
885
|
+
values: string[];
|
|
886
|
+
}[];
|
|
887
|
+
_id: string;
|
|
888
|
+
dnssecEnabled: boolean;
|
|
889
|
+
};
|
|
890
|
+
}
|
|
891
|
+
interface UpdateDnsZoneResponseNonNullableFields {
|
|
892
|
+
dnsZone?: {
|
|
893
|
+
domainName: string;
|
|
894
|
+
records: {
|
|
895
|
+
type: RecordType;
|
|
896
|
+
hostName: string;
|
|
897
|
+
ttl: number;
|
|
898
|
+
values: string[];
|
|
899
|
+
}[];
|
|
900
|
+
_id: string;
|
|
901
|
+
dnssecEnabled: boolean;
|
|
902
|
+
};
|
|
903
|
+
}
|
|
904
|
+
interface PreviewDnsZoneResponseNonNullableFields {
|
|
905
|
+
dnsZone?: {
|
|
906
|
+
domainName: string;
|
|
907
|
+
records: {
|
|
908
|
+
type: RecordType;
|
|
909
|
+
hostName: string;
|
|
910
|
+
ttl: number;
|
|
911
|
+
values: string[];
|
|
912
|
+
}[];
|
|
913
|
+
_id: string;
|
|
914
|
+
dnssecEnabled: boolean;
|
|
915
|
+
};
|
|
916
|
+
}
|
|
917
|
+
interface UpdateDnsZoneOptions {
|
|
918
|
+
/**
|
|
919
|
+
* DNS records to add to the DNS zone.
|
|
920
|
+
*
|
|
921
|
+
* Max: 10 additions
|
|
922
|
+
*/
|
|
923
|
+
additions?: DnsRecord[];
|
|
924
|
+
/**
|
|
925
|
+
* DNS records to remove from the DNS zone.
|
|
926
|
+
*
|
|
927
|
+
* Max: 10 deletions
|
|
928
|
+
*/
|
|
929
|
+
deletions?: DnsRecord[];
|
|
930
|
+
/** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
|
|
931
|
+
dnssecEnabled?: boolean | null;
|
|
71
932
|
}
|
|
72
933
|
|
|
73
934
|
declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
@@ -78,13 +939,865 @@ declare const updateDnsZone: ReturnType<typeof createRESTModule$3<typeof publicU
|
|
|
78
939
|
declare const deleteDnsZone: ReturnType<typeof createRESTModule$3<typeof publicDeleteDnsZone>>;
|
|
79
940
|
declare const previewDnsZone: ReturnType<typeof createRESTModule$3<typeof publicPreviewDnsZone>>;
|
|
80
941
|
|
|
942
|
+
type context$3_CreateDnsZoneRequest = CreateDnsZoneRequest;
|
|
943
|
+
type context$3_CreateDnsZoneResponse = CreateDnsZoneResponse;
|
|
944
|
+
type context$3_CreateDnsZoneResponseNonNullableFields = CreateDnsZoneResponseNonNullableFields;
|
|
945
|
+
type context$3_DeleteDnsZoneRequest = DeleteDnsZoneRequest;
|
|
946
|
+
type context$3_DeleteDnsZoneResponse = DeleteDnsZoneResponse;
|
|
947
|
+
type context$3_DnsRecord = DnsRecord;
|
|
948
|
+
type context$3_DnsZone = DnsZone;
|
|
949
|
+
type context$3_DomainRemovedEvent = DomainRemovedEvent;
|
|
950
|
+
type context$3_GetDnsZoneRequest = GetDnsZoneRequest;
|
|
951
|
+
type context$3_GetDnsZoneResponse = GetDnsZoneResponse;
|
|
952
|
+
type context$3_GetDnsZoneResponseNonNullableFields = GetDnsZoneResponseNonNullableFields;
|
|
953
|
+
type context$3_PreviewDnsZoneRequest = PreviewDnsZoneRequest;
|
|
954
|
+
type context$3_PreviewDnsZoneResponse = PreviewDnsZoneResponse;
|
|
955
|
+
type context$3_PreviewDnsZoneResponseNonNullableFields = PreviewDnsZoneResponseNonNullableFields;
|
|
956
|
+
type context$3_RecordType = RecordType;
|
|
957
|
+
declare const context$3_RecordType: typeof RecordType;
|
|
958
|
+
type context$3_UpdateDnsZoneOptions = UpdateDnsZoneOptions;
|
|
959
|
+
type context$3_UpdateDnsZoneRequest = UpdateDnsZoneRequest;
|
|
960
|
+
type context$3_UpdateDnsZoneResponse = UpdateDnsZoneResponse;
|
|
961
|
+
type context$3_UpdateDnsZoneResponseNonNullableFields = UpdateDnsZoneResponseNonNullableFields;
|
|
81
962
|
declare const context$3_createDnsZone: typeof createDnsZone;
|
|
82
963
|
declare const context$3_deleteDnsZone: typeof deleteDnsZone;
|
|
83
964
|
declare const context$3_getDnsZone: typeof getDnsZone;
|
|
84
965
|
declare const context$3_previewDnsZone: typeof previewDnsZone;
|
|
85
966
|
declare const context$3_updateDnsZone: typeof updateDnsZone;
|
|
86
967
|
declare namespace context$3 {
|
|
87
|
-
export { context$3_createDnsZone as createDnsZone, context$3_deleteDnsZone as deleteDnsZone, context$3_getDnsZone as getDnsZone, context$3_previewDnsZone as previewDnsZone, context$3_updateDnsZone as updateDnsZone };
|
|
968
|
+
export { type ActionEvent$1 as ActionEvent, type context$3_CreateDnsZoneRequest as CreateDnsZoneRequest, type context$3_CreateDnsZoneResponse as CreateDnsZoneResponse, type context$3_CreateDnsZoneResponseNonNullableFields as CreateDnsZoneResponseNonNullableFields, type context$3_DeleteDnsZoneRequest as DeleteDnsZoneRequest, type context$3_DeleteDnsZoneResponse as DeleteDnsZoneResponse, type context$3_DnsRecord as DnsRecord, type context$3_DnsZone as DnsZone, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type context$3_DomainRemovedEvent as DomainRemovedEvent, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type context$3_GetDnsZoneRequest as GetDnsZoneRequest, type context$3_GetDnsZoneResponse as GetDnsZoneResponse, type context$3_GetDnsZoneResponseNonNullableFields as GetDnsZoneResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type context$3_PreviewDnsZoneRequest as PreviewDnsZoneRequest, type context$3_PreviewDnsZoneResponse as PreviewDnsZoneResponse, type context$3_PreviewDnsZoneResponseNonNullableFields as PreviewDnsZoneResponseNonNullableFields, context$3_RecordType as RecordType, type context$3_UpdateDnsZoneOptions as UpdateDnsZoneOptions, type context$3_UpdateDnsZoneRequest as UpdateDnsZoneRequest, type context$3_UpdateDnsZoneResponse as UpdateDnsZoneResponse, type context$3_UpdateDnsZoneResponseNonNullableFields as UpdateDnsZoneResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, context$3_createDnsZone as createDnsZone, context$3_deleteDnsZone as deleteDnsZone, context$3_getDnsZone as getDnsZone, context$3_previewDnsZone as previewDnsZone, context$3_updateDnsZone as updateDnsZone };
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
/**
|
|
972
|
+
* A registered domain is a domain that Wix has registered on behalf of a customer
|
|
973
|
+
* with an external registar.
|
|
974
|
+
*/
|
|
975
|
+
interface RegisteredDomain extends RegisteredDomainStatusInfoOneOf {
|
|
976
|
+
/**
|
|
977
|
+
* Information about a domain that hasn't been successfully registered
|
|
978
|
+
* yet. Includes the timestamp of the latest registration attempt.
|
|
979
|
+
* @readonly
|
|
980
|
+
*/
|
|
981
|
+
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
982
|
+
/**
|
|
983
|
+
* Information about a domain that couldn't be registered. Includes
|
|
984
|
+
* failure code and message.
|
|
985
|
+
* @readonly
|
|
986
|
+
*/
|
|
987
|
+
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
988
|
+
/**
|
|
989
|
+
* Domain ID. Identical to `domain`.
|
|
990
|
+
* @readonly
|
|
991
|
+
*/
|
|
992
|
+
_id?: string;
|
|
993
|
+
/**
|
|
994
|
+
* Name of the domain including TLD.
|
|
995
|
+
* Subdomains aren't supported. You can only register a root domain.
|
|
996
|
+
* Domain name and TLD must be separated by a dot. For example,
|
|
997
|
+
* `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
|
|
998
|
+
* supported.
|
|
999
|
+
*
|
|
1000
|
+
* Min: 3 characters
|
|
1001
|
+
* Max: 63 characters
|
|
1002
|
+
*/
|
|
1003
|
+
domain?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* ID of the product instance from the
|
|
1006
|
+
* [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
|
|
1007
|
+
* that belongs to the `registeredDomain` object.
|
|
1008
|
+
* Your account must own a product that supports the chosen TLD, regardless of
|
|
1009
|
+
* whether you want to assign the domain to a site or keep it floating. If
|
|
1010
|
+
* you want to assign the domain to a site, the relevant site must also
|
|
1011
|
+
* own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
|
|
1012
|
+
* for more information about how to become a reseller and a list of available
|
|
1013
|
+
* product IDs.
|
|
1014
|
+
*/
|
|
1015
|
+
productInstanceId?: string;
|
|
1016
|
+
/**
|
|
1017
|
+
* Date and time the `registeredDomain` object was created in
|
|
1018
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1019
|
+
* @readonly
|
|
1020
|
+
*/
|
|
1021
|
+
_createdDate?: Date;
|
|
1022
|
+
/**
|
|
1023
|
+
* Date and time the `registeredDomain` object was last updated in
|
|
1024
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1025
|
+
* @readonly
|
|
1026
|
+
*/
|
|
1027
|
+
_updatedDate?: Date;
|
|
1028
|
+
/**
|
|
1029
|
+
* Revision number, which increments by 1 each time the registered domain
|
|
1030
|
+
* is updated. To prevent conflicting changes, the current revision must be
|
|
1031
|
+
* passed when updating the registered domain.
|
|
1032
|
+
*
|
|
1033
|
+
* Ignored when creating a registered domain.
|
|
1034
|
+
*/
|
|
1035
|
+
revision?: string | null;
|
|
1036
|
+
/**
|
|
1037
|
+
* Information about the Wix site the domain is connected to and whether the
|
|
1038
|
+
* domain is assigned as the primary domain or a redirect.
|
|
1039
|
+
*/
|
|
1040
|
+
siteInfo?: SiteInfo;
|
|
1041
|
+
/**
|
|
1042
|
+
* Contact details for the registrant, admin, and tech support of the registered domain.
|
|
1043
|
+
* You can read more about which
|
|
1044
|
+
* [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
|
|
1045
|
+
* are implemented.
|
|
1046
|
+
*/
|
|
1047
|
+
contacts?: Contacts;
|
|
1048
|
+
/**
|
|
1049
|
+
* Status of the registered domain.
|
|
1050
|
+
*
|
|
1051
|
+
* + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
|
|
1052
|
+
* + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
|
|
1053
|
+
* + `"ACTIVE"`: The domain has been registered successfully and is active.
|
|
1054
|
+
* + `"FAILED_REGISTRATION"`: Wix has tried to register the domain, but has stopped the process due to too many failed attempts. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
|
|
1055
|
+
* + `"CANCELED"`: The domain has been canceled and isn't active any longer.
|
|
1056
|
+
* @readonly
|
|
1057
|
+
*/
|
|
1058
|
+
status?: Status;
|
|
1059
|
+
/**
|
|
1060
|
+
* ICANN confirmation status.
|
|
1061
|
+
*
|
|
1062
|
+
* + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
|
|
1063
|
+
* + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
|
|
1064
|
+
* + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
|
|
1065
|
+
* + `"EXPIRED"`: The domain hasn't been confirmed by all contacts before the ICANN confirmation process expired. The domain isn't active and a new confirmation process must be started. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
|
|
1066
|
+
* @readonly
|
|
1067
|
+
*/
|
|
1068
|
+
icannConfirmationStatus?: ICANNConfirmationStatus;
|
|
1069
|
+
/**
|
|
1070
|
+
* Details about the ICANN confirmation status.
|
|
1071
|
+
* @readonly
|
|
1072
|
+
*/
|
|
1073
|
+
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo;
|
|
1074
|
+
/**
|
|
1075
|
+
* DNS propagation status.
|
|
1076
|
+
*
|
|
1077
|
+
* + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
|
|
1078
|
+
* + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
|
|
1079
|
+
* + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
|
|
1080
|
+
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
1081
|
+
* @readonly
|
|
1082
|
+
*/
|
|
1083
|
+
dnsPropagationStatus?: DnsPropagationStatus;
|
|
1084
|
+
/**
|
|
1085
|
+
* Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
|
|
1086
|
+
* format.
|
|
1087
|
+
* @readonly
|
|
1088
|
+
*/
|
|
1089
|
+
expirationDate?: Date;
|
|
1090
|
+
}
|
|
1091
|
+
/** @oneof */
|
|
1092
|
+
interface RegisteredDomainStatusInfoOneOf {
|
|
1093
|
+
/**
|
|
1094
|
+
* Information about a domain that hasn't been successfully registered
|
|
1095
|
+
* yet. Includes the timestamp of the latest registration attempt.
|
|
1096
|
+
* @readonly
|
|
1097
|
+
*/
|
|
1098
|
+
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
1099
|
+
/**
|
|
1100
|
+
* Information about a domain that couldn't be registered. Includes
|
|
1101
|
+
* failure code and message.
|
|
1102
|
+
* @readonly
|
|
1103
|
+
*/
|
|
1104
|
+
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
1105
|
+
}
|
|
1106
|
+
interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
|
|
1107
|
+
/**
|
|
1108
|
+
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1109
|
+
* @readonly
|
|
1110
|
+
*/
|
|
1111
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
1112
|
+
/**
|
|
1113
|
+
* ID of the site to which the domain is assigned.
|
|
1114
|
+
* @readonly
|
|
1115
|
+
*/
|
|
1116
|
+
_id?: string | null;
|
|
1117
|
+
/**
|
|
1118
|
+
* Whether the domain is assigned as the primary domain or a redirect.
|
|
1119
|
+
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
1120
|
+
* __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
|
|
1121
|
+
* in the request of the Create Registered Domain call.
|
|
1122
|
+
*
|
|
1123
|
+
* + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
|
|
1124
|
+
* + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
|
|
1125
|
+
* + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
|
|
1126
|
+
*/
|
|
1127
|
+
assignmentType?: AssignmentType;
|
|
1128
|
+
}
|
|
1129
|
+
/** @oneof */
|
|
1130
|
+
interface SiteInfoAssignmentInfoOneOf {
|
|
1131
|
+
/**
|
|
1132
|
+
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1133
|
+
* @readonly
|
|
1134
|
+
*/
|
|
1135
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
1136
|
+
}
|
|
1137
|
+
declare enum AssignmentType {
|
|
1138
|
+
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
1139
|
+
PRIMARY = "PRIMARY",
|
|
1140
|
+
REDIRECT = "REDIRECT"
|
|
1141
|
+
}
|
|
1142
|
+
interface RedirectAssignmentInfo {
|
|
1143
|
+
/**
|
|
1144
|
+
* Primary domain the redirect points to.
|
|
1145
|
+
* @readonly
|
|
1146
|
+
*/
|
|
1147
|
+
primaryDomain?: string;
|
|
1148
|
+
}
|
|
1149
|
+
interface Contacts {
|
|
1150
|
+
/** Contact information for the domain registrant. */
|
|
1151
|
+
registrant?: ContactData;
|
|
1152
|
+
/** Contact information for the domain admin. */
|
|
1153
|
+
admin?: ContactData;
|
|
1154
|
+
/** Contact information for the tech support of the domain. */
|
|
1155
|
+
tech?: ContactData;
|
|
1156
|
+
}
|
|
1157
|
+
interface ContactData {
|
|
1158
|
+
/**
|
|
1159
|
+
* First name. Only
|
|
1160
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1161
|
+
* are supported.
|
|
1162
|
+
*
|
|
1163
|
+
* Min: 2 characters
|
|
1164
|
+
* Max: 64 characters
|
|
1165
|
+
*/
|
|
1166
|
+
firstName?: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* Last name. Only
|
|
1169
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1170
|
+
* are supported.
|
|
1171
|
+
*
|
|
1172
|
+
* Min: 2 characters
|
|
1173
|
+
* Max: 64 characters
|
|
1174
|
+
*/
|
|
1175
|
+
lastName?: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* Email address. Only
|
|
1178
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1179
|
+
* and a single `@` are supported. Wix doesn't validate that the email address
|
|
1180
|
+
* exists.
|
|
1181
|
+
*
|
|
1182
|
+
* Min: 3 characters
|
|
1183
|
+
* Max: 64 characters before the `@` and 63 after
|
|
1184
|
+
*/
|
|
1185
|
+
email?: string;
|
|
1186
|
+
/**
|
|
1187
|
+
* Address details, including street name and house number. Only
|
|
1188
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1189
|
+
* are supported.
|
|
1190
|
+
*
|
|
1191
|
+
* Min: 2 characters
|
|
1192
|
+
* Max: 64 characters
|
|
1193
|
+
*/
|
|
1194
|
+
address?: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* City. Only
|
|
1197
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1198
|
+
* are supported.
|
|
1199
|
+
*
|
|
1200
|
+
* Min: 2 characters
|
|
1201
|
+
* Max: 64 characters
|
|
1202
|
+
*/
|
|
1203
|
+
city?: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* Subdivision code in
|
|
1206
|
+
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
|
|
1207
|
+
* format. Only
|
|
1208
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1209
|
+
* are supported.
|
|
1210
|
+
* __Required__ for these countries:
|
|
1211
|
+
* `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
|
|
1212
|
+
* `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
|
|
1213
|
+
* `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
|
|
1214
|
+
* `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
|
|
1215
|
+
* `"TW"`, `"UA"`, `"US"`, `”ZA”`.
|
|
1216
|
+
*
|
|
1217
|
+
* Min: 2 characters
|
|
1218
|
+
* Max: 2 characters
|
|
1219
|
+
*/
|
|
1220
|
+
subdivisionCode?: string | null;
|
|
1221
|
+
/**
|
|
1222
|
+
* Postal code. Only
|
|
1223
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1224
|
+
* are supported.
|
|
1225
|
+
*
|
|
1226
|
+
* Min: 2 characters
|
|
1227
|
+
* Max: 16 characters
|
|
1228
|
+
*/
|
|
1229
|
+
postalCode?: string | null;
|
|
1230
|
+
/**
|
|
1231
|
+
* Country code in
|
|
1232
|
+
* [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
|
|
1233
|
+
* format. Only
|
|
1234
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1235
|
+
* are supported. Wix doesn't validate that the postal code is valid for the
|
|
1236
|
+
* given country.
|
|
1237
|
+
*
|
|
1238
|
+
* Min: 2 characters
|
|
1239
|
+
* Max: 2 characters
|
|
1240
|
+
*/
|
|
1241
|
+
countryCode?: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* Phone number. Only
|
|
1244
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1245
|
+
* are supported. For example, `+15551234567`. Wix doesn't validate that the
|
|
1246
|
+
* phone number belongs to the specified country.
|
|
1247
|
+
*
|
|
1248
|
+
* Min: 2 characters
|
|
1249
|
+
* Max: 20 characters
|
|
1250
|
+
*/
|
|
1251
|
+
phone?: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* Company name. Only
|
|
1254
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1255
|
+
* are supported.
|
|
1256
|
+
*
|
|
1257
|
+
* Max: 2 characters
|
|
1258
|
+
* Max: 64 characters
|
|
1259
|
+
*/
|
|
1260
|
+
company?: string | null;
|
|
1261
|
+
}
|
|
1262
|
+
declare enum Status {
|
|
1263
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1264
|
+
PENDING_REGISTRATION = "PENDING_REGISTRATION",
|
|
1265
|
+
ACTIVE = "ACTIVE",
|
|
1266
|
+
FAILED_REGISTRATION = "FAILED_REGISTRATION",
|
|
1267
|
+
CANCELED = "CANCELED"
|
|
1268
|
+
}
|
|
1269
|
+
interface PendingRegistrationInfo {
|
|
1270
|
+
/**
|
|
1271
|
+
* Information about the latest attempt to register
|
|
1272
|
+
* the domain. Wix tries to register the domain several times if the
|
|
1273
|
+
* first attempt is unsuccessful. You can contact the
|
|
1274
|
+
* [Wix B2B team](mailto:bizdev@wix.com)
|
|
1275
|
+
* for more information about the number of attempts and their timing.
|
|
1276
|
+
* @readonly
|
|
1277
|
+
*/
|
|
1278
|
+
latestAttempt?: LatestAttempt;
|
|
1279
|
+
}
|
|
1280
|
+
interface LatestAttempt {
|
|
1281
|
+
/**
|
|
1282
|
+
* Number of the latest attempt to register the domain.
|
|
1283
|
+
* @readonly
|
|
1284
|
+
*/
|
|
1285
|
+
number?: number;
|
|
1286
|
+
/**
|
|
1287
|
+
* Date and time of the latest domain registration attempt in
|
|
1288
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1289
|
+
* @readonly
|
|
1290
|
+
*/
|
|
1291
|
+
timestamp?: Date;
|
|
1292
|
+
}
|
|
1293
|
+
interface FailedRegistrationInfo {
|
|
1294
|
+
/**
|
|
1295
|
+
* Failure code.
|
|
1296
|
+
*
|
|
1297
|
+
* + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
|
|
1298
|
+
* + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
|
|
1299
|
+
* @readonly
|
|
1300
|
+
*/
|
|
1301
|
+
code?: FailureCode;
|
|
1302
|
+
/**
|
|
1303
|
+
* Failure message.
|
|
1304
|
+
* @readonly
|
|
1305
|
+
*/
|
|
1306
|
+
message?: string;
|
|
1307
|
+
}
|
|
1308
|
+
declare enum FailureCode {
|
|
1309
|
+
UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
|
|
1310
|
+
OTHER = "OTHER"
|
|
1311
|
+
}
|
|
1312
|
+
/**
|
|
1313
|
+
* he confirmation status types, a record:
|
|
1314
|
+
* starts at pending
|
|
1315
|
+
* ends either at confirmed_by_all or expired
|
|
1316
|
+
*/
|
|
1317
|
+
declare enum ICANNConfirmationStatus {
|
|
1318
|
+
UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
|
|
1319
|
+
PENDING = "PENDING",
|
|
1320
|
+
CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
|
|
1321
|
+
EXPIRED = "EXPIRED"
|
|
1322
|
+
}
|
|
1323
|
+
interface ICANNConfirmationStatusInfo extends ICANNConfirmationStatusInfoStatusOneOf {
|
|
1324
|
+
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
1325
|
+
pending?: Pending;
|
|
1326
|
+
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
1327
|
+
expired?: Expired;
|
|
1328
|
+
}
|
|
1329
|
+
/** @oneof */
|
|
1330
|
+
interface ICANNConfirmationStatusInfoStatusOneOf {
|
|
1331
|
+
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
1332
|
+
pending?: Pending;
|
|
1333
|
+
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
1334
|
+
expired?: Expired;
|
|
1335
|
+
}
|
|
1336
|
+
interface Pending {
|
|
1337
|
+
/**
|
|
1338
|
+
* Expiration date of the ICANN confirmation process in
|
|
1339
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
|
|
1340
|
+
* before this date or the domain won't be active.
|
|
1341
|
+
*/
|
|
1342
|
+
expirationDate?: Date;
|
|
1343
|
+
/**
|
|
1344
|
+
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
1345
|
+
* yet.
|
|
1346
|
+
*/
|
|
1347
|
+
notConfirmedBy?: string[];
|
|
1348
|
+
}
|
|
1349
|
+
interface Expired {
|
|
1350
|
+
/**
|
|
1351
|
+
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
1352
|
+
* in time.
|
|
1353
|
+
*/
|
|
1354
|
+
notConfirmedBy?: string[];
|
|
1355
|
+
}
|
|
1356
|
+
declare enum DnsPropagationStatus {
|
|
1357
|
+
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
1358
|
+
COMPLETED = "COMPLETED",
|
|
1359
|
+
FAILED = "FAILED",
|
|
1360
|
+
IN_PROGRESS = "IN_PROGRESS"
|
|
1361
|
+
}
|
|
1362
|
+
interface CreateRegisteredDomainRequest {
|
|
1363
|
+
/** Information about the domain to register including contact details. */
|
|
1364
|
+
registeredDomain: RegisteredDomain;
|
|
1365
|
+
}
|
|
1366
|
+
interface CreateRegisteredDomainResponse {
|
|
1367
|
+
/** Created registered domain. */
|
|
1368
|
+
registeredDomain?: RegisteredDomain;
|
|
1369
|
+
}
|
|
1370
|
+
interface GetRegisteredDomainRequest {
|
|
1371
|
+
/** ID of the registered domain to retrieve. */
|
|
1372
|
+
registeredDomainId: string;
|
|
1373
|
+
}
|
|
1374
|
+
interface GetRegisteredDomainResponse {
|
|
1375
|
+
/** Retrieved registered domain. */
|
|
1376
|
+
registeredDomain?: RegisteredDomain;
|
|
1377
|
+
}
|
|
1378
|
+
interface ListRegisteredDomainsRequest {
|
|
1379
|
+
/** Cursor paging options. */
|
|
1380
|
+
paging?: CursorPaging$1;
|
|
1381
|
+
}
|
|
1382
|
+
interface CursorPaging$1 {
|
|
1383
|
+
/**
|
|
1384
|
+
* Number of domains to load.
|
|
1385
|
+
*
|
|
1386
|
+
* Min: `0`
|
|
1387
|
+
* Max: `100`
|
|
1388
|
+
*/
|
|
1389
|
+
limit?: number | null;
|
|
1390
|
+
/**
|
|
1391
|
+
* Pointer to the next or previous page in the list of results.
|
|
1392
|
+
*
|
|
1393
|
+
* You can get the relevant cursor token
|
|
1394
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1395
|
+
* Not relevant for the first request.
|
|
1396
|
+
*/
|
|
1397
|
+
cursor?: string | null;
|
|
1398
|
+
}
|
|
1399
|
+
interface ListRegisteredDomainsResponse {
|
|
1400
|
+
/** Metadata about the returned list of registered domains. */
|
|
1401
|
+
pagingMetadata?: CursorPagingMetadata$1;
|
|
1402
|
+
/** Retrieved registered domains. */
|
|
1403
|
+
registeredDomains?: RegisteredDomain[];
|
|
1404
|
+
}
|
|
1405
|
+
interface CursorPagingMetadata$1 {
|
|
1406
|
+
/** Number of domains returned in the response. */
|
|
1407
|
+
count?: number | null;
|
|
1408
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1409
|
+
cursors?: Cursors$1;
|
|
1410
|
+
/**
|
|
1411
|
+
* Indicates if there are more results after the current page.
|
|
1412
|
+
* If `true`, another page of results can be retrieved.
|
|
1413
|
+
* If `false`, this is the last page.
|
|
1414
|
+
*/
|
|
1415
|
+
hasNext?: boolean | null;
|
|
1416
|
+
}
|
|
1417
|
+
interface Cursors$1 {
|
|
1418
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1419
|
+
next?: string | null;
|
|
1420
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
1421
|
+
prev?: string | null;
|
|
1422
|
+
}
|
|
1423
|
+
interface DeleteRegisteredDomainByIdRequest {
|
|
1424
|
+
/** ID of the registered domain to delete. */
|
|
1425
|
+
registeredDomainId?: string;
|
|
1426
|
+
}
|
|
1427
|
+
interface DeleteRegisteredDomainByIdResponse {
|
|
1428
|
+
}
|
|
1429
|
+
interface RedeemRegisteredDomainRequest {
|
|
1430
|
+
/**
|
|
1431
|
+
* ID of the registered domain to redeem. Identical to the domain name
|
|
1432
|
+
* including TLD.
|
|
1433
|
+
*/
|
|
1434
|
+
registeredDomainId: string;
|
|
1435
|
+
}
|
|
1436
|
+
interface RedeemRegisteredDomainResponse {
|
|
1437
|
+
/** Registered domain to redeem. */
|
|
1438
|
+
registeredDomain?: RegisteredDomain;
|
|
1439
|
+
}
|
|
1440
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1441
|
+
createdEvent?: EntityCreatedEvent;
|
|
1442
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1443
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1444
|
+
actionEvent?: ActionEvent;
|
|
1445
|
+
/**
|
|
1446
|
+
* Unique event ID.
|
|
1447
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1448
|
+
*/
|
|
1449
|
+
_id?: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* Assumes actions are also always typed to an entity_type
|
|
1452
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1453
|
+
*/
|
|
1454
|
+
entityFqdn?: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1457
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1458
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1459
|
+
*/
|
|
1460
|
+
slug?: string;
|
|
1461
|
+
/** ID of the entity associated with the event. */
|
|
1462
|
+
entityId?: string;
|
|
1463
|
+
/** Event timestamp. */
|
|
1464
|
+
eventTime?: Date;
|
|
1465
|
+
/**
|
|
1466
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1467
|
+
* (for example, GDPR).
|
|
1468
|
+
*/
|
|
1469
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1470
|
+
/** If present, indicates the action that triggered the event. */
|
|
1471
|
+
originatedFrom?: string | null;
|
|
1472
|
+
/**
|
|
1473
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1474
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1475
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1476
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1477
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1478
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1479
|
+
*/
|
|
1480
|
+
entityEventSequence?: string | null;
|
|
1481
|
+
}
|
|
1482
|
+
/** @oneof */
|
|
1483
|
+
interface DomainEventBodyOneOf {
|
|
1484
|
+
createdEvent?: EntityCreatedEvent;
|
|
1485
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1486
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1487
|
+
actionEvent?: ActionEvent;
|
|
1488
|
+
}
|
|
1489
|
+
interface EntityCreatedEvent {
|
|
1490
|
+
entity?: string;
|
|
1491
|
+
}
|
|
1492
|
+
interface RestoreInfo {
|
|
1493
|
+
deletedDate?: Date;
|
|
1494
|
+
}
|
|
1495
|
+
interface EntityUpdatedEvent {
|
|
1496
|
+
/**
|
|
1497
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1498
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1499
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1500
|
+
*/
|
|
1501
|
+
currentEntity?: string;
|
|
1502
|
+
}
|
|
1503
|
+
interface EntityDeletedEvent {
|
|
1504
|
+
/** Entity that was deleted */
|
|
1505
|
+
deletedEntity?: string | null;
|
|
1506
|
+
}
|
|
1507
|
+
interface ActionEvent {
|
|
1508
|
+
body?: string;
|
|
1509
|
+
}
|
|
1510
|
+
interface MessageEnvelope {
|
|
1511
|
+
/** App instance ID. */
|
|
1512
|
+
instanceId?: string | null;
|
|
1513
|
+
/** Event type. */
|
|
1514
|
+
eventType?: string;
|
|
1515
|
+
/** The identification type and identity data. */
|
|
1516
|
+
identity?: IdentificationData;
|
|
1517
|
+
/** Stringify payload. */
|
|
1518
|
+
data?: string;
|
|
1519
|
+
}
|
|
1520
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1521
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1522
|
+
anonymousVisitorId?: string;
|
|
1523
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1524
|
+
memberId?: string;
|
|
1525
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1526
|
+
wixUserId?: string;
|
|
1527
|
+
/** ID of an app. */
|
|
1528
|
+
appId?: string;
|
|
1529
|
+
/** @readonly */
|
|
1530
|
+
identityType?: WebhookIdentityType;
|
|
1531
|
+
}
|
|
1532
|
+
/** @oneof */
|
|
1533
|
+
interface IdentificationDataIdOneOf {
|
|
1534
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1535
|
+
anonymousVisitorId?: string;
|
|
1536
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1537
|
+
memberId?: string;
|
|
1538
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1539
|
+
wixUserId?: string;
|
|
1540
|
+
/** ID of an app. */
|
|
1541
|
+
appId?: string;
|
|
1542
|
+
}
|
|
1543
|
+
declare enum WebhookIdentityType {
|
|
1544
|
+
UNKNOWN = "UNKNOWN",
|
|
1545
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1546
|
+
MEMBER = "MEMBER",
|
|
1547
|
+
WIX_USER = "WIX_USER",
|
|
1548
|
+
APP = "APP"
|
|
1549
|
+
}
|
|
1550
|
+
interface CreateRegisteredDomainResponseNonNullableFields {
|
|
1551
|
+
registeredDomain?: {
|
|
1552
|
+
pendingRegistrationInfo?: {
|
|
1553
|
+
latestAttempt?: {
|
|
1554
|
+
number: number;
|
|
1555
|
+
};
|
|
1556
|
+
};
|
|
1557
|
+
failedRegistrationInfo?: {
|
|
1558
|
+
code: FailureCode;
|
|
1559
|
+
message: string;
|
|
1560
|
+
};
|
|
1561
|
+
_id: string;
|
|
1562
|
+
domain: string;
|
|
1563
|
+
productInstanceId: string;
|
|
1564
|
+
siteInfo?: {
|
|
1565
|
+
redirectInfo?: {
|
|
1566
|
+
primaryDomain: string;
|
|
1567
|
+
};
|
|
1568
|
+
assignmentType: AssignmentType;
|
|
1569
|
+
};
|
|
1570
|
+
contacts?: {
|
|
1571
|
+
registrant?: {
|
|
1572
|
+
firstName: string;
|
|
1573
|
+
lastName: string;
|
|
1574
|
+
email: string;
|
|
1575
|
+
address: string;
|
|
1576
|
+
city: string;
|
|
1577
|
+
countryCode: string;
|
|
1578
|
+
phone: string;
|
|
1579
|
+
};
|
|
1580
|
+
admin?: {
|
|
1581
|
+
firstName: string;
|
|
1582
|
+
lastName: string;
|
|
1583
|
+
email: string;
|
|
1584
|
+
address: string;
|
|
1585
|
+
city: string;
|
|
1586
|
+
countryCode: string;
|
|
1587
|
+
phone: string;
|
|
1588
|
+
};
|
|
1589
|
+
tech?: {
|
|
1590
|
+
firstName: string;
|
|
1591
|
+
lastName: string;
|
|
1592
|
+
email: string;
|
|
1593
|
+
address: string;
|
|
1594
|
+
city: string;
|
|
1595
|
+
countryCode: string;
|
|
1596
|
+
phone: string;
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
status: Status;
|
|
1600
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
1601
|
+
icannConfirmationStatusInfo?: {
|
|
1602
|
+
pending?: {
|
|
1603
|
+
notConfirmedBy: string[];
|
|
1604
|
+
};
|
|
1605
|
+
expired?: {
|
|
1606
|
+
notConfirmedBy: string[];
|
|
1607
|
+
};
|
|
1608
|
+
};
|
|
1609
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
1610
|
+
};
|
|
1611
|
+
}
|
|
1612
|
+
interface GetRegisteredDomainResponseNonNullableFields {
|
|
1613
|
+
registeredDomain?: {
|
|
1614
|
+
pendingRegistrationInfo?: {
|
|
1615
|
+
latestAttempt?: {
|
|
1616
|
+
number: number;
|
|
1617
|
+
};
|
|
1618
|
+
};
|
|
1619
|
+
failedRegistrationInfo?: {
|
|
1620
|
+
code: FailureCode;
|
|
1621
|
+
message: string;
|
|
1622
|
+
};
|
|
1623
|
+
_id: string;
|
|
1624
|
+
domain: string;
|
|
1625
|
+
productInstanceId: string;
|
|
1626
|
+
siteInfo?: {
|
|
1627
|
+
redirectInfo?: {
|
|
1628
|
+
primaryDomain: string;
|
|
1629
|
+
};
|
|
1630
|
+
assignmentType: AssignmentType;
|
|
1631
|
+
};
|
|
1632
|
+
contacts?: {
|
|
1633
|
+
registrant?: {
|
|
1634
|
+
firstName: string;
|
|
1635
|
+
lastName: string;
|
|
1636
|
+
email: string;
|
|
1637
|
+
address: string;
|
|
1638
|
+
city: string;
|
|
1639
|
+
countryCode: string;
|
|
1640
|
+
phone: string;
|
|
1641
|
+
};
|
|
1642
|
+
admin?: {
|
|
1643
|
+
firstName: string;
|
|
1644
|
+
lastName: string;
|
|
1645
|
+
email: string;
|
|
1646
|
+
address: string;
|
|
1647
|
+
city: string;
|
|
1648
|
+
countryCode: string;
|
|
1649
|
+
phone: string;
|
|
1650
|
+
};
|
|
1651
|
+
tech?: {
|
|
1652
|
+
firstName: string;
|
|
1653
|
+
lastName: string;
|
|
1654
|
+
email: string;
|
|
1655
|
+
address: string;
|
|
1656
|
+
city: string;
|
|
1657
|
+
countryCode: string;
|
|
1658
|
+
phone: string;
|
|
1659
|
+
};
|
|
1660
|
+
};
|
|
1661
|
+
status: Status;
|
|
1662
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
1663
|
+
icannConfirmationStatusInfo?: {
|
|
1664
|
+
pending?: {
|
|
1665
|
+
notConfirmedBy: string[];
|
|
1666
|
+
};
|
|
1667
|
+
expired?: {
|
|
1668
|
+
notConfirmedBy: string[];
|
|
1669
|
+
};
|
|
1670
|
+
};
|
|
1671
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
1672
|
+
};
|
|
1673
|
+
}
|
|
1674
|
+
interface ListRegisteredDomainsResponseNonNullableFields {
|
|
1675
|
+
registeredDomains: {
|
|
1676
|
+
pendingRegistrationInfo?: {
|
|
1677
|
+
latestAttempt?: {
|
|
1678
|
+
number: number;
|
|
1679
|
+
};
|
|
1680
|
+
};
|
|
1681
|
+
failedRegistrationInfo?: {
|
|
1682
|
+
code: FailureCode;
|
|
1683
|
+
message: string;
|
|
1684
|
+
};
|
|
1685
|
+
_id: string;
|
|
1686
|
+
domain: string;
|
|
1687
|
+
productInstanceId: string;
|
|
1688
|
+
siteInfo?: {
|
|
1689
|
+
redirectInfo?: {
|
|
1690
|
+
primaryDomain: string;
|
|
1691
|
+
};
|
|
1692
|
+
assignmentType: AssignmentType;
|
|
1693
|
+
};
|
|
1694
|
+
contacts?: {
|
|
1695
|
+
registrant?: {
|
|
1696
|
+
firstName: string;
|
|
1697
|
+
lastName: string;
|
|
1698
|
+
email: string;
|
|
1699
|
+
address: string;
|
|
1700
|
+
city: string;
|
|
1701
|
+
countryCode: string;
|
|
1702
|
+
phone: string;
|
|
1703
|
+
};
|
|
1704
|
+
admin?: {
|
|
1705
|
+
firstName: string;
|
|
1706
|
+
lastName: string;
|
|
1707
|
+
email: string;
|
|
1708
|
+
address: string;
|
|
1709
|
+
city: string;
|
|
1710
|
+
countryCode: string;
|
|
1711
|
+
phone: string;
|
|
1712
|
+
};
|
|
1713
|
+
tech?: {
|
|
1714
|
+
firstName: string;
|
|
1715
|
+
lastName: string;
|
|
1716
|
+
email: string;
|
|
1717
|
+
address: string;
|
|
1718
|
+
city: string;
|
|
1719
|
+
countryCode: string;
|
|
1720
|
+
phone: string;
|
|
1721
|
+
};
|
|
1722
|
+
};
|
|
1723
|
+
status: Status;
|
|
1724
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
1725
|
+
icannConfirmationStatusInfo?: {
|
|
1726
|
+
pending?: {
|
|
1727
|
+
notConfirmedBy: string[];
|
|
1728
|
+
};
|
|
1729
|
+
expired?: {
|
|
1730
|
+
notConfirmedBy: string[];
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1733
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
1734
|
+
}[];
|
|
1735
|
+
}
|
|
1736
|
+
interface RedeemRegisteredDomainResponseNonNullableFields {
|
|
1737
|
+
registeredDomain?: {
|
|
1738
|
+
pendingRegistrationInfo?: {
|
|
1739
|
+
latestAttempt?: {
|
|
1740
|
+
number: number;
|
|
1741
|
+
};
|
|
1742
|
+
};
|
|
1743
|
+
failedRegistrationInfo?: {
|
|
1744
|
+
code: FailureCode;
|
|
1745
|
+
message: string;
|
|
1746
|
+
};
|
|
1747
|
+
_id: string;
|
|
1748
|
+
domain: string;
|
|
1749
|
+
productInstanceId: string;
|
|
1750
|
+
siteInfo?: {
|
|
1751
|
+
redirectInfo?: {
|
|
1752
|
+
primaryDomain: string;
|
|
1753
|
+
};
|
|
1754
|
+
assignmentType: AssignmentType;
|
|
1755
|
+
};
|
|
1756
|
+
contacts?: {
|
|
1757
|
+
registrant?: {
|
|
1758
|
+
firstName: string;
|
|
1759
|
+
lastName: string;
|
|
1760
|
+
email: string;
|
|
1761
|
+
address: string;
|
|
1762
|
+
city: string;
|
|
1763
|
+
countryCode: string;
|
|
1764
|
+
phone: string;
|
|
1765
|
+
};
|
|
1766
|
+
admin?: {
|
|
1767
|
+
firstName: string;
|
|
1768
|
+
lastName: string;
|
|
1769
|
+
email: string;
|
|
1770
|
+
address: string;
|
|
1771
|
+
city: string;
|
|
1772
|
+
countryCode: string;
|
|
1773
|
+
phone: string;
|
|
1774
|
+
};
|
|
1775
|
+
tech?: {
|
|
1776
|
+
firstName: string;
|
|
1777
|
+
lastName: string;
|
|
1778
|
+
email: string;
|
|
1779
|
+
address: string;
|
|
1780
|
+
city: string;
|
|
1781
|
+
countryCode: string;
|
|
1782
|
+
phone: string;
|
|
1783
|
+
};
|
|
1784
|
+
};
|
|
1785
|
+
status: Status;
|
|
1786
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
1787
|
+
icannConfirmationStatusInfo?: {
|
|
1788
|
+
pending?: {
|
|
1789
|
+
notConfirmedBy: string[];
|
|
1790
|
+
};
|
|
1791
|
+
expired?: {
|
|
1792
|
+
notConfirmedBy: string[];
|
|
1793
|
+
};
|
|
1794
|
+
};
|
|
1795
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
1796
|
+
};
|
|
1797
|
+
}
|
|
1798
|
+
interface ListRegisteredDomainsOptions {
|
|
1799
|
+
/** Cursor paging options. */
|
|
1800
|
+
paging?: CursorPaging$1;
|
|
88
1801
|
}
|
|
89
1802
|
|
|
90
1803
|
declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
@@ -94,30 +1807,245 @@ declare const getRegisteredDomain: ReturnType<typeof createRESTModule$2<typeof p
|
|
|
94
1807
|
declare const listRegisteredDomains: ReturnType<typeof createRESTModule$2<typeof publicListRegisteredDomains>>;
|
|
95
1808
|
declare const redeemRegisteredDomain: ReturnType<typeof createRESTModule$2<typeof publicRedeemRegisteredDomain>>;
|
|
96
1809
|
|
|
1810
|
+
type context$2_ActionEvent = ActionEvent;
|
|
1811
|
+
type context$2_AssignmentType = AssignmentType;
|
|
1812
|
+
declare const context$2_AssignmentType: typeof AssignmentType;
|
|
1813
|
+
type context$2_ContactData = ContactData;
|
|
1814
|
+
type context$2_Contacts = Contacts;
|
|
1815
|
+
type context$2_CreateRegisteredDomainRequest = CreateRegisteredDomainRequest;
|
|
1816
|
+
type context$2_CreateRegisteredDomainResponse = CreateRegisteredDomainResponse;
|
|
1817
|
+
type context$2_CreateRegisteredDomainResponseNonNullableFields = CreateRegisteredDomainResponseNonNullableFields;
|
|
1818
|
+
type context$2_DeleteRegisteredDomainByIdRequest = DeleteRegisteredDomainByIdRequest;
|
|
1819
|
+
type context$2_DeleteRegisteredDomainByIdResponse = DeleteRegisteredDomainByIdResponse;
|
|
1820
|
+
type context$2_DnsPropagationStatus = DnsPropagationStatus;
|
|
1821
|
+
declare const context$2_DnsPropagationStatus: typeof DnsPropagationStatus;
|
|
1822
|
+
type context$2_DomainEvent = DomainEvent;
|
|
1823
|
+
type context$2_DomainEventBodyOneOf = DomainEventBodyOneOf;
|
|
1824
|
+
type context$2_EntityCreatedEvent = EntityCreatedEvent;
|
|
1825
|
+
type context$2_EntityDeletedEvent = EntityDeletedEvent;
|
|
1826
|
+
type context$2_EntityUpdatedEvent = EntityUpdatedEvent;
|
|
1827
|
+
type context$2_Expired = Expired;
|
|
1828
|
+
type context$2_FailedRegistrationInfo = FailedRegistrationInfo;
|
|
1829
|
+
type context$2_FailureCode = FailureCode;
|
|
1830
|
+
declare const context$2_FailureCode: typeof FailureCode;
|
|
1831
|
+
type context$2_GetRegisteredDomainRequest = GetRegisteredDomainRequest;
|
|
1832
|
+
type context$2_GetRegisteredDomainResponse = GetRegisteredDomainResponse;
|
|
1833
|
+
type context$2_GetRegisteredDomainResponseNonNullableFields = GetRegisteredDomainResponseNonNullableFields;
|
|
1834
|
+
type context$2_ICANNConfirmationStatus = ICANNConfirmationStatus;
|
|
1835
|
+
declare const context$2_ICANNConfirmationStatus: typeof ICANNConfirmationStatus;
|
|
1836
|
+
type context$2_ICANNConfirmationStatusInfo = ICANNConfirmationStatusInfo;
|
|
1837
|
+
type context$2_ICANNConfirmationStatusInfoStatusOneOf = ICANNConfirmationStatusInfoStatusOneOf;
|
|
1838
|
+
type context$2_IdentificationData = IdentificationData;
|
|
1839
|
+
type context$2_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
1840
|
+
type context$2_LatestAttempt = LatestAttempt;
|
|
1841
|
+
type context$2_ListRegisteredDomainsOptions = ListRegisteredDomainsOptions;
|
|
1842
|
+
type context$2_ListRegisteredDomainsRequest = ListRegisteredDomainsRequest;
|
|
1843
|
+
type context$2_ListRegisteredDomainsResponse = ListRegisteredDomainsResponse;
|
|
1844
|
+
type context$2_ListRegisteredDomainsResponseNonNullableFields = ListRegisteredDomainsResponseNonNullableFields;
|
|
1845
|
+
type context$2_MessageEnvelope = MessageEnvelope;
|
|
1846
|
+
type context$2_Pending = Pending;
|
|
1847
|
+
type context$2_PendingRegistrationInfo = PendingRegistrationInfo;
|
|
1848
|
+
type context$2_RedeemRegisteredDomainRequest = RedeemRegisteredDomainRequest;
|
|
1849
|
+
type context$2_RedeemRegisteredDomainResponse = RedeemRegisteredDomainResponse;
|
|
1850
|
+
type context$2_RedeemRegisteredDomainResponseNonNullableFields = RedeemRegisteredDomainResponseNonNullableFields;
|
|
1851
|
+
type context$2_RedirectAssignmentInfo = RedirectAssignmentInfo;
|
|
1852
|
+
type context$2_RegisteredDomain = RegisteredDomain;
|
|
1853
|
+
type context$2_RegisteredDomainStatusInfoOneOf = RegisteredDomainStatusInfoOneOf;
|
|
1854
|
+
type context$2_RestoreInfo = RestoreInfo;
|
|
1855
|
+
type context$2_SiteInfo = SiteInfo;
|
|
1856
|
+
type context$2_SiteInfoAssignmentInfoOneOf = SiteInfoAssignmentInfoOneOf;
|
|
1857
|
+
type context$2_Status = Status;
|
|
1858
|
+
declare const context$2_Status: typeof Status;
|
|
1859
|
+
type context$2_WebhookIdentityType = WebhookIdentityType;
|
|
1860
|
+
declare const context$2_WebhookIdentityType: typeof WebhookIdentityType;
|
|
97
1861
|
declare const context$2_createRegisteredDomain: typeof createRegisteredDomain;
|
|
98
1862
|
declare const context$2_getRegisteredDomain: typeof getRegisteredDomain;
|
|
99
1863
|
declare const context$2_listRegisteredDomains: typeof listRegisteredDomains;
|
|
100
1864
|
declare const context$2_redeemRegisteredDomain: typeof redeemRegisteredDomain;
|
|
101
1865
|
declare namespace context$2 {
|
|
102
|
-
export { context$2_createRegisteredDomain as createRegisteredDomain, context$2_getRegisteredDomain as getRegisteredDomain, context$2_listRegisteredDomains as listRegisteredDomains, context$2_redeemRegisteredDomain as redeemRegisteredDomain };
|
|
1866
|
+
export { type context$2_ActionEvent as ActionEvent, context$2_AssignmentType as AssignmentType, type context$2_ContactData as ContactData, type context$2_Contacts as Contacts, type context$2_CreateRegisteredDomainRequest as CreateRegisteredDomainRequest, type context$2_CreateRegisteredDomainResponse as CreateRegisteredDomainResponse, type context$2_CreateRegisteredDomainResponseNonNullableFields as CreateRegisteredDomainResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type context$2_DeleteRegisteredDomainByIdRequest as DeleteRegisteredDomainByIdRequest, type context$2_DeleteRegisteredDomainByIdResponse as DeleteRegisteredDomainByIdResponse, context$2_DnsPropagationStatus as DnsPropagationStatus, type context$2_DomainEvent as DomainEvent, type context$2_DomainEventBodyOneOf as DomainEventBodyOneOf, type context$2_EntityCreatedEvent as EntityCreatedEvent, type context$2_EntityDeletedEvent as EntityDeletedEvent, type context$2_EntityUpdatedEvent as EntityUpdatedEvent, type context$2_Expired as Expired, type context$2_FailedRegistrationInfo as FailedRegistrationInfo, context$2_FailureCode as FailureCode, type context$2_GetRegisteredDomainRequest as GetRegisteredDomainRequest, type context$2_GetRegisteredDomainResponse as GetRegisteredDomainResponse, type context$2_GetRegisteredDomainResponseNonNullableFields as GetRegisteredDomainResponseNonNullableFields, context$2_ICANNConfirmationStatus as ICANNConfirmationStatus, type context$2_ICANNConfirmationStatusInfo as ICANNConfirmationStatusInfo, type context$2_ICANNConfirmationStatusInfoStatusOneOf as ICANNConfirmationStatusInfoStatusOneOf, type context$2_IdentificationData as IdentificationData, type context$2_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context$2_LatestAttempt as LatestAttempt, type context$2_ListRegisteredDomainsOptions as ListRegisteredDomainsOptions, type context$2_ListRegisteredDomainsRequest as ListRegisteredDomainsRequest, type context$2_ListRegisteredDomainsResponse as ListRegisteredDomainsResponse, type context$2_ListRegisteredDomainsResponseNonNullableFields as ListRegisteredDomainsResponseNonNullableFields, type context$2_MessageEnvelope as MessageEnvelope, type context$2_Pending as Pending, type context$2_PendingRegistrationInfo as PendingRegistrationInfo, type context$2_RedeemRegisteredDomainRequest as RedeemRegisteredDomainRequest, type context$2_RedeemRegisteredDomainResponse as RedeemRegisteredDomainResponse, type context$2_RedeemRegisteredDomainResponseNonNullableFields as RedeemRegisteredDomainResponseNonNullableFields, type context$2_RedirectAssignmentInfo as RedirectAssignmentInfo, type context$2_RegisteredDomain as RegisteredDomain, type context$2_RegisteredDomainStatusInfoOneOf as RegisteredDomainStatusInfoOneOf, type context$2_RestoreInfo as RestoreInfo, type context$2_SiteInfo as SiteInfo, type context$2_SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOf, context$2_Status as Status, context$2_WebhookIdentityType as WebhookIdentityType, context$2_createRegisteredDomain as createRegisteredDomain, context$2_getRegisteredDomain as getRegisteredDomain, context$2_listRegisteredDomains as listRegisteredDomains, context$2_redeemRegisteredDomain as redeemRegisteredDomain };
|
|
1867
|
+
}
|
|
1868
|
+
|
|
1869
|
+
interface DomainAvailability {
|
|
1870
|
+
/** Domain name including TLD. For example, `my-new-domain.com`. */
|
|
1871
|
+
domain?: string;
|
|
1872
|
+
/**
|
|
1873
|
+
* Whether the domain is available for purchase. You can purchase the
|
|
1874
|
+
* domain in case the boolean is `true`. The domain is already taken
|
|
1875
|
+
* when `false` is returned.
|
|
1876
|
+
*/
|
|
1877
|
+
available?: boolean;
|
|
1878
|
+
}
|
|
1879
|
+
interface CheckDomainAvailabilityRequest {
|
|
1880
|
+
/**
|
|
1881
|
+
* Domain name. Must include the TLD. For example, `my-new-domain.com`. Only
|
|
1882
|
+
* alphanumeric characters, hyphens, and dots are supported.
|
|
1883
|
+
*
|
|
1884
|
+
* Min: 3 characters
|
|
1885
|
+
* Max: 63 characters
|
|
1886
|
+
*/
|
|
1887
|
+
domain: string;
|
|
1888
|
+
}
|
|
1889
|
+
interface CheckDomainAvailabilityResponse {
|
|
1890
|
+
/** Information about the domain's availability. */
|
|
1891
|
+
availability?: DomainAvailability;
|
|
1892
|
+
}
|
|
1893
|
+
interface CheckDomainAvailabilityResponseNonNullableFields {
|
|
1894
|
+
availability?: {
|
|
1895
|
+
domain: string;
|
|
1896
|
+
available: boolean;
|
|
1897
|
+
};
|
|
103
1898
|
}
|
|
104
1899
|
|
|
105
1900
|
declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
106
1901
|
|
|
107
1902
|
declare const checkDomainAvailability: ReturnType<typeof createRESTModule$1<typeof publicCheckDomainAvailability>>;
|
|
108
1903
|
|
|
1904
|
+
type context$1_CheckDomainAvailabilityRequest = CheckDomainAvailabilityRequest;
|
|
1905
|
+
type context$1_CheckDomainAvailabilityResponse = CheckDomainAvailabilityResponse;
|
|
1906
|
+
type context$1_CheckDomainAvailabilityResponseNonNullableFields = CheckDomainAvailabilityResponseNonNullableFields;
|
|
1907
|
+
type context$1_DomainAvailability = DomainAvailability;
|
|
109
1908
|
declare const context$1_checkDomainAvailability: typeof checkDomainAvailability;
|
|
110
1909
|
declare namespace context$1 {
|
|
111
|
-
export { context$1_checkDomainAvailability as checkDomainAvailability };
|
|
1910
|
+
export { type context$1_CheckDomainAvailabilityRequest as CheckDomainAvailabilityRequest, type context$1_CheckDomainAvailabilityResponse as CheckDomainAvailabilityResponse, type context$1_CheckDomainAvailabilityResponseNonNullableFields as CheckDomainAvailabilityResponseNonNullableFields, type context$1_DomainAvailability as DomainAvailability, context$1_checkDomainAvailability as checkDomainAvailability };
|
|
1911
|
+
}
|
|
1912
|
+
|
|
1913
|
+
interface DomainSuggestion {
|
|
1914
|
+
/** Suggested domain name including TLD. */
|
|
1915
|
+
domain?: string;
|
|
1916
|
+
}
|
|
1917
|
+
interface SuggestDomainsRequest {
|
|
1918
|
+
/**
|
|
1919
|
+
* Input to base your domain suggestions on. May include
|
|
1920
|
+
* letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
|
|
1921
|
+
*
|
|
1922
|
+
* Min: 3 characters
|
|
1923
|
+
* Max: 100 characters
|
|
1924
|
+
*/
|
|
1925
|
+
query: string;
|
|
1926
|
+
/**
|
|
1927
|
+
* [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
|
|
1928
|
+
* not include the dot. For example, `com`, not `.com`. Not all TLDs can be
|
|
1929
|
+
* connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
|
|
1930
|
+
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
|
|
1931
|
+
* information.
|
|
1932
|
+
*
|
|
1933
|
+
* Max: 10 TLDs
|
|
1934
|
+
*/
|
|
1935
|
+
tlds?: string[];
|
|
1936
|
+
/**
|
|
1937
|
+
* Number of domain suggestions to return.
|
|
1938
|
+
*
|
|
1939
|
+
* Min: `1`
|
|
1940
|
+
* Max: `20`
|
|
1941
|
+
* Default: `10`
|
|
1942
|
+
* Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
|
|
1943
|
+
* @deprecated Number of domain suggestions to return.
|
|
1944
|
+
*
|
|
1945
|
+
* Min: `1`
|
|
1946
|
+
* Max: `20`
|
|
1947
|
+
* Default: `10`
|
|
1948
|
+
* Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
|
|
1949
|
+
* @replacedBy paging.limit
|
|
1950
|
+
* @targetRemovalDate 2025-03-01
|
|
1951
|
+
*/
|
|
1952
|
+
limit?: number | null;
|
|
1953
|
+
/** Cursor paging options. */
|
|
1954
|
+
paging?: CursorPaging;
|
|
1955
|
+
}
|
|
1956
|
+
interface CursorPaging {
|
|
1957
|
+
/**
|
|
1958
|
+
* Number of domains to load.
|
|
1959
|
+
*
|
|
1960
|
+
* Min: `0`
|
|
1961
|
+
* Max: `20`
|
|
1962
|
+
*/
|
|
1963
|
+
limit?: number | null;
|
|
1964
|
+
/**
|
|
1965
|
+
* Pointer to the next or previous page in the list of results.
|
|
1966
|
+
*
|
|
1967
|
+
* You can get the relevant cursor token
|
|
1968
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1969
|
+
* Not relevant for the first request.
|
|
1970
|
+
*/
|
|
1971
|
+
cursor?: string | null;
|
|
1972
|
+
}
|
|
1973
|
+
interface SuggestDomainsResponse {
|
|
1974
|
+
/** List of suggested available domains. */
|
|
1975
|
+
suggestions?: DomainSuggestion[];
|
|
1976
|
+
/** Metadata about the returned list of suggested domains. */
|
|
1977
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1978
|
+
}
|
|
1979
|
+
interface CursorPagingMetadata {
|
|
1980
|
+
/** Number of domains returned in the response. */
|
|
1981
|
+
count?: number | null;
|
|
1982
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1983
|
+
cursors?: Cursors;
|
|
1984
|
+
/**
|
|
1985
|
+
* Indicates if there are more results after the current page.
|
|
1986
|
+
* If `true`, another page of results can be retrieved.
|
|
1987
|
+
* If `false`, this is the last page.
|
|
1988
|
+
*/
|
|
1989
|
+
hasNext?: boolean | null;
|
|
1990
|
+
}
|
|
1991
|
+
interface Cursors {
|
|
1992
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1993
|
+
next?: string | null;
|
|
1994
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
1995
|
+
prev?: string | null;
|
|
1996
|
+
}
|
|
1997
|
+
interface SuggestDomainsResponseNonNullableFields {
|
|
1998
|
+
suggestions: {
|
|
1999
|
+
domain: string;
|
|
2000
|
+
}[];
|
|
2001
|
+
}
|
|
2002
|
+
interface SuggestDomainsOptions {
|
|
2003
|
+
/**
|
|
2004
|
+
* [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
|
|
2005
|
+
* not include the dot. For example, `com`, not `.com`. Not all TLDs can be
|
|
2006
|
+
* connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
|
|
2007
|
+
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
|
|
2008
|
+
* information.
|
|
2009
|
+
*
|
|
2010
|
+
* Max: 10 TLDs
|
|
2011
|
+
*/
|
|
2012
|
+
tlds?: string[];
|
|
2013
|
+
/**
|
|
2014
|
+
* Number of domain suggestions to return.
|
|
2015
|
+
*
|
|
2016
|
+
* Min: `1`
|
|
2017
|
+
* Max: `20`
|
|
2018
|
+
* Default: `10`
|
|
2019
|
+
* Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
|
|
2020
|
+
* @deprecated Number of domain suggestions to return.
|
|
2021
|
+
*
|
|
2022
|
+
* Min: `1`
|
|
2023
|
+
* Max: `20`
|
|
2024
|
+
* Default: `10`
|
|
2025
|
+
* Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
|
|
2026
|
+
* @replacedBy paging.limit
|
|
2027
|
+
* @targetRemovalDate 2025-03-01
|
|
2028
|
+
*/
|
|
2029
|
+
limit?: number | null;
|
|
2030
|
+
/** Cursor paging options. */
|
|
2031
|
+
paging?: CursorPaging;
|
|
112
2032
|
}
|
|
113
2033
|
|
|
114
2034
|
declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
115
2035
|
|
|
116
2036
|
declare const suggestDomains: ReturnType<typeof createRESTModule<typeof publicSuggestDomains>>;
|
|
117
2037
|
|
|
2038
|
+
type context_CursorPaging = CursorPaging;
|
|
2039
|
+
type context_CursorPagingMetadata = CursorPagingMetadata;
|
|
2040
|
+
type context_Cursors = Cursors;
|
|
2041
|
+
type context_DomainSuggestion = DomainSuggestion;
|
|
2042
|
+
type context_SuggestDomainsOptions = SuggestDomainsOptions;
|
|
2043
|
+
type context_SuggestDomainsRequest = SuggestDomainsRequest;
|
|
2044
|
+
type context_SuggestDomainsResponse = SuggestDomainsResponse;
|
|
2045
|
+
type context_SuggestDomainsResponseNonNullableFields = SuggestDomainsResponseNonNullableFields;
|
|
118
2046
|
declare const context_suggestDomains: typeof suggestDomains;
|
|
119
2047
|
declare namespace context {
|
|
120
|
-
export { context_suggestDomains as suggestDomains };
|
|
2048
|
+
export { type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_Cursors as Cursors, type context_DomainSuggestion as DomainSuggestion, type context_SuggestDomainsOptions as SuggestDomainsOptions, type context_SuggestDomainsRequest as SuggestDomainsRequest, type context_SuggestDomainsResponse as SuggestDomainsResponse, type context_SuggestDomainsResponseNonNullableFields as SuggestDomainsResponseNonNullableFields, context_suggestDomains as suggestDomains };
|
|
121
2049
|
}
|
|
122
2050
|
|
|
123
2051
|
export { context$4 as connectedDomainSetupInfo, context$5 as connectedDomains, context$1 as domainAvailability, context$3 as domainDns, context as domainSuggestions, context$2 as registeredDomains };
|