@wix/domains 1.0.0
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 +1 -0
- package/build/cjs/context.js +28 -0
- package/build/cjs/context.js.map +1 -0
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +28 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +28 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/es/context.d.ts +1 -0
- package/build/es/context.js +2 -0
- package/build/es/context.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/context/package.json +7 -0
- package/meta/package.json +7 -0
- package/package.json +47 -0
- package/type-bundles/context.bundle.d.ts +727 -0
- package/type-bundles/index.bundle.d.ts +1041 -0
- package/type-bundles/meta.bundle.d.ts +1453 -0
|
@@ -0,0 +1,727 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A registered domain is a domain that Wix has registered on behalf of a customer
|
|
3
|
+
* with an external registar.
|
|
4
|
+
*/
|
|
5
|
+
interface RegisteredDomain extends RegisteredDomainStatusInfoOneOf {
|
|
6
|
+
/**
|
|
7
|
+
* Information about a domain that hasn't been successfully registered
|
|
8
|
+
* yet. Includes the timestamp of the latest registration attempt.
|
|
9
|
+
* @readonly
|
|
10
|
+
*/
|
|
11
|
+
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
12
|
+
/**
|
|
13
|
+
* Information about a domain that couldn't be registered. Includes
|
|
14
|
+
* failure code and message.
|
|
15
|
+
* @readonly
|
|
16
|
+
*/
|
|
17
|
+
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
18
|
+
/**
|
|
19
|
+
* Domain ID. Identical to `domain`.
|
|
20
|
+
* @readonly
|
|
21
|
+
*/
|
|
22
|
+
_id?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Name of the domain including TLD.
|
|
25
|
+
* Subdomains aren't supported. You can only register a root domain.
|
|
26
|
+
* Domain name and TLD must be separated by a dot. For example,
|
|
27
|
+
* `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
|
|
28
|
+
* supported.
|
|
29
|
+
*
|
|
30
|
+
* Min: 3 characters
|
|
31
|
+
* Max: 63 characters
|
|
32
|
+
*/
|
|
33
|
+
domain?: string;
|
|
34
|
+
/**
|
|
35
|
+
* ID of the product instance from the
|
|
36
|
+
* [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
|
|
37
|
+
* that belongs to the `registeredDomain` object.
|
|
38
|
+
* Your account must own a product that supports the chosen TLD, regardless of
|
|
39
|
+
* whether you want to assign the domain to a site or keep it floating. If
|
|
40
|
+
* you want to assign the domain to a site, the relevant site must also
|
|
41
|
+
* own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
|
|
42
|
+
* for more information about how to become a reseller and a list of available
|
|
43
|
+
* product IDs.
|
|
44
|
+
*/
|
|
45
|
+
productInstanceId?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Date and time the `registeredDomain` object was created in
|
|
48
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
49
|
+
* @readonly
|
|
50
|
+
*/
|
|
51
|
+
_createdDate?: Date;
|
|
52
|
+
/**
|
|
53
|
+
* Date and time the `registeredDomain` object was last updated in
|
|
54
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
55
|
+
* @readonly
|
|
56
|
+
*/
|
|
57
|
+
_updatedDate?: Date;
|
|
58
|
+
/**
|
|
59
|
+
* Revision number, which increments by 1 each time the registered domain
|
|
60
|
+
* is updated. To prevent conflicting changes, the current revision must be
|
|
61
|
+
* passed when updating the registered domain.
|
|
62
|
+
*
|
|
63
|
+
* Ignored when creating a registered domain.
|
|
64
|
+
*/
|
|
65
|
+
revision?: string | null;
|
|
66
|
+
/**
|
|
67
|
+
* Information about the Wix site the domain is connected to and whether the
|
|
68
|
+
* domain is assigned as the primary domain or a redirect.
|
|
69
|
+
*/
|
|
70
|
+
siteInfo?: SiteInfo;
|
|
71
|
+
/**
|
|
72
|
+
* Contact details for the registrant, admin, and tech support of the registered domain.
|
|
73
|
+
* You can read more about which
|
|
74
|
+
* [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
|
|
75
|
+
* are implemented.
|
|
76
|
+
*/
|
|
77
|
+
contacts?: Contacts;
|
|
78
|
+
/**
|
|
79
|
+
* Status of the registered domain.
|
|
80
|
+
*
|
|
81
|
+
* + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
|
|
82
|
+
* + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
|
|
83
|
+
* + `"ACTIVE"`: The domain has been registered successfully and is active.
|
|
84
|
+
* + `"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.
|
|
85
|
+
* + `"CANCELED"`: The domain has been canceled and isn't active any longer.
|
|
86
|
+
* @readonly
|
|
87
|
+
*/
|
|
88
|
+
status?: Status;
|
|
89
|
+
/**
|
|
90
|
+
* ICANN confirmation status.
|
|
91
|
+
*
|
|
92
|
+
* + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
|
|
93
|
+
* + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
|
|
94
|
+
* + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
|
|
95
|
+
* + `"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.
|
|
96
|
+
* @readonly
|
|
97
|
+
*/
|
|
98
|
+
icannConfirmationStatus?: ICANNConfirmationStatus;
|
|
99
|
+
/**
|
|
100
|
+
* Details about the ICANN confirmation status.
|
|
101
|
+
* @readonly
|
|
102
|
+
*/
|
|
103
|
+
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo;
|
|
104
|
+
/**
|
|
105
|
+
* DNS propagation status.
|
|
106
|
+
*
|
|
107
|
+
* + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
|
|
108
|
+
* + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
|
|
109
|
+
* + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
|
|
110
|
+
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
111
|
+
* @readonly
|
|
112
|
+
*/
|
|
113
|
+
dnsPropagationStatus?: DnsPropagationStatus;
|
|
114
|
+
/**
|
|
115
|
+
* Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
|
|
116
|
+
* format.
|
|
117
|
+
* @readonly
|
|
118
|
+
*/
|
|
119
|
+
expirationDate?: Date;
|
|
120
|
+
}
|
|
121
|
+
/** @oneof */
|
|
122
|
+
interface RegisteredDomainStatusInfoOneOf {
|
|
123
|
+
/**
|
|
124
|
+
* Information about a domain that hasn't been successfully registered
|
|
125
|
+
* yet. Includes the timestamp of the latest registration attempt.
|
|
126
|
+
* @readonly
|
|
127
|
+
*/
|
|
128
|
+
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
129
|
+
/**
|
|
130
|
+
* Information about a domain that couldn't be registered. Includes
|
|
131
|
+
* failure code and message.
|
|
132
|
+
* @readonly
|
|
133
|
+
*/
|
|
134
|
+
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
135
|
+
}
|
|
136
|
+
interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
|
|
137
|
+
/**
|
|
138
|
+
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
139
|
+
* @readonly
|
|
140
|
+
*/
|
|
141
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
142
|
+
/**
|
|
143
|
+
* ID of the site to which the domain is assigned.
|
|
144
|
+
* @readonly
|
|
145
|
+
*/
|
|
146
|
+
_id?: string | null;
|
|
147
|
+
/**
|
|
148
|
+
* Whether the domain is assigned as the primary domain or a redirect.
|
|
149
|
+
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
150
|
+
* __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
|
|
151
|
+
* in the request of the Create Registered Domain call.
|
|
152
|
+
*
|
|
153
|
+
* + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
|
|
154
|
+
* + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
|
|
155
|
+
* + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
|
|
156
|
+
*/
|
|
157
|
+
assignmentType?: AssignmentType;
|
|
158
|
+
}
|
|
159
|
+
/** @oneof */
|
|
160
|
+
interface SiteInfoAssignmentInfoOneOf {
|
|
161
|
+
/**
|
|
162
|
+
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
163
|
+
* @readonly
|
|
164
|
+
*/
|
|
165
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
166
|
+
}
|
|
167
|
+
declare enum AssignmentType {
|
|
168
|
+
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
169
|
+
PRIMARY = "PRIMARY",
|
|
170
|
+
REDIRECT = "REDIRECT"
|
|
171
|
+
}
|
|
172
|
+
interface RedirectAssignmentInfo {
|
|
173
|
+
/**
|
|
174
|
+
* Primary domain the redirect points to.
|
|
175
|
+
* @readonly
|
|
176
|
+
*/
|
|
177
|
+
primaryDomain?: string;
|
|
178
|
+
}
|
|
179
|
+
interface Contacts {
|
|
180
|
+
/** Contact information for the domain registrant. */
|
|
181
|
+
registrant?: ContactData;
|
|
182
|
+
/** Contact information for the domain admin. */
|
|
183
|
+
admin?: ContactData;
|
|
184
|
+
/** Contact information for the tech support of the domain. */
|
|
185
|
+
tech?: ContactData;
|
|
186
|
+
}
|
|
187
|
+
interface ContactData {
|
|
188
|
+
/**
|
|
189
|
+
* First name. Only
|
|
190
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
191
|
+
* are supported.
|
|
192
|
+
*
|
|
193
|
+
* Min: 2 characters
|
|
194
|
+
* Max: 64 characters
|
|
195
|
+
*/
|
|
196
|
+
firstName?: string;
|
|
197
|
+
/**
|
|
198
|
+
* Last name. Only
|
|
199
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
200
|
+
* are supported.
|
|
201
|
+
*
|
|
202
|
+
* Min: 2 characters
|
|
203
|
+
* Max: 64 characters
|
|
204
|
+
*/
|
|
205
|
+
lastName?: string;
|
|
206
|
+
/**
|
|
207
|
+
* Email address. Only
|
|
208
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
209
|
+
* and a single `@` are supported. Wix doesn't validate that the email address
|
|
210
|
+
* exists.
|
|
211
|
+
*
|
|
212
|
+
* Min: 3 characters
|
|
213
|
+
* Max: 64 characters before the `@` and 63 after
|
|
214
|
+
*/
|
|
215
|
+
email?: string;
|
|
216
|
+
/**
|
|
217
|
+
* Address details, including street name and house number. Only
|
|
218
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
219
|
+
* are supported.
|
|
220
|
+
*
|
|
221
|
+
* Min: 2 characters
|
|
222
|
+
* Max: 64 characters
|
|
223
|
+
*/
|
|
224
|
+
address?: string;
|
|
225
|
+
/**
|
|
226
|
+
* City. Only
|
|
227
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
228
|
+
* are supported.
|
|
229
|
+
*
|
|
230
|
+
* Min: 2 characters
|
|
231
|
+
* Max: 64 characters
|
|
232
|
+
*/
|
|
233
|
+
city?: string;
|
|
234
|
+
/**
|
|
235
|
+
* Subdivision code in
|
|
236
|
+
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
|
|
237
|
+
* format. Only
|
|
238
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
239
|
+
* are supported.
|
|
240
|
+
* __Required__ for these countries:
|
|
241
|
+
* `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
|
|
242
|
+
* `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
|
|
243
|
+
* `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
|
|
244
|
+
* `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
|
|
245
|
+
* `"TW"`, `"UA"`, `"US"`, `”ZA”`.
|
|
246
|
+
*
|
|
247
|
+
* Min: 2 characters
|
|
248
|
+
* Max: 2 characters
|
|
249
|
+
*/
|
|
250
|
+
subdivisionCode?: string | null;
|
|
251
|
+
/**
|
|
252
|
+
* Postal code. Only
|
|
253
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
254
|
+
* are supported.
|
|
255
|
+
*
|
|
256
|
+
* Min: 2 characters
|
|
257
|
+
* Max: 16 characters
|
|
258
|
+
*/
|
|
259
|
+
postalCode?: string | null;
|
|
260
|
+
/**
|
|
261
|
+
* Country code in
|
|
262
|
+
* [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
|
|
263
|
+
* format. Only
|
|
264
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
265
|
+
* are supported. Wix doesn't validate that the postal code is valid for the
|
|
266
|
+
* given country.
|
|
267
|
+
*
|
|
268
|
+
* Min: 2 characters
|
|
269
|
+
* Max: 2 characters
|
|
270
|
+
*/
|
|
271
|
+
countryCode?: string;
|
|
272
|
+
/**
|
|
273
|
+
* Phone number. Only
|
|
274
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
275
|
+
* are supported. For example, `+15551234567`. Wix doesn't validate that the
|
|
276
|
+
* phone number belongs to the specified country.
|
|
277
|
+
*
|
|
278
|
+
* Min: 2 characters
|
|
279
|
+
* Max: 20 characters
|
|
280
|
+
*/
|
|
281
|
+
phone?: string;
|
|
282
|
+
/**
|
|
283
|
+
* Company name. Only
|
|
284
|
+
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
285
|
+
* are supported.
|
|
286
|
+
*
|
|
287
|
+
* Max: 2 characters
|
|
288
|
+
* Max: 64 characters
|
|
289
|
+
*/
|
|
290
|
+
company?: string | null;
|
|
291
|
+
}
|
|
292
|
+
declare enum Status {
|
|
293
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
294
|
+
PENDING_REGISTRATION = "PENDING_REGISTRATION",
|
|
295
|
+
ACTIVE = "ACTIVE",
|
|
296
|
+
FAILED_REGISTRATION = "FAILED_REGISTRATION",
|
|
297
|
+
CANCELED = "CANCELED"
|
|
298
|
+
}
|
|
299
|
+
interface PendingRegistrationInfo {
|
|
300
|
+
/**
|
|
301
|
+
* Information about the latest attempt to register
|
|
302
|
+
* the domain. Wix tries to register the domain several times if the
|
|
303
|
+
* first attempt is unsuccessful. You can contact the
|
|
304
|
+
* [Wix B2B team](mailto:bizdev@wix.com)
|
|
305
|
+
* for more information about the number of attempts and their timing.
|
|
306
|
+
* @readonly
|
|
307
|
+
*/
|
|
308
|
+
latestAttempt?: LatestAttempt;
|
|
309
|
+
}
|
|
310
|
+
interface LatestAttempt {
|
|
311
|
+
/**
|
|
312
|
+
* Number of the latest attempt to register the domain.
|
|
313
|
+
* @readonly
|
|
314
|
+
*/
|
|
315
|
+
number?: number;
|
|
316
|
+
/**
|
|
317
|
+
* Date and time of the latest domain registration attempt in
|
|
318
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
319
|
+
* @readonly
|
|
320
|
+
*/
|
|
321
|
+
timestamp?: Date;
|
|
322
|
+
}
|
|
323
|
+
interface FailedRegistrationInfo {
|
|
324
|
+
/**
|
|
325
|
+
* Failure code.
|
|
326
|
+
*
|
|
327
|
+
* + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
|
|
328
|
+
* + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
|
|
329
|
+
* @readonly
|
|
330
|
+
*/
|
|
331
|
+
code?: FailureCode;
|
|
332
|
+
/**
|
|
333
|
+
* Failure message.
|
|
334
|
+
* @readonly
|
|
335
|
+
*/
|
|
336
|
+
message?: string;
|
|
337
|
+
}
|
|
338
|
+
declare enum FailureCode {
|
|
339
|
+
UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
|
|
340
|
+
OTHER = "OTHER"
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* he confirmation status types, a record:
|
|
344
|
+
* starts at pending
|
|
345
|
+
* ends either at confirmed_by_all or expired
|
|
346
|
+
*/
|
|
347
|
+
declare enum ICANNConfirmationStatus {
|
|
348
|
+
UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
|
|
349
|
+
PENDING = "PENDING",
|
|
350
|
+
CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
|
|
351
|
+
EXPIRED = "EXPIRED"
|
|
352
|
+
}
|
|
353
|
+
interface ICANNConfirmationStatusInfo extends ICANNConfirmationStatusInfoStatusOneOf {
|
|
354
|
+
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
355
|
+
pending?: Pending;
|
|
356
|
+
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
357
|
+
expired?: Expired;
|
|
358
|
+
}
|
|
359
|
+
/** @oneof */
|
|
360
|
+
interface ICANNConfirmationStatusInfoStatusOneOf {
|
|
361
|
+
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
362
|
+
pending?: Pending;
|
|
363
|
+
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
364
|
+
expired?: Expired;
|
|
365
|
+
}
|
|
366
|
+
interface Pending {
|
|
367
|
+
/**
|
|
368
|
+
* Expiration date of the ICANN confirmation process in
|
|
369
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
|
|
370
|
+
* before this date or the domain won't be active.
|
|
371
|
+
*/
|
|
372
|
+
expirationDate?: Date;
|
|
373
|
+
/**
|
|
374
|
+
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
375
|
+
* yet.
|
|
376
|
+
*/
|
|
377
|
+
notConfirmedBy?: string[];
|
|
378
|
+
}
|
|
379
|
+
interface Expired {
|
|
380
|
+
/**
|
|
381
|
+
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
382
|
+
* in time.
|
|
383
|
+
*/
|
|
384
|
+
notConfirmedBy?: string[];
|
|
385
|
+
}
|
|
386
|
+
declare enum DnsPropagationStatus {
|
|
387
|
+
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
388
|
+
COMPLETED = "COMPLETED",
|
|
389
|
+
FAILED = "FAILED",
|
|
390
|
+
IN_PROGRESS = "IN_PROGRESS"
|
|
391
|
+
}
|
|
392
|
+
interface CursorPaging {
|
|
393
|
+
/**
|
|
394
|
+
* Number of domains to load.
|
|
395
|
+
*
|
|
396
|
+
* Min: `0`
|
|
397
|
+
* Max: `100`
|
|
398
|
+
*/
|
|
399
|
+
limit?: number | null;
|
|
400
|
+
/**
|
|
401
|
+
* Pointer to the next or previous page in the list of results.
|
|
402
|
+
*
|
|
403
|
+
* You can get the relevant cursor token
|
|
404
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
405
|
+
* Not relevant for the first request.
|
|
406
|
+
*/
|
|
407
|
+
cursor?: string | null;
|
|
408
|
+
}
|
|
409
|
+
interface ListRegisteredDomainsResponse {
|
|
410
|
+
/** Metadata about the returned list of registered domains. */
|
|
411
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
412
|
+
/** Retrieved registered domains. */
|
|
413
|
+
registeredDomains?: RegisteredDomain[];
|
|
414
|
+
}
|
|
415
|
+
interface CursorPagingMetadata {
|
|
416
|
+
/** Number of domains returned in the response. */
|
|
417
|
+
count?: number | null;
|
|
418
|
+
/** Offset that was requested. */
|
|
419
|
+
cursors?: Cursors;
|
|
420
|
+
/**
|
|
421
|
+
* Indicates if there are more results after the current page.
|
|
422
|
+
* If `true`, another page of results can be retrieved.
|
|
423
|
+
* If `false`, this is the last page.
|
|
424
|
+
*/
|
|
425
|
+
hasNext?: boolean | null;
|
|
426
|
+
}
|
|
427
|
+
interface Cursors {
|
|
428
|
+
/** Cursor pointing to next page in the list of results. */
|
|
429
|
+
next?: string | null;
|
|
430
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
431
|
+
prev?: string | null;
|
|
432
|
+
}
|
|
433
|
+
interface RedeemRegisteredDomainResponse {
|
|
434
|
+
/** Registered domain to redeem. */
|
|
435
|
+
registeredDomain?: RegisteredDomain;
|
|
436
|
+
}
|
|
437
|
+
interface ListRegisteredDomainsResponseNonNullableFields {
|
|
438
|
+
registeredDomains: {
|
|
439
|
+
pendingRegistrationInfo?: {
|
|
440
|
+
latestAttempt?: {
|
|
441
|
+
number: number;
|
|
442
|
+
};
|
|
443
|
+
};
|
|
444
|
+
failedRegistrationInfo?: {
|
|
445
|
+
code: FailureCode;
|
|
446
|
+
message: string;
|
|
447
|
+
};
|
|
448
|
+
_id: string;
|
|
449
|
+
domain: string;
|
|
450
|
+
productInstanceId: string;
|
|
451
|
+
siteInfo?: {
|
|
452
|
+
redirectInfo?: {
|
|
453
|
+
primaryDomain: string;
|
|
454
|
+
};
|
|
455
|
+
assignmentType: AssignmentType;
|
|
456
|
+
};
|
|
457
|
+
contacts?: {
|
|
458
|
+
registrant?: {
|
|
459
|
+
firstName: string;
|
|
460
|
+
lastName: string;
|
|
461
|
+
email: string;
|
|
462
|
+
address: string;
|
|
463
|
+
city: string;
|
|
464
|
+
countryCode: string;
|
|
465
|
+
phone: string;
|
|
466
|
+
};
|
|
467
|
+
admin?: {
|
|
468
|
+
firstName: string;
|
|
469
|
+
lastName: string;
|
|
470
|
+
email: string;
|
|
471
|
+
address: string;
|
|
472
|
+
city: string;
|
|
473
|
+
countryCode: string;
|
|
474
|
+
phone: string;
|
|
475
|
+
};
|
|
476
|
+
tech?: {
|
|
477
|
+
firstName: string;
|
|
478
|
+
lastName: string;
|
|
479
|
+
email: string;
|
|
480
|
+
address: string;
|
|
481
|
+
city: string;
|
|
482
|
+
countryCode: string;
|
|
483
|
+
phone: string;
|
|
484
|
+
};
|
|
485
|
+
};
|
|
486
|
+
status: Status;
|
|
487
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
488
|
+
icannConfirmationStatusInfo?: {
|
|
489
|
+
pending?: {
|
|
490
|
+
notConfirmedBy: string[];
|
|
491
|
+
};
|
|
492
|
+
expired?: {
|
|
493
|
+
notConfirmedBy: string[];
|
|
494
|
+
};
|
|
495
|
+
};
|
|
496
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
497
|
+
}[];
|
|
498
|
+
}
|
|
499
|
+
interface RedeemRegisteredDomainResponseNonNullableFields {
|
|
500
|
+
registeredDomain?: {
|
|
501
|
+
pendingRegistrationInfo?: {
|
|
502
|
+
latestAttempt?: {
|
|
503
|
+
number: number;
|
|
504
|
+
};
|
|
505
|
+
};
|
|
506
|
+
failedRegistrationInfo?: {
|
|
507
|
+
code: FailureCode;
|
|
508
|
+
message: string;
|
|
509
|
+
};
|
|
510
|
+
_id: string;
|
|
511
|
+
domain: string;
|
|
512
|
+
productInstanceId: string;
|
|
513
|
+
siteInfo?: {
|
|
514
|
+
redirectInfo?: {
|
|
515
|
+
primaryDomain: string;
|
|
516
|
+
};
|
|
517
|
+
assignmentType: AssignmentType;
|
|
518
|
+
};
|
|
519
|
+
contacts?: {
|
|
520
|
+
registrant?: {
|
|
521
|
+
firstName: string;
|
|
522
|
+
lastName: string;
|
|
523
|
+
email: string;
|
|
524
|
+
address: string;
|
|
525
|
+
city: string;
|
|
526
|
+
countryCode: string;
|
|
527
|
+
phone: string;
|
|
528
|
+
};
|
|
529
|
+
admin?: {
|
|
530
|
+
firstName: string;
|
|
531
|
+
lastName: string;
|
|
532
|
+
email: string;
|
|
533
|
+
address: string;
|
|
534
|
+
city: string;
|
|
535
|
+
countryCode: string;
|
|
536
|
+
phone: string;
|
|
537
|
+
};
|
|
538
|
+
tech?: {
|
|
539
|
+
firstName: string;
|
|
540
|
+
lastName: string;
|
|
541
|
+
email: string;
|
|
542
|
+
address: string;
|
|
543
|
+
city: string;
|
|
544
|
+
countryCode: string;
|
|
545
|
+
phone: string;
|
|
546
|
+
};
|
|
547
|
+
};
|
|
548
|
+
status: Status;
|
|
549
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
550
|
+
icannConfirmationStatusInfo?: {
|
|
551
|
+
pending?: {
|
|
552
|
+
notConfirmedBy: string[];
|
|
553
|
+
};
|
|
554
|
+
expired?: {
|
|
555
|
+
notConfirmedBy: string[];
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
559
|
+
};
|
|
560
|
+
}
|
|
561
|
+
interface ListRegisteredDomainsOptions {
|
|
562
|
+
/** Cursor paging options. */
|
|
563
|
+
paging?: CursorPaging;
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
567
|
+
interface HttpClient {
|
|
568
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
569
|
+
}
|
|
570
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
571
|
+
type HttpResponse<T = any> = {
|
|
572
|
+
data: T;
|
|
573
|
+
status: number;
|
|
574
|
+
statusText: string;
|
|
575
|
+
headers: any;
|
|
576
|
+
request?: any;
|
|
577
|
+
};
|
|
578
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
579
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
580
|
+
url: string;
|
|
581
|
+
data?: Data;
|
|
582
|
+
params?: URLSearchParams;
|
|
583
|
+
} & APIMetadata;
|
|
584
|
+
type APIMetadata = {
|
|
585
|
+
methodFqn?: string;
|
|
586
|
+
entityFqdn?: string;
|
|
587
|
+
packageName?: string;
|
|
588
|
+
};
|
|
589
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
590
|
+
|
|
591
|
+
declare function createRegisteredDomain$1(httpClient: HttpClient): (registeredDomain: RegisteredDomain) => Promise<RegisteredDomain & {
|
|
592
|
+
pendingRegistrationInfo?: {
|
|
593
|
+
latestAttempt?: {
|
|
594
|
+
number: number;
|
|
595
|
+
} | undefined;
|
|
596
|
+
} | undefined;
|
|
597
|
+
failedRegistrationInfo?: {
|
|
598
|
+
code: FailureCode;
|
|
599
|
+
message: string;
|
|
600
|
+
} | undefined;
|
|
601
|
+
_id: string;
|
|
602
|
+
domain: string;
|
|
603
|
+
productInstanceId: string;
|
|
604
|
+
siteInfo?: {
|
|
605
|
+
redirectInfo?: {
|
|
606
|
+
primaryDomain: string;
|
|
607
|
+
} | undefined;
|
|
608
|
+
assignmentType: AssignmentType;
|
|
609
|
+
} | undefined;
|
|
610
|
+
contacts?: {
|
|
611
|
+
registrant?: {
|
|
612
|
+
firstName: string;
|
|
613
|
+
lastName: string;
|
|
614
|
+
email: string;
|
|
615
|
+
address: string;
|
|
616
|
+
city: string;
|
|
617
|
+
countryCode: string;
|
|
618
|
+
phone: string;
|
|
619
|
+
} | undefined;
|
|
620
|
+
admin?: {
|
|
621
|
+
firstName: string;
|
|
622
|
+
lastName: string;
|
|
623
|
+
email: string;
|
|
624
|
+
address: string;
|
|
625
|
+
city: string;
|
|
626
|
+
countryCode: string;
|
|
627
|
+
phone: string;
|
|
628
|
+
} | undefined;
|
|
629
|
+
tech?: {
|
|
630
|
+
firstName: string;
|
|
631
|
+
lastName: string;
|
|
632
|
+
email: string;
|
|
633
|
+
address: string;
|
|
634
|
+
city: string;
|
|
635
|
+
countryCode: string;
|
|
636
|
+
phone: string;
|
|
637
|
+
} | undefined;
|
|
638
|
+
} | undefined;
|
|
639
|
+
status: Status;
|
|
640
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
641
|
+
icannConfirmationStatusInfo?: {
|
|
642
|
+
pending?: {
|
|
643
|
+
notConfirmedBy: string[];
|
|
644
|
+
} | undefined;
|
|
645
|
+
expired?: {
|
|
646
|
+
notConfirmedBy: string[];
|
|
647
|
+
} | undefined;
|
|
648
|
+
} | undefined;
|
|
649
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
650
|
+
}>;
|
|
651
|
+
declare function getRegisteredDomain$1(httpClient: HttpClient): (registeredDomainId: string) => Promise<RegisteredDomain & {
|
|
652
|
+
pendingRegistrationInfo?: {
|
|
653
|
+
latestAttempt?: {
|
|
654
|
+
number: number;
|
|
655
|
+
} | undefined;
|
|
656
|
+
} | undefined;
|
|
657
|
+
failedRegistrationInfo?: {
|
|
658
|
+
code: FailureCode;
|
|
659
|
+
message: string;
|
|
660
|
+
} | undefined;
|
|
661
|
+
_id: string;
|
|
662
|
+
domain: string;
|
|
663
|
+
productInstanceId: string;
|
|
664
|
+
siteInfo?: {
|
|
665
|
+
redirectInfo?: {
|
|
666
|
+
primaryDomain: string;
|
|
667
|
+
} | undefined;
|
|
668
|
+
assignmentType: AssignmentType;
|
|
669
|
+
} | undefined;
|
|
670
|
+
contacts?: {
|
|
671
|
+
registrant?: {
|
|
672
|
+
firstName: string;
|
|
673
|
+
lastName: string;
|
|
674
|
+
email: string;
|
|
675
|
+
address: string;
|
|
676
|
+
city: string;
|
|
677
|
+
countryCode: string;
|
|
678
|
+
phone: string;
|
|
679
|
+
} | undefined;
|
|
680
|
+
admin?: {
|
|
681
|
+
firstName: string;
|
|
682
|
+
lastName: string;
|
|
683
|
+
email: string;
|
|
684
|
+
address: string;
|
|
685
|
+
city: string;
|
|
686
|
+
countryCode: string;
|
|
687
|
+
phone: string;
|
|
688
|
+
} | undefined;
|
|
689
|
+
tech?: {
|
|
690
|
+
firstName: string;
|
|
691
|
+
lastName: string;
|
|
692
|
+
email: string;
|
|
693
|
+
address: string;
|
|
694
|
+
city: string;
|
|
695
|
+
countryCode: string;
|
|
696
|
+
phone: string;
|
|
697
|
+
} | undefined;
|
|
698
|
+
} | undefined;
|
|
699
|
+
status: Status;
|
|
700
|
+
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
701
|
+
icannConfirmationStatusInfo?: {
|
|
702
|
+
pending?: {
|
|
703
|
+
notConfirmedBy: string[];
|
|
704
|
+
} | undefined;
|
|
705
|
+
expired?: {
|
|
706
|
+
notConfirmedBy: string[];
|
|
707
|
+
} | undefined;
|
|
708
|
+
} | undefined;
|
|
709
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
710
|
+
}>;
|
|
711
|
+
declare function listRegisteredDomains$1(httpClient: HttpClient): (options?: ListRegisteredDomainsOptions) => Promise<ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields>;
|
|
712
|
+
declare function redeemRegisteredDomain$1(httpClient: HttpClient): (registeredDomainId: string) => Promise<RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields>;
|
|
713
|
+
|
|
714
|
+
declare const createRegisteredDomain: BuildRESTFunction<typeof createRegisteredDomain$1>;
|
|
715
|
+
declare const getRegisteredDomain: BuildRESTFunction<typeof getRegisteredDomain$1>;
|
|
716
|
+
declare const listRegisteredDomains: BuildRESTFunction<typeof listRegisteredDomains$1>;
|
|
717
|
+
declare const redeemRegisteredDomain: BuildRESTFunction<typeof redeemRegisteredDomain$1>;
|
|
718
|
+
|
|
719
|
+
declare const context_createRegisteredDomain: typeof createRegisteredDomain;
|
|
720
|
+
declare const context_getRegisteredDomain: typeof getRegisteredDomain;
|
|
721
|
+
declare const context_listRegisteredDomains: typeof listRegisteredDomains;
|
|
722
|
+
declare const context_redeemRegisteredDomain: typeof redeemRegisteredDomain;
|
|
723
|
+
declare namespace context {
|
|
724
|
+
export { context_createRegisteredDomain as createRegisteredDomain, context_getRegisteredDomain as getRegisteredDomain, context_listRegisteredDomains as listRegisteredDomains, context_redeemRegisteredDomain as redeemRegisteredDomain };
|
|
725
|
+
}
|
|
726
|
+
|
|
727
|
+
export { context as registeredDomains };
|