@wix/auto_sdk_domains_registered-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/index.d.ts +788 -0
- package/build/cjs/index.js +277 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +254 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +807 -0
- package/build/cjs/meta.js +236 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/es/index.d.mts +788 -0
- package/build/es/index.mjs +242 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/index.typings.d.mts +1 -0
- package/build/es/index.typings.mjs +219 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +807 -0
- package/build/es/meta.mjs +198 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/es/package.json +3 -0
- package/build/internal/cjs/index.d.ts +35 -0
- package/build/internal/cjs/index.js +277 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +816 -0
- package/build/internal/cjs/index.typings.js +254 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +807 -0
- package/build/internal/cjs/meta.js +236 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/es/index.d.mts +35 -0
- package/build/internal/es/index.mjs +242 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/index.typings.d.mts +816 -0
- package/build/internal/es/index.typings.mjs +219 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +807 -0
- package/build/internal/es/meta.mjs +198 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +55 -0
|
@@ -0,0 +1,788 @@
|
|
|
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 {
|
|
6
|
+
/**
|
|
7
|
+
* Domain ID. Identical to `domain`.
|
|
8
|
+
* @format HOSTNAME
|
|
9
|
+
* @readonly
|
|
10
|
+
*/
|
|
11
|
+
_id?: string;
|
|
12
|
+
/**
|
|
13
|
+
* Name of the domain including TLD.
|
|
14
|
+
* Subdomains aren't supported. You can only register a root domain.
|
|
15
|
+
* Domain name and TLD must be separated by a dot. For example,
|
|
16
|
+
* `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
|
|
17
|
+
* supported.
|
|
18
|
+
*
|
|
19
|
+
* Min: 3 characters
|
|
20
|
+
* Max: 63 characters
|
|
21
|
+
* @format HOSTNAME
|
|
22
|
+
*/
|
|
23
|
+
domain?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Date and time the `registeredDomain` object was created in
|
|
26
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
27
|
+
* @readonly
|
|
28
|
+
*/
|
|
29
|
+
_createdDate?: Date | null;
|
|
30
|
+
/**
|
|
31
|
+
* Date and time the `registeredDomain` object was last updated in
|
|
32
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
33
|
+
* @readonly
|
|
34
|
+
*/
|
|
35
|
+
_updatedDate?: Date | null;
|
|
36
|
+
/**
|
|
37
|
+
* Revision number, which increments by 1 each time the registered domain
|
|
38
|
+
* is updated. To prevent conflicting changes, the current revision must be
|
|
39
|
+
* passed when updating the registered domain.
|
|
40
|
+
*
|
|
41
|
+
* Ignored when creating a registered domain.
|
|
42
|
+
*/
|
|
43
|
+
revision?: string | null;
|
|
44
|
+
/**
|
|
45
|
+
* corresponds to service id in SBS
|
|
46
|
+
* @format GUID
|
|
47
|
+
*/
|
|
48
|
+
subscriptionId?: string | null;
|
|
49
|
+
/** Registrant (domain owner) contact information */
|
|
50
|
+
registrantContact?: Contact;
|
|
51
|
+
/** Administrative contact information */
|
|
52
|
+
adminContact?: Contact;
|
|
53
|
+
/** Technical contact information */
|
|
54
|
+
techContact?: Contact;
|
|
55
|
+
/** TLD-specific registration requirements */
|
|
56
|
+
tldData?: TldSpecificData;
|
|
57
|
+
}
|
|
58
|
+
/** Contact information for domain registration */
|
|
59
|
+
interface Contact {
|
|
60
|
+
/**
|
|
61
|
+
* First name
|
|
62
|
+
* @minLength 1
|
|
63
|
+
* @maxLength 100
|
|
64
|
+
*/
|
|
65
|
+
firstName?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Last name
|
|
68
|
+
* @minLength 1
|
|
69
|
+
* @maxLength 100
|
|
70
|
+
*/
|
|
71
|
+
lastName?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Email address
|
|
74
|
+
* @format EMAIL
|
|
75
|
+
*/
|
|
76
|
+
email?: string;
|
|
77
|
+
/**
|
|
78
|
+
* Company or organization name (optional)
|
|
79
|
+
* @maxLength 50
|
|
80
|
+
*/
|
|
81
|
+
company?: string | null;
|
|
82
|
+
/**
|
|
83
|
+
* Street address
|
|
84
|
+
* @minLength 1
|
|
85
|
+
* @maxLength 255
|
|
86
|
+
*/
|
|
87
|
+
streetAddress?: string;
|
|
88
|
+
/**
|
|
89
|
+
* City
|
|
90
|
+
* @minLength 1
|
|
91
|
+
* @maxLength 30
|
|
92
|
+
*/
|
|
93
|
+
city?: string;
|
|
94
|
+
/**
|
|
95
|
+
* Subdivision (such as state, prefecture, or province) in ISO-3166 alpha-2 format (optional)
|
|
96
|
+
* @format SUBDIVISION
|
|
97
|
+
*/
|
|
98
|
+
subdivision?: string | null;
|
|
99
|
+
/**
|
|
100
|
+
* Postal or ZIP code. Optional - some countries (e.g. Jamaica) have no postal system. Max 16 chars.
|
|
101
|
+
* @maxLength 16
|
|
102
|
+
*/
|
|
103
|
+
postalCode?: string | null;
|
|
104
|
+
/**
|
|
105
|
+
* ISO 3166-1 alpha-2 country code
|
|
106
|
+
* @format COUNTRY
|
|
107
|
+
*/
|
|
108
|
+
country?: string;
|
|
109
|
+
/**
|
|
110
|
+
* Phone number in international format
|
|
111
|
+
* @format PHONE
|
|
112
|
+
*/
|
|
113
|
+
phone?: string;
|
|
114
|
+
}
|
|
115
|
+
/** TLD-specific registration data required for certain domain extensions. The `tldType` determines which options field to set. */
|
|
116
|
+
interface TldSpecificData extends TldSpecificDataRequirementsOneOf {
|
|
117
|
+
/** Registration options for .ca domains. */
|
|
118
|
+
caOptions?: CaOptions;
|
|
119
|
+
/** Registration options for .it domains. */
|
|
120
|
+
itOptions?: ItOptions;
|
|
121
|
+
/** Registration options for .com.au domains. */
|
|
122
|
+
comAuOptions?: ComAuOptions;
|
|
123
|
+
/** Registration options for .com.br domains. */
|
|
124
|
+
comBrOptions?: ComBrOptions;
|
|
125
|
+
/** Registration options for .us domains. */
|
|
126
|
+
usOptions?: UsOptions;
|
|
127
|
+
/** Registration options for .se domains. */
|
|
128
|
+
seOptions?: SeOptions;
|
|
129
|
+
/** Registration options for .es domains. */
|
|
130
|
+
esOptions?: EsOptions;
|
|
131
|
+
/** TLD-specific registration data required for certain domain extensions. The `tldType` determines which options field to set. */
|
|
132
|
+
tldType?: TldTypeWithLiterals;
|
|
133
|
+
}
|
|
134
|
+
/** @oneof */
|
|
135
|
+
interface TldSpecificDataRequirementsOneOf {
|
|
136
|
+
/** Registration options for .ca domains. */
|
|
137
|
+
caOptions?: CaOptions;
|
|
138
|
+
/** Registration options for .it domains. */
|
|
139
|
+
itOptions?: ItOptions;
|
|
140
|
+
/** Registration options for .com.au domains. */
|
|
141
|
+
comAuOptions?: ComAuOptions;
|
|
142
|
+
/** Registration options for .com.br domains. */
|
|
143
|
+
comBrOptions?: ComBrOptions;
|
|
144
|
+
/** Registration options for .us domains. */
|
|
145
|
+
usOptions?: UsOptions;
|
|
146
|
+
/** Registration options for .se domains. */
|
|
147
|
+
seOptions?: SeOptions;
|
|
148
|
+
/** Registration options for .es domains. */
|
|
149
|
+
esOptions?: EsOptions;
|
|
150
|
+
}
|
|
151
|
+
/** Legal entity types recognized by the Canadian Internet Registration Authority (CIRA). */
|
|
152
|
+
declare enum LegalTypeEnum {
|
|
153
|
+
/** Aboriginal peoples. */
|
|
154
|
+
ABO = "ABO",
|
|
155
|
+
/** Association. */
|
|
156
|
+
ASS = "ASS",
|
|
157
|
+
/** Canadian corporation. */
|
|
158
|
+
CCO = "CCO",
|
|
159
|
+
/** Canadian citizen. */
|
|
160
|
+
CCT = "CCT",
|
|
161
|
+
/** Educational institution. */
|
|
162
|
+
EDU = "EDU",
|
|
163
|
+
/** Government entity. */
|
|
164
|
+
GOV = "GOV",
|
|
165
|
+
/** Hospital. */
|
|
166
|
+
HOP = "HOP",
|
|
167
|
+
/** Indian band. */
|
|
168
|
+
INB = "INB",
|
|
169
|
+
/** Library, archive, or museum. */
|
|
170
|
+
LAM = "LAM",
|
|
171
|
+
/** Legal representative. */
|
|
172
|
+
LGR = "LGR",
|
|
173
|
+
/** Her Majesty the Queen. */
|
|
174
|
+
MAJ = "MAJ",
|
|
175
|
+
/** Official mark registered under the Trademarks Act. */
|
|
176
|
+
OMK = "OMK",
|
|
177
|
+
/** Political party. */
|
|
178
|
+
PLT = "PLT",
|
|
179
|
+
/** Partnership. */
|
|
180
|
+
PRT = "PRT",
|
|
181
|
+
/** Permanent resident. */
|
|
182
|
+
RES = "RES",
|
|
183
|
+
/** Trademark owner. */
|
|
184
|
+
TDM = "TDM",
|
|
185
|
+
/** Trade union. */
|
|
186
|
+
TRD = "TRD",
|
|
187
|
+
/** Trust. */
|
|
188
|
+
TRS = "TRS"
|
|
189
|
+
}
|
|
190
|
+
/** @enumType */
|
|
191
|
+
type LegalTypeEnumWithLiterals = LegalTypeEnum | 'ABO' | 'ASS' | 'CCO' | 'CCT' | 'EDU' | 'GOV' | 'HOP' | 'INB' | 'LAM' | 'LGR' | 'MAJ' | 'OMK' | 'PLT' | 'PRT' | 'RES' | 'TDM' | 'TRD' | 'TRS';
|
|
192
|
+
/** Legal type of the registrant. */
|
|
193
|
+
interface LegalType {
|
|
194
|
+
value?: LegalTypeEnumWithLiterals;
|
|
195
|
+
}
|
|
196
|
+
/** Entity types recognized by the Italian registry (Registro.it). */
|
|
197
|
+
declare enum EntityTypeEnum {
|
|
198
|
+
/** Italian resident. */
|
|
199
|
+
ITR = "ITR",
|
|
200
|
+
/** Foreign resident. */
|
|
201
|
+
FOR = "FOR",
|
|
202
|
+
/** Company or sole proprietorship. */
|
|
203
|
+
COM = "COM",
|
|
204
|
+
/** Freelance worker. */
|
|
205
|
+
FWI = "FWI",
|
|
206
|
+
/** Nonprofit organization. */
|
|
207
|
+
NPO = "NPO",
|
|
208
|
+
/** Public organization. */
|
|
209
|
+
POI = "POI",
|
|
210
|
+
/** Other entity type. */
|
|
211
|
+
OSI = "OSI"
|
|
212
|
+
}
|
|
213
|
+
/** @enumType */
|
|
214
|
+
type EntityTypeEnumWithLiterals = EntityTypeEnum | 'ITR' | 'FOR' | 'COM' | 'FWI' | 'NPO' | 'POI' | 'OSI';
|
|
215
|
+
/** Entity type of the registrant. */
|
|
216
|
+
interface EntityType {
|
|
217
|
+
value?: EntityTypeEnumWithLiterals;
|
|
218
|
+
}
|
|
219
|
+
/** Policy reasons recognized by the .au Domain Administration (auDA). */
|
|
220
|
+
declare enum PolicyReasonEnum {
|
|
221
|
+
/** Exact match to the registrant's name or trademark. */
|
|
222
|
+
EXC = "EXC",
|
|
223
|
+
/** Close and substantial connection to the registrant. */
|
|
224
|
+
CLS = "CLS"
|
|
225
|
+
}
|
|
226
|
+
/** @enumType */
|
|
227
|
+
type PolicyReasonEnumWithLiterals = PolicyReasonEnum | 'EXC' | 'CLS';
|
|
228
|
+
/** Eligibility types recognized by the .au Domain Administration (auDA). */
|
|
229
|
+
declare enum EligibilityTypeEnum {
|
|
230
|
+
/** Company. */
|
|
231
|
+
COM = "COM",
|
|
232
|
+
/** Sole trader. */
|
|
233
|
+
STR = "STR",
|
|
234
|
+
/** Partnership. */
|
|
235
|
+
PRT = "PRT",
|
|
236
|
+
/** Trademark owner. */
|
|
237
|
+
TRO = "TRO",
|
|
238
|
+
/** Pending trademark owner. */
|
|
239
|
+
PTO = "PTO",
|
|
240
|
+
/** Commonwealth entity. */
|
|
241
|
+
CWE = "CWE",
|
|
242
|
+
/** Government body. */
|
|
243
|
+
GVB = "GVB",
|
|
244
|
+
/** Incorporated association. */
|
|
245
|
+
INA = "INA",
|
|
246
|
+
/** Trust. */
|
|
247
|
+
TRS = "TRS",
|
|
248
|
+
/** Statutory body. */
|
|
249
|
+
STB = "STB",
|
|
250
|
+
/** Trading cooperative. */
|
|
251
|
+
TRC = "TRC",
|
|
252
|
+
/** Registered business. */
|
|
253
|
+
RBU = "RBU"
|
|
254
|
+
}
|
|
255
|
+
/** @enumType */
|
|
256
|
+
type EligibilityTypeEnumWithLiterals = EligibilityTypeEnum | 'COM' | 'STR' | 'PRT' | 'TRO' | 'PTO' | 'CWE' | 'GVB' | 'INA' | 'TRS' | 'STB' | 'TRC' | 'RBU';
|
|
257
|
+
/** Identification types recognized by the .au Domain Administration (auDA). */
|
|
258
|
+
declare enum EligibilityIdTypeEnum {
|
|
259
|
+
/** Australian Business Number. */
|
|
260
|
+
ABN = "ABN",
|
|
261
|
+
/** Australian Company Number. */
|
|
262
|
+
ACN = "ACN"
|
|
263
|
+
}
|
|
264
|
+
/** @enumType */
|
|
265
|
+
type EligibilityIdTypeEnumWithLiterals = EligibilityIdTypeEnum | 'ABN' | 'ACN';
|
|
266
|
+
/** Reason the registrant is eligible for the domain name. */
|
|
267
|
+
interface PolicyReason {
|
|
268
|
+
value?: PolicyReasonEnumWithLiterals;
|
|
269
|
+
}
|
|
270
|
+
/** Type of entity registering the domain. */
|
|
271
|
+
interface EligibilityType {
|
|
272
|
+
value?: EligibilityTypeEnumWithLiterals;
|
|
273
|
+
}
|
|
274
|
+
/** Type of identification number provided for eligibility. */
|
|
275
|
+
interface EligibilityIdType {
|
|
276
|
+
value?: EligibilityIdTypeEnumWithLiterals;
|
|
277
|
+
}
|
|
278
|
+
/** Nexus category indicating the registrant's connection to the United States. */
|
|
279
|
+
declare enum NexusCategory {
|
|
280
|
+
/** US citizen. */
|
|
281
|
+
C11 = "C11",
|
|
282
|
+
/** Permanent resident. */
|
|
283
|
+
C12 = "C12",
|
|
284
|
+
/** US entity or organization. */
|
|
285
|
+
C21 = "C21",
|
|
286
|
+
/** Foreign entity with a presence in the US market. */
|
|
287
|
+
C31 = "C31",
|
|
288
|
+
/** Foreign entity with a US office. */
|
|
289
|
+
C32 = "C32"
|
|
290
|
+
}
|
|
291
|
+
/** @enumType */
|
|
292
|
+
type NexusCategoryWithLiterals = NexusCategory | 'C11' | 'C12' | 'C21' | 'C31' | 'C32';
|
|
293
|
+
/** TLD-specific registration data required for certain domain extensions. The `tldType` determines which options field to set. */
|
|
294
|
+
declare enum TldType {
|
|
295
|
+
/** .ca domains. */
|
|
296
|
+
CA = "CA",
|
|
297
|
+
/** .it domains. */
|
|
298
|
+
IT = "IT",
|
|
299
|
+
/** .com.au domains. */
|
|
300
|
+
COM_AU = "COM_AU",
|
|
301
|
+
/** .com.br domains. */
|
|
302
|
+
COM_BR = "COM_BR",
|
|
303
|
+
/** .us domains. */
|
|
304
|
+
US = "US",
|
|
305
|
+
/** .se domains. */
|
|
306
|
+
SE = "SE",
|
|
307
|
+
/** .es domains. */
|
|
308
|
+
ES = "ES"
|
|
309
|
+
}
|
|
310
|
+
/** @enumType */
|
|
311
|
+
type TldTypeWithLiterals = TldType | 'CA' | 'IT' | 'COM_AU' | 'COM_BR' | 'US' | 'SE' | 'ES';
|
|
312
|
+
/** Registration options for .ca domains. */
|
|
313
|
+
interface CaOptions {
|
|
314
|
+
/** Registrant's legal type. Required for .ca domains. */
|
|
315
|
+
legalType?: LegalType;
|
|
316
|
+
}
|
|
317
|
+
/** Registration options for .it domains. */
|
|
318
|
+
interface ItOptions {
|
|
319
|
+
/** Registrant's entity type. Required for .it domains. */
|
|
320
|
+
entityType?: EntityType;
|
|
321
|
+
/**
|
|
322
|
+
* Registration code such as a VAT number, tax ID, or fiscal code. Required for .it domains. Maximum 20 characters.
|
|
323
|
+
* @maxLength 20
|
|
324
|
+
*/
|
|
325
|
+
regCode?: string | null;
|
|
326
|
+
}
|
|
327
|
+
/** Registration options for .com.au domains. */
|
|
328
|
+
interface ComAuOptions {
|
|
329
|
+
/** Reason the registrant is eligible for the domain name. Required for .com.au domains. */
|
|
330
|
+
policyReason?: PolicyReason;
|
|
331
|
+
/** Type of entity registering the domain. Required for .com.au domains. */
|
|
332
|
+
eligibilityType?: EligibilityType;
|
|
333
|
+
/** Type of identification number provided. Required for .com.au domains. */
|
|
334
|
+
eligibilityIdType?: EligibilityIdType;
|
|
335
|
+
/**
|
|
336
|
+
* Eligibility identification number, such as an ABN or ACN. Required for .com.au domains. Maximum 20 characters.
|
|
337
|
+
* @maxLength 20
|
|
338
|
+
*/
|
|
339
|
+
eligibilityId?: string | null;
|
|
340
|
+
/**
|
|
341
|
+
* Registrant's entity name. Required for .com.au domains. Maximum 255 characters.
|
|
342
|
+
* @maxLength 255
|
|
343
|
+
*/
|
|
344
|
+
registrantName?: string | null;
|
|
345
|
+
}
|
|
346
|
+
/** Registration options for .com.br domains. */
|
|
347
|
+
interface ComBrOptions {
|
|
348
|
+
/**
|
|
349
|
+
* Brazilian tax ID. CPF for individuals, CNPJ for companies.
|
|
350
|
+
*
|
|
351
|
+
* + CPF format: 123.456.789-87 (11 digits)
|
|
352
|
+
* + CNPJ format: 01.234.456/5432-10 (14 digits)
|
|
353
|
+
* @minLength 11
|
|
354
|
+
* @maxLength 18
|
|
355
|
+
*/
|
|
356
|
+
identificationNumber?: string | null;
|
|
357
|
+
}
|
|
358
|
+
/** Registration options for .us domains. */
|
|
359
|
+
interface UsOptions {
|
|
360
|
+
/** Registrant's nexus category. Required for .us domains. */
|
|
361
|
+
nexusCategory?: NexusCategoryWithLiterals;
|
|
362
|
+
}
|
|
363
|
+
/** Registration options for .se domains. */
|
|
364
|
+
interface SeOptions {
|
|
365
|
+
/**
|
|
366
|
+
* Registrant's identification number. Required for .se domains.
|
|
367
|
+
*
|
|
368
|
+
* + Individuals: national ID card or passport number.
|
|
369
|
+
* + Organizations: business registration number or VAT-ID.
|
|
370
|
+
* @maxLength 20
|
|
371
|
+
*/
|
|
372
|
+
idNumber?: string | null;
|
|
373
|
+
}
|
|
374
|
+
/** Registration options for .es domains. */
|
|
375
|
+
interface EsOptions {
|
|
376
|
+
/**
|
|
377
|
+
* Registrant's government-issued ID number. Required for .es domains.
|
|
378
|
+
*
|
|
379
|
+
* + Spanish registrants: DNI, NIF, or NIE.
|
|
380
|
+
* + Foreign registrants: equivalent national ID or tax ID.
|
|
381
|
+
*
|
|
382
|
+
* Note: the admin contact must be a natural person (not a company).
|
|
383
|
+
* @maxLength 20
|
|
384
|
+
*/
|
|
385
|
+
govId?: string | null;
|
|
386
|
+
}
|
|
387
|
+
interface InitiateTransferRequest {
|
|
388
|
+
/**
|
|
389
|
+
* Domain name to transfer.
|
|
390
|
+
* @format HOSTNAME
|
|
391
|
+
*/
|
|
392
|
+
domain: string;
|
|
393
|
+
/**
|
|
394
|
+
* Email address of the Wix account to transfer the domain to.
|
|
395
|
+
* @format EMAIL
|
|
396
|
+
*/
|
|
397
|
+
targetEmail: string;
|
|
398
|
+
}
|
|
399
|
+
interface InitiateTransferResponse {
|
|
400
|
+
}
|
|
401
|
+
interface ApproveTransferRequest {
|
|
402
|
+
/**
|
|
403
|
+
* Domain name to approve the transfer for.
|
|
404
|
+
* @format HOSTNAME
|
|
405
|
+
*/
|
|
406
|
+
domain: string;
|
|
407
|
+
/**
|
|
408
|
+
* Confirmation token received in the transfer invite email.
|
|
409
|
+
* @maxLength 1024
|
|
410
|
+
*/
|
|
411
|
+
confirmationToken: string;
|
|
412
|
+
}
|
|
413
|
+
interface ApproveTransferResponse {
|
|
414
|
+
}
|
|
415
|
+
interface DomainChangedEvent extends DomainChangedEventPayloadOneOf {
|
|
416
|
+
/** WARNING: `registered` event payload is DEPRECATED */
|
|
417
|
+
registered?: Registered;
|
|
418
|
+
/** WARNING: `registration_cancelled` event payload is DEPRECATED */
|
|
419
|
+
registrationCancelled?: RegistrationCancelled;
|
|
420
|
+
connectedToSite?: ConnectedToSite;
|
|
421
|
+
disconnectedFromSite?: DisconnectedFromSite;
|
|
422
|
+
/** WARNING: `registration_extended` event payload is DEPRECATED */
|
|
423
|
+
registrationExtended?: RegistrationExtended;
|
|
424
|
+
/** WARNING: `owner_changed` event payload is DEPRECATED */
|
|
425
|
+
ownerChanged?: OwnerChanged;
|
|
426
|
+
/** WARNING: `privacy_changed` event payload is DEPRECATED */
|
|
427
|
+
privacyChanged?: PrivacyChanged;
|
|
428
|
+
/** WARNING: `management_type_changed` event payload is DEPRECATED */
|
|
429
|
+
managementTypeChanged?: ManagementTypeChanged;
|
|
430
|
+
/** WARNING: `billing_subscription_cancelled` event payload is DEPRECATED */
|
|
431
|
+
billingSubscriptionCancelled?: BillingSubscriptionCancelled;
|
|
432
|
+
/** WARNING: `connection_verified` event payload is DEPRECATED */
|
|
433
|
+
connectionVerified?: ConnectionVerified;
|
|
434
|
+
/** WARNING: `connection_lost` event payload is DEPRECATED */
|
|
435
|
+
connectionLost?: ConnectionLost;
|
|
436
|
+
/** WARNING: `expiration_date_changed` event payload is DEPRECATED */
|
|
437
|
+
expirationDateChanged?: ExpirationDateChanged;
|
|
438
|
+
propagationStarted?: PropagationStarted;
|
|
439
|
+
verificationStarted?: VerificationStarted;
|
|
440
|
+
contactVerificationStatusChanged?: ContactVerificationStatusChanged;
|
|
441
|
+
/** Expiry/GraceStarted */
|
|
442
|
+
expired?: Expired;
|
|
443
|
+
/** GraceEnded/RedemptionStarted */
|
|
444
|
+
graceEnded?: GraceEnded;
|
|
445
|
+
/** RedemptionEnded */
|
|
446
|
+
redemptionEnded?: RedemptionEnded;
|
|
447
|
+
/** enable or disable dnssec */
|
|
448
|
+
dnssecChanged?: DnssecChanged;
|
|
449
|
+
/** domain SKU updated due to price increase */
|
|
450
|
+
priceIncreaseProcessed?: PriceIncreaseProcessed;
|
|
451
|
+
domainName?: string;
|
|
452
|
+
changeTime?: Date | null;
|
|
453
|
+
}
|
|
454
|
+
/** @oneof */
|
|
455
|
+
interface DomainChangedEventPayloadOneOf {
|
|
456
|
+
/** WARNING: `registered` event payload is DEPRECATED */
|
|
457
|
+
registered?: Registered;
|
|
458
|
+
/** WARNING: `registration_cancelled` event payload is DEPRECATED */
|
|
459
|
+
registrationCancelled?: RegistrationCancelled;
|
|
460
|
+
connectedToSite?: ConnectedToSite;
|
|
461
|
+
disconnectedFromSite?: DisconnectedFromSite;
|
|
462
|
+
/** WARNING: `registration_extended` event payload is DEPRECATED */
|
|
463
|
+
registrationExtended?: RegistrationExtended;
|
|
464
|
+
/** WARNING: `owner_changed` event payload is DEPRECATED */
|
|
465
|
+
ownerChanged?: OwnerChanged;
|
|
466
|
+
/** WARNING: `privacy_changed` event payload is DEPRECATED */
|
|
467
|
+
privacyChanged?: PrivacyChanged;
|
|
468
|
+
/** WARNING: `management_type_changed` event payload is DEPRECATED */
|
|
469
|
+
managementTypeChanged?: ManagementTypeChanged;
|
|
470
|
+
/** WARNING: `billing_subscription_cancelled` event payload is DEPRECATED */
|
|
471
|
+
billingSubscriptionCancelled?: BillingSubscriptionCancelled;
|
|
472
|
+
/** WARNING: `connection_verified` event payload is DEPRECATED */
|
|
473
|
+
connectionVerified?: ConnectionVerified;
|
|
474
|
+
/** WARNING: `connection_lost` event payload is DEPRECATED */
|
|
475
|
+
connectionLost?: ConnectionLost;
|
|
476
|
+
/** WARNING: `expiration_date_changed` event payload is DEPRECATED */
|
|
477
|
+
expirationDateChanged?: ExpirationDateChanged;
|
|
478
|
+
propagationStarted?: PropagationStarted;
|
|
479
|
+
verificationStarted?: VerificationStarted;
|
|
480
|
+
contactVerificationStatusChanged?: ContactVerificationStatusChanged;
|
|
481
|
+
/** Expiry/GraceStarted */
|
|
482
|
+
expired?: Expired;
|
|
483
|
+
/** GraceEnded/RedemptionStarted */
|
|
484
|
+
graceEnded?: GraceEnded;
|
|
485
|
+
/** RedemptionEnded */
|
|
486
|
+
redemptionEnded?: RedemptionEnded;
|
|
487
|
+
/** enable or disable dnssec */
|
|
488
|
+
dnssecChanged?: DnssecChanged;
|
|
489
|
+
/** domain SKU updated due to price increase */
|
|
490
|
+
priceIncreaseProcessed?: PriceIncreaseProcessed;
|
|
491
|
+
}
|
|
492
|
+
interface Registered {
|
|
493
|
+
/** @format GUID */
|
|
494
|
+
registrationId?: string;
|
|
495
|
+
}
|
|
496
|
+
interface RegistrationCancelled {
|
|
497
|
+
/** @format GUID */
|
|
498
|
+
registrationId?: string;
|
|
499
|
+
}
|
|
500
|
+
interface ConnectedToSite {
|
|
501
|
+
/** @format GUID */
|
|
502
|
+
msid?: string;
|
|
503
|
+
}
|
|
504
|
+
interface DisconnectedFromSite {
|
|
505
|
+
/** @format GUID */
|
|
506
|
+
msid?: string;
|
|
507
|
+
}
|
|
508
|
+
interface RegistrationExtended {
|
|
509
|
+
/** @format GUID */
|
|
510
|
+
registrationId?: string;
|
|
511
|
+
}
|
|
512
|
+
interface OwnerChanged {
|
|
513
|
+
/** @format GUID */
|
|
514
|
+
oldUserGuid?: string;
|
|
515
|
+
/** @format GUID */
|
|
516
|
+
newUserGuid?: string;
|
|
517
|
+
/** @format GUID */
|
|
518
|
+
oldRegistrationId?: string | null;
|
|
519
|
+
/** @format GUID */
|
|
520
|
+
newRegistrationId?: string | null;
|
|
521
|
+
}
|
|
522
|
+
interface PrivacyChanged {
|
|
523
|
+
/** @format GUID */
|
|
524
|
+
registrationId?: string;
|
|
525
|
+
}
|
|
526
|
+
interface ManagementTypeChanged {
|
|
527
|
+
}
|
|
528
|
+
interface BillingSubscriptionCancelled {
|
|
529
|
+
/** @format GUID */
|
|
530
|
+
registrationId?: string;
|
|
531
|
+
}
|
|
532
|
+
interface ConnectionVerified {
|
|
533
|
+
}
|
|
534
|
+
interface ConnectionLost {
|
|
535
|
+
}
|
|
536
|
+
interface ExpirationDateChanged {
|
|
537
|
+
/** @format GUID */
|
|
538
|
+
registrationId?: string;
|
|
539
|
+
}
|
|
540
|
+
interface PropagationStarted {
|
|
541
|
+
/** @format GUID */
|
|
542
|
+
userGuid?: string;
|
|
543
|
+
}
|
|
544
|
+
interface VerificationStarted {
|
|
545
|
+
/** @format GUID */
|
|
546
|
+
userGuid?: string;
|
|
547
|
+
}
|
|
548
|
+
interface ContactVerificationStatusChanged {
|
|
549
|
+
status?: ContactVerificationStatusWithLiterals;
|
|
550
|
+
}
|
|
551
|
+
declare enum ContactVerificationStatus {
|
|
552
|
+
PENDING = "PENDING",
|
|
553
|
+
DEACTIVATED = "DEACTIVATED",
|
|
554
|
+
CONFIRMED_BY_WIX = "CONFIRMED_BY_WIX",
|
|
555
|
+
CONFIRMED_BY_REGDOTCOM = "CONFIRMED_BY_REGDOTCOM"
|
|
556
|
+
}
|
|
557
|
+
/** @enumType */
|
|
558
|
+
type ContactVerificationStatusWithLiterals = ContactVerificationStatus | 'PENDING' | 'DEACTIVATED' | 'CONFIRMED_BY_WIX' | 'CONFIRMED_BY_REGDOTCOM';
|
|
559
|
+
interface Expired {
|
|
560
|
+
}
|
|
561
|
+
interface GraceEnded {
|
|
562
|
+
}
|
|
563
|
+
interface RedemptionEnded {
|
|
564
|
+
}
|
|
565
|
+
interface DnssecChanged {
|
|
566
|
+
/**
|
|
567
|
+
* unique registration id
|
|
568
|
+
* @format GUID
|
|
569
|
+
*/
|
|
570
|
+
registrationId?: string;
|
|
571
|
+
}
|
|
572
|
+
interface PriceIncreaseProcessed {
|
|
573
|
+
}
|
|
574
|
+
interface DomainReleaseCouponEvent extends DomainReleaseCouponEventTriggerTypeInfoOneOf {
|
|
575
|
+
reviveFromChargebackInfo?: ReviveFromChargebackInfo;
|
|
576
|
+
domainName?: string;
|
|
577
|
+
couponCode?: string;
|
|
578
|
+
triggerType?: TriggerTypeWithLiterals;
|
|
579
|
+
}
|
|
580
|
+
/** @oneof */
|
|
581
|
+
interface DomainReleaseCouponEventTriggerTypeInfoOneOf {
|
|
582
|
+
reviveFromChargebackInfo?: ReviveFromChargebackInfo;
|
|
583
|
+
}
|
|
584
|
+
declare enum TriggerType {
|
|
585
|
+
UNKNOWN_EVENT_TYPE = "UNKNOWN_EVENT_TYPE",
|
|
586
|
+
REVIVE_FROM_CHARGEBACK = "REVIVE_FROM_CHARGEBACK"
|
|
587
|
+
}
|
|
588
|
+
/** @enumType */
|
|
589
|
+
type TriggerTypeWithLiterals = TriggerType | 'UNKNOWN_EVENT_TYPE' | 'REVIVE_FROM_CHARGEBACK';
|
|
590
|
+
interface ReviveFromChargebackInfo {
|
|
591
|
+
/** @format GUID */
|
|
592
|
+
extContractId?: string;
|
|
593
|
+
}
|
|
594
|
+
interface CreateRegisteredDomainRequest {
|
|
595
|
+
/** Information about the domain to register including contact details. */
|
|
596
|
+
registeredDomain?: RegisteredDomain;
|
|
597
|
+
}
|
|
598
|
+
interface CreateRegisteredDomainResponse {
|
|
599
|
+
/** Created registered domain. */
|
|
600
|
+
registeredDomain?: RegisteredDomain;
|
|
601
|
+
}
|
|
602
|
+
interface CreateRegisteredDomainInternalRequest {
|
|
603
|
+
/** Information about the domain to register including contact details. */
|
|
604
|
+
registeredDomain?: RegisteredDomain;
|
|
605
|
+
}
|
|
606
|
+
interface CreateRegisteredDomainInternalResponse {
|
|
607
|
+
/** Created registered domain. */
|
|
608
|
+
registeredDomain?: RegisteredDomain;
|
|
609
|
+
}
|
|
610
|
+
interface UpdateRegisteredDomainRequest {
|
|
611
|
+
/** Registered domain with updated fields. */
|
|
612
|
+
registeredDomain?: RegisteredDomain;
|
|
613
|
+
/** Fields to update. Only specified fields are modified. */
|
|
614
|
+
fieldMask?: string[];
|
|
615
|
+
}
|
|
616
|
+
interface UpdateRegisteredDomainResponse {
|
|
617
|
+
/** Updated registered domain. */
|
|
618
|
+
registeredDomain?: RegisteredDomain;
|
|
619
|
+
}
|
|
620
|
+
interface ScheduleNearExpirationReminderRequest {
|
|
621
|
+
/** @format HOSTNAME */
|
|
622
|
+
domain?: string;
|
|
623
|
+
}
|
|
624
|
+
interface ScheduleNearExpirationReminderResponse {
|
|
625
|
+
registeredDomain?: RegisteredDomain;
|
|
626
|
+
}
|
|
627
|
+
interface ScheduleContactDetailsReminderRequest {
|
|
628
|
+
/** @format HOSTNAME */
|
|
629
|
+
domain?: string;
|
|
630
|
+
}
|
|
631
|
+
interface ScheduleContactDetailsReminderResponse {
|
|
632
|
+
registeredDomain?: RegisteredDomain;
|
|
633
|
+
}
|
|
634
|
+
interface ScheduleParkAfterRefundRequest {
|
|
635
|
+
/** @format HOSTNAME */
|
|
636
|
+
domain?: string;
|
|
637
|
+
/** @format GUID */
|
|
638
|
+
subscriptionId?: string;
|
|
639
|
+
parkAtDate?: Date | null;
|
|
640
|
+
}
|
|
641
|
+
interface ScheduleParkAfterRefundResponse {
|
|
642
|
+
registeredDomain?: RegisteredDomain;
|
|
643
|
+
}
|
|
644
|
+
interface MessageEnvelope {
|
|
645
|
+
/**
|
|
646
|
+
* App instance ID.
|
|
647
|
+
* @format GUID
|
|
648
|
+
*/
|
|
649
|
+
instanceId?: string | null;
|
|
650
|
+
/**
|
|
651
|
+
* Event type.
|
|
652
|
+
* @maxLength 150
|
|
653
|
+
*/
|
|
654
|
+
eventType?: string;
|
|
655
|
+
/** The identification type and identity data. */
|
|
656
|
+
identity?: IdentificationData;
|
|
657
|
+
/** Stringify payload. */
|
|
658
|
+
data?: string;
|
|
659
|
+
/** Details related to the account */
|
|
660
|
+
accountInfo?: AccountInfo;
|
|
661
|
+
}
|
|
662
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
663
|
+
/**
|
|
664
|
+
* ID of a site visitor that has not logged in to the site.
|
|
665
|
+
* @format GUID
|
|
666
|
+
*/
|
|
667
|
+
anonymousVisitorId?: string;
|
|
668
|
+
/**
|
|
669
|
+
* ID of a site visitor that has logged in to the site.
|
|
670
|
+
* @format GUID
|
|
671
|
+
*/
|
|
672
|
+
memberId?: string;
|
|
673
|
+
/**
|
|
674
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
675
|
+
* @format GUID
|
|
676
|
+
*/
|
|
677
|
+
wixUserId?: string;
|
|
678
|
+
/**
|
|
679
|
+
* ID of an app.
|
|
680
|
+
* @format GUID
|
|
681
|
+
*/
|
|
682
|
+
appId?: string;
|
|
683
|
+
/** @readonly */
|
|
684
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
685
|
+
}
|
|
686
|
+
/** @oneof */
|
|
687
|
+
interface IdentificationDataIdOneOf {
|
|
688
|
+
/**
|
|
689
|
+
* ID of a site visitor that has not logged in to the site.
|
|
690
|
+
* @format GUID
|
|
691
|
+
*/
|
|
692
|
+
anonymousVisitorId?: string;
|
|
693
|
+
/**
|
|
694
|
+
* ID of a site visitor that has logged in to the site.
|
|
695
|
+
* @format GUID
|
|
696
|
+
*/
|
|
697
|
+
memberId?: string;
|
|
698
|
+
/**
|
|
699
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
700
|
+
* @format GUID
|
|
701
|
+
*/
|
|
702
|
+
wixUserId?: string;
|
|
703
|
+
/**
|
|
704
|
+
* ID of an app.
|
|
705
|
+
* @format GUID
|
|
706
|
+
*/
|
|
707
|
+
appId?: string;
|
|
708
|
+
}
|
|
709
|
+
declare enum WebhookIdentityType {
|
|
710
|
+
UNKNOWN = "UNKNOWN",
|
|
711
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
712
|
+
MEMBER = "MEMBER",
|
|
713
|
+
WIX_USER = "WIX_USER",
|
|
714
|
+
APP = "APP"
|
|
715
|
+
}
|
|
716
|
+
/** @enumType */
|
|
717
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
718
|
+
interface AccountInfo {
|
|
719
|
+
/**
|
|
720
|
+
* ID of the Wix account associated with the event.
|
|
721
|
+
* @format GUID
|
|
722
|
+
*/
|
|
723
|
+
accountId?: string | null;
|
|
724
|
+
/**
|
|
725
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
726
|
+
* @format GUID
|
|
727
|
+
*/
|
|
728
|
+
parentAccountId?: string | null;
|
|
729
|
+
/**
|
|
730
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
731
|
+
* @format GUID
|
|
732
|
+
*/
|
|
733
|
+
siteId?: string | null;
|
|
734
|
+
}
|
|
735
|
+
/** @docsIgnore */
|
|
736
|
+
type InitiateTransferApplicationErrors = {
|
|
737
|
+
code?: 'DOMAIN_NOT_OWNED_BY_CALLER';
|
|
738
|
+
description?: string;
|
|
739
|
+
data?: Record<string, any>;
|
|
740
|
+
} | {
|
|
741
|
+
code?: 'DOMAIN_NOT_ELIGIBLE_FOR_TRANSFER';
|
|
742
|
+
description?: string;
|
|
743
|
+
data?: Record<string, any>;
|
|
744
|
+
} | {
|
|
745
|
+
code?: 'TARGET_EMAIL_NOT_FOUND';
|
|
746
|
+
description?: string;
|
|
747
|
+
data?: Record<string, any>;
|
|
748
|
+
} | {
|
|
749
|
+
code?: 'CANNOT_TRANSFER_TO_SELF';
|
|
750
|
+
description?: string;
|
|
751
|
+
data?: Record<string, any>;
|
|
752
|
+
};
|
|
753
|
+
/** @docsIgnore */
|
|
754
|
+
type ApproveTransferApplicationErrors = {
|
|
755
|
+
code?: 'TRANSFER_REQUEST_EXPIRED';
|
|
756
|
+
description?: string;
|
|
757
|
+
data?: Record<string, any>;
|
|
758
|
+
} | {
|
|
759
|
+
code?: 'CONFIRMATION_PROCESS_NOT_FOUND';
|
|
760
|
+
description?: string;
|
|
761
|
+
data?: Record<string, any>;
|
|
762
|
+
} | {
|
|
763
|
+
code?: 'CONFIRMATION_PROCESS_INVALID_TOKEN';
|
|
764
|
+
description?: string;
|
|
765
|
+
data?: Record<string, any>;
|
|
766
|
+
} | {
|
|
767
|
+
code?: 'CONFIRMATION_PROCESS_TOKEN_ALREADY_REPORTED';
|
|
768
|
+
description?: string;
|
|
769
|
+
data?: Record<string, any>;
|
|
770
|
+
} | {
|
|
771
|
+
code?: 'DOMAIN_ALREADY_BELONGS_TO_USER';
|
|
772
|
+
description?: string;
|
|
773
|
+
data?: Record<string, any>;
|
|
774
|
+
} | {
|
|
775
|
+
code?: 'DOMAINS_TRANSFER_BETWEEN_ACCOUNTS_NOT_ALLOWED';
|
|
776
|
+
description?: string;
|
|
777
|
+
data?: Record<string, any>;
|
|
778
|
+
} | {
|
|
779
|
+
code?: 'DOMAINS_TRANSFER_FOR_PENDING_REDEMPTION_NOT_ALLOWED';
|
|
780
|
+
description?: string;
|
|
781
|
+
data?: Record<string, any>;
|
|
782
|
+
} | {
|
|
783
|
+
code?: 'DOMAINS_TRANSFER_BETWEEN_ACCOUNTS_NOT_ALLOWED_FOR_BASE44';
|
|
784
|
+
description?: string;
|
|
785
|
+
data?: Record<string, any>;
|
|
786
|
+
};
|
|
787
|
+
|
|
788
|
+
export { type AccountInfo, type ApproveTransferApplicationErrors, type ApproveTransferRequest, type ApproveTransferResponse, type BillingSubscriptionCancelled, type CaOptions, type ComAuOptions, type ComBrOptions, type ConnectedToSite, type ConnectionLost, type ConnectionVerified, type Contact, ContactVerificationStatus, type ContactVerificationStatusChanged, type ContactVerificationStatusWithLiterals, type CreateRegisteredDomainInternalRequest, type CreateRegisteredDomainInternalResponse, type CreateRegisteredDomainRequest, type CreateRegisteredDomainResponse, type DisconnectedFromSite, type DnssecChanged, type DomainChangedEvent, type DomainChangedEventPayloadOneOf, type DomainReleaseCouponEvent, type DomainReleaseCouponEventTriggerTypeInfoOneOf, type EligibilityIdType, EligibilityIdTypeEnum, type EligibilityIdTypeEnumWithLiterals, type EligibilityType, EligibilityTypeEnum, type EligibilityTypeEnumWithLiterals, type EntityType, EntityTypeEnum, type EntityTypeEnumWithLiterals, type EsOptions, type ExpirationDateChanged, type Expired, type GraceEnded, type IdentificationData, type IdentificationDataIdOneOf, type InitiateTransferApplicationErrors, type InitiateTransferRequest, type InitiateTransferResponse, type ItOptions, type LegalType, LegalTypeEnum, type LegalTypeEnumWithLiterals, type ManagementTypeChanged, type MessageEnvelope, NexusCategory, type NexusCategoryWithLiterals, type OwnerChanged, type PolicyReason, PolicyReasonEnum, type PolicyReasonEnumWithLiterals, type PriceIncreaseProcessed, type PrivacyChanged, type PropagationStarted, type RedemptionEnded, type Registered, type RegisteredDomain, type RegistrationCancelled, type RegistrationExtended, type ReviveFromChargebackInfo, type ScheduleContactDetailsReminderRequest, type ScheduleContactDetailsReminderResponse, type ScheduleNearExpirationReminderRequest, type ScheduleNearExpirationReminderResponse, type ScheduleParkAfterRefundRequest, type ScheduleParkAfterRefundResponse, type SeOptions, type TldSpecificData, type TldSpecificDataRequirementsOneOf, TldType, type TldTypeWithLiterals, TriggerType, type TriggerTypeWithLiterals, type UpdateRegisteredDomainRequest, type UpdateRegisteredDomainResponse, type UsOptions, type VerificationStarted, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };
|