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