@wix/auto_sdk_domains_registered-domains 1.0.13 → 1.0.15

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