@wix/domains 1.0.51 → 1.0.53

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/domains",
3
- "version": "1.0.51",
3
+ "version": "1.0.53",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -22,9 +22,9 @@
22
22
  ],
23
23
  "dependencies": {
24
24
  "@wix/domains_connected-domain-setup-info": "1.0.20",
25
- "@wix/domains_connected-domains": "1.0.23",
25
+ "@wix/domains_connected-domains": "1.0.25",
26
26
  "@wix/domains_domain-availability": "1.0.16",
27
- "@wix/domains_domain-dns": "1.0.14",
27
+ "@wix/domains_domain-dns": "1.0.15",
28
28
  "@wix/domains_domain-suggestions": "1.0.23"
29
29
  },
30
30
  "devDependencies": {
@@ -50,5 +50,5 @@
50
50
  "fqdn": ""
51
51
  }
52
52
  },
53
- "falconPackageHash": "78fba637191b1b7a69d495a64e3334b13ea4d3eb2a612b08504341ae"
53
+ "falconPackageHash": "633abba19f04bdc575a6fcb99c8da758ebf7cf9a63f7f991de0494c4"
54
54
  }
@@ -488,14 +488,7 @@ interface ConnectedDomain {
488
488
  * Both root domains and subdomains are supported.
489
489
  */
490
490
  domain?: string;
491
- /**
492
- * How the domain is connected to the Wix site.
493
- *
494
- * + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
495
- * + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
496
- * + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
497
- * + `"HIDDEN"`: The domain isn't visible to site visitors.
498
- */
491
+ /** How the domain is connected to the Wix site. */
499
492
  connectionType?: ConnectionType$1;
500
493
  /**
501
494
  * Information about the site to which the domain is assigned, and whether
@@ -511,25 +504,30 @@ interface ConnectedDomain {
511
504
  suppressNotifications?: boolean;
512
505
  /**
513
506
  * DNS propagation status.
514
- *
515
- * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
516
- * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
517
- * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
518
- * + `"FAILED"`: The domain's DNS propagation process has failed.
519
507
  * @readonly
520
508
  */
521
509
  dnsPropagationStatus?: DnsPropagationStatus;
510
+ /**
511
+ * Date and time the `connectedDomain` object was created in
512
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
513
+ * @readonly
514
+ */
515
+ _createdDate?: Date | null;
516
+ /**
517
+ * Date and time the `connectedDomain` object was last updated in
518
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
519
+ * @readonly
520
+ */
521
+ _updatedDate?: Date | null;
522
522
  }
523
523
  declare enum ConnectionType$1 {
524
- /** Used by sub domain */
524
+ /** There is no information about the connection type. */
525
525
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
526
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
526
527
  POINTING = "POINTING",
528
+ /** The domain is connected by nameservers. Wix manages DNS information. */
527
529
  NAMESERVERS = "NAMESERVERS",
528
- /**
529
- * internal used by photography company.
530
- * when a customer creates a photo album, each album has its sub domain and this sub domain
531
- * is not visible in my domains page.
532
- */
530
+ /** The domain isn't visible to site visitors. */
533
531
  HIDDEN = "HIDDEN"
534
532
  }
535
533
  interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
@@ -544,10 +542,8 @@ interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
544
542
  */
545
543
  _id?: string | null;
546
544
  /**
547
- * The relationship assigned for this domain to the site:
548
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
549
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
550
- * + `"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.
545
+ * The relationship assigned for this domain to the site.
546
+ *
551
547
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
552
548
  */
553
549
  assignmentType?: AssignmentType;
@@ -561,8 +557,11 @@ interface SiteInfoAssignmentInfoOneOf {
561
557
  redirectInfo?: RedirectAssignmentInfo;
562
558
  }
563
559
  declare enum AssignmentType {
560
+ /** There is no information about the domain assignment type. */
564
561
  UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
562
+ /** The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site. */
565
563
  PRIMARY = "PRIMARY",
564
+ /** 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. */
566
565
  REDIRECT = "REDIRECT"
567
566
  }
568
567
  interface RedirectAssignmentInfo {
@@ -573,9 +572,13 @@ interface RedirectAssignmentInfo {
573
572
  primaryDomain?: string;
574
573
  }
575
574
  declare enum DnsPropagationStatus {
575
+ /** There's no information about the domain's DNS propagation status. */
576
576
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
577
+ /** The domain's DNS propagation process has successfully finished. */
577
578
  COMPLETED = "COMPLETED",
579
+ /** The domain's DNS propagation process has failed. */
578
580
  FAILED = "FAILED",
581
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
579
582
  IN_PROGRESS = "IN_PROGRESS"
580
583
  }
581
584
  interface DomainRemovedEvent$1 {
@@ -1176,22 +1179,7 @@ interface DnsZone {
1176
1179
  dnssecInfo?: DnssecInfo;
1177
1180
  }
1178
1181
  interface DnsRecord {
1179
- /**
1180
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
1181
- *
1182
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
1183
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
1184
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
1185
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
1186
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
1187
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
1188
- * + `MX`: MX record. Directs emails to mail servers.
1189
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
1190
- * + `SPF`: SPF record. Used for email authentication.
1191
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
1192
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
1193
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
1194
- */
1182
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
1195
1183
  type?: RecordType;
1196
1184
  /**
1197
1185
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -1211,17 +1199,29 @@ interface DnsRecord {
1211
1199
  values?: string[];
1212
1200
  }
1213
1201
  declare enum RecordType {
1202
+ /** Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`. */
1214
1203
  UNKNOWN = "UNKNOWN",
1204
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
1215
1205
  A = "A",
1206
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
1216
1207
  AAAA = "AAAA",
1208
+ /** Name server record. Describes which server contains the actual DNS record. */
1217
1209
  NS = "NS",
1210
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
1218
1211
  SOA = "SOA",
1212
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
1219
1213
  CNAME = "CNAME",
1214
+ /** MX record. Directs emails to mail servers. */
1220
1215
  MX = "MX",
1216
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
1221
1217
  TXT = "TXT",
1218
+ /** SPF record. Used for email authentication. */
1222
1219
  SPF = "SPF",
1220
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
1223
1221
  SRV = "SRV",
1222
+ /** Pointer record. Specifies which host is supported for a given IP address. */
1224
1223
  PTR = "PTR",
1224
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
1225
1225
  NAPTR = "NAPTR"
1226
1226
  }
1227
1227
  interface DnssecInfo {
@@ -488,14 +488,7 @@ interface ConnectedDomain {
488
488
  * Both root domains and subdomains are supported.
489
489
  */
490
490
  domain?: string;
491
- /**
492
- * How the domain is connected to the Wix site.
493
- *
494
- * + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
495
- * + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
496
- * + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
497
- * + `"HIDDEN"`: The domain isn't visible to site visitors.
498
- */
491
+ /** How the domain is connected to the Wix site. */
499
492
  connectionType?: ConnectionType$1;
500
493
  /**
501
494
  * Information about the site to which the domain is assigned, and whether
@@ -511,25 +504,30 @@ interface ConnectedDomain {
511
504
  suppressNotifications?: boolean;
512
505
  /**
513
506
  * DNS propagation status.
514
- *
515
- * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
516
- * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
517
- * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
518
- * + `"FAILED"`: The domain's DNS propagation process has failed.
519
507
  * @readonly
520
508
  */
521
509
  dnsPropagationStatus?: DnsPropagationStatus;
510
+ /**
511
+ * Date and time the `connectedDomain` object was created in
512
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
513
+ * @readonly
514
+ */
515
+ _createdDate?: Date | null;
516
+ /**
517
+ * Date and time the `connectedDomain` object was last updated in
518
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
519
+ * @readonly
520
+ */
521
+ _updatedDate?: Date | null;
522
522
  }
523
523
  declare enum ConnectionType$1 {
524
- /** Used by sub domain */
524
+ /** There is no information about the connection type. */
525
525
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
526
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
526
527
  POINTING = "POINTING",
528
+ /** The domain is connected by nameservers. Wix manages DNS information. */
527
529
  NAMESERVERS = "NAMESERVERS",
528
- /**
529
- * internal used by photography company.
530
- * when a customer creates a photo album, each album has its sub domain and this sub domain
531
- * is not visible in my domains page.
532
- */
530
+ /** The domain isn't visible to site visitors. */
533
531
  HIDDEN = "HIDDEN"
534
532
  }
535
533
  interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
@@ -544,10 +542,8 @@ interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
544
542
  */
545
543
  _id?: string | null;
546
544
  /**
547
- * The relationship assigned for this domain to the site:
548
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
549
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
550
- * + `"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.
545
+ * The relationship assigned for this domain to the site.
546
+ *
551
547
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
552
548
  */
553
549
  assignmentType?: AssignmentType;
@@ -561,8 +557,11 @@ interface SiteInfoAssignmentInfoOneOf {
561
557
  redirectInfo?: RedirectAssignmentInfo;
562
558
  }
563
559
  declare enum AssignmentType {
560
+ /** There is no information about the domain assignment type. */
564
561
  UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
562
+ /** The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site. */
565
563
  PRIMARY = "PRIMARY",
564
+ /** 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. */
566
565
  REDIRECT = "REDIRECT"
567
566
  }
568
567
  interface RedirectAssignmentInfo {
@@ -573,9 +572,13 @@ interface RedirectAssignmentInfo {
573
572
  primaryDomain?: string;
574
573
  }
575
574
  declare enum DnsPropagationStatus {
575
+ /** There's no information about the domain's DNS propagation status. */
576
576
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
577
+ /** The domain's DNS propagation process has successfully finished. */
577
578
  COMPLETED = "COMPLETED",
579
+ /** The domain's DNS propagation process has failed. */
578
580
  FAILED = "FAILED",
581
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
579
582
  IN_PROGRESS = "IN_PROGRESS"
580
583
  }
581
584
  interface DomainRemovedEvent$1 {
@@ -1176,22 +1179,7 @@ interface DnsZone {
1176
1179
  dnssecInfo?: DnssecInfo;
1177
1180
  }
1178
1181
  interface DnsRecord {
1179
- /**
1180
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
1181
- *
1182
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
1183
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
1184
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
1185
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
1186
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
1187
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
1188
- * + `MX`: MX record. Directs emails to mail servers.
1189
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
1190
- * + `SPF`: SPF record. Used for email authentication.
1191
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
1192
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
1193
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
1194
- */
1182
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
1195
1183
  type?: RecordType;
1196
1184
  /**
1197
1185
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -1211,17 +1199,29 @@ interface DnsRecord {
1211
1199
  values?: string[];
1212
1200
  }
1213
1201
  declare enum RecordType {
1202
+ /** Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`. */
1214
1203
  UNKNOWN = "UNKNOWN",
1204
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
1215
1205
  A = "A",
1206
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
1216
1207
  AAAA = "AAAA",
1208
+ /** Name server record. Describes which server contains the actual DNS record. */
1217
1209
  NS = "NS",
1210
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
1218
1211
  SOA = "SOA",
1212
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
1219
1213
  CNAME = "CNAME",
1214
+ /** MX record. Directs emails to mail servers. */
1220
1215
  MX = "MX",
1216
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
1221
1217
  TXT = "TXT",
1218
+ /** SPF record. Used for email authentication. */
1222
1219
  SPF = "SPF",
1220
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
1223
1221
  SRV = "SRV",
1222
+ /** Pointer record. Specifies which host is supported for a given IP address. */
1224
1223
  PTR = "PTR",
1224
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
1225
1225
  NAPTR = "NAPTR"
1226
1226
  }
1227
1227
  interface DnssecInfo {
@@ -10,14 +10,7 @@ interface ConnectedDomain$1 {
10
10
  * Both root domains and subdomains are supported.
11
11
  */
12
12
  domain?: string;
13
- /**
14
- * How the domain is connected to the Wix site.
15
- *
16
- * + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
17
- * + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
18
- * + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
19
- * + `"HIDDEN"`: The domain isn't visible to site visitors.
20
- */
13
+ /** How the domain is connected to the Wix site. */
21
14
  connectionType?: ConnectionType$1;
22
15
  /**
23
16
  * Information about the site to which the domain is assigned, and whether
@@ -33,25 +26,30 @@ interface ConnectedDomain$1 {
33
26
  suppressNotifications?: boolean;
34
27
  /**
35
28
  * DNS propagation status.
36
- *
37
- * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
38
- * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
39
- * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
40
- * + `"FAILED"`: The domain's DNS propagation process has failed.
41
29
  * @readonly
42
30
  */
43
31
  dnsPropagationStatus?: DnsPropagationStatus$1;
32
+ /**
33
+ * Date and time the `connectedDomain` object was created in
34
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
35
+ * @readonly
36
+ */
37
+ createdDate?: Date | null;
38
+ /**
39
+ * Date and time the `connectedDomain` object was last updated in
40
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
41
+ * @readonly
42
+ */
43
+ updatedDate?: Date | null;
44
44
  }
45
45
  declare enum ConnectionType$1 {
46
- /** Used by sub domain */
46
+ /** There is no information about the connection type. */
47
47
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
48
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
48
49
  POINTING = "POINTING",
50
+ /** The domain is connected by nameservers. Wix manages DNS information. */
49
51
  NAMESERVERS = "NAMESERVERS",
50
- /**
51
- * internal used by photography company.
52
- * when a customer creates a photo album, each album has its sub domain and this sub domain
53
- * is not visible in my domains page.
54
- */
52
+ /** The domain isn't visible to site visitors. */
55
53
  HIDDEN = "HIDDEN"
56
54
  }
57
55
  interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
@@ -66,10 +64,8 @@ interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
66
64
  */
67
65
  id?: string | null;
68
66
  /**
69
- * The relationship assigned for this domain to the site:
70
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
71
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
72
- * + `"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.
67
+ * The relationship assigned for this domain to the site.
68
+ *
73
69
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
74
70
  */
75
71
  assignmentType?: AssignmentType$1;
@@ -83,8 +79,11 @@ interface SiteInfoAssignmentInfoOneOf$1 {
83
79
  redirectInfo?: RedirectAssignmentInfo$1;
84
80
  }
85
81
  declare enum AssignmentType$1 {
82
+ /** There is no information about the domain assignment type. */
86
83
  UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
84
+ /** The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site. */
87
85
  PRIMARY = "PRIMARY",
86
+ /** 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. */
88
87
  REDIRECT = "REDIRECT"
89
88
  }
90
89
  interface RedirectAssignmentInfo$1 {
@@ -95,9 +94,13 @@ interface RedirectAssignmentInfo$1 {
95
94
  primaryDomain?: string;
96
95
  }
97
96
  declare enum DnsPropagationStatus$1 {
97
+ /** There's no information about the domain's DNS propagation status. */
98
98
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
99
+ /** The domain's DNS propagation process has successfully finished. */
99
100
  COMPLETED = "COMPLETED",
101
+ /** The domain's DNS propagation process has failed. */
100
102
  FAILED = "FAILED",
103
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
101
104
  IN_PROGRESS = "IN_PROGRESS"
102
105
  }
103
106
  interface CreateConnectedDomainRequest$1 {
@@ -204,14 +207,7 @@ interface ConnectedDomain {
204
207
  * Both root domains and subdomains are supported.
205
208
  */
206
209
  domain?: string;
207
- /**
208
- * How the domain is connected to the Wix site.
209
- *
210
- * + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
211
- * + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
212
- * + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
213
- * + `"HIDDEN"`: The domain isn't visible to site visitors.
214
- */
210
+ /** How the domain is connected to the Wix site. */
215
211
  connectionType?: ConnectionType;
216
212
  /**
217
213
  * Information about the site to which the domain is assigned, and whether
@@ -227,25 +223,30 @@ interface ConnectedDomain {
227
223
  suppressNotifications?: boolean;
228
224
  /**
229
225
  * DNS propagation status.
230
- *
231
- * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
232
- * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
233
- * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
234
- * + `"FAILED"`: The domain's DNS propagation process has failed.
235
226
  * @readonly
236
227
  */
237
228
  dnsPropagationStatus?: DnsPropagationStatus;
229
+ /**
230
+ * Date and time the `connectedDomain` object was created in
231
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
232
+ * @readonly
233
+ */
234
+ _createdDate?: Date | null;
235
+ /**
236
+ * Date and time the `connectedDomain` object was last updated in
237
+ * `YYYY-MM-DDThh:mm:ss.sssZ` format.
238
+ * @readonly
239
+ */
240
+ _updatedDate?: Date | null;
238
241
  }
239
242
  declare enum ConnectionType {
240
- /** Used by sub domain */
243
+ /** There is no information about the connection type. */
241
244
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
245
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
242
246
  POINTING = "POINTING",
247
+ /** The domain is connected by nameservers. Wix manages DNS information. */
243
248
  NAMESERVERS = "NAMESERVERS",
244
- /**
245
- * internal used by photography company.
246
- * when a customer creates a photo album, each album has its sub domain and this sub domain
247
- * is not visible in my domains page.
248
- */
249
+ /** The domain isn't visible to site visitors. */
249
250
  HIDDEN = "HIDDEN"
250
251
  }
251
252
  interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
@@ -260,10 +261,8 @@ interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
260
261
  */
261
262
  _id?: string | null;
262
263
  /**
263
- * The relationship assigned for this domain to the site:
264
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
265
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
266
- * + `"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.
264
+ * The relationship assigned for this domain to the site.
265
+ *
267
266
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
268
267
  */
269
268
  assignmentType?: AssignmentType;
@@ -277,8 +276,11 @@ interface SiteInfoAssignmentInfoOneOf {
277
276
  redirectInfo?: RedirectAssignmentInfo;
278
277
  }
279
278
  declare enum AssignmentType {
279
+ /** There is no information about the domain assignment type. */
280
280
  UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
281
+ /** The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site. */
281
282
  PRIMARY = "PRIMARY",
283
+ /** 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. */
282
284
  REDIRECT = "REDIRECT"
283
285
  }
284
286
  interface RedirectAssignmentInfo {
@@ -289,9 +291,13 @@ interface RedirectAssignmentInfo {
289
291
  primaryDomain?: string;
290
292
  }
291
293
  declare enum DnsPropagationStatus {
294
+ /** There's no information about the domain's DNS propagation status. */
292
295
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
296
+ /** The domain's DNS propagation process has successfully finished. */
293
297
  COMPLETED = "COMPLETED",
298
+ /** The domain's DNS propagation process has failed. */
294
299
  FAILED = "FAILED",
300
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
295
301
  IN_PROGRESS = "IN_PROGRESS"
296
302
  }
297
303
  interface CreateConnectedDomainRequest {
@@ -805,22 +811,7 @@ interface DnsZone$1 {
805
811
  dnssecInfo?: DnssecInfo$1;
806
812
  }
807
813
  interface DnsRecord$1 {
808
- /**
809
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
810
- *
811
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
812
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
813
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
814
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
815
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
816
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
817
- * + `MX`: MX record. Directs emails to mail servers.
818
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
819
- * + `SPF`: SPF record. Used for email authentication.
820
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
821
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
822
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
823
- */
814
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
824
815
  type?: RecordType$1;
825
816
  /**
826
817
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -840,17 +831,29 @@ interface DnsRecord$1 {
840
831
  values?: string[];
841
832
  }
842
833
  declare enum RecordType$1 {
834
+ /** Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`. */
843
835
  UNKNOWN = "UNKNOWN",
836
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
844
837
  A = "A",
838
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
845
839
  AAAA = "AAAA",
840
+ /** Name server record. Describes which server contains the actual DNS record. */
846
841
  NS = "NS",
842
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
847
843
  SOA = "SOA",
844
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
848
845
  CNAME = "CNAME",
846
+ /** MX record. Directs emails to mail servers. */
849
847
  MX = "MX",
848
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
850
849
  TXT = "TXT",
850
+ /** SPF record. Used for email authentication. */
851
851
  SPF = "SPF",
852
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
852
853
  SRV = "SRV",
854
+ /** Pointer record. Specifies which host is supported for a given IP address. */
853
855
  PTR = "PTR",
856
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
854
857
  NAPTR = "NAPTR"
855
858
  }
856
859
  interface DnssecInfo$1 {
@@ -985,22 +988,7 @@ interface DnsZone {
985
988
  dnssecInfo?: DnssecInfo;
986
989
  }
987
990
  interface DnsRecord {
988
- /**
989
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
990
- *
991
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
992
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
993
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
994
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
995
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
996
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
997
- * + `MX`: MX record. Directs emails to mail servers.
998
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
999
- * + `SPF`: SPF record. Used for email authentication.
1000
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
1001
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
1002
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
1003
- */
991
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
1004
992
  type?: RecordType;
1005
993
  /**
1006
994
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -1020,17 +1008,29 @@ interface DnsRecord {
1020
1008
  values?: string[];
1021
1009
  }
1022
1010
  declare enum RecordType {
1011
+ /** Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`. */
1023
1012
  UNKNOWN = "UNKNOWN",
1013
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
1024
1014
  A = "A",
1015
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
1025
1016
  AAAA = "AAAA",
1017
+ /** Name server record. Describes which server contains the actual DNS record. */
1026
1018
  NS = "NS",
1019
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
1027
1020
  SOA = "SOA",
1021
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
1028
1022
  CNAME = "CNAME",
1023
+ /** MX record. Directs emails to mail servers. */
1029
1024
  MX = "MX",
1025
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
1030
1026
  TXT = "TXT",
1027
+ /** SPF record. Used for email authentication. */
1031
1028
  SPF = "SPF",
1029
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
1032
1030
  SRV = "SRV",
1031
+ /** Pointer record. Specifies which host is supported for a given IP address. */
1033
1032
  PTR = "PTR",
1033
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
1034
1034
  NAPTR = "NAPTR"
1035
1035
  }
1036
1036
  interface DnssecInfo {