@wix/domains 1.0.35 → 1.0.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/context.d.ts +0 -1
- package/build/cjs/context.js +1 -2
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +1 -2
- package/build/cjs/index.js +1 -3
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +1 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +0 -1
- package/build/es/context.js +0 -1
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +1 -2
- package/build/es/index.js +1 -2
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -1
- package/build/es/meta.js.map +1 -1
- package/package.json +3 -4
- package/type-bundles/context.bundle.d.ts +143 -914
- package/type-bundles/index.bundle.d.ts +143 -914
- package/type-bundles/meta.bundle.d.ts +73 -1160
|
@@ -433,7 +433,7 @@ interface ConnectedDomain {
|
|
|
433
433
|
* Information about the site to which the domain is assigned, and whether
|
|
434
434
|
* it's the primary domain or a redirect.
|
|
435
435
|
*/
|
|
436
|
-
siteInfo?: SiteInfo
|
|
436
|
+
siteInfo?: SiteInfo;
|
|
437
437
|
/**
|
|
438
438
|
* Whether the site owner receives standard email notifications from Wix about
|
|
439
439
|
* the connected domain.
|
|
@@ -450,7 +450,7 @@ interface ConnectedDomain {
|
|
|
450
450
|
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
451
451
|
* @readonly
|
|
452
452
|
*/
|
|
453
|
-
dnsPropagationStatus?: DnsPropagationStatus
|
|
453
|
+
dnsPropagationStatus?: DnsPropagationStatus;
|
|
454
454
|
}
|
|
455
455
|
declare enum ConnectionType$1 {
|
|
456
456
|
/** Used by sub domain */
|
|
@@ -464,12 +464,12 @@ declare enum ConnectionType$1 {
|
|
|
464
464
|
*/
|
|
465
465
|
HIDDEN = "HIDDEN"
|
|
466
466
|
}
|
|
467
|
-
interface SiteInfo
|
|
467
|
+
interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
|
|
468
468
|
/**
|
|
469
469
|
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
470
470
|
* @readonly
|
|
471
471
|
*/
|
|
472
|
-
redirectInfo?: RedirectAssignmentInfo
|
|
472
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
473
473
|
/**
|
|
474
474
|
* ID of the site to which the domain is assigned.
|
|
475
475
|
* @readonly
|
|
@@ -482,29 +482,29 @@ interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
|
|
|
482
482
|
* + `"REDIRECT"`: A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain.
|
|
483
483
|
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
484
484
|
*/
|
|
485
|
-
assignmentType?: AssignmentType
|
|
485
|
+
assignmentType?: AssignmentType;
|
|
486
486
|
}
|
|
487
487
|
/** @oneof */
|
|
488
|
-
interface SiteInfoAssignmentInfoOneOf
|
|
488
|
+
interface SiteInfoAssignmentInfoOneOf {
|
|
489
489
|
/**
|
|
490
490
|
* Redirect information, relevant when `assignmentType` = `REDIRECT`.
|
|
491
491
|
* @readonly
|
|
492
492
|
*/
|
|
493
|
-
redirectInfo?: RedirectAssignmentInfo
|
|
493
|
+
redirectInfo?: RedirectAssignmentInfo;
|
|
494
494
|
}
|
|
495
|
-
declare enum AssignmentType
|
|
495
|
+
declare enum AssignmentType {
|
|
496
496
|
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
497
497
|
PRIMARY = "PRIMARY",
|
|
498
498
|
REDIRECT = "REDIRECT"
|
|
499
499
|
}
|
|
500
|
-
interface RedirectAssignmentInfo
|
|
500
|
+
interface RedirectAssignmentInfo {
|
|
501
501
|
/**
|
|
502
502
|
* Primary domain to which this domain will redirect.
|
|
503
503
|
* @readonly
|
|
504
504
|
*/
|
|
505
505
|
primaryDomain?: string;
|
|
506
506
|
}
|
|
507
|
-
declare enum DnsPropagationStatus
|
|
507
|
+
declare enum DnsPropagationStatus {
|
|
508
508
|
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
509
509
|
COMPLETED = "COMPLETED",
|
|
510
510
|
FAILED = "FAILED",
|
|
@@ -541,9 +541,9 @@ interface DeleteConnectedDomainResponse {
|
|
|
541
541
|
}
|
|
542
542
|
interface ListConnectedDomainsRequest {
|
|
543
543
|
/** Cursor paging options. */
|
|
544
|
-
paging?: CursorPaging$
|
|
544
|
+
paging?: CursorPaging$1;
|
|
545
545
|
}
|
|
546
|
-
interface CursorPaging$
|
|
546
|
+
interface CursorPaging$1 {
|
|
547
547
|
/**
|
|
548
548
|
* Number of domains to load.
|
|
549
549
|
*
|
|
@@ -562,15 +562,15 @@ interface CursorPaging$2 {
|
|
|
562
562
|
}
|
|
563
563
|
interface ListConnectedDomainsResponse {
|
|
564
564
|
/** Metadata about the returned list of connected domains. */
|
|
565
|
-
pagingMetadata?: CursorPagingMetadata$
|
|
565
|
+
pagingMetadata?: CursorPagingMetadata$1;
|
|
566
566
|
/** Retrieved connected domains. */
|
|
567
567
|
connectedDomains?: ConnectedDomain[];
|
|
568
568
|
}
|
|
569
|
-
interface CursorPagingMetadata$
|
|
569
|
+
interface CursorPagingMetadata$1 {
|
|
570
570
|
/** Number of domains returned in the response. */
|
|
571
571
|
count?: number | null;
|
|
572
572
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
573
|
-
cursors?: Cursors$
|
|
573
|
+
cursors?: Cursors$1;
|
|
574
574
|
/**
|
|
575
575
|
* Indicates if there are more results after the current page.
|
|
576
576
|
* If `true`, another page of results can be retrieved.
|
|
@@ -578,17 +578,17 @@ interface CursorPagingMetadata$2 {
|
|
|
578
578
|
*/
|
|
579
579
|
hasNext?: boolean | null;
|
|
580
580
|
}
|
|
581
|
-
interface Cursors$
|
|
581
|
+
interface Cursors$1 {
|
|
582
582
|
/** Cursor pointing to next page in the list of results. */
|
|
583
583
|
next?: string | null;
|
|
584
584
|
/** Cursor pointing to previous page in the list of results. */
|
|
585
585
|
prev?: string | null;
|
|
586
586
|
}
|
|
587
|
-
interface DomainEvent$
|
|
588
|
-
createdEvent?: EntityCreatedEvent$
|
|
589
|
-
updatedEvent?: EntityUpdatedEvent$
|
|
590
|
-
deletedEvent?: EntityDeletedEvent$
|
|
591
|
-
actionEvent?: ActionEvent$
|
|
587
|
+
interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
|
|
588
|
+
createdEvent?: EntityCreatedEvent$1;
|
|
589
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
|
590
|
+
deletedEvent?: EntityDeletedEvent$1;
|
|
591
|
+
actionEvent?: ActionEvent$1;
|
|
592
592
|
/**
|
|
593
593
|
* Unique event ID.
|
|
594
594
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -627,19 +627,19 @@ interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
|
|
|
627
627
|
entityEventSequence?: string | null;
|
|
628
628
|
}
|
|
629
629
|
/** @oneof */
|
|
630
|
-
interface DomainEventBodyOneOf$
|
|
631
|
-
createdEvent?: EntityCreatedEvent$
|
|
632
|
-
updatedEvent?: EntityUpdatedEvent$
|
|
633
|
-
deletedEvent?: EntityDeletedEvent$
|
|
634
|
-
actionEvent?: ActionEvent$
|
|
630
|
+
interface DomainEventBodyOneOf$1 {
|
|
631
|
+
createdEvent?: EntityCreatedEvent$1;
|
|
632
|
+
updatedEvent?: EntityUpdatedEvent$1;
|
|
633
|
+
deletedEvent?: EntityDeletedEvent$1;
|
|
634
|
+
actionEvent?: ActionEvent$1;
|
|
635
635
|
}
|
|
636
|
-
interface EntityCreatedEvent$
|
|
636
|
+
interface EntityCreatedEvent$1 {
|
|
637
637
|
entity?: string;
|
|
638
638
|
}
|
|
639
|
-
interface RestoreInfo$
|
|
639
|
+
interface RestoreInfo$1 {
|
|
640
640
|
deletedDate?: Date;
|
|
641
641
|
}
|
|
642
|
-
interface EntityUpdatedEvent$
|
|
642
|
+
interface EntityUpdatedEvent$1 {
|
|
643
643
|
/**
|
|
644
644
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
645
645
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -647,24 +647,24 @@ interface EntityUpdatedEvent$2 {
|
|
|
647
647
|
*/
|
|
648
648
|
currentEntity?: string;
|
|
649
649
|
}
|
|
650
|
-
interface EntityDeletedEvent$
|
|
650
|
+
interface EntityDeletedEvent$1 {
|
|
651
651
|
/** Entity that was deleted */
|
|
652
652
|
deletedEntity?: string | null;
|
|
653
653
|
}
|
|
654
|
-
interface ActionEvent$
|
|
654
|
+
interface ActionEvent$1 {
|
|
655
655
|
body?: string;
|
|
656
656
|
}
|
|
657
|
-
interface MessageEnvelope$
|
|
657
|
+
interface MessageEnvelope$1 {
|
|
658
658
|
/** App instance ID. */
|
|
659
659
|
instanceId?: string | null;
|
|
660
660
|
/** Event type. */
|
|
661
661
|
eventType?: string;
|
|
662
662
|
/** The identification type and identity data. */
|
|
663
|
-
identity?: IdentificationData$
|
|
663
|
+
identity?: IdentificationData$1;
|
|
664
664
|
/** Stringify payload. */
|
|
665
665
|
data?: string;
|
|
666
666
|
}
|
|
667
|
-
interface IdentificationData$
|
|
667
|
+
interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
|
|
668
668
|
/** ID of a site visitor that has not logged in to the site. */
|
|
669
669
|
anonymousVisitorId?: string;
|
|
670
670
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -674,10 +674,10 @@ interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
|
|
|
674
674
|
/** ID of an app. */
|
|
675
675
|
appId?: string;
|
|
676
676
|
/** @readonly */
|
|
677
|
-
identityType?: WebhookIdentityType$
|
|
677
|
+
identityType?: WebhookIdentityType$1;
|
|
678
678
|
}
|
|
679
679
|
/** @oneof */
|
|
680
|
-
interface IdentificationDataIdOneOf$
|
|
680
|
+
interface IdentificationDataIdOneOf$1 {
|
|
681
681
|
/** ID of a site visitor that has not logged in to the site. */
|
|
682
682
|
anonymousVisitorId?: string;
|
|
683
683
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -687,27 +687,27 @@ interface IdentificationDataIdOneOf$2 {
|
|
|
687
687
|
/** ID of an app. */
|
|
688
688
|
appId?: string;
|
|
689
689
|
}
|
|
690
|
-
declare enum WebhookIdentityType$
|
|
690
|
+
declare enum WebhookIdentityType$1 {
|
|
691
691
|
UNKNOWN = "UNKNOWN",
|
|
692
692
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
693
693
|
MEMBER = "MEMBER",
|
|
694
694
|
WIX_USER = "WIX_USER",
|
|
695
695
|
APP = "APP"
|
|
696
696
|
}
|
|
697
|
-
interface RedirectAssignmentInfoNonNullableFields
|
|
697
|
+
interface RedirectAssignmentInfoNonNullableFields {
|
|
698
698
|
primaryDomain: string;
|
|
699
699
|
}
|
|
700
|
-
interface SiteInfoNonNullableFields
|
|
701
|
-
redirectInfo?: RedirectAssignmentInfoNonNullableFields
|
|
702
|
-
assignmentType: AssignmentType
|
|
700
|
+
interface SiteInfoNonNullableFields {
|
|
701
|
+
redirectInfo?: RedirectAssignmentInfoNonNullableFields;
|
|
702
|
+
assignmentType: AssignmentType;
|
|
703
703
|
}
|
|
704
704
|
interface ConnectedDomainNonNullableFields {
|
|
705
705
|
_id: string;
|
|
706
706
|
domain: string;
|
|
707
707
|
connectionType: ConnectionType$1;
|
|
708
|
-
siteInfo?: SiteInfoNonNullableFields
|
|
708
|
+
siteInfo?: SiteInfoNonNullableFields;
|
|
709
709
|
suppressNotifications: boolean;
|
|
710
|
-
dnsPropagationStatus: DnsPropagationStatus
|
|
710
|
+
dnsPropagationStatus: DnsPropagationStatus;
|
|
711
711
|
}
|
|
712
712
|
interface CreateConnectedDomainResponseNonNullableFields {
|
|
713
713
|
connectedDomain?: ConnectedDomainNonNullableFields;
|
|
@@ -720,7 +720,7 @@ interface ListConnectedDomainsResponseNonNullableFields {
|
|
|
720
720
|
}
|
|
721
721
|
interface ListConnectedDomainsOptions {
|
|
722
722
|
/** Cursor paging options. */
|
|
723
|
-
paging?: CursorPaging$
|
|
723
|
+
paging?: CursorPaging$1;
|
|
724
724
|
}
|
|
725
725
|
|
|
726
726
|
declare function createConnectedDomain$1(httpClient: HttpClient): CreateConnectedDomainSignature;
|
|
@@ -796,26 +796,33 @@ declare const getConnectedDomain: MaybeContext<BuildRESTFunction<typeof getConne
|
|
|
796
796
|
declare const deleteConnectedDomain: MaybeContext<BuildRESTFunction<typeof deleteConnectedDomain$1> & typeof deleteConnectedDomain$1>;
|
|
797
797
|
declare const listConnectedDomains: MaybeContext<BuildRESTFunction<typeof listConnectedDomains$1> & typeof listConnectedDomains$1>;
|
|
798
798
|
|
|
799
|
-
type context$
|
|
800
|
-
|
|
801
|
-
type context$
|
|
802
|
-
type context$
|
|
803
|
-
type context$
|
|
804
|
-
type context$
|
|
805
|
-
type context$
|
|
806
|
-
type context$
|
|
807
|
-
type context$
|
|
808
|
-
type context$
|
|
809
|
-
|
|
810
|
-
type context$
|
|
811
|
-
type context$
|
|
812
|
-
type context$
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
799
|
+
type context$4_AssignmentType = AssignmentType;
|
|
800
|
+
declare const context$4_AssignmentType: typeof AssignmentType;
|
|
801
|
+
type context$4_ConnectedDomain = ConnectedDomain;
|
|
802
|
+
type context$4_ConnectedDomainNonNullableFields = ConnectedDomainNonNullableFields;
|
|
803
|
+
type context$4_CreateConnectedDomainRequest = CreateConnectedDomainRequest;
|
|
804
|
+
type context$4_CreateConnectedDomainResponse = CreateConnectedDomainResponse;
|
|
805
|
+
type context$4_CreateConnectedDomainResponseNonNullableFields = CreateConnectedDomainResponseNonNullableFields;
|
|
806
|
+
type context$4_DeleteConnectedDomainRequest = DeleteConnectedDomainRequest;
|
|
807
|
+
type context$4_DeleteConnectedDomainResponse = DeleteConnectedDomainResponse;
|
|
808
|
+
type context$4_DnsPropagationStatus = DnsPropagationStatus;
|
|
809
|
+
declare const context$4_DnsPropagationStatus: typeof DnsPropagationStatus;
|
|
810
|
+
type context$4_GetConnectedDomainRequest = GetConnectedDomainRequest;
|
|
811
|
+
type context$4_GetConnectedDomainResponse = GetConnectedDomainResponse;
|
|
812
|
+
type context$4_GetConnectedDomainResponseNonNullableFields = GetConnectedDomainResponseNonNullableFields;
|
|
813
|
+
type context$4_ListConnectedDomainsOptions = ListConnectedDomainsOptions;
|
|
814
|
+
type context$4_ListConnectedDomainsRequest = ListConnectedDomainsRequest;
|
|
815
|
+
type context$4_ListConnectedDomainsResponse = ListConnectedDomainsResponse;
|
|
816
|
+
type context$4_ListConnectedDomainsResponseNonNullableFields = ListConnectedDomainsResponseNonNullableFields;
|
|
817
|
+
type context$4_RedirectAssignmentInfo = RedirectAssignmentInfo;
|
|
818
|
+
type context$4_SiteInfo = SiteInfo;
|
|
819
|
+
type context$4_SiteInfoAssignmentInfoOneOf = SiteInfoAssignmentInfoOneOf;
|
|
820
|
+
declare const context$4_createConnectedDomain: typeof createConnectedDomain;
|
|
821
|
+
declare const context$4_deleteConnectedDomain: typeof deleteConnectedDomain;
|
|
822
|
+
declare const context$4_getConnectedDomain: typeof getConnectedDomain;
|
|
823
|
+
declare const context$4_listConnectedDomains: typeof listConnectedDomains;
|
|
824
|
+
declare namespace context$4 {
|
|
825
|
+
export { type ActionEvent$1 as ActionEvent, context$4_AssignmentType as AssignmentType, type context$4_ConnectedDomain as ConnectedDomain, type context$4_ConnectedDomainNonNullableFields as ConnectedDomainNonNullableFields, ConnectionType$1 as ConnectionType, type context$4_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type context$4_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type context$4_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type context$4_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type context$4_DeleteConnectedDomainResponse as DeleteConnectedDomainResponse, context$4_DnsPropagationStatus as DnsPropagationStatus, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type DomainRemovedEvent$1 as DomainRemovedEvent, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type context$4_GetConnectedDomainRequest as GetConnectedDomainRequest, type context$4_GetConnectedDomainResponse as GetConnectedDomainResponse, type context$4_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type context$4_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type context$4_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type context$4_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type context$4_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type context$4_RedirectAssignmentInfo as RedirectAssignmentInfo, type RestoreInfo$1 as RestoreInfo, type context$4_SiteInfo as SiteInfo, type context$4_SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$1 as WebhookIdentityType, context$4_createConnectedDomain as createConnectedDomain, context$4_deleteConnectedDomain as deleteConnectedDomain, context$4_getConnectedDomain as getConnectedDomain, context$4_listConnectedDomains as listConnectedDomains };
|
|
819
826
|
}
|
|
820
827
|
|
|
821
828
|
/**
|
|
@@ -1042,27 +1049,27 @@ interface GetConnectedDomainSetupInfoSignature {
|
|
|
1042
1049
|
|
|
1043
1050
|
declare const getConnectedDomainSetupInfo: MaybeContext<BuildRESTFunction<typeof getConnectedDomainSetupInfo$1> & typeof getConnectedDomainSetupInfo$1>;
|
|
1044
1051
|
|
|
1045
|
-
type context$
|
|
1046
|
-
type context$
|
|
1047
|
-
type context$
|
|
1048
|
-
type context$
|
|
1049
|
-
type context$
|
|
1050
|
-
declare const context$
|
|
1051
|
-
type context$
|
|
1052
|
-
type context$
|
|
1053
|
-
type context$
|
|
1054
|
-
type context$
|
|
1055
|
-
type context$
|
|
1056
|
-
type context$
|
|
1057
|
-
type context$
|
|
1058
|
-
type context$
|
|
1059
|
-
type context$
|
|
1060
|
-
type context$
|
|
1061
|
-
type context$
|
|
1062
|
-
type context$
|
|
1063
|
-
declare const context$
|
|
1064
|
-
declare namespace context$
|
|
1065
|
-
export { type context$
|
|
1052
|
+
type context$3_ARecord = ARecord;
|
|
1053
|
+
type context$3_CnameRecord = CnameRecord;
|
|
1054
|
+
type context$3_ConnectedDomainSetupInfo = ConnectedDomainSetupInfo;
|
|
1055
|
+
type context$3_ConnectedDomainSetupInfoDnsRecordsOneOf = ConnectedDomainSetupInfoDnsRecordsOneOf;
|
|
1056
|
+
type context$3_ConnectionType = ConnectionType;
|
|
1057
|
+
declare const context$3_ConnectionType: typeof ConnectionType;
|
|
1058
|
+
type context$3_GetConnectedDomainSetupInfoRequest = GetConnectedDomainSetupInfoRequest;
|
|
1059
|
+
type context$3_GetConnectedDomainSetupInfoResponse = GetConnectedDomainSetupInfoResponse;
|
|
1060
|
+
type context$3_GetConnectedDomainSetupInfoResponseNonNullableFields = GetConnectedDomainSetupInfoResponseNonNullableFields;
|
|
1061
|
+
type context$3_GetSetupInfoRequest = GetSetupInfoRequest;
|
|
1062
|
+
type context$3_GetSetupInfoResponse = GetSetupInfoResponse;
|
|
1063
|
+
type context$3_NameserverRecord = NameserverRecord;
|
|
1064
|
+
type context$3_NsRecord = NsRecord;
|
|
1065
|
+
type context$3_PointingRecords = PointingRecords;
|
|
1066
|
+
type context$3_PreCreateConnectedDomainRequest = PreCreateConnectedDomainRequest;
|
|
1067
|
+
type context$3_PreCreateConnectedDomainResponse = PreCreateConnectedDomainResponse;
|
|
1068
|
+
type context$3_Registrar = Registrar;
|
|
1069
|
+
type context$3_SubdomainRecords = SubdomainRecords;
|
|
1070
|
+
declare const context$3_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
|
|
1071
|
+
declare namespace context$3 {
|
|
1072
|
+
export { type context$3_ARecord as ARecord, type context$3_CnameRecord as CnameRecord, type context$3_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type context$3_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, context$3_ConnectionType as ConnectionType, type context$3_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type context$3_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type context$3_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type context$3_GetSetupInfoRequest as GetSetupInfoRequest, type context$3_GetSetupInfoResponse as GetSetupInfoResponse, type context$3_NameserverRecord as NameserverRecord, type context$3_NsRecord as NsRecord, type context$3_PointingRecords as PointingRecords, type context$3_PreCreateConnectedDomainRequest as PreCreateConnectedDomainRequest, type context$3_PreCreateConnectedDomainResponse as PreCreateConnectedDomainResponse, type context$3_Registrar as Registrar, type context$3_SubdomainRecords as SubdomainRecords, context$3_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
1066
1073
|
}
|
|
1067
1074
|
|
|
1068
1075
|
/** DNS zones hold information about the records that map a domain's URL to an IP address. */
|
|
@@ -1226,11 +1233,11 @@ interface PreviewDnsZoneResponse {
|
|
|
1226
1233
|
*/
|
|
1227
1234
|
dnsZone?: DnsZone;
|
|
1228
1235
|
}
|
|
1229
|
-
interface DomainEvent
|
|
1230
|
-
createdEvent?: EntityCreatedEvent
|
|
1231
|
-
updatedEvent?: EntityUpdatedEvent
|
|
1232
|
-
deletedEvent?: EntityDeletedEvent
|
|
1233
|
-
actionEvent?: ActionEvent
|
|
1236
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1237
|
+
createdEvent?: EntityCreatedEvent;
|
|
1238
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1239
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1240
|
+
actionEvent?: ActionEvent;
|
|
1234
1241
|
/**
|
|
1235
1242
|
* Unique event ID.
|
|
1236
1243
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1269,19 +1276,19 @@ interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
|
|
|
1269
1276
|
entityEventSequence?: string | null;
|
|
1270
1277
|
}
|
|
1271
1278
|
/** @oneof */
|
|
1272
|
-
interface DomainEventBodyOneOf
|
|
1273
|
-
createdEvent?: EntityCreatedEvent
|
|
1274
|
-
updatedEvent?: EntityUpdatedEvent
|
|
1275
|
-
deletedEvent?: EntityDeletedEvent
|
|
1276
|
-
actionEvent?: ActionEvent
|
|
1279
|
+
interface DomainEventBodyOneOf {
|
|
1280
|
+
createdEvent?: EntityCreatedEvent;
|
|
1281
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1282
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1283
|
+
actionEvent?: ActionEvent;
|
|
1277
1284
|
}
|
|
1278
|
-
interface EntityCreatedEvent
|
|
1285
|
+
interface EntityCreatedEvent {
|
|
1279
1286
|
entity?: string;
|
|
1280
1287
|
}
|
|
1281
|
-
interface RestoreInfo
|
|
1288
|
+
interface RestoreInfo {
|
|
1282
1289
|
deletedDate?: Date;
|
|
1283
1290
|
}
|
|
1284
|
-
interface EntityUpdatedEvent
|
|
1291
|
+
interface EntityUpdatedEvent {
|
|
1285
1292
|
/**
|
|
1286
1293
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1287
1294
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1289,24 +1296,24 @@ interface EntityUpdatedEvent$1 {
|
|
|
1289
1296
|
*/
|
|
1290
1297
|
currentEntity?: string;
|
|
1291
1298
|
}
|
|
1292
|
-
interface EntityDeletedEvent
|
|
1299
|
+
interface EntityDeletedEvent {
|
|
1293
1300
|
/** Entity that was deleted */
|
|
1294
1301
|
deletedEntity?: string | null;
|
|
1295
1302
|
}
|
|
1296
|
-
interface ActionEvent
|
|
1303
|
+
interface ActionEvent {
|
|
1297
1304
|
body?: string;
|
|
1298
1305
|
}
|
|
1299
|
-
interface MessageEnvelope
|
|
1306
|
+
interface MessageEnvelope {
|
|
1300
1307
|
/** App instance ID. */
|
|
1301
1308
|
instanceId?: string | null;
|
|
1302
1309
|
/** Event type. */
|
|
1303
1310
|
eventType?: string;
|
|
1304
1311
|
/** The identification type and identity data. */
|
|
1305
|
-
identity?: IdentificationData
|
|
1312
|
+
identity?: IdentificationData;
|
|
1306
1313
|
/** Stringify payload. */
|
|
1307
1314
|
data?: string;
|
|
1308
1315
|
}
|
|
1309
|
-
interface IdentificationData
|
|
1316
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1310
1317
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1311
1318
|
anonymousVisitorId?: string;
|
|
1312
1319
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1316,10 +1323,10 @@ interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
|
|
|
1316
1323
|
/** ID of an app. */
|
|
1317
1324
|
appId?: string;
|
|
1318
1325
|
/** @readonly */
|
|
1319
|
-
identityType?: WebhookIdentityType
|
|
1326
|
+
identityType?: WebhookIdentityType;
|
|
1320
1327
|
}
|
|
1321
1328
|
/** @oneof */
|
|
1322
|
-
interface IdentificationDataIdOneOf
|
|
1329
|
+
interface IdentificationDataIdOneOf {
|
|
1323
1330
|
/** ID of a site visitor that has not logged in to the site. */
|
|
1324
1331
|
anonymousVisitorId?: string;
|
|
1325
1332
|
/** ID of a site visitor that has logged in to the site. */
|
|
@@ -1329,7 +1336,7 @@ interface IdentificationDataIdOneOf$1 {
|
|
|
1329
1336
|
/** ID of an app. */
|
|
1330
1337
|
appId?: string;
|
|
1331
1338
|
}
|
|
1332
|
-
declare enum WebhookIdentityType
|
|
1339
|
+
declare enum WebhookIdentityType {
|
|
1333
1340
|
UNKNOWN = "UNKNOWN",
|
|
1334
1341
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1335
1342
|
MEMBER = "MEMBER",
|
|
@@ -1475,826 +1482,48 @@ declare const updateDnsZone: MaybeContext<BuildRESTFunction<typeof updateDnsZone
|
|
|
1475
1482
|
declare const deleteDnsZone: MaybeContext<BuildRESTFunction<typeof deleteDnsZone$1> & typeof deleteDnsZone$1>;
|
|
1476
1483
|
declare const previewDnsZone: MaybeContext<BuildRESTFunction<typeof previewDnsZone$1> & typeof previewDnsZone$1>;
|
|
1477
1484
|
|
|
1478
|
-
type context$3_CreateDnsZoneRequest = CreateDnsZoneRequest;
|
|
1479
|
-
type context$3_CreateDnsZoneResponse = CreateDnsZoneResponse;
|
|
1480
|
-
type context$3_CreateDnsZoneResponseNonNullableFields = CreateDnsZoneResponseNonNullableFields;
|
|
1481
|
-
type context$3_DeleteDnsZoneRequest = DeleteDnsZoneRequest;
|
|
1482
|
-
type context$3_DeleteDnsZoneResponse = DeleteDnsZoneResponse;
|
|
1483
|
-
type context$3_DnsRecord = DnsRecord;
|
|
1484
|
-
type context$3_DnsRecordsChangedEvent = DnsRecordsChangedEvent;
|
|
1485
|
-
type context$3_DnsZone = DnsZone;
|
|
1486
|
-
type context$3_DnsZoneNonNullableFields = DnsZoneNonNullableFields;
|
|
1487
|
-
type context$3_DnssecInfo = DnssecInfo;
|
|
1488
|
-
type context$3_DomainRemovedEvent = DomainRemovedEvent;
|
|
1489
|
-
type context$3_GetDnsZoneRequest = GetDnsZoneRequest;
|
|
1490
|
-
type context$3_GetDnsZoneResponse = GetDnsZoneResponse;
|
|
1491
|
-
type context$3_GetDnsZoneResponseNonNullableFields = GetDnsZoneResponseNonNullableFields;
|
|
1492
|
-
type context$3_PreviewDnsZoneRequest = PreviewDnsZoneRequest;
|
|
1493
|
-
type context$3_PreviewDnsZoneResponse = PreviewDnsZoneResponse;
|
|
1494
|
-
type context$3_PreviewDnsZoneResponseNonNullableFields = PreviewDnsZoneResponseNonNullableFields;
|
|
1495
|
-
type context$3_RecordType = RecordType;
|
|
1496
|
-
declare const context$3_RecordType: typeof RecordType;
|
|
1497
|
-
type context$3_UpdateDnsZoneOptions = UpdateDnsZoneOptions;
|
|
1498
|
-
type context$3_UpdateDnsZoneRequest = UpdateDnsZoneRequest;
|
|
1499
|
-
type context$3_UpdateDnsZoneResponse = UpdateDnsZoneResponse;
|
|
1500
|
-
type context$3_UpdateDnsZoneResponseNonNullableFields = UpdateDnsZoneResponseNonNullableFields;
|
|
1501
|
-
declare const context$3_createDnsZone: typeof createDnsZone;
|
|
1502
|
-
declare const context$3_deleteDnsZone: typeof deleteDnsZone;
|
|
1503
|
-
declare const context$3_getDnsZone: typeof getDnsZone;
|
|
1504
|
-
declare const context$3_previewDnsZone: typeof previewDnsZone;
|
|
1505
|
-
declare const context$3_updateDnsZone: typeof updateDnsZone;
|
|
1506
|
-
declare namespace context$3 {
|
|
1507
|
-
export { type ActionEvent$1 as ActionEvent, type context$3_CreateDnsZoneRequest as CreateDnsZoneRequest, type context$3_CreateDnsZoneResponse as CreateDnsZoneResponse, type context$3_CreateDnsZoneResponseNonNullableFields as CreateDnsZoneResponseNonNullableFields, type context$3_DeleteDnsZoneRequest as DeleteDnsZoneRequest, type context$3_DeleteDnsZoneResponse as DeleteDnsZoneResponse, type context$3_DnsRecord as DnsRecord, type context$3_DnsRecordsChangedEvent as DnsRecordsChangedEvent, type context$3_DnsZone as DnsZone, type context$3_DnsZoneNonNullableFields as DnsZoneNonNullableFields, type context$3_DnssecInfo as DnssecInfo, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type context$3_DomainRemovedEvent as DomainRemovedEvent, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type context$3_GetDnsZoneRequest as GetDnsZoneRequest, type context$3_GetDnsZoneResponse as GetDnsZoneResponse, type context$3_GetDnsZoneResponseNonNullableFields as GetDnsZoneResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type context$3_PreviewDnsZoneRequest as PreviewDnsZoneRequest, type context$3_PreviewDnsZoneResponse as PreviewDnsZoneResponse, type context$3_PreviewDnsZoneResponseNonNullableFields as PreviewDnsZoneResponseNonNullableFields, context$3_RecordType as RecordType, type RestoreInfo$1 as RestoreInfo, type context$3_UpdateDnsZoneOptions as UpdateDnsZoneOptions, type context$3_UpdateDnsZoneRequest as UpdateDnsZoneRequest, type context$3_UpdateDnsZoneResponse as UpdateDnsZoneResponse, type context$3_UpdateDnsZoneResponseNonNullableFields as UpdateDnsZoneResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, context$3_createDnsZone as createDnsZone, context$3_deleteDnsZone as deleteDnsZone, context$3_getDnsZone as getDnsZone, context$3_previewDnsZone as previewDnsZone, context$3_updateDnsZone as updateDnsZone };
|
|
1508
|
-
}
|
|
1509
|
-
|
|
1510
|
-
/**
|
|
1511
|
-
* A registered domain is a domain that Wix has registered on behalf of a customer
|
|
1512
|
-
* with an external registar.
|
|
1513
|
-
*/
|
|
1514
|
-
interface RegisteredDomain extends RegisteredDomainStatusInfoOneOf {
|
|
1515
|
-
/**
|
|
1516
|
-
* Information about a domain that hasn't been successfully registered
|
|
1517
|
-
* yet. Includes the timestamp of the latest registration attempt.
|
|
1518
|
-
* @readonly
|
|
1519
|
-
*/
|
|
1520
|
-
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
1521
|
-
/**
|
|
1522
|
-
* Information about a domain that couldn't be registered. Includes
|
|
1523
|
-
* failure code and message.
|
|
1524
|
-
* @readonly
|
|
1525
|
-
*/
|
|
1526
|
-
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
1527
|
-
/**
|
|
1528
|
-
* Domain ID. Identical to `domain`.
|
|
1529
|
-
* @readonly
|
|
1530
|
-
*/
|
|
1531
|
-
_id?: string;
|
|
1532
|
-
/**
|
|
1533
|
-
* Name of the domain including TLD.
|
|
1534
|
-
* Subdomains aren't supported. You can only register a root domain.
|
|
1535
|
-
* Domain name and TLD must be separated by a dot. For example,
|
|
1536
|
-
* `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
|
|
1537
|
-
* supported.
|
|
1538
|
-
*
|
|
1539
|
-
* Min: 3 characters
|
|
1540
|
-
* Max: 63 characters
|
|
1541
|
-
*/
|
|
1542
|
-
domain?: string;
|
|
1543
|
-
/**
|
|
1544
|
-
* ID of the product instance from the
|
|
1545
|
-
* [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
|
|
1546
|
-
* that belongs to the `registeredDomain` object.
|
|
1547
|
-
* Your account must own a product that supports the chosen TLD, regardless of
|
|
1548
|
-
* whether you want to assign the domain to a site or keep it floating. If
|
|
1549
|
-
* you want to assign the domain to a site, the relevant site must also
|
|
1550
|
-
* own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
|
|
1551
|
-
* for more information about how to become a reseller and a list of available
|
|
1552
|
-
* product IDs.
|
|
1553
|
-
*/
|
|
1554
|
-
productInstanceId?: string;
|
|
1555
|
-
/**
|
|
1556
|
-
* Date and time the `registeredDomain` object was created in
|
|
1557
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1558
|
-
* @readonly
|
|
1559
|
-
*/
|
|
1560
|
-
_createdDate?: Date;
|
|
1561
|
-
/**
|
|
1562
|
-
* Date and time the `registeredDomain` object was last updated in
|
|
1563
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1564
|
-
* @readonly
|
|
1565
|
-
*/
|
|
1566
|
-
_updatedDate?: Date;
|
|
1567
|
-
/**
|
|
1568
|
-
* Revision number, which increments by 1 each time the registered domain
|
|
1569
|
-
* is updated. To prevent conflicting changes, the current revision must be
|
|
1570
|
-
* passed when updating the registered domain.
|
|
1571
|
-
*
|
|
1572
|
-
* Ignored when creating a registered domain.
|
|
1573
|
-
*/
|
|
1574
|
-
revision?: string | null;
|
|
1575
|
-
/**
|
|
1576
|
-
* Information about the Wix site the domain is connected to and whether the
|
|
1577
|
-
* domain is assigned as the primary domain or a redirect.
|
|
1578
|
-
*/
|
|
1579
|
-
siteInfo?: SiteInfo;
|
|
1580
|
-
/**
|
|
1581
|
-
* Contact details for the registrant, admin, and tech support of the registered domain.
|
|
1582
|
-
* You can read more about which
|
|
1583
|
-
* [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
|
|
1584
|
-
* are implemented.
|
|
1585
|
-
*/
|
|
1586
|
-
contacts?: Contacts;
|
|
1587
|
-
/**
|
|
1588
|
-
* Status of the registered domain.
|
|
1589
|
-
*
|
|
1590
|
-
* + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
|
|
1591
|
-
* + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
|
|
1592
|
-
* + `"ACTIVE"`: The domain has been registered successfully and is active.
|
|
1593
|
-
* + `"FAILED_REGISTRATION"`: Wix has tried to register the domain, but has stopped the process due to too many failed attempts. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
|
|
1594
|
-
* + `"CANCELED"`: The domain has been canceled and isn't active any longer.
|
|
1595
|
-
* @readonly
|
|
1596
|
-
*/
|
|
1597
|
-
status?: Status;
|
|
1598
|
-
/**
|
|
1599
|
-
* ICANN confirmation status.
|
|
1600
|
-
*
|
|
1601
|
-
* + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
|
|
1602
|
-
* + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
|
|
1603
|
-
* + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
|
|
1604
|
-
* + `"EXPIRED"`: The domain hasn't been confirmed by all contacts before the ICANN confirmation process expired. The domain isn't active and a new confirmation process must be started. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
|
|
1605
|
-
* @readonly
|
|
1606
|
-
*/
|
|
1607
|
-
icannConfirmationStatus?: ICANNConfirmationStatus;
|
|
1608
|
-
/**
|
|
1609
|
-
* Details about the ICANN confirmation status.
|
|
1610
|
-
* @readonly
|
|
1611
|
-
*/
|
|
1612
|
-
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo;
|
|
1613
|
-
/**
|
|
1614
|
-
* DNS propagation status.
|
|
1615
|
-
*
|
|
1616
|
-
* + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
|
|
1617
|
-
* + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
|
|
1618
|
-
* + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
|
|
1619
|
-
* + `"FAILED"`: The domain's DNS propagation process has failed.
|
|
1620
|
-
* @readonly
|
|
1621
|
-
*/
|
|
1622
|
-
dnsPropagationStatus?: DnsPropagationStatus;
|
|
1623
|
-
/**
|
|
1624
|
-
* Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
|
|
1625
|
-
* format.
|
|
1626
|
-
* @readonly
|
|
1627
|
-
*/
|
|
1628
|
-
expirationDate?: Date;
|
|
1629
|
-
}
|
|
1630
|
-
/** @oneof */
|
|
1631
|
-
interface RegisteredDomainStatusInfoOneOf {
|
|
1632
|
-
/**
|
|
1633
|
-
* Information about a domain that hasn't been successfully registered
|
|
1634
|
-
* yet. Includes the timestamp of the latest registration attempt.
|
|
1635
|
-
* @readonly
|
|
1636
|
-
*/
|
|
1637
|
-
pendingRegistrationInfo?: PendingRegistrationInfo;
|
|
1638
|
-
/**
|
|
1639
|
-
* Information about a domain that couldn't be registered. Includes
|
|
1640
|
-
* failure code and message.
|
|
1641
|
-
* @readonly
|
|
1642
|
-
*/
|
|
1643
|
-
failedRegistrationInfo?: FailedRegistrationInfo;
|
|
1644
|
-
}
|
|
1645
|
-
interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
|
|
1646
|
-
/**
|
|
1647
|
-
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1648
|
-
* @readonly
|
|
1649
|
-
*/
|
|
1650
|
-
redirectInfo?: RedirectAssignmentInfo;
|
|
1651
|
-
/**
|
|
1652
|
-
* ID of the site to which the domain is assigned.
|
|
1653
|
-
* @readonly
|
|
1654
|
-
*/
|
|
1655
|
-
_id?: string | null;
|
|
1656
|
-
/**
|
|
1657
|
-
* Whether the domain is assigned as the primary domain or a redirect.
|
|
1658
|
-
* Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
|
|
1659
|
-
* __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
|
|
1660
|
-
* in the request of the Create Registered Domain call.
|
|
1661
|
-
*
|
|
1662
|
-
* + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
|
|
1663
|
-
* + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
|
|
1664
|
-
* + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
|
|
1665
|
-
*/
|
|
1666
|
-
assignmentType?: AssignmentType;
|
|
1667
|
-
}
|
|
1668
|
-
/** @oneof */
|
|
1669
|
-
interface SiteInfoAssignmentInfoOneOf {
|
|
1670
|
-
/**
|
|
1671
|
-
* Extra details if `{"assignmentType": `"REDIRECT"}`.
|
|
1672
|
-
* @readonly
|
|
1673
|
-
*/
|
|
1674
|
-
redirectInfo?: RedirectAssignmentInfo;
|
|
1675
|
-
}
|
|
1676
|
-
declare enum AssignmentType {
|
|
1677
|
-
UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
|
|
1678
|
-
PRIMARY = "PRIMARY",
|
|
1679
|
-
REDIRECT = "REDIRECT"
|
|
1680
|
-
}
|
|
1681
|
-
interface RedirectAssignmentInfo {
|
|
1682
|
-
/**
|
|
1683
|
-
* Primary domain the redirect points to.
|
|
1684
|
-
* @readonly
|
|
1685
|
-
*/
|
|
1686
|
-
primaryDomain?: string;
|
|
1687
|
-
}
|
|
1688
|
-
interface Contacts {
|
|
1689
|
-
/** Contact information for the domain registrant. */
|
|
1690
|
-
registrant?: ContactData;
|
|
1691
|
-
/** Contact information for the domain admin. */
|
|
1692
|
-
admin?: ContactData;
|
|
1693
|
-
/** Contact information for the tech support of the domain. */
|
|
1694
|
-
tech?: ContactData;
|
|
1695
|
-
}
|
|
1696
|
-
interface ContactData {
|
|
1697
|
-
/**
|
|
1698
|
-
* First name. Only
|
|
1699
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1700
|
-
* are supported.
|
|
1701
|
-
*
|
|
1702
|
-
* Min: 2 characters
|
|
1703
|
-
* Max: 64 characters
|
|
1704
|
-
*/
|
|
1705
|
-
firstName?: string;
|
|
1706
|
-
/**
|
|
1707
|
-
* Last name. Only
|
|
1708
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1709
|
-
* are supported.
|
|
1710
|
-
*
|
|
1711
|
-
* Min: 2 characters
|
|
1712
|
-
* Max: 64 characters
|
|
1713
|
-
*/
|
|
1714
|
-
lastName?: string;
|
|
1715
|
-
/**
|
|
1716
|
-
* Email address. Only
|
|
1717
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1718
|
-
* and a single `@` are supported. Wix doesn't validate that the email address
|
|
1719
|
-
* exists.
|
|
1720
|
-
*
|
|
1721
|
-
* Min: 3 characters
|
|
1722
|
-
* Max: 64 characters before the `@` and 63 after
|
|
1723
|
-
*/
|
|
1724
|
-
email?: string;
|
|
1725
|
-
/**
|
|
1726
|
-
* Address details, including street name and house number. Only
|
|
1727
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1728
|
-
* are supported.
|
|
1729
|
-
*
|
|
1730
|
-
* Min: 2 characters
|
|
1731
|
-
* Max: 64 characters
|
|
1732
|
-
*/
|
|
1733
|
-
address?: string;
|
|
1734
|
-
/**
|
|
1735
|
-
* City. Only
|
|
1736
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1737
|
-
* are supported.
|
|
1738
|
-
*
|
|
1739
|
-
* Min: 2 characters
|
|
1740
|
-
* Max: 64 characters
|
|
1741
|
-
*/
|
|
1742
|
-
city?: string;
|
|
1743
|
-
/**
|
|
1744
|
-
* Subdivision code in
|
|
1745
|
-
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
|
|
1746
|
-
* format. Only
|
|
1747
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1748
|
-
* are supported.
|
|
1749
|
-
* __Required__ for these countries:
|
|
1750
|
-
* `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
|
|
1751
|
-
* `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
|
|
1752
|
-
* `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
|
|
1753
|
-
* `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
|
|
1754
|
-
* `"TW"`, `"UA"`, `"US"`, `”ZA”`.
|
|
1755
|
-
*
|
|
1756
|
-
* Min: 2 characters
|
|
1757
|
-
* Max: 2 characters
|
|
1758
|
-
*/
|
|
1759
|
-
subdivisionCode?: string | null;
|
|
1760
|
-
/**
|
|
1761
|
-
* Postal code. Only
|
|
1762
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1763
|
-
* are supported.
|
|
1764
|
-
*
|
|
1765
|
-
* Min: 2 characters
|
|
1766
|
-
* Max: 16 characters
|
|
1767
|
-
*/
|
|
1768
|
-
postalCode?: string | null;
|
|
1769
|
-
/**
|
|
1770
|
-
* Country code in
|
|
1771
|
-
* [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
|
|
1772
|
-
* format. Only
|
|
1773
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1774
|
-
* are supported. Wix doesn't validate that the postal code is valid for the
|
|
1775
|
-
* given country.
|
|
1776
|
-
*
|
|
1777
|
-
* Min: 2 characters
|
|
1778
|
-
* Max: 2 characters
|
|
1779
|
-
*/
|
|
1780
|
-
countryCode?: string;
|
|
1781
|
-
/**
|
|
1782
|
-
* Phone number. Only
|
|
1783
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1784
|
-
* are supported. For example, `+15551234567`. Wix doesn't validate that the
|
|
1785
|
-
* phone number belongs to the specified country.
|
|
1786
|
-
*
|
|
1787
|
-
* Min: 2 characters
|
|
1788
|
-
* Max: 20 characters
|
|
1789
|
-
*/
|
|
1790
|
-
phone?: string;
|
|
1791
|
-
/**
|
|
1792
|
-
* Company name. Only
|
|
1793
|
-
* [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
|
|
1794
|
-
* are supported.
|
|
1795
|
-
*
|
|
1796
|
-
* Max: 2 characters
|
|
1797
|
-
* Max: 64 characters
|
|
1798
|
-
*/
|
|
1799
|
-
company?: string | null;
|
|
1800
|
-
}
|
|
1801
|
-
declare enum Status {
|
|
1802
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1803
|
-
PENDING_REGISTRATION = "PENDING_REGISTRATION",
|
|
1804
|
-
ACTIVE = "ACTIVE",
|
|
1805
|
-
FAILED_REGISTRATION = "FAILED_REGISTRATION",
|
|
1806
|
-
CANCELED = "CANCELED"
|
|
1807
|
-
}
|
|
1808
|
-
interface PendingRegistrationInfo {
|
|
1809
|
-
/**
|
|
1810
|
-
* Information about the latest attempt to register
|
|
1811
|
-
* the domain. Wix tries to register the domain several times if the
|
|
1812
|
-
* first attempt is unsuccessful. You can contact the
|
|
1813
|
-
* [Wix B2B team](mailto:bizdev@wix.com)
|
|
1814
|
-
* for more information about the number of attempts and their timing.
|
|
1815
|
-
* @readonly
|
|
1816
|
-
*/
|
|
1817
|
-
latestAttempt?: LatestAttempt;
|
|
1818
|
-
}
|
|
1819
|
-
interface LatestAttempt {
|
|
1820
|
-
/**
|
|
1821
|
-
* Number of the latest attempt to register the domain.
|
|
1822
|
-
* @readonly
|
|
1823
|
-
*/
|
|
1824
|
-
number?: number;
|
|
1825
|
-
/**
|
|
1826
|
-
* Date and time of the latest domain registration attempt in
|
|
1827
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
1828
|
-
* @readonly
|
|
1829
|
-
*/
|
|
1830
|
-
timestamp?: Date;
|
|
1831
|
-
}
|
|
1832
|
-
interface FailedRegistrationInfo {
|
|
1833
|
-
/**
|
|
1834
|
-
* Failure code.
|
|
1835
|
-
*
|
|
1836
|
-
* + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
|
|
1837
|
-
* + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
|
|
1838
|
-
* @readonly
|
|
1839
|
-
*/
|
|
1840
|
-
code?: FailureCode;
|
|
1841
|
-
/**
|
|
1842
|
-
* Failure message.
|
|
1843
|
-
* @readonly
|
|
1844
|
-
*/
|
|
1845
|
-
message?: string;
|
|
1846
|
-
}
|
|
1847
|
-
declare enum FailureCode {
|
|
1848
|
-
UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
|
|
1849
|
-
OTHER = "OTHER"
|
|
1850
|
-
}
|
|
1851
|
-
/**
|
|
1852
|
-
* he confirmation status types, a record:
|
|
1853
|
-
* starts at pending
|
|
1854
|
-
* ends either at confirmed_by_all or expired
|
|
1855
|
-
*/
|
|
1856
|
-
declare enum ICANNConfirmationStatus {
|
|
1857
|
-
UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
|
|
1858
|
-
PENDING = "PENDING",
|
|
1859
|
-
CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
|
|
1860
|
-
EXPIRED = "EXPIRED"
|
|
1861
|
-
}
|
|
1862
|
-
interface ICANNConfirmationStatusInfo extends ICANNConfirmationStatusInfoStatusOneOf {
|
|
1863
|
-
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
1864
|
-
pending?: Pending;
|
|
1865
|
-
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
1866
|
-
expired?: Expired;
|
|
1867
|
-
}
|
|
1868
|
-
/** @oneof */
|
|
1869
|
-
interface ICANNConfirmationStatusInfoStatusOneOf {
|
|
1870
|
-
/** Details about domains with `"PENDING"` ICANN confirmation status. */
|
|
1871
|
-
pending?: Pending;
|
|
1872
|
-
/** Details about domains with `"EXPIRED"` ICANN confirmation status. */
|
|
1873
|
-
expired?: Expired;
|
|
1874
|
-
}
|
|
1875
|
-
interface Pending {
|
|
1876
|
-
/**
|
|
1877
|
-
* Expiration date of the ICANN confirmation process in
|
|
1878
|
-
* `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
|
|
1879
|
-
* before this date or the domain won't be active.
|
|
1880
|
-
*/
|
|
1881
|
-
expirationDate?: Date;
|
|
1882
|
-
/**
|
|
1883
|
-
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
1884
|
-
* yet.
|
|
1885
|
-
*/
|
|
1886
|
-
notConfirmedBy?: string[];
|
|
1887
|
-
}
|
|
1888
|
-
interface Expired {
|
|
1889
|
-
/**
|
|
1890
|
-
* Email addresses of the contacts who haven't confirmed the domain with ICANN
|
|
1891
|
-
* in time.
|
|
1892
|
-
*/
|
|
1893
|
-
notConfirmedBy?: string[];
|
|
1894
|
-
}
|
|
1895
|
-
declare enum DnsPropagationStatus {
|
|
1896
|
-
UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
|
|
1897
|
-
COMPLETED = "COMPLETED",
|
|
1898
|
-
FAILED = "FAILED",
|
|
1899
|
-
IN_PROGRESS = "IN_PROGRESS"
|
|
1900
|
-
}
|
|
1901
|
-
interface CreateRegisteredDomainRequest {
|
|
1902
|
-
/** Information about the domain to register including contact details. */
|
|
1903
|
-
registeredDomain: RegisteredDomain;
|
|
1904
|
-
}
|
|
1905
|
-
interface CreateRegisteredDomainResponse {
|
|
1906
|
-
/** Created registered domain. */
|
|
1907
|
-
registeredDomain?: RegisteredDomain;
|
|
1908
|
-
}
|
|
1909
|
-
interface GetRegisteredDomainRequest {
|
|
1910
|
-
/** ID of the registered domain to retrieve. */
|
|
1911
|
-
registeredDomainId: string;
|
|
1912
|
-
}
|
|
1913
|
-
interface GetRegisteredDomainResponse {
|
|
1914
|
-
/** Retrieved registered domain. */
|
|
1915
|
-
registeredDomain?: RegisteredDomain;
|
|
1916
|
-
}
|
|
1917
|
-
interface ListRegisteredDomainsRequest {
|
|
1918
|
-
/** Cursor paging options. */
|
|
1919
|
-
paging?: CursorPaging$1;
|
|
1920
|
-
}
|
|
1921
|
-
interface CursorPaging$1 {
|
|
1922
|
-
/**
|
|
1923
|
-
* Number of domains to load.
|
|
1924
|
-
*
|
|
1925
|
-
* Min: `0`
|
|
1926
|
-
* Max: `100`
|
|
1927
|
-
*/
|
|
1928
|
-
limit?: number | null;
|
|
1929
|
-
/**
|
|
1930
|
-
* Pointer to the next or previous page in the list of results.
|
|
1931
|
-
*
|
|
1932
|
-
* You can get the relevant cursor token
|
|
1933
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1934
|
-
* Not relevant for the first request.
|
|
1935
|
-
*/
|
|
1936
|
-
cursor?: string | null;
|
|
1937
|
-
}
|
|
1938
|
-
interface ListRegisteredDomainsResponse {
|
|
1939
|
-
/** Metadata about the returned list of registered domains. */
|
|
1940
|
-
pagingMetadata?: CursorPagingMetadata$1;
|
|
1941
|
-
/** Retrieved registered domains. */
|
|
1942
|
-
registeredDomains?: RegisteredDomain[];
|
|
1943
|
-
}
|
|
1944
|
-
interface CursorPagingMetadata$1 {
|
|
1945
|
-
/** Number of domains returned in the response. */
|
|
1946
|
-
count?: number | null;
|
|
1947
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1948
|
-
cursors?: Cursors$1;
|
|
1949
|
-
/**
|
|
1950
|
-
* Indicates if there are more results after the current page.
|
|
1951
|
-
* If `true`, another page of results can be retrieved.
|
|
1952
|
-
* If `false`, this is the last page.
|
|
1953
|
-
*/
|
|
1954
|
-
hasNext?: boolean | null;
|
|
1955
|
-
}
|
|
1956
|
-
interface Cursors$1 {
|
|
1957
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1958
|
-
next?: string | null;
|
|
1959
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
1960
|
-
prev?: string | null;
|
|
1961
|
-
}
|
|
1962
|
-
interface DeleteRegisteredDomainByIdRequest {
|
|
1963
|
-
/** ID of the registered domain to delete. */
|
|
1964
|
-
registeredDomainId?: string;
|
|
1965
|
-
}
|
|
1966
|
-
interface DeleteRegisteredDomainByIdResponse {
|
|
1967
|
-
}
|
|
1968
|
-
interface RedeemRegisteredDomainRequest {
|
|
1969
|
-
/**
|
|
1970
|
-
* ID of the registered domain to redeem. Identical to the domain name
|
|
1971
|
-
* including TLD.
|
|
1972
|
-
*/
|
|
1973
|
-
registeredDomainId: string;
|
|
1974
|
-
}
|
|
1975
|
-
interface RedeemRegisteredDomainResponse {
|
|
1976
|
-
/** Registered domain to redeem. */
|
|
1977
|
-
registeredDomain?: RegisteredDomain;
|
|
1978
|
-
}
|
|
1979
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1980
|
-
createdEvent?: EntityCreatedEvent;
|
|
1981
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1982
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1983
|
-
actionEvent?: ActionEvent;
|
|
1984
|
-
/**
|
|
1985
|
-
* Unique event ID.
|
|
1986
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1987
|
-
*/
|
|
1988
|
-
_id?: string;
|
|
1989
|
-
/**
|
|
1990
|
-
* Assumes actions are also always typed to an entity_type
|
|
1991
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1992
|
-
*/
|
|
1993
|
-
entityFqdn?: string;
|
|
1994
|
-
/**
|
|
1995
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1996
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1997
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1998
|
-
*/
|
|
1999
|
-
slug?: string;
|
|
2000
|
-
/** ID of the entity associated with the event. */
|
|
2001
|
-
entityId?: string;
|
|
2002
|
-
/** Event timestamp. */
|
|
2003
|
-
eventTime?: Date;
|
|
2004
|
-
/**
|
|
2005
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2006
|
-
* (for example, GDPR).
|
|
2007
|
-
*/
|
|
2008
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2009
|
-
/** If present, indicates the action that triggered the event. */
|
|
2010
|
-
originatedFrom?: string | null;
|
|
2011
|
-
/**
|
|
2012
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
2013
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2014
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2015
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2016
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2017
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2018
|
-
*/
|
|
2019
|
-
entityEventSequence?: string | null;
|
|
2020
|
-
}
|
|
2021
|
-
/** @oneof */
|
|
2022
|
-
interface DomainEventBodyOneOf {
|
|
2023
|
-
createdEvent?: EntityCreatedEvent;
|
|
2024
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2025
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2026
|
-
actionEvent?: ActionEvent;
|
|
2027
|
-
}
|
|
2028
|
-
interface EntityCreatedEvent {
|
|
2029
|
-
entity?: string;
|
|
2030
|
-
}
|
|
2031
|
-
interface RestoreInfo {
|
|
2032
|
-
deletedDate?: Date;
|
|
2033
|
-
}
|
|
2034
|
-
interface EntityUpdatedEvent {
|
|
2035
|
-
/**
|
|
2036
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2037
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2038
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2039
|
-
*/
|
|
2040
|
-
currentEntity?: string;
|
|
2041
|
-
}
|
|
2042
|
-
interface EntityDeletedEvent {
|
|
2043
|
-
/** Entity that was deleted */
|
|
2044
|
-
deletedEntity?: string | null;
|
|
2045
|
-
}
|
|
2046
|
-
interface ActionEvent {
|
|
2047
|
-
body?: string;
|
|
2048
|
-
}
|
|
2049
|
-
interface MessageEnvelope {
|
|
2050
|
-
/** App instance ID. */
|
|
2051
|
-
instanceId?: string | null;
|
|
2052
|
-
/** Event type. */
|
|
2053
|
-
eventType?: string;
|
|
2054
|
-
/** The identification type and identity data. */
|
|
2055
|
-
identity?: IdentificationData;
|
|
2056
|
-
/** Stringify payload. */
|
|
2057
|
-
data?: string;
|
|
2058
|
-
}
|
|
2059
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2060
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
2061
|
-
anonymousVisitorId?: string;
|
|
2062
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
2063
|
-
memberId?: string;
|
|
2064
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2065
|
-
wixUserId?: string;
|
|
2066
|
-
/** ID of an app. */
|
|
2067
|
-
appId?: string;
|
|
2068
|
-
/** @readonly */
|
|
2069
|
-
identityType?: WebhookIdentityType;
|
|
2070
|
-
}
|
|
2071
|
-
/** @oneof */
|
|
2072
|
-
interface IdentificationDataIdOneOf {
|
|
2073
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
2074
|
-
anonymousVisitorId?: string;
|
|
2075
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
2076
|
-
memberId?: string;
|
|
2077
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2078
|
-
wixUserId?: string;
|
|
2079
|
-
/** ID of an app. */
|
|
2080
|
-
appId?: string;
|
|
2081
|
-
}
|
|
2082
|
-
declare enum WebhookIdentityType {
|
|
2083
|
-
UNKNOWN = "UNKNOWN",
|
|
2084
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2085
|
-
MEMBER = "MEMBER",
|
|
2086
|
-
WIX_USER = "WIX_USER",
|
|
2087
|
-
APP = "APP"
|
|
2088
|
-
}
|
|
2089
|
-
interface LatestAttemptNonNullableFields {
|
|
2090
|
-
number: number;
|
|
2091
|
-
}
|
|
2092
|
-
interface PendingRegistrationInfoNonNullableFields {
|
|
2093
|
-
latestAttempt?: LatestAttemptNonNullableFields;
|
|
2094
|
-
}
|
|
2095
|
-
interface FailedRegistrationInfoNonNullableFields {
|
|
2096
|
-
code: FailureCode;
|
|
2097
|
-
message: string;
|
|
2098
|
-
}
|
|
2099
|
-
interface RedirectAssignmentInfoNonNullableFields {
|
|
2100
|
-
primaryDomain: string;
|
|
2101
|
-
}
|
|
2102
|
-
interface SiteInfoNonNullableFields {
|
|
2103
|
-
redirectInfo?: RedirectAssignmentInfoNonNullableFields;
|
|
2104
|
-
assignmentType: AssignmentType;
|
|
2105
|
-
}
|
|
2106
|
-
interface ContactDataNonNullableFields {
|
|
2107
|
-
firstName: string;
|
|
2108
|
-
lastName: string;
|
|
2109
|
-
email: string;
|
|
2110
|
-
address: string;
|
|
2111
|
-
city: string;
|
|
2112
|
-
countryCode: string;
|
|
2113
|
-
phone: string;
|
|
2114
|
-
}
|
|
2115
|
-
interface ContactsNonNullableFields {
|
|
2116
|
-
registrant?: ContactDataNonNullableFields;
|
|
2117
|
-
admin?: ContactDataNonNullableFields;
|
|
2118
|
-
tech?: ContactDataNonNullableFields;
|
|
2119
|
-
}
|
|
2120
|
-
interface PendingNonNullableFields {
|
|
2121
|
-
notConfirmedBy: string[];
|
|
2122
|
-
}
|
|
2123
|
-
interface ExpiredNonNullableFields {
|
|
2124
|
-
notConfirmedBy: string[];
|
|
2125
|
-
}
|
|
2126
|
-
interface ICANNConfirmationStatusInfoNonNullableFields {
|
|
2127
|
-
pending?: PendingNonNullableFields;
|
|
2128
|
-
expired?: ExpiredNonNullableFields;
|
|
2129
|
-
}
|
|
2130
|
-
interface RegisteredDomainNonNullableFields {
|
|
2131
|
-
pendingRegistrationInfo?: PendingRegistrationInfoNonNullableFields;
|
|
2132
|
-
failedRegistrationInfo?: FailedRegistrationInfoNonNullableFields;
|
|
2133
|
-
_id: string;
|
|
2134
|
-
domain: string;
|
|
2135
|
-
productInstanceId: string;
|
|
2136
|
-
siteInfo?: SiteInfoNonNullableFields;
|
|
2137
|
-
contacts?: ContactsNonNullableFields;
|
|
2138
|
-
status: Status;
|
|
2139
|
-
icannConfirmationStatus: ICANNConfirmationStatus;
|
|
2140
|
-
icannConfirmationStatusInfo?: ICANNConfirmationStatusInfoNonNullableFields;
|
|
2141
|
-
dnsPropagationStatus: DnsPropagationStatus;
|
|
2142
|
-
}
|
|
2143
|
-
interface CreateRegisteredDomainResponseNonNullableFields {
|
|
2144
|
-
registeredDomain?: RegisteredDomainNonNullableFields;
|
|
2145
|
-
}
|
|
2146
|
-
interface GetRegisteredDomainResponseNonNullableFields {
|
|
2147
|
-
registeredDomain?: RegisteredDomainNonNullableFields;
|
|
2148
|
-
}
|
|
2149
|
-
interface ListRegisteredDomainsResponseNonNullableFields {
|
|
2150
|
-
registeredDomains: RegisteredDomainNonNullableFields[];
|
|
2151
|
-
}
|
|
2152
|
-
interface RedeemRegisteredDomainResponseNonNullableFields {
|
|
2153
|
-
registeredDomain?: RegisteredDomainNonNullableFields;
|
|
2154
|
-
}
|
|
2155
|
-
interface ListRegisteredDomainsOptions {
|
|
2156
|
-
/** Cursor paging options. */
|
|
2157
|
-
paging?: CursorPaging$1;
|
|
2158
|
-
}
|
|
2159
|
-
|
|
2160
|
-
declare function createRegisteredDomain$1(httpClient: HttpClient): CreateRegisteredDomainSignature;
|
|
2161
|
-
interface CreateRegisteredDomainSignature {
|
|
2162
|
-
/**
|
|
2163
|
-
* Creates a registeredDomain object and starts the domain registration process that may take up to 48 hours to resolve.
|
|
2164
|
-
*
|
|
2165
|
-
* You must pass the relevant Wix account ID in the header of the call. You may also pass a Wix site ID in the header of the call. This assigns the domain to the site when the registration succeeds. If you don't provide a site ID, the domain is registered but not assigned to a Wix site. Information about the site is returned in the `siteInfo object`, while information about the account isn't returned.
|
|
2166
|
-
*
|
|
2167
|
-
* To register a domain and assign it to a site, the site must have an active [Premium plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683). However, if you just want to register a domain without connecting it to a site, the account doesn't need an active Premium plan. In both situations, the account must own a product that supports linking a domain with the chosen TLD. Use [Create Package](/packages/create-package) of the Resellers API to add the relevant Premium plan or product to your customer's site. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about the available product IDs.
|
|
2168
|
-
*
|
|
2169
|
-
* You can register domains for 1, 2, or 3 years, but you don't set the duration with this endpoint. Instead Wix chooses the registration length based on the billing cycle of the corresponding `productInstance` from the [Resellers API](/packages/Introduction). The [Create Registered Domain](/registeredDomains/create-registered-domains) call fails if the billing cycle of the relevant productInstance isn't 1, 2, or 3 years.
|
|
2170
|
-
*
|
|
2171
|
-
* You can only register a root domain. You can't register a subdomain.
|
|
2172
|
-
*
|
|
2173
|
-
* If you try to register a domain that isn't available for purchase or there is already a `registeredDomain` object for the specified domain, the call fails without creating a `registeredDomain` object or starting the registration process.
|
|
2174
|
-
*
|
|
2175
|
-
* Wix tries to register the domain several times, but stops if the process fails too often. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information about the number of attempts and their timing.
|
|
2176
|
-
*
|
|
2177
|
-
* Wix only checks formal requirements of each field in the `contacts` object, such as the maximum number of characters. Wix doesn't check whether the actual domain registrar has additional requirements, for example that the postal code is valid in the specified country. If there is such a mismatch between the request and the registrar's requirements, the call succeeds but the registration process can't succeed. Read more about [contact validations](https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-validations).
|
|
2178
|
-
*
|
|
2179
|
-
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
2180
|
-
* @param - Information about the domain to register including contact details.
|
|
2181
|
-
* @returns Created registered domain.
|
|
2182
|
-
*/
|
|
2183
|
-
(registeredDomain: RegisteredDomain): Promise<RegisteredDomain & RegisteredDomainNonNullableFields>;
|
|
2184
|
-
}
|
|
2185
|
-
declare function getRegisteredDomain$1(httpClient: HttpClient): GetRegisteredDomainSignature;
|
|
2186
|
-
interface GetRegisteredDomainSignature {
|
|
2187
|
-
/**
|
|
2188
|
-
* Retrieves a registered domain.
|
|
2189
|
-
*
|
|
2190
|
-
*
|
|
2191
|
-
* You must pass the relevant Wix account ID in the header of the call.
|
|
2192
|
-
*
|
|
2193
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
2194
|
-
* @param - ID of the registered domain to retrieve.
|
|
2195
|
-
* @returns Retrieved registered domain.
|
|
2196
|
-
*/
|
|
2197
|
-
(registeredDomainId: string): Promise<RegisteredDomain & RegisteredDomainNonNullableFields>;
|
|
2198
|
-
}
|
|
2199
|
-
declare function listRegisteredDomains$1(httpClient: HttpClient): ListRegisteredDomainsSignature;
|
|
2200
|
-
interface ListRegisteredDomainsSignature {
|
|
2201
|
-
/**
|
|
2202
|
-
* Retrieves a list of up to 100 registered domains.
|
|
2203
|
-
*
|
|
2204
|
-
*
|
|
2205
|
-
* You must pass the relevant Wix account ID in the header of the call.
|
|
2206
|
-
*
|
|
2207
|
-
* The retrieved domains are sorted by `createdDate` in descending order.
|
|
2208
|
-
*
|
|
2209
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
2210
|
-
*/
|
|
2211
|
-
(options?: ListRegisteredDomainsOptions | undefined): Promise<ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields>;
|
|
2212
|
-
}
|
|
2213
|
-
declare function redeemRegisteredDomain$1(httpClient: HttpClient): RedeemRegisteredDomainSignature;
|
|
2214
|
-
interface RedeemRegisteredDomainSignature {
|
|
2215
|
-
/**
|
|
2216
|
-
* Redeems a registered domain that's currently in redemption.
|
|
2217
|
-
*
|
|
2218
|
-
*
|
|
2219
|
-
* You must pass the relevant Wix account ID in the header of the call.
|
|
2220
|
-
*
|
|
2221
|
-
* It may take up to 7 days to complete the domain redemption. If the domain
|
|
2222
|
-
* is successfully redeemed, the new `expirationDate` is 1 year after the
|
|
2223
|
-
* original `expirationDate`.
|
|
2224
|
-
*
|
|
2225
|
-
* You can't redeem registered domains that haven't expired yet or have passed
|
|
2226
|
-
* the redemption period.
|
|
2227
|
-
*
|
|
2228
|
-
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
2229
|
-
* @param - ID of the registered domain to redeem. Identical to the domain name
|
|
2230
|
-
* including TLD.
|
|
2231
|
-
*/
|
|
2232
|
-
(registeredDomainId: string): Promise<RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields>;
|
|
2233
|
-
}
|
|
2234
|
-
|
|
2235
|
-
declare const createRegisteredDomain: MaybeContext<BuildRESTFunction<typeof createRegisteredDomain$1> & typeof createRegisteredDomain$1>;
|
|
2236
|
-
declare const getRegisteredDomain: MaybeContext<BuildRESTFunction<typeof getRegisteredDomain$1> & typeof getRegisteredDomain$1>;
|
|
2237
|
-
declare const listRegisteredDomains: MaybeContext<BuildRESTFunction<typeof listRegisteredDomains$1> & typeof listRegisteredDomains$1>;
|
|
2238
|
-
declare const redeemRegisteredDomain: MaybeContext<BuildRESTFunction<typeof redeemRegisteredDomain$1> & typeof redeemRegisteredDomain$1>;
|
|
2239
|
-
|
|
2240
1485
|
type context$2_ActionEvent = ActionEvent;
|
|
2241
|
-
type context$
|
|
2242
|
-
|
|
2243
|
-
type context$
|
|
2244
|
-
type context$
|
|
2245
|
-
type context$
|
|
2246
|
-
type context$
|
|
2247
|
-
type context$
|
|
2248
|
-
type context$
|
|
2249
|
-
type context$
|
|
2250
|
-
type context$
|
|
2251
|
-
declare const context$2_DnsPropagationStatus: typeof DnsPropagationStatus;
|
|
1486
|
+
type context$2_CreateDnsZoneRequest = CreateDnsZoneRequest;
|
|
1487
|
+
type context$2_CreateDnsZoneResponse = CreateDnsZoneResponse;
|
|
1488
|
+
type context$2_CreateDnsZoneResponseNonNullableFields = CreateDnsZoneResponseNonNullableFields;
|
|
1489
|
+
type context$2_DeleteDnsZoneRequest = DeleteDnsZoneRequest;
|
|
1490
|
+
type context$2_DeleteDnsZoneResponse = DeleteDnsZoneResponse;
|
|
1491
|
+
type context$2_DnsRecord = DnsRecord;
|
|
1492
|
+
type context$2_DnsRecordsChangedEvent = DnsRecordsChangedEvent;
|
|
1493
|
+
type context$2_DnsZone = DnsZone;
|
|
1494
|
+
type context$2_DnsZoneNonNullableFields = DnsZoneNonNullableFields;
|
|
1495
|
+
type context$2_DnssecInfo = DnssecInfo;
|
|
2252
1496
|
type context$2_DomainEvent = DomainEvent;
|
|
2253
1497
|
type context$2_DomainEventBodyOneOf = DomainEventBodyOneOf;
|
|
1498
|
+
type context$2_DomainRemovedEvent = DomainRemovedEvent;
|
|
2254
1499
|
type context$2_EntityCreatedEvent = EntityCreatedEvent;
|
|
2255
1500
|
type context$2_EntityDeletedEvent = EntityDeletedEvent;
|
|
2256
1501
|
type context$2_EntityUpdatedEvent = EntityUpdatedEvent;
|
|
2257
|
-
type context$
|
|
2258
|
-
type context$
|
|
2259
|
-
type context$
|
|
2260
|
-
declare const context$2_FailureCode: typeof FailureCode;
|
|
2261
|
-
type context$2_GetRegisteredDomainRequest = GetRegisteredDomainRequest;
|
|
2262
|
-
type context$2_GetRegisteredDomainResponse = GetRegisteredDomainResponse;
|
|
2263
|
-
type context$2_GetRegisteredDomainResponseNonNullableFields = GetRegisteredDomainResponseNonNullableFields;
|
|
2264
|
-
type context$2_ICANNConfirmationStatus = ICANNConfirmationStatus;
|
|
2265
|
-
declare const context$2_ICANNConfirmationStatus: typeof ICANNConfirmationStatus;
|
|
2266
|
-
type context$2_ICANNConfirmationStatusInfo = ICANNConfirmationStatusInfo;
|
|
2267
|
-
type context$2_ICANNConfirmationStatusInfoStatusOneOf = ICANNConfirmationStatusInfoStatusOneOf;
|
|
1502
|
+
type context$2_GetDnsZoneRequest = GetDnsZoneRequest;
|
|
1503
|
+
type context$2_GetDnsZoneResponse = GetDnsZoneResponse;
|
|
1504
|
+
type context$2_GetDnsZoneResponseNonNullableFields = GetDnsZoneResponseNonNullableFields;
|
|
2268
1505
|
type context$2_IdentificationData = IdentificationData;
|
|
2269
1506
|
type context$2_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
2270
|
-
type context$2_LatestAttempt = LatestAttempt;
|
|
2271
|
-
type context$2_ListRegisteredDomainsOptions = ListRegisteredDomainsOptions;
|
|
2272
|
-
type context$2_ListRegisteredDomainsRequest = ListRegisteredDomainsRequest;
|
|
2273
|
-
type context$2_ListRegisteredDomainsResponse = ListRegisteredDomainsResponse;
|
|
2274
|
-
type context$2_ListRegisteredDomainsResponseNonNullableFields = ListRegisteredDomainsResponseNonNullableFields;
|
|
2275
1507
|
type context$2_MessageEnvelope = MessageEnvelope;
|
|
2276
|
-
type context$
|
|
2277
|
-
type context$
|
|
2278
|
-
type context$
|
|
2279
|
-
type context$
|
|
2280
|
-
|
|
2281
|
-
type context$2_RedirectAssignmentInfo = RedirectAssignmentInfo;
|
|
2282
|
-
type context$2_RegisteredDomain = RegisteredDomain;
|
|
2283
|
-
type context$2_RegisteredDomainNonNullableFields = RegisteredDomainNonNullableFields;
|
|
2284
|
-
type context$2_RegisteredDomainStatusInfoOneOf = RegisteredDomainStatusInfoOneOf;
|
|
1508
|
+
type context$2_PreviewDnsZoneRequest = PreviewDnsZoneRequest;
|
|
1509
|
+
type context$2_PreviewDnsZoneResponse = PreviewDnsZoneResponse;
|
|
1510
|
+
type context$2_PreviewDnsZoneResponseNonNullableFields = PreviewDnsZoneResponseNonNullableFields;
|
|
1511
|
+
type context$2_RecordType = RecordType;
|
|
1512
|
+
declare const context$2_RecordType: typeof RecordType;
|
|
2285
1513
|
type context$2_RestoreInfo = RestoreInfo;
|
|
2286
|
-
type context$
|
|
2287
|
-
type context$
|
|
2288
|
-
type context$
|
|
2289
|
-
|
|
1514
|
+
type context$2_UpdateDnsZoneOptions = UpdateDnsZoneOptions;
|
|
1515
|
+
type context$2_UpdateDnsZoneRequest = UpdateDnsZoneRequest;
|
|
1516
|
+
type context$2_UpdateDnsZoneResponse = UpdateDnsZoneResponse;
|
|
1517
|
+
type context$2_UpdateDnsZoneResponseNonNullableFields = UpdateDnsZoneResponseNonNullableFields;
|
|
2290
1518
|
type context$2_WebhookIdentityType = WebhookIdentityType;
|
|
2291
1519
|
declare const context$2_WebhookIdentityType: typeof WebhookIdentityType;
|
|
2292
|
-
declare const context$
|
|
2293
|
-
declare const context$
|
|
2294
|
-
declare const context$
|
|
2295
|
-
declare const context$
|
|
1520
|
+
declare const context$2_createDnsZone: typeof createDnsZone;
|
|
1521
|
+
declare const context$2_deleteDnsZone: typeof deleteDnsZone;
|
|
1522
|
+
declare const context$2_getDnsZone: typeof getDnsZone;
|
|
1523
|
+
declare const context$2_previewDnsZone: typeof previewDnsZone;
|
|
1524
|
+
declare const context$2_updateDnsZone: typeof updateDnsZone;
|
|
2296
1525
|
declare namespace context$2 {
|
|
2297
|
-
export { type context$2_ActionEvent as ActionEvent, context$
|
|
1526
|
+
export { type context$2_ActionEvent as ActionEvent, type context$2_CreateDnsZoneRequest as CreateDnsZoneRequest, type context$2_CreateDnsZoneResponse as CreateDnsZoneResponse, type context$2_CreateDnsZoneResponseNonNullableFields as CreateDnsZoneResponseNonNullableFields, type context$2_DeleteDnsZoneRequest as DeleteDnsZoneRequest, type context$2_DeleteDnsZoneResponse as DeleteDnsZoneResponse, type context$2_DnsRecord as DnsRecord, type context$2_DnsRecordsChangedEvent as DnsRecordsChangedEvent, type context$2_DnsZone as DnsZone, type context$2_DnsZoneNonNullableFields as DnsZoneNonNullableFields, type context$2_DnssecInfo as DnssecInfo, type context$2_DomainEvent as DomainEvent, type context$2_DomainEventBodyOneOf as DomainEventBodyOneOf, type context$2_DomainRemovedEvent as DomainRemovedEvent, type context$2_EntityCreatedEvent as EntityCreatedEvent, type context$2_EntityDeletedEvent as EntityDeletedEvent, type context$2_EntityUpdatedEvent as EntityUpdatedEvent, type context$2_GetDnsZoneRequest as GetDnsZoneRequest, type context$2_GetDnsZoneResponse as GetDnsZoneResponse, type context$2_GetDnsZoneResponseNonNullableFields as GetDnsZoneResponseNonNullableFields, type context$2_IdentificationData as IdentificationData, type context$2_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context$2_MessageEnvelope as MessageEnvelope, type context$2_PreviewDnsZoneRequest as PreviewDnsZoneRequest, type context$2_PreviewDnsZoneResponse as PreviewDnsZoneResponse, type context$2_PreviewDnsZoneResponseNonNullableFields as PreviewDnsZoneResponseNonNullableFields, context$2_RecordType as RecordType, type context$2_RestoreInfo as RestoreInfo, type context$2_UpdateDnsZoneOptions as UpdateDnsZoneOptions, type context$2_UpdateDnsZoneRequest as UpdateDnsZoneRequest, type context$2_UpdateDnsZoneResponse as UpdateDnsZoneResponse, type context$2_UpdateDnsZoneResponseNonNullableFields as UpdateDnsZoneResponseNonNullableFields, context$2_WebhookIdentityType as WebhookIdentityType, context$2_createDnsZone as createDnsZone, context$2_deleteDnsZone as deleteDnsZone, context$2_getDnsZone as getDnsZone, context$2_previewDnsZone as previewDnsZone, context$2_updateDnsZone as updateDnsZone };
|
|
2298
1527
|
}
|
|
2299
1528
|
|
|
2300
1529
|
interface DomainAvailability {
|
|
@@ -2540,4 +1769,4 @@ declare namespace context {
|
|
|
2540
1769
|
export { type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_Cursors as Cursors, type context_DomainSuggestion as DomainSuggestion, type context_SuggestDomainsOptions as SuggestDomainsOptions, type context_SuggestDomainsRequest as SuggestDomainsRequest, type context_SuggestDomainsResponse as SuggestDomainsResponse, type context_SuggestDomainsResponseNonNullableFields as SuggestDomainsResponseNonNullableFields, context_suggestDomains as suggestDomains };
|
|
2541
1770
|
}
|
|
2542
1771
|
|
|
2543
|
-
export { context$
|
|
1772
|
+
export { context$3 as connectedDomainSetupInfo, context$4 as connectedDomains, context$1 as domainAvailability, context$2 as domainDns, context as domainSuggestions };
|