@wix/auto_sdk_domains_registered-domains 1.0.19 → 1.0.21

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.
@@ -474,6 +474,26 @@ interface IlOptions {
474
474
  */
475
475
  registrationNumber?: string | null;
476
476
  }
477
+ /** Sent after the registrar accepted new name servers for a registered domain. */
478
+ interface NameServersChanged {
479
+ /**
480
+ * Name of the domain whose name servers changed.
481
+ * @format HOSTNAME
482
+ */
483
+ domain?: string;
484
+ /**
485
+ * Name servers set on the domain.
486
+ * @format HOSTNAME
487
+ * @maxSize 2
488
+ */
489
+ nameServers?: string[];
490
+ /**
491
+ * Name servers the domain had before the change.
492
+ * @format HOSTNAME
493
+ * @maxSize 2
494
+ */
495
+ previousNameServers?: string[];
496
+ }
477
497
  interface InitiateTransferRequest {
478
498
  /**
479
499
  * Domain name to transfer.
@@ -502,6 +522,159 @@ interface ApproveTransferRequest {
502
522
  }
503
523
  interface ApproveTransferResponse {
504
524
  }
525
+ interface DomainEvent extends DomainEventBodyOneOf {
526
+ createdEvent?: EntityCreatedEvent;
527
+ updatedEvent?: EntityUpdatedEvent;
528
+ deletedEvent?: EntityDeletedEvent;
529
+ actionEvent?: ActionEvent;
530
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
531
+ _id?: string;
532
+ /**
533
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
534
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
535
+ */
536
+ entityFqdn?: string;
537
+ /**
538
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
539
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
540
+ */
541
+ slug?: string;
542
+ /** ID of the entity associated with the event. */
543
+ entityId?: string;
544
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
545
+ eventTime?: Date | null;
546
+ /**
547
+ * Whether the event was triggered as a result of a privacy regulation application
548
+ * (for example, GDPR).
549
+ */
550
+ triggeredByAnonymizeRequest?: boolean | null;
551
+ /** If present, indicates the action that triggered the event. */
552
+ originatedFrom?: string | null;
553
+ /**
554
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
555
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
556
+ */
557
+ entityEventSequence?: string | null;
558
+ }
559
+ /** @oneof */
560
+ interface DomainEventBodyOneOf {
561
+ createdEvent?: EntityCreatedEvent;
562
+ updatedEvent?: EntityUpdatedEvent;
563
+ deletedEvent?: EntityDeletedEvent;
564
+ actionEvent?: ActionEvent;
565
+ }
566
+ interface EntityCreatedEvent {
567
+ entity?: string;
568
+ }
569
+ interface RestoreInfo {
570
+ deletedDate?: Date | null;
571
+ }
572
+ interface EntityUpdatedEvent {
573
+ /**
574
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
575
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
576
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
577
+ */
578
+ currentEntity?: string;
579
+ }
580
+ interface EntityDeletedEvent {
581
+ /** Entity that was deleted. */
582
+ deletedEntity?: string | null;
583
+ }
584
+ interface ActionEvent {
585
+ body?: string;
586
+ }
587
+ interface MessageEnvelope {
588
+ /**
589
+ * App instance ID.
590
+ * @format GUID
591
+ */
592
+ instanceId?: string | null;
593
+ /**
594
+ * Event type.
595
+ * @maxLength 150
596
+ */
597
+ eventType?: string;
598
+ /** The identification type and identity data. */
599
+ identity?: IdentificationData;
600
+ /** Stringify payload. */
601
+ data?: string;
602
+ /** Details related to the account */
603
+ accountInfo?: AccountInfo;
604
+ }
605
+ interface IdentificationData extends IdentificationDataIdOneOf {
606
+ /**
607
+ * ID of a site visitor that has not logged in to the site.
608
+ * @format GUID
609
+ */
610
+ anonymousVisitorId?: string;
611
+ /**
612
+ * ID of a site visitor that has logged in to the site.
613
+ * @format GUID
614
+ */
615
+ memberId?: string;
616
+ /**
617
+ * ID of a Wix user (site owner, contributor, etc.).
618
+ * @format GUID
619
+ */
620
+ wixUserId?: string;
621
+ /**
622
+ * ID of an app.
623
+ * @format GUID
624
+ */
625
+ appId?: string;
626
+ /** @readonly */
627
+ identityType?: WebhookIdentityTypeWithLiterals;
628
+ }
629
+ /** @oneof */
630
+ interface IdentificationDataIdOneOf {
631
+ /**
632
+ * ID of a site visitor that has not logged in to the site.
633
+ * @format GUID
634
+ */
635
+ anonymousVisitorId?: string;
636
+ /**
637
+ * ID of a site visitor that has logged in to the site.
638
+ * @format GUID
639
+ */
640
+ memberId?: string;
641
+ /**
642
+ * ID of a Wix user (site owner, contributor, etc.).
643
+ * @format GUID
644
+ */
645
+ wixUserId?: string;
646
+ /**
647
+ * ID of an app.
648
+ * @format GUID
649
+ */
650
+ appId?: string;
651
+ }
652
+ declare enum WebhookIdentityType {
653
+ UNKNOWN = "UNKNOWN",
654
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
655
+ MEMBER = "MEMBER",
656
+ WIX_USER = "WIX_USER",
657
+ APP = "APP"
658
+ }
659
+ /** @enumType */
660
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
661
+ interface AccountInfo {
662
+ /**
663
+ * ID of the Wix account associated with the event.
664
+ * @format GUID
665
+ */
666
+ accountId?: string | null;
667
+ /**
668
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
669
+ * @format GUID
670
+ */
671
+ parentAccountId?: string | null;
672
+ /**
673
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
674
+ * @format GUID
675
+ */
676
+ siteId?: string | null;
677
+ }
505
678
  interface DomainChangedEvent extends DomainChangedEventPayloadOneOf {
506
679
  /** WARNING: `registered` event payload is DEPRECATED */
507
680
  registered?: Registered;
@@ -731,97 +904,6 @@ interface ScheduleParkAfterRefundRequest {
731
904
  interface ScheduleParkAfterRefundResponse {
732
905
  registeredDomain?: RegisteredDomain;
733
906
  }
734
- interface MessageEnvelope {
735
- /**
736
- * App instance ID.
737
- * @format GUID
738
- */
739
- instanceId?: string | null;
740
- /**
741
- * Event type.
742
- * @maxLength 150
743
- */
744
- eventType?: string;
745
- /** The identification type and identity data. */
746
- identity?: IdentificationData;
747
- /** Stringify payload. */
748
- data?: string;
749
- /** Details related to the account */
750
- accountInfo?: AccountInfo;
751
- }
752
- interface IdentificationData extends IdentificationDataIdOneOf {
753
- /**
754
- * ID of a site visitor that has not logged in to the site.
755
- * @format GUID
756
- */
757
- anonymousVisitorId?: string;
758
- /**
759
- * ID of a site visitor that has logged in to the site.
760
- * @format GUID
761
- */
762
- memberId?: string;
763
- /**
764
- * ID of a Wix user (site owner, contributor, etc.).
765
- * @format GUID
766
- */
767
- wixUserId?: string;
768
- /**
769
- * ID of an app.
770
- * @format GUID
771
- */
772
- appId?: string;
773
- /** @readonly */
774
- identityType?: WebhookIdentityTypeWithLiterals;
775
- }
776
- /** @oneof */
777
- interface IdentificationDataIdOneOf {
778
- /**
779
- * ID of a site visitor that has not logged in to the site.
780
- * @format GUID
781
- */
782
- anonymousVisitorId?: string;
783
- /**
784
- * ID of a site visitor that has logged in to the site.
785
- * @format GUID
786
- */
787
- memberId?: string;
788
- /**
789
- * ID of a Wix user (site owner, contributor, etc.).
790
- * @format GUID
791
- */
792
- wixUserId?: string;
793
- /**
794
- * ID of an app.
795
- * @format GUID
796
- */
797
- appId?: string;
798
- }
799
- declare enum WebhookIdentityType {
800
- UNKNOWN = "UNKNOWN",
801
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
802
- MEMBER = "MEMBER",
803
- WIX_USER = "WIX_USER",
804
- APP = "APP"
805
- }
806
- /** @enumType */
807
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
808
- interface AccountInfo {
809
- /**
810
- * ID of the Wix account associated with the event.
811
- * @format GUID
812
- */
813
- accountId?: string | null;
814
- /**
815
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
816
- * @format GUID
817
- */
818
- parentAccountId?: string | null;
819
- /**
820
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
821
- * @format GUID
822
- */
823
- siteId?: string | null;
824
- }
825
907
  /** @docsIgnore */
826
908
  type InitiateTransferApplicationErrors = {
827
909
  code?: 'DOMAIN_NOT_OWNED_BY_CALLER';
@@ -949,12 +1031,13 @@ declare function approveTransfer(domain: string, confirmationToken: string): Pro
949
1031
  __applicationErrorsType?: ApproveTransferApplicationErrors;
950
1032
  }>;
951
1033
  /**
952
- * Updates an existing registered domain using field masks.
1034
+ * Updates a registered domain.
1035
+ *
1036
+ * Only the fields listed in `fieldMask` are updated. You can update `name_servers`, `registrant_contact`, `admin_contact`, `tech_contact`, and `tld_data`. You can't update `name_servers` in the same call as any of the other fields.
953
1037
  *
954
- * Only the fields specified in `field_mask` are updated.
955
- * All other fields are left unchanged.
1038
+ * You can't change the name servers of a domain that's parked, deactivated, expired, or being transferred to another registrar.
956
1039
  *
957
- * > __Important:__ For ICANN-governed gTLDs, changing the registrant email may trigger a verification process requiring confirmation from both the old and new email addresses.
1040
+ * > **Important:** For ICANN-governed gTLDs, changing the registrant email may trigger a verification process requiring confirmation from both the old and new email addresses.
958
1041
  * @param domain - Name of the domain including TLD.
959
1042
  * Subdomains aren't supported. You can only register a root domain.
960
1043
  * Domain name and TLD must be separated by a dot. For example,
@@ -1025,4 +1108,4 @@ interface UpdateRegisteredDomainOptions {
1025
1108
  fieldMask?: string[];
1026
1109
  }
1027
1110
 
1028
- 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 UpdateRegisteredDomainApplicationErrors, type UpdateRegisteredDomainOptions, type UpdateRegisteredDomainRequest, type UpdateRegisteredDomainResponse, UsAppPurpose, type UsAppPurposeWithLiterals, type UsOptions, type VerificationStarted, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, approveTransfer, initiateTransfer, updateRegisteredDomain };
1111
+ export { type AccountInfo, type ActionEvent, 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 DomainEvent, type DomainEventBodyOneOf, type DomainReleaseCouponEvent, type DomainReleaseCouponEventTriggerTypeInfoOneOf, type EligibilityIdType, EligibilityIdTypeEnum, type EligibilityIdTypeEnumWithLiterals, type EligibilityType, EligibilityTypeEnum, type EligibilityTypeEnumWithLiterals, type EntityCreatedEvent, type EntityDeletedEvent, type EntityType, EntityTypeEnum, type EntityTypeEnumWithLiterals, type EntityUpdatedEvent, 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, type NameServersChanged, 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 RestoreInfo, 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 UpdateRegisteredDomainApplicationErrors, type UpdateRegisteredDomainOptions, type UpdateRegisteredDomainRequest, type UpdateRegisteredDomainResponse, UsAppPurpose, type UsAppPurposeWithLiterals, type UsOptions, type VerificationStarted, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, approveTransfer, initiateTransfer, updateRegisteredDomain };
@@ -90,6 +90,10 @@ function resolveComWixpressPremiumDomainsRegisteredRegisteredDomainServiceUrl(op
90
90
  {
91
91
  srcPath: "/domains/v1/transfer-between-accounts",
92
92
  destPath: "/domains/v1/transfer-between-accounts"
93
+ },
94
+ {
95
+ srcPath: "/premium/domains/v1/registered-domains",
96
+ destPath: "/v1/registered-domains"
93
97
  }
94
98
  ]
95
99
  };
@@ -131,6 +135,10 @@ function resolveComWixpressPremiumDomainsRegisteredDomainTransferBetweenAccounts
131
135
  {
132
136
  srcPath: "/domains/v1/transfer-between-accounts",
133
137
  destPath: "/domains/v1/transfer-between-accounts"
138
+ },
139
+ {
140
+ srcPath: "/premium/domains/v1/registered-domains",
141
+ destPath: "/v1/registered-domains"
134
142
  }
135
143
  ]
136
144
  };
@@ -319,6 +327,14 @@ var TldType = /* @__PURE__ */ ((TldType2) => {
319
327
  TldType2["ORG_IL"] = "ORG_IL";
320
328
  return TldType2;
321
329
  })(TldType || {});
330
+ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
331
+ WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
332
+ WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
333
+ WebhookIdentityType2["MEMBER"] = "MEMBER";
334
+ WebhookIdentityType2["WIX_USER"] = "WIX_USER";
335
+ WebhookIdentityType2["APP"] = "APP";
336
+ return WebhookIdentityType2;
337
+ })(WebhookIdentityType || {});
322
338
  var ContactVerificationStatus = /* @__PURE__ */ ((ContactVerificationStatus2) => {
323
339
  ContactVerificationStatus2["PENDING"] = "PENDING";
324
340
  ContactVerificationStatus2["DEACTIVATED"] = "DEACTIVATED";
@@ -331,14 +347,6 @@ var TriggerType = /* @__PURE__ */ ((TriggerType2) => {
331
347
  TriggerType2["REVIVE_FROM_CHARGEBACK"] = "REVIVE_FROM_CHARGEBACK";
332
348
  return TriggerType2;
333
349
  })(TriggerType || {});
334
- var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
335
- WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
336
- WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
337
- WebhookIdentityType2["MEMBER"] = "MEMBER";
338
- WebhookIdentityType2["WIX_USER"] = "WIX_USER";
339
- WebhookIdentityType2["APP"] = "APP";
340
- return WebhookIdentityType2;
341
- })(WebhookIdentityType || {});
342
350
  async function initiateTransfer2(domain, targetEmail) {
343
351
  const { httpClient, sideEffects } = arguments[2];
344
352
  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({