@wix/domains 1.0.36 → 1.0.38
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 +0 -1
- package/build/cjs/context.js +1 -2
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +1 -2
- package/build/cjs/index.js +1 -3
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +1 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +0 -1
- package/build/es/context.js +0 -1
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +1 -2
- package/build/es/index.js +1 -2
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -1
- package/build/es/meta.js.map +1 -1
- package/package.json +3 -4
- package/type-bundles/context.bundle.d.ts +1986 -1117
- package/type-bundles/index.bundle.d.ts +1986 -1117
- package/type-bundles/meta.bundle.d.ts +73 -1160
|
@@ -23,7 +23,7 @@ interface ConnectedDomain$1 {
|
|
|
23
23
|
* Information about the site to which the domain is assigned, and whether
|
|
24
24
|
* it's the primary domain or a redirect.
|
|
25
25
|
*/
|
|
26
|
-
siteInfo?: SiteInfo$
|
|
26
|
+
siteInfo?: SiteInfo$1;
|
|
27
27
|
/**
|
|
28
28
|
* Whether the site owner receives standard email notifications from Wix about
|
|
29
29
|
* the connected domain.
|
|
@@ -40,7 +40,7 @@ interface ConnectedDomain$1 {
|
|
|
40
40
|
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
41
41
|
* @readonly
|
|
42
42
|
*/
|
|
43
|
-
dnsPropagationStatus?: DnsPropagationStatus$
|
|
43
|
+
dnsPropagationStatus?: DnsPropagationStatus$1;
|
|
44
44
|
}
|
|
45
45
|
declare enum ConnectionType$1 {
|
|
46
46
|
/** Used by sub domain */
|
|
@@ -54,12 +54,12 @@ declare enum ConnectionType$1 {
|
|
|
54
54
|
*/
|
|
55
55
|
HIDDEN = "HIDDEN"
|
|
56
56
|
}
|
|
57
|
-
interface SiteInfo$
|
|
57
|
+
interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
|
|
58
58
|
/**
|
|
59
59
|
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
60
60
|
* @readonly
|
|
61
61
|
*/
|
|
62
|
-
redirectInfo?: RedirectAssignmentInfo$
|
|
62
|
+
redirectInfo?: RedirectAssignmentInfo$1;
|
|
63
63
|
/**
|
|
64
64
|
* ID of the site to which the domain is assigned.
|
|
65
65
|
* @readonly
|
|
@@ -72,29 +72,29 @@ interface SiteInfo$3 extends SiteInfoAssignmentInfoOneOf$3 {
|
|
|
72
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
73
|
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
74
74
|
*/
|
|
75
|
-
assignmentType?: AssignmentType$
|
|
75
|
+
assignmentType?: AssignmentType$1;
|
|
76
76
|
}
|
|
77
77
|
/** @oneof */
|
|
78
|
-
interface SiteInfoAssignmentInfoOneOf$
|
|
78
|
+
interface SiteInfoAssignmentInfoOneOf$1 {
|
|
79
79
|
/**
|
|
80
80
|
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
81
81
|
* @readonly
|
|
82
82
|
*/
|
|
83
|
-
redirectInfo?: RedirectAssignmentInfo$
|
|
83
|
+
redirectInfo?: RedirectAssignmentInfo$1;
|
|
84
84
|
}
|
|
85
|
-
declare enum AssignmentType$
|
|
85
|
+
declare enum AssignmentType$1 {
|
|
86
86
|
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
87
87
|
PRIMARY = "PRIMARY",
|
|
88
88
|
REDIRECT = "REDIRECT"
|
|
89
89
|
}
|
|
90
|
-
interface RedirectAssignmentInfo$
|
|
90
|
+
interface RedirectAssignmentInfo$1 {
|
|
91
91
|
/**
|
|
92
92
|
* Primary domain to which this domain will redirect.
|
|
93
93
|
* @readonly
|
|
94
94
|
*/
|
|
95
95
|
primaryDomain?: string;
|
|
96
96
|
}
|
|
97
|
-
declare enum DnsPropagationStatus$
|
|
97
|
+
declare enum DnsPropagationStatus$1 {
|
|
98
98
|
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
99
99
|
COMPLETED = "COMPLETED",
|
|
100
100
|
FAILED = "FAILED",
|
|
@@ -124,9 +124,9 @@ interface DeleteConnectedDomainResponse$1 {
|
|
|
124
124
|
}
|
|
125
125
|
interface ListConnectedDomainsRequest$1 {
|
|
126
126
|
/** Cursor paging options. */
|
|
127
|
-
paging?: CursorPaging$
|
|
127
|
+
paging?: CursorPaging$3;
|
|
128
128
|
}
|
|
129
|
-
interface CursorPaging$
|
|
129
|
+
interface CursorPaging$3 {
|
|
130
130
|
/**
|
|
131
131
|
* Number of domains to load.
|
|
132
132
|
*
|
|
@@ -145,15 +145,15 @@ interface CursorPaging$5 {
|
|
|
145
145
|
}
|
|
146
146
|
interface ListConnectedDomainsResponse$1 {
|
|
147
147
|
/** Metadata about the returned list of connected domains. */
|
|
148
|
-
pagingMetadata?: CursorPagingMetadata$
|
|
148
|
+
pagingMetadata?: CursorPagingMetadata$3;
|
|
149
149
|
/** Retrieved connected domains. */
|
|
150
150
|
connectedDomains?: ConnectedDomain$1[];
|
|
151
151
|
}
|
|
152
|
-
interface CursorPagingMetadata$
|
|
152
|
+
interface CursorPagingMetadata$3 {
|
|
153
153
|
/** Number of domains returned in the response. */
|
|
154
154
|
count?: number | null;
|
|
155
155
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
156
|
-
cursors?: Cursors$
|
|
156
|
+
cursors?: Cursors$3;
|
|
157
157
|
/**
|
|
158
158
|
* Indicates if there are more results after the current page.
|
|
159
159
|
* If `true`, another page of results can be retrieved.
|
|
@@ -161,26 +161,26 @@ interface CursorPagingMetadata$5 {
|
|
|
161
161
|
*/
|
|
162
162
|
hasNext?: boolean | null;
|
|
163
163
|
}
|
|
164
|
-
interface Cursors$
|
|
164
|
+
interface Cursors$3 {
|
|
165
165
|
/** Cursor pointing to next page in the list of results. */
|
|
166
166
|
next?: string | null;
|
|
167
167
|
/** Cursor pointing to previous page in the list of results. */
|
|
168
168
|
prev?: string | null;
|
|
169
169
|
}
|
|
170
|
-
interface RedirectAssignmentInfoNonNullableFields$
|
|
170
|
+
interface RedirectAssignmentInfoNonNullableFields$1 {
|
|
171
171
|
primaryDomain: string;
|
|
172
172
|
}
|
|
173
|
-
interface SiteInfoNonNullableFields$
|
|
174
|
-
redirectInfo?: RedirectAssignmentInfoNonNullableFields$
|
|
175
|
-
assignmentType: AssignmentType$
|
|
173
|
+
interface SiteInfoNonNullableFields$1 {
|
|
174
|
+
redirectInfo?: RedirectAssignmentInfoNonNullableFields$1;
|
|
175
|
+
assignmentType: AssignmentType$1;
|
|
176
176
|
}
|
|
177
177
|
interface ConnectedDomainNonNullableFields$1 {
|
|
178
178
|
id: string;
|
|
179
179
|
domain: string;
|
|
180
180
|
connectionType: ConnectionType$1;
|
|
181
|
-
siteInfo?: SiteInfoNonNullableFields$
|
|
181
|
+
siteInfo?: SiteInfoNonNullableFields$1;
|
|
182
182
|
suppressNotifications: boolean;
|
|
183
|
-
dnsPropagationStatus: DnsPropagationStatus$
|
|
183
|
+
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
184
184
|
}
|
|
185
185
|
interface CreateConnectedDomainResponseNonNullableFields$1 {
|
|
186
186
|
connectedDomain?: ConnectedDomainNonNullableFields$1;
|
|
@@ -217,7 +217,7 @@ interface ConnectedDomain {
|
|
|
217
217
|
* Information about the site to which the domain is assigned, and whether
|
|
218
218
|
* it's the primary domain or a redirect.
|
|
219
219
|
*/
|
|
220
|
-
siteInfo?: SiteInfo
|
|
220
|
+
siteInfo?: SiteInfo;
|
|
221
221
|
/**
|
|
222
222
|
* Whether the site owner receives standard email notifications from Wix about
|
|
223
223
|
* the connected domain.
|
|
@@ -234,7 +234,7 @@ interface ConnectedDomain {
|
|
|
234
234
|
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
235
235
|
* @readonly
|
|
236
236
|
*/
|
|
237
|
-
dnsPropagationStatus?: DnsPropagationStatus
|
|
237
|
+
dnsPropagationStatus?: DnsPropagationStatus;
|
|
238
238
|
}
|
|
239
239
|
declare enum ConnectionType {
|
|
240
240
|
/** Used by sub domain */
|
|
@@ -248,12 +248,12 @@ declare enum ConnectionType {
|
|
|
248
248
|
*/
|
|
249
249
|
HIDDEN = "HIDDEN"
|
|
250
250
|
}
|
|
251
|
-
interface SiteInfo
|
|
251
|
+
interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
|
|
252
252
|
/**
|
|
253
253
|
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
254
254
|
* @readonly
|
|
255
255
|
*/
|
|
256
|
-
redirectInfo?: RedirectAssignmentInfo
|
|
256
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
257
257
|
/**
|
|
258
258
|
* ID of the site to which the domain is assigned.
|
|
259
259
|
* @readonly
|
|
@@ -266,29 +266,29 @@ interface SiteInfo$2 extends SiteInfoAssignmentInfoOneOf$2 {
|
|
|
266
266
|
* + `"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.
|
|
267
267
|
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
268
268
|
*/
|
|
269
|
-
assignmentType?: AssignmentType
|
|
269
|
+
assignmentType?: AssignmentType;
|
|
270
270
|
}
|
|
271
271
|
/** @oneof */
|
|
272
|
-
interface SiteInfoAssignmentInfoOneOf
|
|
272
|
+
interface SiteInfoAssignmentInfoOneOf {
|
|
273
273
|
/**
|
|
274
274
|
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
275
275
|
* @readonly
|
|
276
276
|
*/
|
|
277
|
-
redirectInfo?: RedirectAssignmentInfo
|
|
277
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
278
278
|
}
|
|
279
|
-
declare enum AssignmentType
|
|
279
|
+
declare enum AssignmentType {
|
|
280
280
|
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
281
281
|
PRIMARY = "PRIMARY",
|
|
282
282
|
REDIRECT = "REDIRECT"
|
|
283
283
|
}
|
|
284
|
-
interface RedirectAssignmentInfo
|
|
284
|
+
interface RedirectAssignmentInfo {
|
|
285
285
|
/**
|
|
286
286
|
* Primary domain to which this domain will redirect.
|
|
287
287
|
* @readonly
|
|
288
288
|
*/
|
|
289
289
|
primaryDomain?: string;
|
|
290
290
|
}
|
|
291
|
-
declare enum DnsPropagationStatus
|
|
291
|
+
declare enum DnsPropagationStatus {
|
|
292
292
|
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
293
293
|
COMPLETED = "COMPLETED",
|
|
294
294
|
FAILED = "FAILED",
|
|
@@ -318,9 +318,9 @@ interface DeleteConnectedDomainResponse {
|
|
|
318
318
|
}
|
|
319
319
|
interface ListConnectedDomainsRequest {
|
|
320
320
|
/** Cursor paging options. */
|
|
321
|
-
paging?: CursorPaging$
|
|
321
|
+
paging?: CursorPaging$2;
|
|
322
322
|
}
|
|
323
|
-
interface CursorPaging$
|
|
323
|
+
interface CursorPaging$2 {
|
|
324
324
|
/**
|
|
325
325
|
* Number of domains to load.
|
|
326
326
|
*
|
|
@@ -339,15 +339,15 @@ interface CursorPaging$4 {
|
|
|
339
339
|
}
|
|
340
340
|
interface ListConnectedDomainsResponse {
|
|
341
341
|
/** Metadata about the returned list of connected domains. */
|
|
342
|
-
pagingMetadata?: CursorPagingMetadata$
|
|
342
|
+
pagingMetadata?: CursorPagingMetadata$2;
|
|
343
343
|
/** Retrieved connected domains. */
|
|
344
344
|
connectedDomains?: ConnectedDomain[];
|
|
345
345
|
}
|
|
346
|
-
interface CursorPagingMetadata$
|
|
346
|
+
interface CursorPagingMetadata$2 {
|
|
347
347
|
/** Number of domains returned in the response. */
|
|
348
348
|
count?: number | null;
|
|
349
349
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
350
|
-
cursors?: Cursors$
|
|
350
|
+
cursors?: Cursors$2;
|
|
351
351
|
/**
|
|
352
352
|
* Indicates if there are more results after the current page.
|
|
353
353
|
* If `true`, another page of results can be retrieved.
|
|
@@ -355,26 +355,26 @@ interface CursorPagingMetadata$4 {
|
|
|
355
355
|
*/
|
|
356
356
|
hasNext?: boolean | null;
|
|
357
357
|
}
|
|
358
|
-
interface Cursors$
|
|
358
|
+
interface Cursors$2 {
|
|
359
359
|
/** Cursor pointing to next page in the list of results. */
|
|
360
360
|
next?: string | null;
|
|
361
361
|
/** Cursor pointing to previous page in the list of results. */
|
|
362
362
|
prev?: string | null;
|
|
363
363
|
}
|
|
364
|
-
interface RedirectAssignmentInfoNonNullableFields
|
|
364
|
+
interface RedirectAssignmentInfoNonNullableFields {
|
|
365
365
|
primaryDomain: string;
|
|
366
366
|
}
|
|
367
|
-
interface SiteInfoNonNullableFields
|
|
368
|
-
redirectInfo?: RedirectAssignmentInfoNonNullableFields
|
|
369
|
-
assignmentType: AssignmentType
|
|
367
|
+
interface SiteInfoNonNullableFields {
|
|
368
|
+
redirectInfo?: RedirectAssignmentInfoNonNullableFields;
|
|
369
|
+
assignmentType: AssignmentType;
|
|
370
370
|
}
|
|
371
371
|
interface ConnectedDomainNonNullableFields {
|
|
372
372
|
_id: string;
|
|
373
373
|
domain: string;
|
|
374
374
|
connectionType: ConnectionType;
|
|
375
|
-
siteInfo?: SiteInfoNonNullableFields
|
|
375
|
+
siteInfo?: SiteInfoNonNullableFields;
|
|
376
376
|
suppressNotifications: boolean;
|
|
377
|
-
dnsPropagationStatus: DnsPropagationStatus
|
|
377
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
378
378
|
}
|
|
379
379
|
interface CreateConnectedDomainResponseNonNullableFields {
|
|
380
380
|
connectedDomain?: ConnectedDomainNonNullableFields;
|
|
@@ -386,7 +386,7 @@ interface ListConnectedDomainsResponseNonNullableFields {
|
|
|
386
386
|
connectedDomains: ConnectedDomainNonNullableFields[];
|
|
387
387
|
}
|
|
388
388
|
|
|
389
|
-
type __PublicMethodMetaInfo$
|
|
389
|
+
type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
390
390
|
getUrl: (context: any) => string;
|
|
391
391
|
httpMethod: K;
|
|
392
392
|
path: string;
|
|
@@ -396,21 +396,21 @@ type __PublicMethodMetaInfo$5<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
396
396
|
__responseType: Q;
|
|
397
397
|
__originalResponseType: R;
|
|
398
398
|
};
|
|
399
|
-
declare function createConnectedDomain(): __PublicMethodMetaInfo$
|
|
400
|
-
declare function getConnectedDomain(): __PublicMethodMetaInfo$
|
|
399
|
+
declare function createConnectedDomain(): __PublicMethodMetaInfo$4<'POST', {}, CreateConnectedDomainRequest, CreateConnectedDomainRequest$1, CreateConnectedDomainResponse & CreateConnectedDomainResponseNonNullableFields, CreateConnectedDomainResponse$1 & CreateConnectedDomainResponseNonNullableFields$1>;
|
|
400
|
+
declare function getConnectedDomain(): __PublicMethodMetaInfo$4<'GET', {
|
|
401
401
|
connectedDomainId: string;
|
|
402
402
|
}, GetConnectedDomainRequest, GetConnectedDomainRequest$1, GetConnectedDomainResponse & GetConnectedDomainResponseNonNullableFields, GetConnectedDomainResponse$1 & GetConnectedDomainResponseNonNullableFields$1>;
|
|
403
|
-
declare function deleteConnectedDomain(): __PublicMethodMetaInfo$
|
|
403
|
+
declare function deleteConnectedDomain(): __PublicMethodMetaInfo$4<'DELETE', {
|
|
404
404
|
connectedDomainId: string;
|
|
405
405
|
}, DeleteConnectedDomainRequest, DeleteConnectedDomainRequest$1, DeleteConnectedDomainResponse, DeleteConnectedDomainResponse$1>;
|
|
406
|
-
declare function listConnectedDomains(): __PublicMethodMetaInfo$
|
|
406
|
+
declare function listConnectedDomains(): __PublicMethodMetaInfo$4<'GET', {}, ListConnectedDomainsRequest, ListConnectedDomainsRequest$1, ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields, ListConnectedDomainsResponse$1 & ListConnectedDomainsResponseNonNullableFields$1>;
|
|
407
407
|
|
|
408
|
-
declare const meta$
|
|
409
|
-
declare const meta$
|
|
410
|
-
declare const meta$
|
|
411
|
-
declare const meta$
|
|
412
|
-
declare namespace meta$
|
|
413
|
-
export { type __PublicMethodMetaInfo$
|
|
408
|
+
declare const meta$4_createConnectedDomain: typeof createConnectedDomain;
|
|
409
|
+
declare const meta$4_deleteConnectedDomain: typeof deleteConnectedDomain;
|
|
410
|
+
declare const meta$4_getConnectedDomain: typeof getConnectedDomain;
|
|
411
|
+
declare const meta$4_listConnectedDomains: typeof listConnectedDomains;
|
|
412
|
+
declare namespace meta$4 {
|
|
413
|
+
export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_createConnectedDomain as createConnectedDomain, meta$4_deleteConnectedDomain as deleteConnectedDomain, meta$4_getConnectedDomain as getConnectedDomain, meta$4_listConnectedDomains as listConnectedDomains };
|
|
414
414
|
}
|
|
415
415
|
|
|
416
416
|
/**
|
|
@@ -753,7 +753,7 @@ interface GetConnectedDomainSetupInfoResponseNonNullableFields {
|
|
|
753
753
|
connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields;
|
|
754
754
|
}
|
|
755
755
|
|
|
756
|
-
type __PublicMethodMetaInfo$
|
|
756
|
+
type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
757
757
|
getUrl: (context: any) => string;
|
|
758
758
|
httpMethod: K;
|
|
759
759
|
path: string;
|
|
@@ -763,13 +763,13 @@ type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
763
763
|
__responseType: Q;
|
|
764
764
|
__originalResponseType: R;
|
|
765
765
|
};
|
|
766
|
-
declare function getConnectedDomainSetupInfo(): __PublicMethodMetaInfo$
|
|
766
|
+
declare function getConnectedDomainSetupInfo(): __PublicMethodMetaInfo$3<'GET', {
|
|
767
767
|
connectedDomainId: string;
|
|
768
768
|
}, GetConnectedDomainSetupInfoRequest, GetConnectedDomainSetupInfoRequest$1, GetConnectedDomainSetupInfoResponse & GetConnectedDomainSetupInfoResponseNonNullableFields, GetConnectedDomainSetupInfoResponse$1 & GetConnectedDomainSetupInfoResponseNonNullableFields$1>;
|
|
769
769
|
|
|
770
|
-
declare const meta$
|
|
771
|
-
declare namespace meta$
|
|
772
|
-
export { type __PublicMethodMetaInfo$
|
|
770
|
+
declare const meta$3_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
|
|
771
|
+
declare namespace meta$3 {
|
|
772
|
+
export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
773
773
|
}
|
|
774
774
|
|
|
775
775
|
/** DNS zones hold information about the records that map a domain's URL to an IP address. */
|
|
@@ -1132,7 +1132,7 @@ interface PreviewDnsZoneResponseNonNullableFields {
|
|
|
1132
1132
|
dnsZone?: DnsZoneNonNullableFields;
|
|
1133
1133
|
}
|
|
1134
1134
|
|
|
1135
|
-
type __PublicMethodMetaInfo$
|
|
1135
|
+
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1136
1136
|
getUrl: (context: any) => string;
|
|
1137
1137
|
httpMethod: K;
|
|
1138
1138
|
path: string;
|
|
@@ -1142,1114 +1142,27 @@ type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
1142
1142
|
__responseType: Q;
|
|
1143
1143
|
__originalResponseType: R;
|
|
1144
1144
|
};
|
|
1145
|
-
declare function createDnsZone(): __PublicMethodMetaInfo$
|
|
1146
|
-
declare function getDnsZone(): __PublicMethodMetaInfo$
|
|
1145
|
+
declare function createDnsZone(): __PublicMethodMetaInfo$2<'POST', {}, CreateDnsZoneRequest, CreateDnsZoneRequest$1, CreateDnsZoneResponse & CreateDnsZoneResponseNonNullableFields, CreateDnsZoneResponse$1 & CreateDnsZoneResponseNonNullableFields$1>;
|
|
1146
|
+
declare function getDnsZone(): __PublicMethodMetaInfo$2<'GET', {
|
|
1147
1147
|
domainName: string;
|
|
1148
1148
|
}, GetDnsZoneRequest, GetDnsZoneRequest$1, GetDnsZoneResponse & GetDnsZoneResponseNonNullableFields, GetDnsZoneResponse$1 & GetDnsZoneResponseNonNullableFields$1>;
|
|
1149
|
-
declare function updateDnsZone(): __PublicMethodMetaInfo$
|
|
1149
|
+
declare function updateDnsZone(): __PublicMethodMetaInfo$2<'PATCH', {
|
|
1150
1150
|
domainName: string;
|
|
1151
1151
|
}, UpdateDnsZoneRequest, UpdateDnsZoneRequest$1, UpdateDnsZoneResponse & UpdateDnsZoneResponseNonNullableFields, UpdateDnsZoneResponse$1 & UpdateDnsZoneResponseNonNullableFields$1>;
|
|
1152
|
-
declare function deleteDnsZone(): __PublicMethodMetaInfo$
|
|
1152
|
+
declare function deleteDnsZone(): __PublicMethodMetaInfo$2<'DELETE', {
|
|
1153
1153
|
domainName: string;
|
|
1154
1154
|
}, DeleteDnsZoneRequest, DeleteDnsZoneRequest$1, DeleteDnsZoneResponse, DeleteDnsZoneResponse$1>;
|
|
1155
|
-
declare function previewDnsZone(): __PublicMethodMetaInfo$
|
|
1155
|
+
declare function previewDnsZone(): __PublicMethodMetaInfo$2<'GET', {
|
|
1156
1156
|
domainName: string;
|
|
1157
1157
|
}, PreviewDnsZoneRequest, PreviewDnsZoneRequest$1, PreviewDnsZoneResponse & PreviewDnsZoneResponseNonNullableFields, PreviewDnsZoneResponse$1 & PreviewDnsZoneResponseNonNullableFields$1>;
|
|
1158
1158
|
|
|
1159
|
-
declare const meta$
|
|
1160
|
-
declare const meta$
|
|
1161
|
-
declare const meta$
|
|
1162
|
-
declare const meta$
|
|
1163
|
-
declare const meta$
|
|
1164
|
-
declare namespace meta$3 {
|
|
1165
|
-
export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_createDnsZone as createDnsZone, meta$3_deleteDnsZone as deleteDnsZone, meta$3_getDnsZone as getDnsZone, meta$3_previewDnsZone as previewDnsZone, meta$3_updateDnsZone as updateDnsZone };
|
|
1166
|
-
}
|
|
1167
|
-
|
|
1168
|
-
/**
|
|
1169
|
-
* A registered domain is a domain that Wix has registered on behalf of a customer
|
|
1170
|
-
* with an external registar.
|
|
1171
|
-
*/
|
|
1172
|
-
interface RegisteredDomain$1 extends RegisteredDomainStatusInfoOneOf$1 {
|
|
1173
|
-
/**
|
|
1174
|
-
* Information about a domain that hasn't been successfully registered
|
|
1175
|
-
* yet. Includes the timestamp of the latest registration attempt.
|
|
1176
|
-
* @readonly
|
|
1177
|
-
*/
|
|
1178
|
-
pendingRegistrationInfo?: PendingRegistrationInfo$1;
|
|
1179
|
-
/**
|
|
1180
|
-
* Information about a domain that couldn't be registered. Includes
|
|
1181
|
-
* failure code and message.
|
|
1182
|
-
* @readonly
|
|
1183
|
-
*/
|
|
1184
|
-
failedRegistrationInfo?: FailedRegistrationInfo$1;
|
|
1185
|
-
/**
|
|
1186
|
-
* Domain ID. Identical to `domain`.
|
|
1187
|
-
* @readonly
|
|
1188
|
-
*/
|
|
1189
|
-
id?: string;
|
|
1190
|
-
/**
|
|
1191
|
-
* Name of the domain including TLD.
|
|
1192
|
-
* Subdomains aren't supported. You can only register a root domain.
|
|
1193
|
-
* Domain name and TLD must be separated by a dot. For example,
|
|
1194
|
-
* `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
|
|
1195
|
-
* supported.
|
|
1196
|
-
*
|
|
1197
|
-
* Min: 3 characters
|
|
1198
|
-
* Max: 63 characters
|
|
1199
|
-
*/
|
|
1200
|
-
domain?: string;
|
|
1201
|
-
/**
|
|
1202
|
-
* ID of the product instance from the
|
|
1203
|
-
* [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
|
|
1204
|
-
* that belongs to the `registeredDomain` object.
|
|
1205
|
-
* Your account must own a product that supports the chosen TLD, regardless of
|
|
1206
|
-
* whether you want to assign the domain to a site or keep it floating. If
|
|
1207
|
-
* you want to assign the domain to a site, the relevant site must also
|
|
1208
|
-
* own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
|
|
1209
|
-
* for more information about how to become a reseller and a list of available
|
|
1210
|
-
* product IDs.
|
|
1211
|
-
*/
|
|
1212
|
-
productInstanceId?: string;
|
|
1213
|
-
/**
|
|
1214
|
-
* Date and time the `registeredDomain` object was created in
|
|
1215
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1216
|
-
* @readonly
|
|
1217
|
-
*/
|
|
1218
|
-
createdDate?: Date;
|
|
1219
|
-
/**
|
|
1220
|
-
* Date and time the `registeredDomain` object was last updated in
|
|
1221
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1222
|
-
* @readonly
|
|
1223
|
-
*/
|
|
1224
|
-
updatedDate?: Date;
|
|
1225
|
-
/**
|
|
1226
|
-
* Revision number, which increments by 1 each time the registered domain
|
|
1227
|
-
* is updated. To prevent conflicting changes, the current revision must be
|
|
1228
|
-
* passed when updating the registered domain.
|
|
1229
|
-
*
|
|
1230
|
-
* Ignored when creating a registered domain.
|
|
1231
|
-
*/
|
|
1232
|
-
revision?: string | null;
|
|
1233
|
-
/**
|
|
1234
|
-
* Information about the Wix site the domain is connected to and whether the
|
|
1235
|
-
* domain is assigned as the primary domain or a redirect.
|
|
1236
|
-
*/
|
|
1237
|
-
siteInfo?: SiteInfo$1;
|
|
1238
|
-
/**
|
|
1239
|
-
* Contact details for the registrant, admin, and tech support of the registered domain.
|
|
1240
|
-
* You can read more about which
|
|
1241
|
-
* [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
|
|
1242
|
-
* are implemented.
|
|
1243
|
-
*/
|
|
1244
|
-
contacts?: Contacts$1;
|
|
1245
|
-
/**
|
|
1246
|
-
* Status of the registered domain.
|
|
1247
|
-
*
|
|
1248
|
-
* + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
|
|
1249
|
-
* + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
|
|
1250
|
-
* + `"ACTIVE"`: The domain has been registered successfully and is active.
|
|
1251
|
-
* + `"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.
|
|
1252
|
-
* + `"CANCELED"`: The domain has been canceled and isn't active any longer.
|
|
1253
|
-
* @readonly
|
|
1254
|
-
*/
|
|
1255
|
-
status?: Status$1;
|
|
1256
|
-
/**
|
|
1257
|
-
* ICANN confirmation status.
|
|
1258
|
-
*
|
|
1259
|
-
* + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
|
|
1260
|
-
* + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
|
|
1261
|
-
* + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
|
|
1262
|
-
* + `"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.
|
|
1263
|
-
* @readonly
|
|
1264
|
-
*/
|
|
1265
|
-
icannConfirmationStatus?: ICANNConfirmationStatus$1;
|
|
1266
|
-
/**
|
|
1267
|
-
* Details about the ICANN confirmation status.
|
|
1268
|
-
* @readonly
|
|
1269
|
-
*/
|
|
1270
|
-
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo$1;
|
|
1271
|
-
/**
|
|
1272
|
-
* DNS propagation status.
|
|
1273
|
-
*
|
|
1274
|
-
* + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
|
|
1275
|
-
* + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
|
|
1276
|
-
* + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
|
|
1277
|
-
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
1278
|
-
* @readonly
|
|
1279
|
-
*/
|
|
1280
|
-
dnsPropagationStatus?: DnsPropagationStatus$1;
|
|
1281
|
-
/**
|
|
1282
|
-
* Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
|
|
1283
|
-
* format.
|
|
1284
|
-
* @readonly
|
|
1285
|
-
*/
|
|
1286
|
-
expirationDate?: Date;
|
|
1287
|
-
}
|
|
1288
|
-
/** @oneof */
|
|
1289
|
-
interface RegisteredDomainStatusInfoOneOf$1 {
|
|
1290
|
-
/**
|
|
1291
|
-
* Information about a domain that hasn't been successfully registered
|
|
1292
|
-
* yet. Includes the timestamp of the latest registration attempt.
|
|
1293
|
-
* @readonly
|
|
1294
|
-
*/
|
|
1295
|
-
pendingRegistrationInfo?: PendingRegistrationInfo$1;
|
|
1296
|
-
/**
|
|
1297
|
-
* Information about a domain that couldn't be registered. Includes
|
|
1298
|
-
* failure code and message.
|
|
1299
|
-
* @readonly
|
|
1300
|
-
*/
|
|
1301
|
-
failedRegistrationInfo?: FailedRegistrationInfo$1;
|
|
1302
|
-
}
|
|
1303
|
-
interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
|
|
1304
|
-
/**
|
|
1305
|
-
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1306
|
-
* @readonly
|
|
1307
|
-
*/
|
|
1308
|
-
redirectInfo?: RedirectAssignmentInfo$1;
|
|
1309
|
-
/**
|
|
1310
|
-
* ID of the site to which the domain is assigned.
|
|
1311
|
-
* @readonly
|
|
1312
|
-
*/
|
|
1313
|
-
id?: string | null;
|
|
1314
|
-
/**
|
|
1315
|
-
* Whether the domain is assigned as the primary domain or a redirect.
|
|
1316
|
-
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
1317
|
-
* __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
|
|
1318
|
-
* in the request of the Create Registered Domain call.
|
|
1319
|
-
*
|
|
1320
|
-
* + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
|
|
1321
|
-
* + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
|
|
1322
|
-
* + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
|
|
1323
|
-
*/
|
|
1324
|
-
assignmentType?: AssignmentType$1;
|
|
1325
|
-
}
|
|
1326
|
-
/** @oneof */
|
|
1327
|
-
interface SiteInfoAssignmentInfoOneOf$1 {
|
|
1328
|
-
/**
|
|
1329
|
-
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1330
|
-
* @readonly
|
|
1331
|
-
*/
|
|
1332
|
-
redirectInfo?: RedirectAssignmentInfo$1;
|
|
1333
|
-
}
|
|
1334
|
-
declare enum AssignmentType$1 {
|
|
1335
|
-
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
1336
|
-
PRIMARY = "PRIMARY",
|
|
1337
|
-
REDIRECT = "REDIRECT"
|
|
1338
|
-
}
|
|
1339
|
-
interface RedirectAssignmentInfo$1 {
|
|
1340
|
-
/**
|
|
1341
|
-
* Primary domain the redirect points to.
|
|
1342
|
-
* @readonly
|
|
1343
|
-
*/
|
|
1344
|
-
primaryDomain?: string;
|
|
1345
|
-
}
|
|
1346
|
-
interface Contacts$1 {
|
|
1347
|
-
/** Contact information for the domain registrant. */
|
|
1348
|
-
registrant?: ContactData$1;
|
|
1349
|
-
/** Contact information for the domain admin. */
|
|
1350
|
-
admin?: ContactData$1;
|
|
1351
|
-
/** Contact information for the tech support of the domain. */
|
|
1352
|
-
tech?: ContactData$1;
|
|
1353
|
-
}
|
|
1354
|
-
interface ContactData$1 {
|
|
1355
|
-
/**
|
|
1356
|
-
* First name. Only
|
|
1357
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1358
|
-
* are supported.
|
|
1359
|
-
*
|
|
1360
|
-
* Min: 2 characters
|
|
1361
|
-
* Max: 64 characters
|
|
1362
|
-
*/
|
|
1363
|
-
firstName?: string;
|
|
1364
|
-
/**
|
|
1365
|
-
* Last name. Only
|
|
1366
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1367
|
-
* are supported.
|
|
1368
|
-
*
|
|
1369
|
-
* Min: 2 characters
|
|
1370
|
-
* Max: 64 characters
|
|
1371
|
-
*/
|
|
1372
|
-
lastName?: string;
|
|
1373
|
-
/**
|
|
1374
|
-
* Email address. Only
|
|
1375
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1376
|
-
* and a single `@` are supported. Wix doesn't validate that the email address
|
|
1377
|
-
* exists.
|
|
1378
|
-
*
|
|
1379
|
-
* Min: 3 characters
|
|
1380
|
-
* Max: 64 characters before the `@` and 63 after
|
|
1381
|
-
*/
|
|
1382
|
-
email?: string;
|
|
1383
|
-
/**
|
|
1384
|
-
* Address details, including street name and house number. Only
|
|
1385
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1386
|
-
* are supported.
|
|
1387
|
-
*
|
|
1388
|
-
* Min: 2 characters
|
|
1389
|
-
* Max: 64 characters
|
|
1390
|
-
*/
|
|
1391
|
-
address?: string;
|
|
1392
|
-
/**
|
|
1393
|
-
* City. Only
|
|
1394
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1395
|
-
* are supported.
|
|
1396
|
-
*
|
|
1397
|
-
* Min: 2 characters
|
|
1398
|
-
* Max: 64 characters
|
|
1399
|
-
*/
|
|
1400
|
-
city?: string;
|
|
1401
|
-
/**
|
|
1402
|
-
* Subdivision code in
|
|
1403
|
-
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
|
|
1404
|
-
* format. Only
|
|
1405
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1406
|
-
* are supported.
|
|
1407
|
-
* __Required__ for these countries:
|
|
1408
|
-
* `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
|
|
1409
|
-
* `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
|
|
1410
|
-
* `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
|
|
1411
|
-
* `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
|
|
1412
|
-
* `"TW"`, `"UA"`, `"US"`, `”ZA”`.
|
|
1413
|
-
*
|
|
1414
|
-
* Min: 2 characters
|
|
1415
|
-
* Max: 2 characters
|
|
1416
|
-
*/
|
|
1417
|
-
subdivisionCode?: string | null;
|
|
1418
|
-
/**
|
|
1419
|
-
* Postal code. Only
|
|
1420
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1421
|
-
* are supported.
|
|
1422
|
-
*
|
|
1423
|
-
* Min: 2 characters
|
|
1424
|
-
* Max: 16 characters
|
|
1425
|
-
*/
|
|
1426
|
-
postalCode?: string | null;
|
|
1427
|
-
/**
|
|
1428
|
-
* Country code in
|
|
1429
|
-
* [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
|
|
1430
|
-
* format. Only
|
|
1431
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1432
|
-
* are supported. Wix doesn't validate that the postal code is valid for the
|
|
1433
|
-
* given country.
|
|
1434
|
-
*
|
|
1435
|
-
* Min: 2 characters
|
|
1436
|
-
* Max: 2 characters
|
|
1437
|
-
*/
|
|
1438
|
-
countryCode?: string;
|
|
1439
|
-
/**
|
|
1440
|
-
* Phone number. Only
|
|
1441
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1442
|
-
* are supported. For example, `+15551234567`. Wix doesn't validate that the
|
|
1443
|
-
* phone number belongs to the specified country.
|
|
1444
|
-
*
|
|
1445
|
-
* Min: 2 characters
|
|
1446
|
-
* Max: 20 characters
|
|
1447
|
-
*/
|
|
1448
|
-
phone?: string;
|
|
1449
|
-
/**
|
|
1450
|
-
* Company name. Only
|
|
1451
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1452
|
-
* are supported.
|
|
1453
|
-
*
|
|
1454
|
-
* Max: 2 characters
|
|
1455
|
-
* Max: 64 characters
|
|
1456
|
-
*/
|
|
1457
|
-
company?: string | null;
|
|
1458
|
-
}
|
|
1459
|
-
declare enum Status$1 {
|
|
1460
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1461
|
-
PENDING_REGISTRATION = "PENDING_REGISTRATION",
|
|
1462
|
-
ACTIVE = "ACTIVE",
|
|
1463
|
-
FAILED_REGISTRATION = "FAILED_REGISTRATION",
|
|
1464
|
-
CANCELED = "CANCELED"
|
|
1465
|
-
}
|
|
1466
|
-
interface PendingRegistrationInfo$1 {
|
|
1467
|
-
/**
|
|
1468
|
-
* Information about the latest attempt to register
|
|
1469
|
-
* the domain. Wix tries to register the domain several times if the
|
|
1470
|
-
* first attempt is unsuccessful. You can contact the
|
|
1471
|
-
* [Wix B2B team](mailto:bizdev@wix.com)
|
|
1472
|
-
* for more information about the number of attempts and their timing.
|
|
1473
|
-
* @readonly
|
|
1474
|
-
*/
|
|
1475
|
-
latestAttempt?: LatestAttempt$1;
|
|
1476
|
-
}
|
|
1477
|
-
interface LatestAttempt$1 {
|
|
1478
|
-
/**
|
|
1479
|
-
* Number of the latest attempt to register the domain.
|
|
1480
|
-
* @readonly
|
|
1481
|
-
*/
|
|
1482
|
-
number?: number;
|
|
1483
|
-
/**
|
|
1484
|
-
* Date and time of the latest domain registration attempt in
|
|
1485
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1486
|
-
* @readonly
|
|
1487
|
-
*/
|
|
1488
|
-
timestamp?: Date;
|
|
1489
|
-
}
|
|
1490
|
-
interface FailedRegistrationInfo$1 {
|
|
1491
|
-
/**
|
|
1492
|
-
* Failure code.
|
|
1493
|
-
*
|
|
1494
|
-
* + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
|
|
1495
|
-
* + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
|
|
1496
|
-
* @readonly
|
|
1497
|
-
*/
|
|
1498
|
-
code?: FailureCode$1;
|
|
1499
|
-
/**
|
|
1500
|
-
* Failure message.
|
|
1501
|
-
* @readonly
|
|
1502
|
-
*/
|
|
1503
|
-
message?: string;
|
|
1504
|
-
}
|
|
1505
|
-
declare enum FailureCode$1 {
|
|
1506
|
-
UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
|
|
1507
|
-
OTHER = "OTHER"
|
|
1508
|
-
}
|
|
1509
|
-
/**
|
|
1510
|
-
* he confirmation status types, a record:
|
|
1511
|
-
* starts at pending
|
|
1512
|
-
* ends either at confirmed_by_all or expired
|
|
1513
|
-
*/
|
|
1514
|
-
declare enum ICANNConfirmationStatus$1 {
|
|
1515
|
-
UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
|
|
1516
|
-
PENDING = "PENDING",
|
|
1517
|
-
CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
|
|
1518
|
-
EXPIRED = "EXPIRED"
|
|
1519
|
-
}
|
|
1520
|
-
interface ICANNConfirmationStatusInfo$1 extends ICANNConfirmationStatusInfoStatusOneOf$1 {
|
|
1521
|
-
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
1522
|
-
pending?: Pending$1;
|
|
1523
|
-
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
1524
|
-
expired?: Expired$1;
|
|
1525
|
-
}
|
|
1526
|
-
/** @oneof */
|
|
1527
|
-
interface ICANNConfirmationStatusInfoStatusOneOf$1 {
|
|
1528
|
-
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
1529
|
-
pending?: Pending$1;
|
|
1530
|
-
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
1531
|
-
expired?: Expired$1;
|
|
1532
|
-
}
|
|
1533
|
-
interface Pending$1 {
|
|
1534
|
-
/**
|
|
1535
|
-
* Expiration date of the ICANN confirmation process in
|
|
1536
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
|
|
1537
|
-
* before this date or the domain won't be active.
|
|
1538
|
-
*/
|
|
1539
|
-
expirationDate?: Date;
|
|
1540
|
-
/**
|
|
1541
|
-
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
1542
|
-
* yet.
|
|
1543
|
-
*/
|
|
1544
|
-
notConfirmedBy?: string[];
|
|
1545
|
-
}
|
|
1546
|
-
interface Expired$1 {
|
|
1547
|
-
/**
|
|
1548
|
-
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
1549
|
-
* in time.
|
|
1550
|
-
*/
|
|
1551
|
-
notConfirmedBy?: string[];
|
|
1552
|
-
}
|
|
1553
|
-
declare enum DnsPropagationStatus$1 {
|
|
1554
|
-
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
1555
|
-
COMPLETED = "COMPLETED",
|
|
1556
|
-
FAILED = "FAILED",
|
|
1557
|
-
IN_PROGRESS = "IN_PROGRESS"
|
|
1558
|
-
}
|
|
1559
|
-
interface CreateRegisteredDomainRequest$1 {
|
|
1560
|
-
/** Information about the domain to register including contact details. */
|
|
1561
|
-
registeredDomain: RegisteredDomain$1;
|
|
1562
|
-
}
|
|
1563
|
-
interface CreateRegisteredDomainResponse$1 {
|
|
1564
|
-
/** Created registered domain. */
|
|
1565
|
-
registeredDomain?: RegisteredDomain$1;
|
|
1566
|
-
}
|
|
1567
|
-
interface GetRegisteredDomainRequest$1 {
|
|
1568
|
-
/** ID of the registered domain to retrieve. */
|
|
1569
|
-
registeredDomainId: string;
|
|
1570
|
-
}
|
|
1571
|
-
interface GetRegisteredDomainResponse$1 {
|
|
1572
|
-
/** Retrieved registered domain. */
|
|
1573
|
-
registeredDomain?: RegisteredDomain$1;
|
|
1574
|
-
}
|
|
1575
|
-
interface ListRegisteredDomainsRequest$1 {
|
|
1576
|
-
/** Cursor paging options. */
|
|
1577
|
-
paging?: CursorPaging$3;
|
|
1578
|
-
}
|
|
1579
|
-
interface CursorPaging$3 {
|
|
1580
|
-
/**
|
|
1581
|
-
* Number of domains to load.
|
|
1582
|
-
*
|
|
1583
|
-
* Min: `0`
|
|
1584
|
-
* Max: `100`
|
|
1585
|
-
*/
|
|
1586
|
-
limit?: number | null;
|
|
1587
|
-
/**
|
|
1588
|
-
* Pointer to the next or previous page in the list of results.
|
|
1589
|
-
*
|
|
1590
|
-
* You can get the relevant cursor token
|
|
1591
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1592
|
-
* Not relevant for the first request.
|
|
1593
|
-
*/
|
|
1594
|
-
cursor?: string | null;
|
|
1595
|
-
}
|
|
1596
|
-
interface ListRegisteredDomainsResponse$1 {
|
|
1597
|
-
/** Metadata about the returned list of registered domains. */
|
|
1598
|
-
pagingMetadata?: CursorPagingMetadata$3;
|
|
1599
|
-
/** Retrieved registered domains. */
|
|
1600
|
-
registeredDomains?: RegisteredDomain$1[];
|
|
1601
|
-
}
|
|
1602
|
-
interface CursorPagingMetadata$3 {
|
|
1603
|
-
/** Number of domains returned in the response. */
|
|
1604
|
-
count?: number | null;
|
|
1605
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1606
|
-
cursors?: Cursors$3;
|
|
1607
|
-
/**
|
|
1608
|
-
* Indicates if there are more results after the current page.
|
|
1609
|
-
* If `true`, another page of results can be retrieved.
|
|
1610
|
-
* If `false`, this is the last page.
|
|
1611
|
-
*/
|
|
1612
|
-
hasNext?: boolean | null;
|
|
1613
|
-
}
|
|
1614
|
-
interface Cursors$3 {
|
|
1615
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1616
|
-
next?: string | null;
|
|
1617
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
1618
|
-
prev?: string | null;
|
|
1619
|
-
}
|
|
1620
|
-
interface RedeemRegisteredDomainRequest$1 {
|
|
1621
|
-
/**
|
|
1622
|
-
* ID of the registered domain to redeem. Identical to the domain name
|
|
1623
|
-
* including TLD.
|
|
1624
|
-
*/
|
|
1625
|
-
registeredDomainId: string;
|
|
1626
|
-
}
|
|
1627
|
-
interface RedeemRegisteredDomainResponse$1 {
|
|
1628
|
-
/** Registered domain to redeem. */
|
|
1629
|
-
registeredDomain?: RegisteredDomain$1;
|
|
1630
|
-
}
|
|
1631
|
-
interface LatestAttemptNonNullableFields$1 {
|
|
1632
|
-
number: number;
|
|
1633
|
-
}
|
|
1634
|
-
interface PendingRegistrationInfoNonNullableFields$1 {
|
|
1635
|
-
latestAttempt?: LatestAttemptNonNullableFields$1;
|
|
1636
|
-
}
|
|
1637
|
-
interface FailedRegistrationInfoNonNullableFields$1 {
|
|
1638
|
-
code: FailureCode$1;
|
|
1639
|
-
message: string;
|
|
1640
|
-
}
|
|
1641
|
-
interface RedirectAssignmentInfoNonNullableFields$1 {
|
|
1642
|
-
primaryDomain: string;
|
|
1643
|
-
}
|
|
1644
|
-
interface SiteInfoNonNullableFields$1 {
|
|
1645
|
-
redirectInfo?: RedirectAssignmentInfoNonNullableFields$1;
|
|
1646
|
-
assignmentType: AssignmentType$1;
|
|
1647
|
-
}
|
|
1648
|
-
interface ContactDataNonNullableFields$1 {
|
|
1649
|
-
firstName: string;
|
|
1650
|
-
lastName: string;
|
|
1651
|
-
email: string;
|
|
1652
|
-
address: string;
|
|
1653
|
-
city: string;
|
|
1654
|
-
countryCode: string;
|
|
1655
|
-
phone: string;
|
|
1656
|
-
}
|
|
1657
|
-
interface ContactsNonNullableFields$1 {
|
|
1658
|
-
registrant?: ContactDataNonNullableFields$1;
|
|
1659
|
-
admin?: ContactDataNonNullableFields$1;
|
|
1660
|
-
tech?: ContactDataNonNullableFields$1;
|
|
1661
|
-
}
|
|
1662
|
-
interface PendingNonNullableFields$1 {
|
|
1663
|
-
notConfirmedBy: string[];
|
|
1664
|
-
}
|
|
1665
|
-
interface ExpiredNonNullableFields$1 {
|
|
1666
|
-
notConfirmedBy: string[];
|
|
1667
|
-
}
|
|
1668
|
-
interface ICANNConfirmationStatusInfoNonNullableFields$1 {
|
|
1669
|
-
pending?: PendingNonNullableFields$1;
|
|
1670
|
-
expired?: ExpiredNonNullableFields$1;
|
|
1671
|
-
}
|
|
1672
|
-
interface RegisteredDomainNonNullableFields$1 {
|
|
1673
|
-
pendingRegistrationInfo?: PendingRegistrationInfoNonNullableFields$1;
|
|
1674
|
-
failedRegistrationInfo?: FailedRegistrationInfoNonNullableFields$1;
|
|
1675
|
-
id: string;
|
|
1676
|
-
domain: string;
|
|
1677
|
-
productInstanceId: string;
|
|
1678
|
-
siteInfo?: SiteInfoNonNullableFields$1;
|
|
1679
|
-
contacts?: ContactsNonNullableFields$1;
|
|
1680
|
-
status: Status$1;
|
|
1681
|
-
icannConfirmationStatus: ICANNConfirmationStatus$1;
|
|
1682
|
-
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfoNonNullableFields$1;
|
|
1683
|
-
dnsPropagationStatus: DnsPropagationStatus$1;
|
|
1684
|
-
}
|
|
1685
|
-
interface CreateRegisteredDomainResponseNonNullableFields$1 {
|
|
1686
|
-
registeredDomain?: RegisteredDomainNonNullableFields$1;
|
|
1687
|
-
}
|
|
1688
|
-
interface GetRegisteredDomainResponseNonNullableFields$1 {
|
|
1689
|
-
registeredDomain?: RegisteredDomainNonNullableFields$1;
|
|
1690
|
-
}
|
|
1691
|
-
interface ListRegisteredDomainsResponseNonNullableFields$1 {
|
|
1692
|
-
registeredDomains: RegisteredDomainNonNullableFields$1[];
|
|
1693
|
-
}
|
|
1694
|
-
interface RedeemRegisteredDomainResponseNonNullableFields$1 {
|
|
1695
|
-
registeredDomain?: RegisteredDomainNonNullableFields$1;
|
|
1696
|
-
}
|
|
1697
|
-
|
|
1698
|
-
/**
|
|
1699
|
-
* A registered domain is a domain that Wix has registered on behalf of a customer
|
|
1700
|
-
* with an external registar.
|
|
1701
|
-
*/
|
|
1702
|
-
interface RegisteredDomain extends RegisteredDomainStatusInfoOneOf {
|
|
1703
|
-
/**
|
|
1704
|
-
* Information about a domain that hasn't been successfully registered
|
|
1705
|
-
* yet. Includes the timestamp of the latest registration attempt.
|
|
1706
|
-
* @readonly
|
|
1707
|
-
*/
|
|
1708
|
-
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
1709
|
-
/**
|
|
1710
|
-
* Information about a domain that couldn't be registered. Includes
|
|
1711
|
-
* failure code and message.
|
|
1712
|
-
* @readonly
|
|
1713
|
-
*/
|
|
1714
|
-
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
1715
|
-
/**
|
|
1716
|
-
* Domain ID. Identical to `domain`.
|
|
1717
|
-
* @readonly
|
|
1718
|
-
*/
|
|
1719
|
-
_id?: string;
|
|
1720
|
-
/**
|
|
1721
|
-
* Name of the domain including TLD.
|
|
1722
|
-
* Subdomains aren't supported. You can only register a root domain.
|
|
1723
|
-
* Domain name and TLD must be separated by a dot. For example,
|
|
1724
|
-
* `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
|
|
1725
|
-
* supported.
|
|
1726
|
-
*
|
|
1727
|
-
* Min: 3 characters
|
|
1728
|
-
* Max: 63 characters
|
|
1729
|
-
*/
|
|
1730
|
-
domain?: string;
|
|
1731
|
-
/**
|
|
1732
|
-
* ID of the product instance from the
|
|
1733
|
-
* [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
|
|
1734
|
-
* that belongs to the `registeredDomain` object.
|
|
1735
|
-
* Your account must own a product that supports the chosen TLD, regardless of
|
|
1736
|
-
* whether you want to assign the domain to a site or keep it floating. If
|
|
1737
|
-
* you want to assign the domain to a site, the relevant site must also
|
|
1738
|
-
* own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
|
|
1739
|
-
* for more information about how to become a reseller and a list of available
|
|
1740
|
-
* product IDs.
|
|
1741
|
-
*/
|
|
1742
|
-
productInstanceId?: string;
|
|
1743
|
-
/**
|
|
1744
|
-
* Date and time the `registeredDomain` object was created in
|
|
1745
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1746
|
-
* @readonly
|
|
1747
|
-
*/
|
|
1748
|
-
_createdDate?: Date;
|
|
1749
|
-
/**
|
|
1750
|
-
* Date and time the `registeredDomain` object was last updated in
|
|
1751
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1752
|
-
* @readonly
|
|
1753
|
-
*/
|
|
1754
|
-
_updatedDate?: Date;
|
|
1755
|
-
/**
|
|
1756
|
-
* Revision number, which increments by 1 each time the registered domain
|
|
1757
|
-
* is updated. To prevent conflicting changes, the current revision must be
|
|
1758
|
-
* passed when updating the registered domain.
|
|
1759
|
-
*
|
|
1760
|
-
* Ignored when creating a registered domain.
|
|
1761
|
-
*/
|
|
1762
|
-
revision?: string | null;
|
|
1763
|
-
/**
|
|
1764
|
-
* Information about the Wix site the domain is connected to and whether the
|
|
1765
|
-
* domain is assigned as the primary domain or a redirect.
|
|
1766
|
-
*/
|
|
1767
|
-
siteInfo?: SiteInfo;
|
|
1768
|
-
/**
|
|
1769
|
-
* Contact details for the registrant, admin, and tech support of the registered domain.
|
|
1770
|
-
* You can read more about which
|
|
1771
|
-
* [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
|
|
1772
|
-
* are implemented.
|
|
1773
|
-
*/
|
|
1774
|
-
contacts?: Contacts;
|
|
1775
|
-
/**
|
|
1776
|
-
* Status of the registered domain.
|
|
1777
|
-
*
|
|
1778
|
-
* + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
|
|
1779
|
-
* + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
|
|
1780
|
-
* + `"ACTIVE"`: The domain has been registered successfully and is active.
|
|
1781
|
-
* + `"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.
|
|
1782
|
-
* + `"CANCELED"`: The domain has been canceled and isn't active any longer.
|
|
1783
|
-
* @readonly
|
|
1784
|
-
*/
|
|
1785
|
-
status?: Status;
|
|
1786
|
-
/**
|
|
1787
|
-
* ICANN confirmation status.
|
|
1788
|
-
*
|
|
1789
|
-
* + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
|
|
1790
|
-
* + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
|
|
1791
|
-
* + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
|
|
1792
|
-
* + `"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.
|
|
1793
|
-
* @readonly
|
|
1794
|
-
*/
|
|
1795
|
-
icannConfirmationStatus?: ICANNConfirmationStatus;
|
|
1796
|
-
/**
|
|
1797
|
-
* Details about the ICANN confirmation status.
|
|
1798
|
-
* @readonly
|
|
1799
|
-
*/
|
|
1800
|
-
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo;
|
|
1801
|
-
/**
|
|
1802
|
-
* DNS propagation status.
|
|
1803
|
-
*
|
|
1804
|
-
* + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
|
|
1805
|
-
* + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
|
|
1806
|
-
* + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
|
|
1807
|
-
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
1808
|
-
* @readonly
|
|
1809
|
-
*/
|
|
1810
|
-
dnsPropagationStatus?: DnsPropagationStatus;
|
|
1811
|
-
/**
|
|
1812
|
-
* Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
|
|
1813
|
-
* format.
|
|
1814
|
-
* @readonly
|
|
1815
|
-
*/
|
|
1816
|
-
expirationDate?: Date;
|
|
1817
|
-
}
|
|
1818
|
-
/** @oneof */
|
|
1819
|
-
interface RegisteredDomainStatusInfoOneOf {
|
|
1820
|
-
/**
|
|
1821
|
-
* Information about a domain that hasn't been successfully registered
|
|
1822
|
-
* yet. Includes the timestamp of the latest registration attempt.
|
|
1823
|
-
* @readonly
|
|
1824
|
-
*/
|
|
1825
|
-
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
1826
|
-
/**
|
|
1827
|
-
* Information about a domain that couldn't be registered. Includes
|
|
1828
|
-
* failure code and message.
|
|
1829
|
-
* @readonly
|
|
1830
|
-
*/
|
|
1831
|
-
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
1832
|
-
}
|
|
1833
|
-
interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
|
|
1834
|
-
/**
|
|
1835
|
-
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1836
|
-
* @readonly
|
|
1837
|
-
*/
|
|
1838
|
-
redirectInfo?: RedirectAssignmentInfo;
|
|
1839
|
-
/**
|
|
1840
|
-
* ID of the site to which the domain is assigned.
|
|
1841
|
-
* @readonly
|
|
1842
|
-
*/
|
|
1843
|
-
_id?: string | null;
|
|
1844
|
-
/**
|
|
1845
|
-
* Whether the domain is assigned as the primary domain or a redirect.
|
|
1846
|
-
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
1847
|
-
* __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
|
|
1848
|
-
* in the request of the Create Registered Domain call.
|
|
1849
|
-
*
|
|
1850
|
-
* + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
|
|
1851
|
-
* + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
|
|
1852
|
-
* + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
|
|
1853
|
-
*/
|
|
1854
|
-
assignmentType?: AssignmentType;
|
|
1855
|
-
}
|
|
1856
|
-
/** @oneof */
|
|
1857
|
-
interface SiteInfoAssignmentInfoOneOf {
|
|
1858
|
-
/**
|
|
1859
|
-
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1860
|
-
* @readonly
|
|
1861
|
-
*/
|
|
1862
|
-
redirectInfo?: RedirectAssignmentInfo;
|
|
1863
|
-
}
|
|
1864
|
-
declare enum AssignmentType {
|
|
1865
|
-
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
1866
|
-
PRIMARY = "PRIMARY",
|
|
1867
|
-
REDIRECT = "REDIRECT"
|
|
1868
|
-
}
|
|
1869
|
-
interface RedirectAssignmentInfo {
|
|
1870
|
-
/**
|
|
1871
|
-
* Primary domain the redirect points to.
|
|
1872
|
-
* @readonly
|
|
1873
|
-
*/
|
|
1874
|
-
primaryDomain?: string;
|
|
1875
|
-
}
|
|
1876
|
-
interface Contacts {
|
|
1877
|
-
/** Contact information for the domain registrant. */
|
|
1878
|
-
registrant?: ContactData;
|
|
1879
|
-
/** Contact information for the domain admin. */
|
|
1880
|
-
admin?: ContactData;
|
|
1881
|
-
/** Contact information for the tech support of the domain. */
|
|
1882
|
-
tech?: ContactData;
|
|
1883
|
-
}
|
|
1884
|
-
interface ContactData {
|
|
1885
|
-
/**
|
|
1886
|
-
* First name. Only
|
|
1887
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1888
|
-
* are supported.
|
|
1889
|
-
*
|
|
1890
|
-
* Min: 2 characters
|
|
1891
|
-
* Max: 64 characters
|
|
1892
|
-
*/
|
|
1893
|
-
firstName?: string;
|
|
1894
|
-
/**
|
|
1895
|
-
* Last name. Only
|
|
1896
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1897
|
-
* are supported.
|
|
1898
|
-
*
|
|
1899
|
-
* Min: 2 characters
|
|
1900
|
-
* Max: 64 characters
|
|
1901
|
-
*/
|
|
1902
|
-
lastName?: string;
|
|
1903
|
-
/**
|
|
1904
|
-
* Email address. Only
|
|
1905
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1906
|
-
* and a single `@` are supported. Wix doesn't validate that the email address
|
|
1907
|
-
* exists.
|
|
1908
|
-
*
|
|
1909
|
-
* Min: 3 characters
|
|
1910
|
-
* Max: 64 characters before the `@` and 63 after
|
|
1911
|
-
*/
|
|
1912
|
-
email?: string;
|
|
1913
|
-
/**
|
|
1914
|
-
* Address details, including street name and house number. Only
|
|
1915
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1916
|
-
* are supported.
|
|
1917
|
-
*
|
|
1918
|
-
* Min: 2 characters
|
|
1919
|
-
* Max: 64 characters
|
|
1920
|
-
*/
|
|
1921
|
-
address?: string;
|
|
1922
|
-
/**
|
|
1923
|
-
* City. Only
|
|
1924
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1925
|
-
* are supported.
|
|
1926
|
-
*
|
|
1927
|
-
* Min: 2 characters
|
|
1928
|
-
* Max: 64 characters
|
|
1929
|
-
*/
|
|
1930
|
-
city?: string;
|
|
1931
|
-
/**
|
|
1932
|
-
* Subdivision code in
|
|
1933
|
-
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
|
|
1934
|
-
* format. Only
|
|
1935
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1936
|
-
* are supported.
|
|
1937
|
-
* __Required__ for these countries:
|
|
1938
|
-
* `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
|
|
1939
|
-
* `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
|
|
1940
|
-
* `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
|
|
1941
|
-
* `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
|
|
1942
|
-
* `"TW"`, `"UA"`, `"US"`, `”ZA”`.
|
|
1943
|
-
*
|
|
1944
|
-
* Min: 2 characters
|
|
1945
|
-
* Max: 2 characters
|
|
1946
|
-
*/
|
|
1947
|
-
subdivisionCode?: string | null;
|
|
1948
|
-
/**
|
|
1949
|
-
* Postal code. Only
|
|
1950
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1951
|
-
* are supported.
|
|
1952
|
-
*
|
|
1953
|
-
* Min: 2 characters
|
|
1954
|
-
* Max: 16 characters
|
|
1955
|
-
*/
|
|
1956
|
-
postalCode?: string | null;
|
|
1957
|
-
/**
|
|
1958
|
-
* Country code in
|
|
1959
|
-
* [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
|
|
1960
|
-
* format. Only
|
|
1961
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1962
|
-
* are supported. Wix doesn't validate that the postal code is valid for the
|
|
1963
|
-
* given country.
|
|
1964
|
-
*
|
|
1965
|
-
* Min: 2 characters
|
|
1966
|
-
* Max: 2 characters
|
|
1967
|
-
*/
|
|
1968
|
-
countryCode?: string;
|
|
1969
|
-
/**
|
|
1970
|
-
* Phone number. Only
|
|
1971
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1972
|
-
* are supported. For example, `+15551234567`. Wix doesn't validate that the
|
|
1973
|
-
* phone number belongs to the specified country.
|
|
1974
|
-
*
|
|
1975
|
-
* Min: 2 characters
|
|
1976
|
-
* Max: 20 characters
|
|
1977
|
-
*/
|
|
1978
|
-
phone?: string;
|
|
1979
|
-
/**
|
|
1980
|
-
* Company name. Only
|
|
1981
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1982
|
-
* are supported.
|
|
1983
|
-
*
|
|
1984
|
-
* Max: 2 characters
|
|
1985
|
-
* Max: 64 characters
|
|
1986
|
-
*/
|
|
1987
|
-
company?: string | null;
|
|
1988
|
-
}
|
|
1989
|
-
declare enum Status {
|
|
1990
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1991
|
-
PENDING_REGISTRATION = "PENDING_REGISTRATION",
|
|
1992
|
-
ACTIVE = "ACTIVE",
|
|
1993
|
-
FAILED_REGISTRATION = "FAILED_REGISTRATION",
|
|
1994
|
-
CANCELED = "CANCELED"
|
|
1995
|
-
}
|
|
1996
|
-
interface PendingRegistrationInfo {
|
|
1997
|
-
/**
|
|
1998
|
-
* Information about the latest attempt to register
|
|
1999
|
-
* the domain. Wix tries to register the domain several times if the
|
|
2000
|
-
* first attempt is unsuccessful. You can contact the
|
|
2001
|
-
* [Wix B2B team](mailto:bizdev@wix.com)
|
|
2002
|
-
* for more information about the number of attempts and their timing.
|
|
2003
|
-
* @readonly
|
|
2004
|
-
*/
|
|
2005
|
-
latestAttempt?: LatestAttempt;
|
|
2006
|
-
}
|
|
2007
|
-
interface LatestAttempt {
|
|
2008
|
-
/**
|
|
2009
|
-
* Number of the latest attempt to register the domain.
|
|
2010
|
-
* @readonly
|
|
2011
|
-
*/
|
|
2012
|
-
number?: number;
|
|
2013
|
-
/**
|
|
2014
|
-
* Date and time of the latest domain registration attempt in
|
|
2015
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
2016
|
-
* @readonly
|
|
2017
|
-
*/
|
|
2018
|
-
timestamp?: Date;
|
|
2019
|
-
}
|
|
2020
|
-
interface FailedRegistrationInfo {
|
|
2021
|
-
/**
|
|
2022
|
-
* Failure code.
|
|
2023
|
-
*
|
|
2024
|
-
* + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
|
|
2025
|
-
* + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
|
|
2026
|
-
* @readonly
|
|
2027
|
-
*/
|
|
2028
|
-
code?: FailureCode;
|
|
2029
|
-
/**
|
|
2030
|
-
* Failure message.
|
|
2031
|
-
* @readonly
|
|
2032
|
-
*/
|
|
2033
|
-
message?: string;
|
|
2034
|
-
}
|
|
2035
|
-
declare enum FailureCode {
|
|
2036
|
-
UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
|
|
2037
|
-
OTHER = "OTHER"
|
|
2038
|
-
}
|
|
2039
|
-
/**
|
|
2040
|
-
* he confirmation status types, a record:
|
|
2041
|
-
* starts at pending
|
|
2042
|
-
* ends either at confirmed_by_all or expired
|
|
2043
|
-
*/
|
|
2044
|
-
declare enum ICANNConfirmationStatus {
|
|
2045
|
-
UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
|
|
2046
|
-
PENDING = "PENDING",
|
|
2047
|
-
CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
|
|
2048
|
-
EXPIRED = "EXPIRED"
|
|
2049
|
-
}
|
|
2050
|
-
interface ICANNConfirmationStatusInfo extends ICANNConfirmationStatusInfoStatusOneOf {
|
|
2051
|
-
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
2052
|
-
pending?: Pending;
|
|
2053
|
-
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
2054
|
-
expired?: Expired;
|
|
2055
|
-
}
|
|
2056
|
-
/** @oneof */
|
|
2057
|
-
interface ICANNConfirmationStatusInfoStatusOneOf {
|
|
2058
|
-
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
2059
|
-
pending?: Pending;
|
|
2060
|
-
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
2061
|
-
expired?: Expired;
|
|
2062
|
-
}
|
|
2063
|
-
interface Pending {
|
|
2064
|
-
/**
|
|
2065
|
-
* Expiration date of the ICANN confirmation process in
|
|
2066
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
|
|
2067
|
-
* before this date or the domain won't be active.
|
|
2068
|
-
*/
|
|
2069
|
-
expirationDate?: Date;
|
|
2070
|
-
/**
|
|
2071
|
-
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
2072
|
-
* yet.
|
|
2073
|
-
*/
|
|
2074
|
-
notConfirmedBy?: string[];
|
|
2075
|
-
}
|
|
2076
|
-
interface Expired {
|
|
2077
|
-
/**
|
|
2078
|
-
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
2079
|
-
* in time.
|
|
2080
|
-
*/
|
|
2081
|
-
notConfirmedBy?: string[];
|
|
2082
|
-
}
|
|
2083
|
-
declare enum DnsPropagationStatus {
|
|
2084
|
-
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
2085
|
-
COMPLETED = "COMPLETED",
|
|
2086
|
-
FAILED = "FAILED",
|
|
2087
|
-
IN_PROGRESS = "IN_PROGRESS"
|
|
2088
|
-
}
|
|
2089
|
-
interface CreateRegisteredDomainRequest {
|
|
2090
|
-
/** Information about the domain to register including contact details. */
|
|
2091
|
-
registeredDomain: RegisteredDomain;
|
|
2092
|
-
}
|
|
2093
|
-
interface CreateRegisteredDomainResponse {
|
|
2094
|
-
/** Created registered domain. */
|
|
2095
|
-
registeredDomain?: RegisteredDomain;
|
|
2096
|
-
}
|
|
2097
|
-
interface GetRegisteredDomainRequest {
|
|
2098
|
-
/** ID of the registered domain to retrieve. */
|
|
2099
|
-
registeredDomainId: string;
|
|
2100
|
-
}
|
|
2101
|
-
interface GetRegisteredDomainResponse {
|
|
2102
|
-
/** Retrieved registered domain. */
|
|
2103
|
-
registeredDomain?: RegisteredDomain;
|
|
2104
|
-
}
|
|
2105
|
-
interface ListRegisteredDomainsRequest {
|
|
2106
|
-
/** Cursor paging options. */
|
|
2107
|
-
paging?: CursorPaging$2;
|
|
2108
|
-
}
|
|
2109
|
-
interface CursorPaging$2 {
|
|
2110
|
-
/**
|
|
2111
|
-
* Number of domains to load.
|
|
2112
|
-
*
|
|
2113
|
-
* Min: `0`
|
|
2114
|
-
* Max: `100`
|
|
2115
|
-
*/
|
|
2116
|
-
limit?: number | null;
|
|
2117
|
-
/**
|
|
2118
|
-
* Pointer to the next or previous page in the list of results.
|
|
2119
|
-
*
|
|
2120
|
-
* You can get the relevant cursor token
|
|
2121
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
2122
|
-
* Not relevant for the first request.
|
|
2123
|
-
*/
|
|
2124
|
-
cursor?: string | null;
|
|
2125
|
-
}
|
|
2126
|
-
interface ListRegisteredDomainsResponse {
|
|
2127
|
-
/** Metadata about the returned list of registered domains. */
|
|
2128
|
-
pagingMetadata?: CursorPagingMetadata$2;
|
|
2129
|
-
/** Retrieved registered domains. */
|
|
2130
|
-
registeredDomains?: RegisteredDomain[];
|
|
2131
|
-
}
|
|
2132
|
-
interface CursorPagingMetadata$2 {
|
|
2133
|
-
/** Number of domains returned in the response. */
|
|
2134
|
-
count?: number | null;
|
|
2135
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2136
|
-
cursors?: Cursors$2;
|
|
2137
|
-
/**
|
|
2138
|
-
* Indicates if there are more results after the current page.
|
|
2139
|
-
* If `true`, another page of results can be retrieved.
|
|
2140
|
-
* If `false`, this is the last page.
|
|
2141
|
-
*/
|
|
2142
|
-
hasNext?: boolean | null;
|
|
2143
|
-
}
|
|
2144
|
-
interface Cursors$2 {
|
|
2145
|
-
/** Cursor pointing to next page in the list of results. */
|
|
2146
|
-
next?: string | null;
|
|
2147
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
2148
|
-
prev?: string | null;
|
|
2149
|
-
}
|
|
2150
|
-
interface RedeemRegisteredDomainRequest {
|
|
2151
|
-
/**
|
|
2152
|
-
* ID of the registered domain to redeem. Identical to the domain name
|
|
2153
|
-
* including TLD.
|
|
2154
|
-
*/
|
|
2155
|
-
registeredDomainId: string;
|
|
2156
|
-
}
|
|
2157
|
-
interface RedeemRegisteredDomainResponse {
|
|
2158
|
-
/** Registered domain to redeem. */
|
|
2159
|
-
registeredDomain?: RegisteredDomain;
|
|
2160
|
-
}
|
|
2161
|
-
interface LatestAttemptNonNullableFields {
|
|
2162
|
-
number: number;
|
|
2163
|
-
}
|
|
2164
|
-
interface PendingRegistrationInfoNonNullableFields {
|
|
2165
|
-
latestAttempt?: LatestAttemptNonNullableFields;
|
|
2166
|
-
}
|
|
2167
|
-
interface FailedRegistrationInfoNonNullableFields {
|
|
2168
|
-
code: FailureCode;
|
|
2169
|
-
message: string;
|
|
2170
|
-
}
|
|
2171
|
-
interface RedirectAssignmentInfoNonNullableFields {
|
|
2172
|
-
primaryDomain: string;
|
|
2173
|
-
}
|
|
2174
|
-
interface SiteInfoNonNullableFields {
|
|
2175
|
-
redirectInfo?: RedirectAssignmentInfoNonNullableFields;
|
|
2176
|
-
assignmentType: AssignmentType;
|
|
2177
|
-
}
|
|
2178
|
-
interface ContactDataNonNullableFields {
|
|
2179
|
-
firstName: string;
|
|
2180
|
-
lastName: string;
|
|
2181
|
-
email: string;
|
|
2182
|
-
address: string;
|
|
2183
|
-
city: string;
|
|
2184
|
-
countryCode: string;
|
|
2185
|
-
phone: string;
|
|
2186
|
-
}
|
|
2187
|
-
interface ContactsNonNullableFields {
|
|
2188
|
-
registrant?: ContactDataNonNullableFields;
|
|
2189
|
-
admin?: ContactDataNonNullableFields;
|
|
2190
|
-
tech?: ContactDataNonNullableFields;
|
|
2191
|
-
}
|
|
2192
|
-
interface PendingNonNullableFields {
|
|
2193
|
-
notConfirmedBy: string[];
|
|
2194
|
-
}
|
|
2195
|
-
interface ExpiredNonNullableFields {
|
|
2196
|
-
notConfirmedBy: string[];
|
|
2197
|
-
}
|
|
2198
|
-
interface ICANNConfirmationStatusInfoNonNullableFields {
|
|
2199
|
-
pending?: PendingNonNullableFields;
|
|
2200
|
-
expired?: ExpiredNonNullableFields;
|
|
2201
|
-
}
|
|
2202
|
-
interface RegisteredDomainNonNullableFields {
|
|
2203
|
-
pendingRegistrationInfo?: PendingRegistrationInfoNonNullableFields;
|
|
2204
|
-
failedRegistrationInfo?: FailedRegistrationInfoNonNullableFields;
|
|
2205
|
-
_id: string;
|
|
2206
|
-
domain: string;
|
|
2207
|
-
productInstanceId: string;
|
|
2208
|
-
siteInfo?: SiteInfoNonNullableFields;
|
|
2209
|
-
contacts?: ContactsNonNullableFields;
|
|
2210
|
-
status: Status;
|
|
2211
|
-
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
2212
|
-
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfoNonNullableFields;
|
|
2213
|
-
dnsPropagationStatus: DnsPropagationStatus;
|
|
2214
|
-
}
|
|
2215
|
-
interface CreateRegisteredDomainResponseNonNullableFields {
|
|
2216
|
-
registeredDomain?: RegisteredDomainNonNullableFields;
|
|
2217
|
-
}
|
|
2218
|
-
interface GetRegisteredDomainResponseNonNullableFields {
|
|
2219
|
-
registeredDomain?: RegisteredDomainNonNullableFields;
|
|
2220
|
-
}
|
|
2221
|
-
interface ListRegisteredDomainsResponseNonNullableFields {
|
|
2222
|
-
registeredDomains: RegisteredDomainNonNullableFields[];
|
|
2223
|
-
}
|
|
2224
|
-
interface RedeemRegisteredDomainResponseNonNullableFields {
|
|
2225
|
-
registeredDomain?: RegisteredDomainNonNullableFields;
|
|
2226
|
-
}
|
|
2227
|
-
|
|
2228
|
-
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2229
|
-
getUrl: (context: any) => string;
|
|
2230
|
-
httpMethod: K;
|
|
2231
|
-
path: string;
|
|
2232
|
-
pathParams: M;
|
|
2233
|
-
__requestType: T;
|
|
2234
|
-
__originalRequestType: S;
|
|
2235
|
-
__responseType: Q;
|
|
2236
|
-
__originalResponseType: R;
|
|
2237
|
-
};
|
|
2238
|
-
declare function createRegisteredDomain(): __PublicMethodMetaInfo$2<'POST', {}, CreateRegisteredDomainRequest, CreateRegisteredDomainRequest$1, CreateRegisteredDomainResponse & CreateRegisteredDomainResponseNonNullableFields, CreateRegisteredDomainResponse$1 & CreateRegisteredDomainResponseNonNullableFields$1>;
|
|
2239
|
-
declare function getRegisteredDomain(): __PublicMethodMetaInfo$2<'GET', {
|
|
2240
|
-
registeredDomainId: string;
|
|
2241
|
-
}, GetRegisteredDomainRequest, GetRegisteredDomainRequest$1, GetRegisteredDomainResponse & GetRegisteredDomainResponseNonNullableFields, GetRegisteredDomainResponse$1 & GetRegisteredDomainResponseNonNullableFields$1>;
|
|
2242
|
-
declare function listRegisteredDomains(): __PublicMethodMetaInfo$2<'GET', {}, ListRegisteredDomainsRequest, ListRegisteredDomainsRequest$1, ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields, ListRegisteredDomainsResponse$1 & ListRegisteredDomainsResponseNonNullableFields$1>;
|
|
2243
|
-
declare function redeemRegisteredDomain(): __PublicMethodMetaInfo$2<'POST', {
|
|
2244
|
-
registeredDomainId: string;
|
|
2245
|
-
}, RedeemRegisteredDomainRequest, RedeemRegisteredDomainRequest$1, RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields, RedeemRegisteredDomainResponse$1 & RedeemRegisteredDomainResponseNonNullableFields$1>;
|
|
2246
|
-
|
|
2247
|
-
declare const meta$2_createRegisteredDomain: typeof createRegisteredDomain;
|
|
2248
|
-
declare const meta$2_getRegisteredDomain: typeof getRegisteredDomain;
|
|
2249
|
-
declare const meta$2_listRegisteredDomains: typeof listRegisteredDomains;
|
|
2250
|
-
declare const meta$2_redeemRegisteredDomain: typeof redeemRegisteredDomain;
|
|
1159
|
+
declare const meta$2_createDnsZone: typeof createDnsZone;
|
|
1160
|
+
declare const meta$2_deleteDnsZone: typeof deleteDnsZone;
|
|
1161
|
+
declare const meta$2_getDnsZone: typeof getDnsZone;
|
|
1162
|
+
declare const meta$2_previewDnsZone: typeof previewDnsZone;
|
|
1163
|
+
declare const meta$2_updateDnsZone: typeof updateDnsZone;
|
|
2251
1164
|
declare namespace meta$2 {
|
|
2252
|
-
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$
|
|
1165
|
+
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_createDnsZone as createDnsZone, meta$2_deleteDnsZone as deleteDnsZone, meta$2_getDnsZone as getDnsZone, meta$2_previewDnsZone as previewDnsZone, meta$2_updateDnsZone as updateDnsZone };
|
|
2253
1166
|
}
|
|
2254
1167
|
|
|
2255
1168
|
interface DomainAvailability$1 {
|
|
@@ -2561,4 +1474,4 @@ declare namespace meta {
|
|
|
2561
1474
|
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_suggestDomains as suggestDomains };
|
|
2562
1475
|
}
|
|
2563
1476
|
|
|
2564
|
-
export { meta$
|
|
1477
|
+
export { meta$3 as connectedDomainSetupInfo, meta$4 as connectedDomains, meta$1 as domainAvailability, meta$2 as domainDns, meta as domainSuggestions };
|