@wix/domains 1.0.52 → 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.52",
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.24",
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": "7ef70f77442a377be45ec47b1478393057fbd4cce8070aa569583573"
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,11 +504,6 @@ 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;
@@ -533,15 +521,13 @@ interface ConnectedDomain {
533
521
  _updatedDate?: Date | null;
534
522
  }
535
523
  declare enum ConnectionType$1 {
536
- /** Used by sub domain */
524
+ /** There is no information about the connection type. */
537
525
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
526
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
538
527
  POINTING = "POINTING",
528
+ /** The domain is connected by nameservers. Wix manages DNS information. */
539
529
  NAMESERVERS = "NAMESERVERS",
540
- /**
541
- * internal used by photography company.
542
- * when a customer creates a photo album, each album has its sub domain and this sub domain
543
- * is not visible in my domains page.
544
- */
530
+ /** The domain isn't visible to site visitors. */
545
531
  HIDDEN = "HIDDEN"
546
532
  }
547
533
  interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
@@ -556,10 +542,8 @@ interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
556
542
  */
557
543
  _id?: string | null;
558
544
  /**
559
- * The relationship assigned for this domain to the site:
560
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
561
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
562
- * + `"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
+ *
563
547
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
564
548
  */
565
549
  assignmentType?: AssignmentType;
@@ -573,8 +557,11 @@ interface SiteInfoAssignmentInfoOneOf {
573
557
  redirectInfo?: RedirectAssignmentInfo;
574
558
  }
575
559
  declare enum AssignmentType {
560
+ /** There is no information about the domain assignment type. */
576
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. */
577
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. */
578
565
  REDIRECT = "REDIRECT"
579
566
  }
580
567
  interface RedirectAssignmentInfo {
@@ -585,9 +572,13 @@ interface RedirectAssignmentInfo {
585
572
  primaryDomain?: string;
586
573
  }
587
574
  declare enum DnsPropagationStatus {
575
+ /** There's no information about the domain's DNS propagation status. */
588
576
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
577
+ /** The domain's DNS propagation process has successfully finished. */
589
578
  COMPLETED = "COMPLETED",
579
+ /** The domain's DNS propagation process has failed. */
590
580
  FAILED = "FAILED",
581
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
591
582
  IN_PROGRESS = "IN_PROGRESS"
592
583
  }
593
584
  interface DomainRemovedEvent$1 {
@@ -1188,22 +1179,7 @@ interface DnsZone {
1188
1179
  dnssecInfo?: DnssecInfo;
1189
1180
  }
1190
1181
  interface DnsRecord {
1191
- /**
1192
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
1193
- *
1194
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
1195
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
1196
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
1197
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
1198
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
1199
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
1200
- * + `MX`: MX record. Directs emails to mail servers.
1201
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
1202
- * + `SPF`: SPF record. Used for email authentication.
1203
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
1204
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
1205
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
1206
- */
1182
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
1207
1183
  type?: RecordType;
1208
1184
  /**
1209
1185
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -1223,17 +1199,29 @@ interface DnsRecord {
1223
1199
  values?: string[];
1224
1200
  }
1225
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`. */
1226
1203
  UNKNOWN = "UNKNOWN",
1204
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
1227
1205
  A = "A",
1206
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
1228
1207
  AAAA = "AAAA",
1208
+ /** Name server record. Describes which server contains the actual DNS record. */
1229
1209
  NS = "NS",
1210
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
1230
1211
  SOA = "SOA",
1212
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
1231
1213
  CNAME = "CNAME",
1214
+ /** MX record. Directs emails to mail servers. */
1232
1215
  MX = "MX",
1216
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
1233
1217
  TXT = "TXT",
1218
+ /** SPF record. Used for email authentication. */
1234
1219
  SPF = "SPF",
1220
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
1235
1221
  SRV = "SRV",
1222
+ /** Pointer record. Specifies which host is supported for a given IP address. */
1236
1223
  PTR = "PTR",
1224
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
1237
1225
  NAPTR = "NAPTR"
1238
1226
  }
1239
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,11 +504,6 @@ 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;
@@ -533,15 +521,13 @@ interface ConnectedDomain {
533
521
  _updatedDate?: Date | null;
534
522
  }
535
523
  declare enum ConnectionType$1 {
536
- /** Used by sub domain */
524
+ /** There is no information about the connection type. */
537
525
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
526
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
538
527
  POINTING = "POINTING",
528
+ /** The domain is connected by nameservers. Wix manages DNS information. */
539
529
  NAMESERVERS = "NAMESERVERS",
540
- /**
541
- * internal used by photography company.
542
- * when a customer creates a photo album, each album has its sub domain and this sub domain
543
- * is not visible in my domains page.
544
- */
530
+ /** The domain isn't visible to site visitors. */
545
531
  HIDDEN = "HIDDEN"
546
532
  }
547
533
  interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
@@ -556,10 +542,8 @@ interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
556
542
  */
557
543
  _id?: string | null;
558
544
  /**
559
- * The relationship assigned for this domain to the site:
560
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
561
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
562
- * + `"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
+ *
563
547
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
564
548
  */
565
549
  assignmentType?: AssignmentType;
@@ -573,8 +557,11 @@ interface SiteInfoAssignmentInfoOneOf {
573
557
  redirectInfo?: RedirectAssignmentInfo;
574
558
  }
575
559
  declare enum AssignmentType {
560
+ /** There is no information about the domain assignment type. */
576
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. */
577
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. */
578
565
  REDIRECT = "REDIRECT"
579
566
  }
580
567
  interface RedirectAssignmentInfo {
@@ -585,9 +572,13 @@ interface RedirectAssignmentInfo {
585
572
  primaryDomain?: string;
586
573
  }
587
574
  declare enum DnsPropagationStatus {
575
+ /** There's no information about the domain's DNS propagation status. */
588
576
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
577
+ /** The domain's DNS propagation process has successfully finished. */
589
578
  COMPLETED = "COMPLETED",
579
+ /** The domain's DNS propagation process has failed. */
590
580
  FAILED = "FAILED",
581
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
591
582
  IN_PROGRESS = "IN_PROGRESS"
592
583
  }
593
584
  interface DomainRemovedEvent$1 {
@@ -1188,22 +1179,7 @@ interface DnsZone {
1188
1179
  dnssecInfo?: DnssecInfo;
1189
1180
  }
1190
1181
  interface DnsRecord {
1191
- /**
1192
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
1193
- *
1194
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
1195
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
1196
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
1197
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
1198
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
1199
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
1200
- * + `MX`: MX record. Directs emails to mail servers.
1201
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
1202
- * + `SPF`: SPF record. Used for email authentication.
1203
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
1204
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
1205
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
1206
- */
1182
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
1207
1183
  type?: RecordType;
1208
1184
  /**
1209
1185
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -1223,17 +1199,29 @@ interface DnsRecord {
1223
1199
  values?: string[];
1224
1200
  }
1225
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`. */
1226
1203
  UNKNOWN = "UNKNOWN",
1204
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
1227
1205
  A = "A",
1206
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
1228
1207
  AAAA = "AAAA",
1208
+ /** Name server record. Describes which server contains the actual DNS record. */
1229
1209
  NS = "NS",
1210
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
1230
1211
  SOA = "SOA",
1212
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
1231
1213
  CNAME = "CNAME",
1214
+ /** MX record. Directs emails to mail servers. */
1232
1215
  MX = "MX",
1216
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
1233
1217
  TXT = "TXT",
1218
+ /** SPF record. Used for email authentication. */
1234
1219
  SPF = "SPF",
1220
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
1235
1221
  SRV = "SRV",
1222
+ /** Pointer record. Specifies which host is supported for a given IP address. */
1236
1223
  PTR = "PTR",
1224
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
1237
1225
  NAPTR = "NAPTR"
1238
1226
  }
1239
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,11 +26,6 @@ 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;
@@ -55,15 +43,13 @@ interface ConnectedDomain$1 {
55
43
  updatedDate?: Date | null;
56
44
  }
57
45
  declare enum ConnectionType$1 {
58
- /** Used by sub domain */
46
+ /** There is no information about the connection type. */
59
47
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
48
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
60
49
  POINTING = "POINTING",
50
+ /** The domain is connected by nameservers. Wix manages DNS information. */
61
51
  NAMESERVERS = "NAMESERVERS",
62
- /**
63
- * internal used by photography company.
64
- * when a customer creates a photo album, each album has its sub domain and this sub domain
65
- * is not visible in my domains page.
66
- */
52
+ /** The domain isn't visible to site visitors. */
67
53
  HIDDEN = "HIDDEN"
68
54
  }
69
55
  interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
@@ -78,10 +64,8 @@ interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
78
64
  */
79
65
  id?: string | null;
80
66
  /**
81
- * The relationship assigned for this domain to the site:
82
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
83
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
84
- * + `"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
+ *
85
69
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
86
70
  */
87
71
  assignmentType?: AssignmentType$1;
@@ -95,8 +79,11 @@ interface SiteInfoAssignmentInfoOneOf$1 {
95
79
  redirectInfo?: RedirectAssignmentInfo$1;
96
80
  }
97
81
  declare enum AssignmentType$1 {
82
+ /** There is no information about the domain assignment type. */
98
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. */
99
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. */
100
87
  REDIRECT = "REDIRECT"
101
88
  }
102
89
  interface RedirectAssignmentInfo$1 {
@@ -107,9 +94,13 @@ interface RedirectAssignmentInfo$1 {
107
94
  primaryDomain?: string;
108
95
  }
109
96
  declare enum DnsPropagationStatus$1 {
97
+ /** There's no information about the domain's DNS propagation status. */
110
98
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
99
+ /** The domain's DNS propagation process has successfully finished. */
111
100
  COMPLETED = "COMPLETED",
101
+ /** The domain's DNS propagation process has failed. */
112
102
  FAILED = "FAILED",
103
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
113
104
  IN_PROGRESS = "IN_PROGRESS"
114
105
  }
115
106
  interface CreateConnectedDomainRequest$1 {
@@ -216,14 +207,7 @@ interface ConnectedDomain {
216
207
  * Both root domains and subdomains are supported.
217
208
  */
218
209
  domain?: string;
219
- /**
220
- * How the domain is connected to the Wix site.
221
- *
222
- * + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
223
- * + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
224
- * + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
225
- * + `"HIDDEN"`: The domain isn't visible to site visitors.
226
- */
210
+ /** How the domain is connected to the Wix site. */
227
211
  connectionType?: ConnectionType;
228
212
  /**
229
213
  * Information about the site to which the domain is assigned, and whether
@@ -239,11 +223,6 @@ interface ConnectedDomain {
239
223
  suppressNotifications?: boolean;
240
224
  /**
241
225
  * DNS propagation status.
242
- *
243
- * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
244
- * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
245
- * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
246
- * + `"FAILED"`: The domain's DNS propagation process has failed.
247
226
  * @readonly
248
227
  */
249
228
  dnsPropagationStatus?: DnsPropagationStatus;
@@ -261,15 +240,13 @@ interface ConnectedDomain {
261
240
  _updatedDate?: Date | null;
262
241
  }
263
242
  declare enum ConnectionType {
264
- /** Used by sub domain */
243
+ /** There is no information about the connection type. */
265
244
  UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
245
+ /** The domain is connected by pointing. Wix doesn't manage DNS information. */
266
246
  POINTING = "POINTING",
247
+ /** The domain is connected by nameservers. Wix manages DNS information. */
267
248
  NAMESERVERS = "NAMESERVERS",
268
- /**
269
- * internal used by photography company.
270
- * when a customer creates a photo album, each album has its sub domain and this sub domain
271
- * is not visible in my domains page.
272
- */
249
+ /** The domain isn't visible to site visitors. */
273
250
  HIDDEN = "HIDDEN"
274
251
  }
275
252
  interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
@@ -284,10 +261,8 @@ interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
284
261
  */
285
262
  _id?: string | null;
286
263
  /**
287
- * The relationship assigned for this domain to the site:
288
- * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
289
- * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
290
- * + `"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
+ *
291
266
  * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
292
267
  */
293
268
  assignmentType?: AssignmentType;
@@ -301,8 +276,11 @@ interface SiteInfoAssignmentInfoOneOf {
301
276
  redirectInfo?: RedirectAssignmentInfo;
302
277
  }
303
278
  declare enum AssignmentType {
279
+ /** There is no information about the domain assignment type. */
304
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. */
305
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. */
306
284
  REDIRECT = "REDIRECT"
307
285
  }
308
286
  interface RedirectAssignmentInfo {
@@ -313,9 +291,13 @@ interface RedirectAssignmentInfo {
313
291
  primaryDomain?: string;
314
292
  }
315
293
  declare enum DnsPropagationStatus {
294
+ /** There's no information about the domain's DNS propagation status. */
316
295
  UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
296
+ /** The domain's DNS propagation process has successfully finished. */
317
297
  COMPLETED = "COMPLETED",
298
+ /** The domain's DNS propagation process has failed. */
318
299
  FAILED = "FAILED",
300
+ /** The domain's DNS propagation process has started but hasn't successfully completed yet. */
319
301
  IN_PROGRESS = "IN_PROGRESS"
320
302
  }
321
303
  interface CreateConnectedDomainRequest {
@@ -829,22 +811,7 @@ interface DnsZone$1 {
829
811
  dnssecInfo?: DnssecInfo$1;
830
812
  }
831
813
  interface DnsRecord$1 {
832
- /**
833
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
834
- *
835
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
836
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
837
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
838
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
839
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
840
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
841
- * + `MX`: MX record. Directs emails to mail servers.
842
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
843
- * + `SPF`: SPF record. Used for email authentication.
844
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
845
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
846
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
847
- */
814
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
848
815
  type?: RecordType$1;
849
816
  /**
850
817
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -864,17 +831,29 @@ interface DnsRecord$1 {
864
831
  values?: string[];
865
832
  }
866
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`. */
867
835
  UNKNOWN = "UNKNOWN",
836
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
868
837
  A = "A",
838
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
869
839
  AAAA = "AAAA",
840
+ /** Name server record. Describes which server contains the actual DNS record. */
870
841
  NS = "NS",
842
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
871
843
  SOA = "SOA",
844
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
872
845
  CNAME = "CNAME",
846
+ /** MX record. Directs emails to mail servers. */
873
847
  MX = "MX",
848
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
874
849
  TXT = "TXT",
850
+ /** SPF record. Used for email authentication. */
875
851
  SPF = "SPF",
852
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
876
853
  SRV = "SRV",
854
+ /** Pointer record. Specifies which host is supported for a given IP address. */
877
855
  PTR = "PTR",
856
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
878
857
  NAPTR = "NAPTR"
879
858
  }
880
859
  interface DnssecInfo$1 {
@@ -1009,22 +988,7 @@ interface DnsZone {
1009
988
  dnssecInfo?: DnssecInfo;
1010
989
  }
1011
990
  interface DnsRecord {
1012
- /**
1013
- * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
1014
- *
1015
- * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
1016
- * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
1017
- * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
1018
- * + `NS`: Name server record. Describes which server contains the actual DNS record.
1019
- * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
1020
- * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
1021
- * + `MX`: MX record. Directs emails to mail servers.
1022
- * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
1023
- * + `SPF`: SPF record. Used for email authentication.
1024
- * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
1025
- * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
1026
- * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
1027
- */
991
+ /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */
1028
992
  type?: RecordType;
1029
993
  /**
1030
994
  * Host name. Can be a subdomain. For example, `domain.com` or
@@ -1044,17 +1008,29 @@ interface DnsRecord {
1044
1008
  values?: string[];
1045
1009
  }
1046
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`. */
1047
1012
  UNKNOWN = "UNKNOWN",
1013
+ /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */
1048
1014
  A = "A",
1015
+ /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */
1049
1016
  AAAA = "AAAA",
1017
+ /** Name server record. Describes which server contains the actual DNS record. */
1050
1018
  NS = "NS",
1019
+ /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */
1051
1020
  SOA = "SOA",
1021
+ /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */
1052
1022
  CNAME = "CNAME",
1023
+ /** MX record. Directs emails to mail servers. */
1053
1024
  MX = "MX",
1025
+ /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */
1054
1026
  TXT = "TXT",
1027
+ /** SPF record. Used for email authentication. */
1055
1028
  SPF = "SPF",
1029
+ /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */
1056
1030
  SRV = "SRV",
1031
+ /** Pointer record. Specifies which host is supported for a given IP address. */
1057
1032
  PTR = "PTR",
1033
+ /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */
1058
1034
  NAPTR = "NAPTR"
1059
1035
  }
1060
1036
  interface DnssecInfo {