@wix/domains 1.0.0 → 1.0.2
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/build/cjs/context.d.ts +4 -0
- package/build/cjs/context.js +5 -1
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +4 -0
- package/build/cjs/index.js +5 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +4 -0
- package/build/cjs/meta.js +5 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +4 -0
- package/build/es/context.js +4 -0
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +4 -0
- package/build/es/index.js +4 -0
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +4 -0
- package/build/es/meta.js +4 -0
- package/build/es/meta.js.map +1 -1
- package/package.json +6 -2
- package/type-bundles/context.bundle.d.ts +714 -31
- package/type-bundles/index.bundle.d.ts +1222 -83
- package/type-bundles/meta.bundle.d.ts +1303 -11
|
@@ -1,3 +1,1088 @@
|
|
|
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 to 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
|
+
* Extra details in case assignment type is redirect.
|
|
60
|
+
* @readonly
|
|
61
|
+
*/
|
|
62
|
+
redirectInfo?: RedirectAssignmentInfo$1;
|
|
63
|
+
/**
|
|
64
|
+
* ID of the site the domain is assigned to, will be taken from context.
|
|
65
|
+
* @readonly
|
|
66
|
+
*/
|
|
67
|
+
_id?: string | null;
|
|
68
|
+
/**
|
|
69
|
+
* The assignment type the relationship will be based on:
|
|
70
|
+
* + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type
|
|
71
|
+
* + `"PRIMARY"`: There can only be one primary domain per site, the result of this assignment type is that the domain will lead directly to a site.
|
|
72
|
+
* + `"REDIRECT"`: There can be multiple redirect domains. the result of this assignment type is that the redirects will lead 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
|
+
* Extra details in case assignment type is 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 the redirect points to.
|
|
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$1;
|
|
135
|
+
}
|
|
136
|
+
interface CursorPaging$1 {
|
|
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$1;
|
|
156
|
+
/** Retrieved connected domains. */
|
|
157
|
+
connectedDomains?: ConnectedDomain[];
|
|
158
|
+
}
|
|
159
|
+
interface CursorPagingMetadata$1 {
|
|
160
|
+
/** Number of domains returned in the response. */
|
|
161
|
+
count?: number | null;
|
|
162
|
+
/** Offset that was requested. */
|
|
163
|
+
cursors?: Cursors$1;
|
|
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$1 {
|
|
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 EntityUpdatedEvent$2 {
|
|
230
|
+
/**
|
|
231
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
232
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
233
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
234
|
+
*/
|
|
235
|
+
currentEntity?: string;
|
|
236
|
+
}
|
|
237
|
+
interface EntityDeletedEvent$2 {
|
|
238
|
+
/** Entity that was deleted */
|
|
239
|
+
deletedEntity?: string | null;
|
|
240
|
+
}
|
|
241
|
+
interface ActionEvent$2 {
|
|
242
|
+
body?: string;
|
|
243
|
+
}
|
|
244
|
+
interface MessageEnvelope$2 {
|
|
245
|
+
/** App instance ID. */
|
|
246
|
+
instanceId?: string | null;
|
|
247
|
+
/** Event type. */
|
|
248
|
+
eventType?: string;
|
|
249
|
+
/** The identification type and identity data. */
|
|
250
|
+
identity?: IdentificationData$2;
|
|
251
|
+
/** Stringify payload. */
|
|
252
|
+
data?: string;
|
|
253
|
+
}
|
|
254
|
+
interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
|
|
255
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
256
|
+
anonymousVisitorId?: string;
|
|
257
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
258
|
+
memberId?: string;
|
|
259
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
260
|
+
wixUserId?: string;
|
|
261
|
+
/** ID of an app. */
|
|
262
|
+
appId?: string;
|
|
263
|
+
/** @readonly */
|
|
264
|
+
identityType?: WebhookIdentityType$2;
|
|
265
|
+
}
|
|
266
|
+
/** @oneof */
|
|
267
|
+
interface IdentificationDataIdOneOf$2 {
|
|
268
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
269
|
+
anonymousVisitorId?: string;
|
|
270
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
271
|
+
memberId?: string;
|
|
272
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
273
|
+
wixUserId?: string;
|
|
274
|
+
/** ID of an app. */
|
|
275
|
+
appId?: string;
|
|
276
|
+
}
|
|
277
|
+
declare enum WebhookIdentityType$2 {
|
|
278
|
+
UNKNOWN = "UNKNOWN",
|
|
279
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
280
|
+
MEMBER = "MEMBER",
|
|
281
|
+
WIX_USER = "WIX_USER",
|
|
282
|
+
APP = "APP"
|
|
283
|
+
}
|
|
284
|
+
interface CreateConnectedDomainResponseNonNullableFields {
|
|
285
|
+
connectedDomain?: {
|
|
286
|
+
_id: string;
|
|
287
|
+
domain: string;
|
|
288
|
+
connectionType: ConnectionType$1;
|
|
289
|
+
siteInfo?: {
|
|
290
|
+
redirectInfo?: {
|
|
291
|
+
primaryDomain: string;
|
|
292
|
+
};
|
|
293
|
+
assignmentType: AssignmentType$1;
|
|
294
|
+
};
|
|
295
|
+
suppressNotifications: boolean;
|
|
296
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
297
|
+
};
|
|
298
|
+
}
|
|
299
|
+
interface GetConnectedDomainResponseNonNullableFields {
|
|
300
|
+
connectedDomain?: {
|
|
301
|
+
_id: string;
|
|
302
|
+
domain: string;
|
|
303
|
+
connectionType: ConnectionType$1;
|
|
304
|
+
siteInfo?: {
|
|
305
|
+
redirectInfo?: {
|
|
306
|
+
primaryDomain: string;
|
|
307
|
+
};
|
|
308
|
+
assignmentType: AssignmentType$1;
|
|
309
|
+
};
|
|
310
|
+
suppressNotifications: boolean;
|
|
311
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
312
|
+
};
|
|
313
|
+
}
|
|
314
|
+
interface ListConnectedDomainsResponseNonNullableFields {
|
|
315
|
+
connectedDomains: {
|
|
316
|
+
_id: string;
|
|
317
|
+
domain: string;
|
|
318
|
+
connectionType: ConnectionType$1;
|
|
319
|
+
siteInfo?: {
|
|
320
|
+
redirectInfo?: {
|
|
321
|
+
primaryDomain: string;
|
|
322
|
+
};
|
|
323
|
+
assignmentType: AssignmentType$1;
|
|
324
|
+
};
|
|
325
|
+
suppressNotifications: boolean;
|
|
326
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
327
|
+
}[];
|
|
328
|
+
}
|
|
329
|
+
interface BaseEventMetadata {
|
|
330
|
+
/** App instance ID. */
|
|
331
|
+
instanceId?: string | null;
|
|
332
|
+
/** Event type. */
|
|
333
|
+
eventType?: string;
|
|
334
|
+
/** The identification type and identity data. */
|
|
335
|
+
identity?: IdentificationData$2;
|
|
336
|
+
}
|
|
337
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
338
|
+
/**
|
|
339
|
+
* Unique event ID.
|
|
340
|
+
* Allows clients to ignore duplicate webhooks.
|
|
341
|
+
*/
|
|
342
|
+
_id?: string;
|
|
343
|
+
/**
|
|
344
|
+
* Assumes actions are also always typed to an entity_type
|
|
345
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
346
|
+
*/
|
|
347
|
+
entityFqdn?: string;
|
|
348
|
+
/**
|
|
349
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
350
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
351
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
352
|
+
*/
|
|
353
|
+
slug?: string;
|
|
354
|
+
/** ID of the entity associated with the event. */
|
|
355
|
+
entityId?: string;
|
|
356
|
+
/** Event timestamp. */
|
|
357
|
+
eventTime?: Date;
|
|
358
|
+
/**
|
|
359
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
360
|
+
* (for example, GDPR).
|
|
361
|
+
*/
|
|
362
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
363
|
+
/** If present, indicates the action that triggered the event. */
|
|
364
|
+
originatedFrom?: string | null;
|
|
365
|
+
/**
|
|
366
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
367
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
368
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
369
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
370
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
371
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
372
|
+
*/
|
|
373
|
+
entityEventSequence?: string | null;
|
|
374
|
+
}
|
|
375
|
+
interface ConnectedDomainRemovedEnvelope {
|
|
376
|
+
data: DomainRemovedEvent$1;
|
|
377
|
+
metadata: EventMetadata;
|
|
378
|
+
}
|
|
379
|
+
interface ListConnectedDomainsOptions {
|
|
380
|
+
/** Cursor paging options. */
|
|
381
|
+
paging?: CursorPaging$1;
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
interface HttpClient {
|
|
385
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
386
|
+
}
|
|
387
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
388
|
+
type HttpResponse<T = any> = {
|
|
389
|
+
data: T;
|
|
390
|
+
status: number;
|
|
391
|
+
statusText: string;
|
|
392
|
+
headers: any;
|
|
393
|
+
request?: any;
|
|
394
|
+
};
|
|
395
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
396
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
397
|
+
url: string;
|
|
398
|
+
data?: Data;
|
|
399
|
+
params?: URLSearchParams;
|
|
400
|
+
} & APIMetadata;
|
|
401
|
+
type APIMetadata = {
|
|
402
|
+
methodFqn?: string;
|
|
403
|
+
entityFqdn?: string;
|
|
404
|
+
packageName?: string;
|
|
405
|
+
};
|
|
406
|
+
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
407
|
+
__type: 'event-definition';
|
|
408
|
+
type: Type;
|
|
409
|
+
isDomainEvent?: boolean;
|
|
410
|
+
transformations?: unknown;
|
|
411
|
+
__payload: Payload;
|
|
412
|
+
};
|
|
413
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
414
|
+
|
|
415
|
+
declare const __metadata$4: {
|
|
416
|
+
PACKAGE_NAME: string;
|
|
417
|
+
};
|
|
418
|
+
declare function createConnectedDomain(httpClient: HttpClient): (connectedDomain: ConnectedDomain) => Promise<ConnectedDomain & {
|
|
419
|
+
_id: string;
|
|
420
|
+
domain: string;
|
|
421
|
+
connectionType: ConnectionType$1;
|
|
422
|
+
siteInfo?: {
|
|
423
|
+
redirectInfo?: {
|
|
424
|
+
primaryDomain: string;
|
|
425
|
+
} | undefined;
|
|
426
|
+
assignmentType: AssignmentType$1;
|
|
427
|
+
} | undefined;
|
|
428
|
+
suppressNotifications: boolean;
|
|
429
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
430
|
+
}>;
|
|
431
|
+
declare function getConnectedDomain(httpClient: HttpClient): (connectedDomainId: string) => Promise<ConnectedDomain & {
|
|
432
|
+
_id: string;
|
|
433
|
+
domain: string;
|
|
434
|
+
connectionType: ConnectionType$1;
|
|
435
|
+
siteInfo?: {
|
|
436
|
+
redirectInfo?: {
|
|
437
|
+
primaryDomain: string;
|
|
438
|
+
} | undefined;
|
|
439
|
+
assignmentType: AssignmentType$1;
|
|
440
|
+
} | undefined;
|
|
441
|
+
suppressNotifications: boolean;
|
|
442
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
443
|
+
}>;
|
|
444
|
+
declare function listConnectedDomains(httpClient: HttpClient): (options?: ListConnectedDomainsOptions) => Promise<ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields>;
|
|
445
|
+
declare const onConnectedDomainRemoved: EventDefinition<ConnectedDomainRemovedEnvelope, "wix.premium.domains.v1.connected_domain_removed">;
|
|
446
|
+
|
|
447
|
+
type index_d$4_BaseEventMetadata = BaseEventMetadata;
|
|
448
|
+
type index_d$4_ConnectedDomain = ConnectedDomain;
|
|
449
|
+
type index_d$4_ConnectedDomainRemovedEnvelope = ConnectedDomainRemovedEnvelope;
|
|
450
|
+
type index_d$4_CreateConnectedDomainRequest = CreateConnectedDomainRequest;
|
|
451
|
+
type index_d$4_CreateConnectedDomainResponse = CreateConnectedDomainResponse;
|
|
452
|
+
type index_d$4_CreateConnectedDomainResponseNonNullableFields = CreateConnectedDomainResponseNonNullableFields;
|
|
453
|
+
type index_d$4_DeleteConnectedDomainRequest = DeleteConnectedDomainRequest;
|
|
454
|
+
type index_d$4_DeleteConnectedDomainResponse = DeleteConnectedDomainResponse;
|
|
455
|
+
type index_d$4_EventMetadata = EventMetadata;
|
|
456
|
+
type index_d$4_GetConnectedDomainRequest = GetConnectedDomainRequest;
|
|
457
|
+
type index_d$4_GetConnectedDomainResponse = GetConnectedDomainResponse;
|
|
458
|
+
type index_d$4_GetConnectedDomainResponseNonNullableFields = GetConnectedDomainResponseNonNullableFields;
|
|
459
|
+
type index_d$4_ListConnectedDomainsOptions = ListConnectedDomainsOptions;
|
|
460
|
+
type index_d$4_ListConnectedDomainsRequest = ListConnectedDomainsRequest;
|
|
461
|
+
type index_d$4_ListConnectedDomainsResponse = ListConnectedDomainsResponse;
|
|
462
|
+
type index_d$4_ListConnectedDomainsResponseNonNullableFields = ListConnectedDomainsResponseNonNullableFields;
|
|
463
|
+
declare const index_d$4_createConnectedDomain: typeof createConnectedDomain;
|
|
464
|
+
declare const index_d$4_getConnectedDomain: typeof getConnectedDomain;
|
|
465
|
+
declare const index_d$4_listConnectedDomains: typeof listConnectedDomains;
|
|
466
|
+
declare const index_d$4_onConnectedDomainRemoved: typeof onConnectedDomainRemoved;
|
|
467
|
+
declare namespace index_d$4 {
|
|
468
|
+
export { type ActionEvent$2 as ActionEvent, AssignmentType$1 as AssignmentType, type index_d$4_BaseEventMetadata as BaseEventMetadata, type index_d$4_ConnectedDomain as ConnectedDomain, type index_d$4_ConnectedDomainRemovedEnvelope as ConnectedDomainRemovedEnvelope, ConnectionType$1 as ConnectionType, type index_d$4_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type index_d$4_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type index_d$4_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type index_d$4_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type index_d$4_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 index_d$4_EventMetadata as EventMetadata, type index_d$4_GetConnectedDomainRequest as GetConnectedDomainRequest, type index_d$4_GetConnectedDomainResponse as GetConnectedDomainResponse, type index_d$4_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$4_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type index_d$4_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type index_d$4_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type index_d$4_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type RedirectAssignmentInfo$1 as RedirectAssignmentInfo, type SiteInfo$1 as SiteInfo, type SiteInfoAssignmentInfoOneOf$1 as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$2 as WebhookIdentityType, __metadata$4 as __metadata, index_d$4_createConnectedDomain as createConnectedDomain, index_d$4_getConnectedDomain as getConnectedDomain, index_d$4_listConnectedDomains as listConnectedDomains, index_d$4_onConnectedDomainRemoved as onConnectedDomainRemoved };
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* A `connectedDomainSetupInfo` object holds information the connected domain's
|
|
473
|
+
* external registrar and some DNS records. You can use this information to guide
|
|
474
|
+
* the site owner through the domain's setup process.
|
|
475
|
+
*/
|
|
476
|
+
interface ConnectedDomainSetupInfo extends ConnectedDomainSetupInfoDnsRecordsOneOf {
|
|
477
|
+
/**
|
|
478
|
+
* Information about domains connected using nameservers. Available only for
|
|
479
|
+
* `{"connectionType": "NAMESERVERS"}`.
|
|
480
|
+
*/
|
|
481
|
+
nameserverRecord?: NameserverRecord;
|
|
482
|
+
/**
|
|
483
|
+
* Information about domains connected by pointing. Available only for
|
|
484
|
+
* `{"connectionType": "POINTING"}`.
|
|
485
|
+
* @readonly
|
|
486
|
+
*/
|
|
487
|
+
pointingRecords?: PointingRecords;
|
|
488
|
+
/**
|
|
489
|
+
* Information about subdomains. Available only for subdomains.
|
|
490
|
+
* @readonly
|
|
491
|
+
*/
|
|
492
|
+
subdomainRecords?: SubdomainRecords;
|
|
493
|
+
/** ID of the connected domain. Identical to the domain name including TLD. */
|
|
494
|
+
connectedDomainId?: string;
|
|
495
|
+
/**
|
|
496
|
+
* Information about the external domain registrar including current name
|
|
497
|
+
* servers.
|
|
498
|
+
*/
|
|
499
|
+
registrar?: Registrar;
|
|
500
|
+
}
|
|
501
|
+
/** @oneof */
|
|
502
|
+
interface ConnectedDomainSetupInfoDnsRecordsOneOf {
|
|
503
|
+
/**
|
|
504
|
+
* Information about domains connected using nameservers. Available only for
|
|
505
|
+
* `{"connectionType": "NAMESERVERS"}`.
|
|
506
|
+
*/
|
|
507
|
+
nameserverRecord?: NameserverRecord;
|
|
508
|
+
/**
|
|
509
|
+
* Information about domains connected by pointing. Available only for
|
|
510
|
+
* `{"connectionType": "POINTING"}`.
|
|
511
|
+
* @readonly
|
|
512
|
+
*/
|
|
513
|
+
pointingRecords?: PointingRecords;
|
|
514
|
+
/**
|
|
515
|
+
* Information about subdomains. Available only for subdomains.
|
|
516
|
+
* @readonly
|
|
517
|
+
*/
|
|
518
|
+
subdomainRecords?: SubdomainRecords;
|
|
519
|
+
}
|
|
520
|
+
interface Registrar {
|
|
521
|
+
/**
|
|
522
|
+
* Name of the external domain registrar. For subdomains it's the registrar of the root domain.
|
|
523
|
+
* @readonly
|
|
524
|
+
*/
|
|
525
|
+
name?: string | null;
|
|
526
|
+
/**
|
|
527
|
+
* Values of the current name server records. In case you connect an external
|
|
528
|
+
* domain using name servers, site owners must replace these current name servers
|
|
529
|
+
* with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
|
|
530
|
+
* during the initial domain setup.
|
|
531
|
+
* The replacement can't be performed through Wix APIs, you must use the
|
|
532
|
+
* infrastructure of the external domain registrar. Read more about
|
|
533
|
+
* [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).
|
|
534
|
+
* @readonly
|
|
535
|
+
*/
|
|
536
|
+
nameServers?: string[];
|
|
537
|
+
}
|
|
538
|
+
/** Information about domains connected by nameservers. */
|
|
539
|
+
interface NameserverRecord {
|
|
540
|
+
/**
|
|
541
|
+
* Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
|
|
542
|
+
* @readonly
|
|
543
|
+
*/
|
|
544
|
+
nsRecord?: NsRecord;
|
|
545
|
+
}
|
|
546
|
+
interface NsRecord {
|
|
547
|
+
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
548
|
+
hostName?: string;
|
|
549
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
550
|
+
ttl?: number;
|
|
551
|
+
/** DNS record values. */
|
|
552
|
+
values?: string[];
|
|
553
|
+
}
|
|
554
|
+
/** Information about domains connected by pointing. */
|
|
555
|
+
interface PointingRecords {
|
|
556
|
+
/**
|
|
557
|
+
* [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).
|
|
558
|
+
* @readonly
|
|
559
|
+
*/
|
|
560
|
+
aRecord?: ARecord;
|
|
561
|
+
/**
|
|
562
|
+
* [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).
|
|
563
|
+
* @readonly
|
|
564
|
+
*/
|
|
565
|
+
cnameRecord?: CnameRecord;
|
|
566
|
+
}
|
|
567
|
+
interface ARecord {
|
|
568
|
+
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
569
|
+
hostName?: string;
|
|
570
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
571
|
+
ttl?: number;
|
|
572
|
+
/** DNS record values. */
|
|
573
|
+
values?: string[];
|
|
574
|
+
}
|
|
575
|
+
interface CnameRecord {
|
|
576
|
+
/** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
|
|
577
|
+
hostName?: string;
|
|
578
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
579
|
+
ttl?: number;
|
|
580
|
+
/** DNS record value. */
|
|
581
|
+
value?: string;
|
|
582
|
+
}
|
|
583
|
+
/** Information about subdomains. */
|
|
584
|
+
interface SubdomainRecords {
|
|
585
|
+
/**
|
|
586
|
+
* [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
|
|
587
|
+
* @readonly
|
|
588
|
+
*/
|
|
589
|
+
cnameRecords?: CnameRecord[];
|
|
590
|
+
}
|
|
591
|
+
interface GetSetupInfoRequest {
|
|
592
|
+
/** Domain name including TLD */
|
|
593
|
+
domain?: string;
|
|
594
|
+
/**
|
|
595
|
+
* How the domain should be to connected the Wix site.
|
|
596
|
+
*
|
|
597
|
+
* + `"UNKNOWN_CONNECTION_TYPE"`: supported only for subdomain.
|
|
598
|
+
* + `"POINTING"`: Get domain or subdomain setup by pointing
|
|
599
|
+
* + `"NAMESERVERS"`: Get domain setup by nameservers
|
|
600
|
+
* + `"HIDDEN"`: supported only for subdomain.
|
|
601
|
+
*/
|
|
602
|
+
connectionType?: ConnectionType;
|
|
603
|
+
/** Whether to return registrar information or not. Default is false. */
|
|
604
|
+
includeRegistrar?: boolean;
|
|
605
|
+
}
|
|
606
|
+
declare enum ConnectionType {
|
|
607
|
+
/** Used by sub domain */
|
|
608
|
+
UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
|
|
609
|
+
POINTING = "POINTING",
|
|
610
|
+
NAMESERVERS = "NAMESERVERS",
|
|
611
|
+
/**
|
|
612
|
+
* internal used by photography company.
|
|
613
|
+
* when a customer creates a photo album, each album has its sub domain and this sub domain
|
|
614
|
+
* is not visible in my domains page.
|
|
615
|
+
*/
|
|
616
|
+
HIDDEN = "HIDDEN"
|
|
617
|
+
}
|
|
618
|
+
interface GetSetupInfoResponse {
|
|
619
|
+
/** Retrieved setup information. */
|
|
620
|
+
domainSetupInfo?: ConnectedDomainSetupInfo;
|
|
621
|
+
}
|
|
622
|
+
interface GetConnectedDomainSetupInfoRequest {
|
|
623
|
+
/**
|
|
624
|
+
* ID of the connected domain to retrieve setup information for.
|
|
625
|
+
* Identical to the domain name including TLD.
|
|
626
|
+
*/
|
|
627
|
+
connectedDomainId: string;
|
|
628
|
+
}
|
|
629
|
+
interface GetConnectedDomainSetupInfoResponse {
|
|
630
|
+
/** Retrieved setup information. */
|
|
631
|
+
connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
|
|
632
|
+
}
|
|
633
|
+
interface GetDomainSetupInfoRequest {
|
|
634
|
+
/** Domain name including TLD */
|
|
635
|
+
domain?: string;
|
|
636
|
+
/**
|
|
637
|
+
* How the domain should be to connected the Wix site.
|
|
638
|
+
*
|
|
639
|
+
* + `"UNKNOWN_CONNECTION_TYPE"`: supported only for subdomain.
|
|
640
|
+
* + `"POINTING"`: Get domain or subdomain setup by pointing
|
|
641
|
+
* + `"NAMESERVERS"`: Get domain setup by nameservers
|
|
642
|
+
* + `"HIDDEN"`: supported only for subdomain.
|
|
643
|
+
*/
|
|
644
|
+
connectionType?: ConnectionType;
|
|
645
|
+
/** Whether to return registrar information or not. Default is false. */
|
|
646
|
+
includeRegistrar?: boolean;
|
|
647
|
+
}
|
|
648
|
+
interface GetDomainSetupInfoResponse {
|
|
649
|
+
/** Retrieved setup information. */
|
|
650
|
+
domainSetupInfo?: ConnectedDomainSetupInfo;
|
|
651
|
+
}
|
|
652
|
+
interface GetConnectedDomainSetupInfoResponseNonNullableFields {
|
|
653
|
+
connectedDomainSetupInfo?: {
|
|
654
|
+
nameserverRecord?: {
|
|
655
|
+
nsRecord?: {
|
|
656
|
+
hostName: string;
|
|
657
|
+
ttl: number;
|
|
658
|
+
values: string[];
|
|
659
|
+
};
|
|
660
|
+
};
|
|
661
|
+
pointingRecords?: {
|
|
662
|
+
aRecord?: {
|
|
663
|
+
hostName: string;
|
|
664
|
+
ttl: number;
|
|
665
|
+
values: string[];
|
|
666
|
+
};
|
|
667
|
+
cnameRecord?: {
|
|
668
|
+
hostName: string;
|
|
669
|
+
ttl: number;
|
|
670
|
+
value: string;
|
|
671
|
+
};
|
|
672
|
+
};
|
|
673
|
+
subdomainRecords?: {
|
|
674
|
+
cnameRecords: {
|
|
675
|
+
hostName: string;
|
|
676
|
+
ttl: number;
|
|
677
|
+
value: string;
|
|
678
|
+
}[];
|
|
679
|
+
};
|
|
680
|
+
connectedDomainId: string;
|
|
681
|
+
registrar?: {
|
|
682
|
+
nameServers: string[];
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
}
|
|
686
|
+
|
|
687
|
+
declare const __metadata$3: {
|
|
688
|
+
PACKAGE_NAME: string;
|
|
689
|
+
};
|
|
690
|
+
declare function getConnectedDomainSetupInfo(httpClient: HttpClient): (connectedDomainId: string) => Promise<GetConnectedDomainSetupInfoResponse & GetConnectedDomainSetupInfoResponseNonNullableFields>;
|
|
691
|
+
|
|
692
|
+
type index_d$3_ARecord = ARecord;
|
|
693
|
+
type index_d$3_CnameRecord = CnameRecord;
|
|
694
|
+
type index_d$3_ConnectedDomainSetupInfo = ConnectedDomainSetupInfo;
|
|
695
|
+
type index_d$3_ConnectedDomainSetupInfoDnsRecordsOneOf = ConnectedDomainSetupInfoDnsRecordsOneOf;
|
|
696
|
+
type index_d$3_ConnectionType = ConnectionType;
|
|
697
|
+
declare const index_d$3_ConnectionType: typeof ConnectionType;
|
|
698
|
+
type index_d$3_GetConnectedDomainSetupInfoRequest = GetConnectedDomainSetupInfoRequest;
|
|
699
|
+
type index_d$3_GetConnectedDomainSetupInfoResponse = GetConnectedDomainSetupInfoResponse;
|
|
700
|
+
type index_d$3_GetConnectedDomainSetupInfoResponseNonNullableFields = GetConnectedDomainSetupInfoResponseNonNullableFields;
|
|
701
|
+
type index_d$3_GetDomainSetupInfoRequest = GetDomainSetupInfoRequest;
|
|
702
|
+
type index_d$3_GetDomainSetupInfoResponse = GetDomainSetupInfoResponse;
|
|
703
|
+
type index_d$3_GetSetupInfoRequest = GetSetupInfoRequest;
|
|
704
|
+
type index_d$3_GetSetupInfoResponse = GetSetupInfoResponse;
|
|
705
|
+
type index_d$3_NameserverRecord = NameserverRecord;
|
|
706
|
+
type index_d$3_NsRecord = NsRecord;
|
|
707
|
+
type index_d$3_PointingRecords = PointingRecords;
|
|
708
|
+
type index_d$3_Registrar = Registrar;
|
|
709
|
+
type index_d$3_SubdomainRecords = SubdomainRecords;
|
|
710
|
+
declare const index_d$3_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
|
|
711
|
+
declare namespace index_d$3 {
|
|
712
|
+
export { type index_d$3_ARecord as ARecord, type index_d$3_CnameRecord as CnameRecord, type index_d$3_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type index_d$3_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, index_d$3_ConnectionType as ConnectionType, type index_d$3_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type index_d$3_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type index_d$3_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type index_d$3_GetDomainSetupInfoRequest as GetDomainSetupInfoRequest, type index_d$3_GetDomainSetupInfoResponse as GetDomainSetupInfoResponse, type index_d$3_GetSetupInfoRequest as GetSetupInfoRequest, type index_d$3_GetSetupInfoResponse as GetSetupInfoResponse, type index_d$3_NameserverRecord as NameserverRecord, type index_d$3_NsRecord as NsRecord, type index_d$3_PointingRecords as PointingRecords, type index_d$3_Registrar as Registrar, type index_d$3_SubdomainRecords as SubdomainRecords, __metadata$3 as __metadata, index_d$3_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
713
|
+
}
|
|
714
|
+
|
|
715
|
+
/** DNS zones hold information about the records that map a domain's URL to an IP address. */
|
|
716
|
+
interface DnsZone {
|
|
717
|
+
/** Domain name including the TLD. Both root domains and subdomains are supported. */
|
|
718
|
+
domainName?: string;
|
|
719
|
+
/**
|
|
720
|
+
* DNS records. You can only set up a single `record` object per DNS record
|
|
721
|
+
* type. If you want to specify multiple values for the same record type, you
|
|
722
|
+
* must save them in the `values` for the relevant type.
|
|
723
|
+
*
|
|
724
|
+
* Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
|
|
725
|
+
* Max: 5000 DNS records
|
|
726
|
+
*/
|
|
727
|
+
records?: DnsRecord[];
|
|
728
|
+
/**
|
|
729
|
+
* ID of the Dns Zone. Identical to the domain name including TLD.
|
|
730
|
+
* @readonly
|
|
731
|
+
*/
|
|
732
|
+
_id?: string;
|
|
733
|
+
/**
|
|
734
|
+
* Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) are enabled.
|
|
735
|
+
*
|
|
736
|
+
* Default: `false`
|
|
737
|
+
*/
|
|
738
|
+
dnssecEnabled?: boolean;
|
|
739
|
+
}
|
|
740
|
+
interface DnsRecord {
|
|
741
|
+
/**
|
|
742
|
+
* [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
|
|
743
|
+
*
|
|
744
|
+
* + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
|
|
745
|
+
* + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
|
|
746
|
+
* + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
|
|
747
|
+
* + `NS`: Name server record. Describes which server contains the actual DNS record.
|
|
748
|
+
* + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
|
|
749
|
+
* + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
|
|
750
|
+
* + `MX`: MX record. Directs emails to mail servers.
|
|
751
|
+
* + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
|
|
752
|
+
* + `SPF`: SPF record. Used for email authentication.
|
|
753
|
+
* + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
|
|
754
|
+
* + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
|
|
755
|
+
* + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
|
|
756
|
+
*/
|
|
757
|
+
type?: RecordType;
|
|
758
|
+
/**
|
|
759
|
+
* Host name. Can be a subdomain. For example, `domain.com` or
|
|
760
|
+
* `mail.domain.com`. Equal to the domain name, except for `CNAME` records.
|
|
761
|
+
*/
|
|
762
|
+
hostName?: string;
|
|
763
|
+
/** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
|
|
764
|
+
ttl?: number;
|
|
765
|
+
/**
|
|
766
|
+
* DNS record values. Wix limits DNS records to 50 values per type. External
|
|
767
|
+
* providers may support a different maximum number of DNS records for a
|
|
768
|
+
* specific type, Wix doesn't validate that you don't exceed these external
|
|
769
|
+
* limits.
|
|
770
|
+
*
|
|
771
|
+
* Max: 50 records
|
|
772
|
+
*/
|
|
773
|
+
values?: string[];
|
|
774
|
+
}
|
|
775
|
+
declare enum RecordType {
|
|
776
|
+
UNKNOWN = "UNKNOWN",
|
|
777
|
+
A = "A",
|
|
778
|
+
AAAA = "AAAA",
|
|
779
|
+
NS = "NS",
|
|
780
|
+
SOA = "SOA",
|
|
781
|
+
CNAME = "CNAME",
|
|
782
|
+
MX = "MX",
|
|
783
|
+
TXT = "TXT",
|
|
784
|
+
SPF = "SPF",
|
|
785
|
+
SRV = "SRV",
|
|
786
|
+
PTR = "PTR",
|
|
787
|
+
NAPTR = "NAPTR"
|
|
788
|
+
}
|
|
789
|
+
interface DomainRemovedEvent {
|
|
790
|
+
/**
|
|
791
|
+
* Domain name including TLD.
|
|
792
|
+
* Both root domains and subdomains are supported.
|
|
793
|
+
*/
|
|
794
|
+
domain?: string;
|
|
795
|
+
}
|
|
796
|
+
interface CreateDnsZoneRequest {
|
|
797
|
+
/** DNS zone to create. */
|
|
798
|
+
dnsZone: DnsZone;
|
|
799
|
+
}
|
|
800
|
+
interface CreateDnsZoneResponse {
|
|
801
|
+
/** Created DNS zone. */
|
|
802
|
+
dnsZone?: DnsZone;
|
|
803
|
+
}
|
|
804
|
+
interface GetDnsZoneRequest {
|
|
805
|
+
/** Domain to retrieve the DNS zone for. */
|
|
806
|
+
domainName: string;
|
|
807
|
+
}
|
|
808
|
+
interface GetDnsZoneResponse {
|
|
809
|
+
/** Retrieved DNS zone. */
|
|
810
|
+
dnsZone?: DnsZone;
|
|
811
|
+
}
|
|
812
|
+
interface UpdateDnsZoneRequest {
|
|
813
|
+
/** Domain to update the DNS zone for. Must include the TLD. */
|
|
814
|
+
domainName: string;
|
|
815
|
+
/**
|
|
816
|
+
* DNS records to add to the DNS zone.
|
|
817
|
+
*
|
|
818
|
+
* Max: 10 additions
|
|
819
|
+
*/
|
|
820
|
+
additions?: DnsRecord[];
|
|
821
|
+
/**
|
|
822
|
+
* DNS records to remove from the DNS zone.
|
|
823
|
+
*
|
|
824
|
+
* Max: 10 deletions
|
|
825
|
+
*/
|
|
826
|
+
deletions?: DnsRecord[];
|
|
827
|
+
/** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
|
|
828
|
+
dnssecEnabled?: boolean | null;
|
|
829
|
+
}
|
|
830
|
+
interface UpdateDnsZoneResponse {
|
|
831
|
+
/** Updated DNS zone. */
|
|
832
|
+
dnsZone?: DnsZone;
|
|
833
|
+
}
|
|
834
|
+
interface DeleteDnsZoneRequest {
|
|
835
|
+
/** Domain name to delete the DNS zone for. */
|
|
836
|
+
domainName: string;
|
|
837
|
+
}
|
|
838
|
+
interface DeleteDnsZoneResponse {
|
|
839
|
+
}
|
|
840
|
+
interface PreviewDnsZoneRequest {
|
|
841
|
+
/** Domain name to generate a DNS zone preview for. */
|
|
842
|
+
domainName: string;
|
|
843
|
+
}
|
|
844
|
+
interface PreviewDnsZoneResponse {
|
|
845
|
+
/**
|
|
846
|
+
* DNS zone preview.
|
|
847
|
+
*
|
|
848
|
+
* Includes calculated `A`, `CNAME`, `NS` and `SOA` records.
|
|
849
|
+
*/
|
|
850
|
+
dnsZone?: DnsZone;
|
|
851
|
+
}
|
|
852
|
+
interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
|
|
853
|
+
createdEvent?: EntityCreatedEvent$1;
|
|
854
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
|
855
|
+
deletedEvent?: EntityDeletedEvent$1;
|
|
856
|
+
actionEvent?: ActionEvent$1;
|
|
857
|
+
/**
|
|
858
|
+
* Unique event ID.
|
|
859
|
+
* Allows clients to ignore duplicate webhooks.
|
|
860
|
+
*/
|
|
861
|
+
_id?: string;
|
|
862
|
+
/**
|
|
863
|
+
* Assumes actions are also always typed to an entity_type
|
|
864
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
865
|
+
*/
|
|
866
|
+
entityFqdn?: string;
|
|
867
|
+
/**
|
|
868
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
869
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
870
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
871
|
+
*/
|
|
872
|
+
slug?: string;
|
|
873
|
+
/** ID of the entity associated with the event. */
|
|
874
|
+
entityId?: string;
|
|
875
|
+
/** Event timestamp. */
|
|
876
|
+
eventTime?: Date;
|
|
877
|
+
/**
|
|
878
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
879
|
+
* (for example, GDPR).
|
|
880
|
+
*/
|
|
881
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
882
|
+
/** If present, indicates the action that triggered the event. */
|
|
883
|
+
originatedFrom?: string | null;
|
|
884
|
+
/**
|
|
885
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
886
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
887
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
888
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
889
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
890
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
891
|
+
*/
|
|
892
|
+
entityEventSequence?: string | null;
|
|
893
|
+
}
|
|
894
|
+
/** @oneof */
|
|
895
|
+
interface DomainEventBodyOneOf$1 {
|
|
896
|
+
createdEvent?: EntityCreatedEvent$1;
|
|
897
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
|
898
|
+
deletedEvent?: EntityDeletedEvent$1;
|
|
899
|
+
actionEvent?: ActionEvent$1;
|
|
900
|
+
}
|
|
901
|
+
interface EntityCreatedEvent$1 {
|
|
902
|
+
entity?: string;
|
|
903
|
+
}
|
|
904
|
+
interface EntityUpdatedEvent$1 {
|
|
905
|
+
/**
|
|
906
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
907
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
908
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
909
|
+
*/
|
|
910
|
+
currentEntity?: string;
|
|
911
|
+
}
|
|
912
|
+
interface EntityDeletedEvent$1 {
|
|
913
|
+
/** Entity that was deleted */
|
|
914
|
+
deletedEntity?: string | null;
|
|
915
|
+
}
|
|
916
|
+
interface ActionEvent$1 {
|
|
917
|
+
body?: string;
|
|
918
|
+
}
|
|
919
|
+
interface MessageEnvelope$1 {
|
|
920
|
+
/** App instance ID. */
|
|
921
|
+
instanceId?: string | null;
|
|
922
|
+
/** Event type. */
|
|
923
|
+
eventType?: string;
|
|
924
|
+
/** The identification type and identity data. */
|
|
925
|
+
identity?: IdentificationData$1;
|
|
926
|
+
/** Stringify payload. */
|
|
927
|
+
data?: string;
|
|
928
|
+
}
|
|
929
|
+
interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
|
|
930
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
931
|
+
anonymousVisitorId?: string;
|
|
932
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
933
|
+
memberId?: string;
|
|
934
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
935
|
+
wixUserId?: string;
|
|
936
|
+
/** ID of an app. */
|
|
937
|
+
appId?: string;
|
|
938
|
+
/** @readonly */
|
|
939
|
+
identityType?: WebhookIdentityType$1;
|
|
940
|
+
}
|
|
941
|
+
/** @oneof */
|
|
942
|
+
interface IdentificationDataIdOneOf$1 {
|
|
943
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
944
|
+
anonymousVisitorId?: string;
|
|
945
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
946
|
+
memberId?: string;
|
|
947
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
948
|
+
wixUserId?: string;
|
|
949
|
+
/** ID of an app. */
|
|
950
|
+
appId?: string;
|
|
951
|
+
}
|
|
952
|
+
declare enum WebhookIdentityType$1 {
|
|
953
|
+
UNKNOWN = "UNKNOWN",
|
|
954
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
955
|
+
MEMBER = "MEMBER",
|
|
956
|
+
WIX_USER = "WIX_USER",
|
|
957
|
+
APP = "APP"
|
|
958
|
+
}
|
|
959
|
+
interface CreateDnsZoneResponseNonNullableFields {
|
|
960
|
+
dnsZone?: {
|
|
961
|
+
domainName: string;
|
|
962
|
+
records: {
|
|
963
|
+
type: RecordType;
|
|
964
|
+
hostName: string;
|
|
965
|
+
ttl: number;
|
|
966
|
+
values: string[];
|
|
967
|
+
}[];
|
|
968
|
+
_id: string;
|
|
969
|
+
dnssecEnabled: boolean;
|
|
970
|
+
};
|
|
971
|
+
}
|
|
972
|
+
interface GetDnsZoneResponseNonNullableFields {
|
|
973
|
+
dnsZone?: {
|
|
974
|
+
domainName: string;
|
|
975
|
+
records: {
|
|
976
|
+
type: RecordType;
|
|
977
|
+
hostName: string;
|
|
978
|
+
ttl: number;
|
|
979
|
+
values: string[];
|
|
980
|
+
}[];
|
|
981
|
+
_id: string;
|
|
982
|
+
dnssecEnabled: boolean;
|
|
983
|
+
};
|
|
984
|
+
}
|
|
985
|
+
interface UpdateDnsZoneResponseNonNullableFields {
|
|
986
|
+
dnsZone?: {
|
|
987
|
+
domainName: string;
|
|
988
|
+
records: {
|
|
989
|
+
type: RecordType;
|
|
990
|
+
hostName: string;
|
|
991
|
+
ttl: number;
|
|
992
|
+
values: string[];
|
|
993
|
+
}[];
|
|
994
|
+
_id: string;
|
|
995
|
+
dnssecEnabled: boolean;
|
|
996
|
+
};
|
|
997
|
+
}
|
|
998
|
+
interface PreviewDnsZoneResponseNonNullableFields {
|
|
999
|
+
dnsZone?: {
|
|
1000
|
+
domainName: string;
|
|
1001
|
+
records: {
|
|
1002
|
+
type: RecordType;
|
|
1003
|
+
hostName: string;
|
|
1004
|
+
ttl: number;
|
|
1005
|
+
values: string[];
|
|
1006
|
+
}[];
|
|
1007
|
+
_id: string;
|
|
1008
|
+
dnssecEnabled: boolean;
|
|
1009
|
+
};
|
|
1010
|
+
}
|
|
1011
|
+
interface UpdateDnsZoneOptions {
|
|
1012
|
+
/**
|
|
1013
|
+
* DNS records to add to the DNS zone.
|
|
1014
|
+
*
|
|
1015
|
+
* Max: 10 additions
|
|
1016
|
+
*/
|
|
1017
|
+
additions?: DnsRecord[];
|
|
1018
|
+
/**
|
|
1019
|
+
* DNS records to remove from the DNS zone.
|
|
1020
|
+
*
|
|
1021
|
+
* Max: 10 deletions
|
|
1022
|
+
*/
|
|
1023
|
+
deletions?: DnsRecord[];
|
|
1024
|
+
/** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
|
|
1025
|
+
dnssecEnabled?: boolean | null;
|
|
1026
|
+
}
|
|
1027
|
+
|
|
1028
|
+
declare const __metadata$2: {
|
|
1029
|
+
PACKAGE_NAME: string;
|
|
1030
|
+
};
|
|
1031
|
+
declare function createDnsZone(httpClient: HttpClient): (dnsZone: DnsZone) => Promise<DnsZone & {
|
|
1032
|
+
domainName: string;
|
|
1033
|
+
records: {
|
|
1034
|
+
type: RecordType;
|
|
1035
|
+
hostName: string;
|
|
1036
|
+
ttl: number;
|
|
1037
|
+
values: string[];
|
|
1038
|
+
}[];
|
|
1039
|
+
_id: string;
|
|
1040
|
+
dnssecEnabled: boolean;
|
|
1041
|
+
}>;
|
|
1042
|
+
declare function getDnsZone(httpClient: HttpClient): (domainName: string) => Promise<DnsZone & {
|
|
1043
|
+
domainName: string;
|
|
1044
|
+
records: {
|
|
1045
|
+
type: RecordType;
|
|
1046
|
+
hostName: string;
|
|
1047
|
+
ttl: number;
|
|
1048
|
+
values: string[];
|
|
1049
|
+
}[];
|
|
1050
|
+
_id: string;
|
|
1051
|
+
dnssecEnabled: boolean;
|
|
1052
|
+
}>;
|
|
1053
|
+
declare function updateDnsZone(httpClient: HttpClient): (domainName: string, options?: UpdateDnsZoneOptions) => Promise<UpdateDnsZoneResponse & UpdateDnsZoneResponseNonNullableFields>;
|
|
1054
|
+
declare function deleteDnsZone(httpClient: HttpClient): (domainName: string) => Promise<void>;
|
|
1055
|
+
declare function previewDnsZone(httpClient: HttpClient): (domainName: string) => Promise<PreviewDnsZoneResponse & PreviewDnsZoneResponseNonNullableFields>;
|
|
1056
|
+
|
|
1057
|
+
type index_d$2_CreateDnsZoneRequest = CreateDnsZoneRequest;
|
|
1058
|
+
type index_d$2_CreateDnsZoneResponse = CreateDnsZoneResponse;
|
|
1059
|
+
type index_d$2_CreateDnsZoneResponseNonNullableFields = CreateDnsZoneResponseNonNullableFields;
|
|
1060
|
+
type index_d$2_DeleteDnsZoneRequest = DeleteDnsZoneRequest;
|
|
1061
|
+
type index_d$2_DeleteDnsZoneResponse = DeleteDnsZoneResponse;
|
|
1062
|
+
type index_d$2_DnsRecord = DnsRecord;
|
|
1063
|
+
type index_d$2_DnsZone = DnsZone;
|
|
1064
|
+
type index_d$2_DomainRemovedEvent = DomainRemovedEvent;
|
|
1065
|
+
type index_d$2_GetDnsZoneRequest = GetDnsZoneRequest;
|
|
1066
|
+
type index_d$2_GetDnsZoneResponse = GetDnsZoneResponse;
|
|
1067
|
+
type index_d$2_GetDnsZoneResponseNonNullableFields = GetDnsZoneResponseNonNullableFields;
|
|
1068
|
+
type index_d$2_PreviewDnsZoneRequest = PreviewDnsZoneRequest;
|
|
1069
|
+
type index_d$2_PreviewDnsZoneResponse = PreviewDnsZoneResponse;
|
|
1070
|
+
type index_d$2_PreviewDnsZoneResponseNonNullableFields = PreviewDnsZoneResponseNonNullableFields;
|
|
1071
|
+
type index_d$2_RecordType = RecordType;
|
|
1072
|
+
declare const index_d$2_RecordType: typeof RecordType;
|
|
1073
|
+
type index_d$2_UpdateDnsZoneOptions = UpdateDnsZoneOptions;
|
|
1074
|
+
type index_d$2_UpdateDnsZoneRequest = UpdateDnsZoneRequest;
|
|
1075
|
+
type index_d$2_UpdateDnsZoneResponse = UpdateDnsZoneResponse;
|
|
1076
|
+
type index_d$2_UpdateDnsZoneResponseNonNullableFields = UpdateDnsZoneResponseNonNullableFields;
|
|
1077
|
+
declare const index_d$2_createDnsZone: typeof createDnsZone;
|
|
1078
|
+
declare const index_d$2_deleteDnsZone: typeof deleteDnsZone;
|
|
1079
|
+
declare const index_d$2_getDnsZone: typeof getDnsZone;
|
|
1080
|
+
declare const index_d$2_previewDnsZone: typeof previewDnsZone;
|
|
1081
|
+
declare const index_d$2_updateDnsZone: typeof updateDnsZone;
|
|
1082
|
+
declare namespace index_d$2 {
|
|
1083
|
+
export { type ActionEvent$1 as ActionEvent, type index_d$2_CreateDnsZoneRequest as CreateDnsZoneRequest, type index_d$2_CreateDnsZoneResponse as CreateDnsZoneResponse, type index_d$2_CreateDnsZoneResponseNonNullableFields as CreateDnsZoneResponseNonNullableFields, type index_d$2_DeleteDnsZoneRequest as DeleteDnsZoneRequest, type index_d$2_DeleteDnsZoneResponse as DeleteDnsZoneResponse, type index_d$2_DnsRecord as DnsRecord, type index_d$2_DnsZone as DnsZone, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$2_DomainRemovedEvent as DomainRemovedEvent, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type index_d$2_GetDnsZoneRequest as GetDnsZoneRequest, type index_d$2_GetDnsZoneResponse as GetDnsZoneResponse, type index_d$2_GetDnsZoneResponseNonNullableFields as GetDnsZoneResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type index_d$2_PreviewDnsZoneRequest as PreviewDnsZoneRequest, type index_d$2_PreviewDnsZoneResponse as PreviewDnsZoneResponse, type index_d$2_PreviewDnsZoneResponseNonNullableFields as PreviewDnsZoneResponseNonNullableFields, index_d$2_RecordType as RecordType, type index_d$2_UpdateDnsZoneOptions as UpdateDnsZoneOptions, type index_d$2_UpdateDnsZoneRequest as UpdateDnsZoneRequest, type index_d$2_UpdateDnsZoneResponse as UpdateDnsZoneResponse, type index_d$2_UpdateDnsZoneResponseNonNullableFields as UpdateDnsZoneResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, __metadata$2 as __metadata, index_d$2_createDnsZone as createDnsZone, index_d$2_deleteDnsZone as deleteDnsZone, index_d$2_getDnsZone as getDnsZone, index_d$2_previewDnsZone as previewDnsZone, index_d$2_updateDnsZone as updateDnsZone };
|
|
1084
|
+
}
|
|
1085
|
+
|
|
1
1086
|
/**
|
|
2
1087
|
* A registered domain is a domain that Wix has registered on behalf of a customer
|
|
3
1088
|
* with an external registar.
|
|
@@ -827,30 +1912,7 @@ interface ListRegisteredDomainsOptions {
|
|
|
827
1912
|
paging?: CursorPaging;
|
|
828
1913
|
}
|
|
829
1914
|
|
|
830
|
-
|
|
831
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
832
|
-
}
|
|
833
|
-
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
834
|
-
type HttpResponse<T = any> = {
|
|
835
|
-
data: T;
|
|
836
|
-
status: number;
|
|
837
|
-
statusText: string;
|
|
838
|
-
headers: any;
|
|
839
|
-
request?: any;
|
|
840
|
-
};
|
|
841
|
-
type RequestOptions<_TResponse = any, Data = any> = {
|
|
842
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
843
|
-
url: string;
|
|
844
|
-
data?: Data;
|
|
845
|
-
params?: URLSearchParams;
|
|
846
|
-
} & APIMetadata;
|
|
847
|
-
type APIMetadata = {
|
|
848
|
-
methodFqn?: string;
|
|
849
|
-
entityFqdn?: string;
|
|
850
|
-
packageName?: string;
|
|
851
|
-
};
|
|
852
|
-
|
|
853
|
-
declare const __metadata: {
|
|
1915
|
+
declare const __metadata$1: {
|
|
854
1916
|
PACKAGE_NAME: string;
|
|
855
1917
|
};
|
|
856
1918
|
declare function createRegisteredDomain(httpClient: HttpClient): (registeredDomain: RegisteredDomain) => Promise<RegisteredDomain & {
|
|
@@ -976,66 +2038,143 @@ declare function getRegisteredDomain(httpClient: HttpClient): (registeredDomainI
|
|
|
976
2038
|
declare function listRegisteredDomains(httpClient: HttpClient): (options?: ListRegisteredDomainsOptions) => Promise<ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields>;
|
|
977
2039
|
declare function redeemRegisteredDomain(httpClient: HttpClient): (registeredDomainId: string) => Promise<RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields>;
|
|
978
2040
|
|
|
979
|
-
type
|
|
980
|
-
type
|
|
981
|
-
declare const
|
|
982
|
-
type
|
|
983
|
-
type
|
|
984
|
-
type
|
|
985
|
-
type
|
|
986
|
-
type
|
|
987
|
-
type
|
|
988
|
-
type
|
|
989
|
-
type
|
|
990
|
-
type
|
|
991
|
-
type
|
|
992
|
-
type
|
|
993
|
-
declare const
|
|
994
|
-
type
|
|
995
|
-
type
|
|
996
|
-
type
|
|
997
|
-
type
|
|
998
|
-
type
|
|
999
|
-
type
|
|
1000
|
-
type
|
|
1001
|
-
type
|
|
1002
|
-
declare const
|
|
1003
|
-
type
|
|
1004
|
-
type
|
|
1005
|
-
type
|
|
1006
|
-
type
|
|
1007
|
-
declare const
|
|
1008
|
-
type
|
|
1009
|
-
type
|
|
1010
|
-
type
|
|
1011
|
-
type
|
|
1012
|
-
type
|
|
1013
|
-
type
|
|
1014
|
-
type
|
|
1015
|
-
type
|
|
1016
|
-
type
|
|
1017
|
-
type
|
|
1018
|
-
type
|
|
1019
|
-
type
|
|
1020
|
-
type
|
|
1021
|
-
type
|
|
1022
|
-
type
|
|
1023
|
-
type
|
|
1024
|
-
type
|
|
1025
|
-
type
|
|
1026
|
-
type
|
|
1027
|
-
type
|
|
1028
|
-
type
|
|
1029
|
-
declare const
|
|
1030
|
-
type
|
|
1031
|
-
declare const
|
|
2041
|
+
type index_d$1_ActionEvent = ActionEvent;
|
|
2042
|
+
type index_d$1_AssignmentType = AssignmentType;
|
|
2043
|
+
declare const index_d$1_AssignmentType: typeof AssignmentType;
|
|
2044
|
+
type index_d$1_ContactData = ContactData;
|
|
2045
|
+
type index_d$1_Contacts = Contacts;
|
|
2046
|
+
type index_d$1_CreateRegisteredDomainRequest = CreateRegisteredDomainRequest;
|
|
2047
|
+
type index_d$1_CreateRegisteredDomainResponse = CreateRegisteredDomainResponse;
|
|
2048
|
+
type index_d$1_CreateRegisteredDomainResponseNonNullableFields = CreateRegisteredDomainResponseNonNullableFields;
|
|
2049
|
+
type index_d$1_CursorPaging = CursorPaging;
|
|
2050
|
+
type index_d$1_CursorPagingMetadata = CursorPagingMetadata;
|
|
2051
|
+
type index_d$1_Cursors = Cursors;
|
|
2052
|
+
type index_d$1_DeleteRegisteredDomainByIdRequest = DeleteRegisteredDomainByIdRequest;
|
|
2053
|
+
type index_d$1_DeleteRegisteredDomainByIdResponse = DeleteRegisteredDomainByIdResponse;
|
|
2054
|
+
type index_d$1_DnsPropagationStatus = DnsPropagationStatus;
|
|
2055
|
+
declare const index_d$1_DnsPropagationStatus: typeof DnsPropagationStatus;
|
|
2056
|
+
type index_d$1_DomainEvent = DomainEvent;
|
|
2057
|
+
type index_d$1_DomainEventBodyOneOf = DomainEventBodyOneOf;
|
|
2058
|
+
type index_d$1_EntityCreatedEvent = EntityCreatedEvent;
|
|
2059
|
+
type index_d$1_EntityDeletedEvent = EntityDeletedEvent;
|
|
2060
|
+
type index_d$1_EntityUpdatedEvent = EntityUpdatedEvent;
|
|
2061
|
+
type index_d$1_Expired = Expired;
|
|
2062
|
+
type index_d$1_FailedRegistrationInfo = FailedRegistrationInfo;
|
|
2063
|
+
type index_d$1_FailureCode = FailureCode;
|
|
2064
|
+
declare const index_d$1_FailureCode: typeof FailureCode;
|
|
2065
|
+
type index_d$1_GetRegisteredDomainRequest = GetRegisteredDomainRequest;
|
|
2066
|
+
type index_d$1_GetRegisteredDomainResponse = GetRegisteredDomainResponse;
|
|
2067
|
+
type index_d$1_GetRegisteredDomainResponseNonNullableFields = GetRegisteredDomainResponseNonNullableFields;
|
|
2068
|
+
type index_d$1_ICANNConfirmationStatus = ICANNConfirmationStatus;
|
|
2069
|
+
declare const index_d$1_ICANNConfirmationStatus: typeof ICANNConfirmationStatus;
|
|
2070
|
+
type index_d$1_ICANNConfirmationStatusInfo = ICANNConfirmationStatusInfo;
|
|
2071
|
+
type index_d$1_ICANNConfirmationStatusInfoStatusOneOf = ICANNConfirmationStatusInfoStatusOneOf;
|
|
2072
|
+
type index_d$1_IdentificationData = IdentificationData;
|
|
2073
|
+
type index_d$1_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
2074
|
+
type index_d$1_LatestAttempt = LatestAttempt;
|
|
2075
|
+
type index_d$1_ListRegisteredDomainsOptions = ListRegisteredDomainsOptions;
|
|
2076
|
+
type index_d$1_ListRegisteredDomainsRequest = ListRegisteredDomainsRequest;
|
|
2077
|
+
type index_d$1_ListRegisteredDomainsResponse = ListRegisteredDomainsResponse;
|
|
2078
|
+
type index_d$1_ListRegisteredDomainsResponseNonNullableFields = ListRegisteredDomainsResponseNonNullableFields;
|
|
2079
|
+
type index_d$1_MessageEnvelope = MessageEnvelope;
|
|
2080
|
+
type index_d$1_Pending = Pending;
|
|
2081
|
+
type index_d$1_PendingRegistrationInfo = PendingRegistrationInfo;
|
|
2082
|
+
type index_d$1_RedeemRegisteredDomainRequest = RedeemRegisteredDomainRequest;
|
|
2083
|
+
type index_d$1_RedeemRegisteredDomainResponse = RedeemRegisteredDomainResponse;
|
|
2084
|
+
type index_d$1_RedeemRegisteredDomainResponseNonNullableFields = RedeemRegisteredDomainResponseNonNullableFields;
|
|
2085
|
+
type index_d$1_RedirectAssignmentInfo = RedirectAssignmentInfo;
|
|
2086
|
+
type index_d$1_RegisteredDomain = RegisteredDomain;
|
|
2087
|
+
type index_d$1_RegisteredDomainStatusInfoOneOf = RegisteredDomainStatusInfoOneOf;
|
|
2088
|
+
type index_d$1_SiteInfo = SiteInfo;
|
|
2089
|
+
type index_d$1_SiteInfoAssignmentInfoOneOf = SiteInfoAssignmentInfoOneOf;
|
|
2090
|
+
type index_d$1_Status = Status;
|
|
2091
|
+
declare const index_d$1_Status: typeof Status;
|
|
2092
|
+
type index_d$1_WebhookIdentityType = WebhookIdentityType;
|
|
2093
|
+
declare const index_d$1_WebhookIdentityType: typeof WebhookIdentityType;
|
|
2094
|
+
declare const index_d$1_createRegisteredDomain: typeof createRegisteredDomain;
|
|
2095
|
+
declare const index_d$1_getRegisteredDomain: typeof getRegisteredDomain;
|
|
2096
|
+
declare const index_d$1_listRegisteredDomains: typeof listRegisteredDomains;
|
|
2097
|
+
declare const index_d$1_redeemRegisteredDomain: typeof redeemRegisteredDomain;
|
|
2098
|
+
declare namespace index_d$1 {
|
|
2099
|
+
export { type index_d$1_ActionEvent as ActionEvent, index_d$1_AssignmentType as AssignmentType, type index_d$1_ContactData as ContactData, type index_d$1_Contacts as Contacts, type index_d$1_CreateRegisteredDomainRequest as CreateRegisteredDomainRequest, type index_d$1_CreateRegisteredDomainResponse as CreateRegisteredDomainResponse, type index_d$1_CreateRegisteredDomainResponseNonNullableFields as CreateRegisteredDomainResponseNonNullableFields, type index_d$1_CursorPaging as CursorPaging, type index_d$1_CursorPagingMetadata as CursorPagingMetadata, type index_d$1_Cursors as Cursors, type index_d$1_DeleteRegisteredDomainByIdRequest as DeleteRegisteredDomainByIdRequest, type index_d$1_DeleteRegisteredDomainByIdResponse as DeleteRegisteredDomainByIdResponse, index_d$1_DnsPropagationStatus as DnsPropagationStatus, type index_d$1_DomainEvent as DomainEvent, type index_d$1_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d$1_EntityCreatedEvent as EntityCreatedEvent, type index_d$1_EntityDeletedEvent as EntityDeletedEvent, type index_d$1_EntityUpdatedEvent as EntityUpdatedEvent, type index_d$1_Expired as Expired, type index_d$1_FailedRegistrationInfo as FailedRegistrationInfo, index_d$1_FailureCode as FailureCode, type index_d$1_GetRegisteredDomainRequest as GetRegisteredDomainRequest, type index_d$1_GetRegisteredDomainResponse as GetRegisteredDomainResponse, type index_d$1_GetRegisteredDomainResponseNonNullableFields as GetRegisteredDomainResponseNonNullableFields, index_d$1_ICANNConfirmationStatus as ICANNConfirmationStatus, type index_d$1_ICANNConfirmationStatusInfo as ICANNConfirmationStatusInfo, type index_d$1_ICANNConfirmationStatusInfoStatusOneOf as ICANNConfirmationStatusInfoStatusOneOf, type index_d$1_IdentificationData as IdentificationData, type index_d$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d$1_LatestAttempt as LatestAttempt, type index_d$1_ListRegisteredDomainsOptions as ListRegisteredDomainsOptions, type index_d$1_ListRegisteredDomainsRequest as ListRegisteredDomainsRequest, type index_d$1_ListRegisteredDomainsResponse as ListRegisteredDomainsResponse, type index_d$1_ListRegisteredDomainsResponseNonNullableFields as ListRegisteredDomainsResponseNonNullableFields, type index_d$1_MessageEnvelope as MessageEnvelope, type index_d$1_Pending as Pending, type index_d$1_PendingRegistrationInfo as PendingRegistrationInfo, type index_d$1_RedeemRegisteredDomainRequest as RedeemRegisteredDomainRequest, type index_d$1_RedeemRegisteredDomainResponse as RedeemRegisteredDomainResponse, type index_d$1_RedeemRegisteredDomainResponseNonNullableFields as RedeemRegisteredDomainResponseNonNullableFields, type index_d$1_RedirectAssignmentInfo as RedirectAssignmentInfo, type index_d$1_RegisteredDomain as RegisteredDomain, type index_d$1_RegisteredDomainStatusInfoOneOf as RegisteredDomainStatusInfoOneOf, type index_d$1_SiteInfo as SiteInfo, type index_d$1_SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOf, index_d$1_Status as Status, index_d$1_WebhookIdentityType as WebhookIdentityType, __metadata$1 as __metadata, index_d$1_createRegisteredDomain as createRegisteredDomain, index_d$1_getRegisteredDomain as getRegisteredDomain, index_d$1_listRegisteredDomains as listRegisteredDomains, index_d$1_redeemRegisteredDomain as redeemRegisteredDomain };
|
|
2100
|
+
}
|
|
2101
|
+
|
|
2102
|
+
interface DomainSuggestion {
|
|
2103
|
+
/** Suggested domain name including TLD. */
|
|
2104
|
+
domain?: string;
|
|
2105
|
+
}
|
|
2106
|
+
interface SuggestDomainsRequest {
|
|
2107
|
+
/**
|
|
2108
|
+
* Input to base your domain suggestions on. May include
|
|
2109
|
+
* letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
|
|
2110
|
+
*
|
|
2111
|
+
* Min: 3 characters
|
|
2112
|
+
* Max: 100 characters
|
|
2113
|
+
*/
|
|
2114
|
+
query: string;
|
|
2115
|
+
/**
|
|
2116
|
+
* [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
|
|
2117
|
+
* not include the dot. For example, `com`, not `.com`. Not all TLDs can be
|
|
2118
|
+
* connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
|
|
2119
|
+
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
|
|
2120
|
+
* information.
|
|
2121
|
+
*
|
|
2122
|
+
* Max: 10 TLDs
|
|
2123
|
+
*/
|
|
2124
|
+
tlds?: string[];
|
|
2125
|
+
/**
|
|
2126
|
+
* Number of domain suggestions to return.
|
|
2127
|
+
*
|
|
2128
|
+
* Min: `1`
|
|
2129
|
+
* Max: `20`
|
|
2130
|
+
* Default: `10`
|
|
2131
|
+
*/
|
|
2132
|
+
limit?: number | null;
|
|
2133
|
+
}
|
|
2134
|
+
interface SuggestDomainsResponse {
|
|
2135
|
+
/** List of suggested available domains. */
|
|
2136
|
+
suggestions?: DomainSuggestion[];
|
|
2137
|
+
}
|
|
2138
|
+
interface SuggestDomainsResponseNonNullableFields {
|
|
2139
|
+
suggestions: {
|
|
2140
|
+
domain: string;
|
|
2141
|
+
}[];
|
|
2142
|
+
}
|
|
2143
|
+
interface SuggestDomainsOptions {
|
|
2144
|
+
/**
|
|
2145
|
+
* [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
|
|
2146
|
+
* not include the dot. For example, `com`, not `.com`. Not all TLDs can be
|
|
2147
|
+
* connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
|
|
2148
|
+
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
|
|
2149
|
+
* information.
|
|
2150
|
+
*
|
|
2151
|
+
* Max: 10 TLDs
|
|
2152
|
+
*/
|
|
2153
|
+
tlds?: string[];
|
|
2154
|
+
/**
|
|
2155
|
+
* Number of domain suggestions to return.
|
|
2156
|
+
*
|
|
2157
|
+
* Min: `1`
|
|
2158
|
+
* Max: `20`
|
|
2159
|
+
* Default: `10`
|
|
2160
|
+
*/
|
|
2161
|
+
limit?: number | null;
|
|
2162
|
+
}
|
|
2163
|
+
|
|
2164
|
+
declare const __metadata: {
|
|
2165
|
+
PACKAGE_NAME: string;
|
|
2166
|
+
};
|
|
2167
|
+
declare function suggestDomains(httpClient: HttpClient): (query: string, options?: SuggestDomainsOptions) => Promise<SuggestDomainsResponse & SuggestDomainsResponseNonNullableFields>;
|
|
2168
|
+
|
|
2169
|
+
type index_d_DomainSuggestion = DomainSuggestion;
|
|
2170
|
+
type index_d_SuggestDomainsOptions = SuggestDomainsOptions;
|
|
2171
|
+
type index_d_SuggestDomainsRequest = SuggestDomainsRequest;
|
|
2172
|
+
type index_d_SuggestDomainsResponse = SuggestDomainsResponse;
|
|
2173
|
+
type index_d_SuggestDomainsResponseNonNullableFields = SuggestDomainsResponseNonNullableFields;
|
|
1032
2174
|
declare const index_d___metadata: typeof __metadata;
|
|
1033
|
-
declare const
|
|
1034
|
-
declare const index_d_getRegisteredDomain: typeof getRegisteredDomain;
|
|
1035
|
-
declare const index_d_listRegisteredDomains: typeof listRegisteredDomains;
|
|
1036
|
-
declare const index_d_redeemRegisteredDomain: typeof redeemRegisteredDomain;
|
|
2175
|
+
declare const index_d_suggestDomains: typeof suggestDomains;
|
|
1037
2176
|
declare namespace index_d {
|
|
1038
|
-
export { type
|
|
2177
|
+
export { type index_d_DomainSuggestion as DomainSuggestion, type index_d_SuggestDomainsOptions as SuggestDomainsOptions, type index_d_SuggestDomainsRequest as SuggestDomainsRequest, type index_d_SuggestDomainsResponse as SuggestDomainsResponse, type index_d_SuggestDomainsResponseNonNullableFields as SuggestDomainsResponseNonNullableFields, index_d___metadata as __metadata, index_d_suggestDomains as suggestDomains };
|
|
1039
2178
|
}
|
|
1040
2179
|
|
|
1041
|
-
export { index_d as registeredDomains };
|
|
2180
|
+
export { index_d$3 as connectedDomainSetupInfo, index_d$4 as connectedDomains, index_d$2 as domainDns, index_d as domainSuggestions, index_d$1 as registeredDomains };
|