@wix/domains 1.0.30 → 1.0.32

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.30",
3
+ "version": "1.0.32",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@wix/domains_connected-domain-setup-info": "1.0.12",
22
22
  "@wix/domains_connected-domains": "1.0.12",
23
- "@wix/domains_domain-availability": "1.0.8",
24
- "@wix/domains_domain-dns": "1.0.7",
25
- "@wix/domains_domain-suggestions": "1.0.15",
23
+ "@wix/domains_domain-availability": "1.0.9",
24
+ "@wix/domains_domain-dns": "1.0.8",
25
+ "@wix/domains_domain-suggestions": "1.0.16",
26
26
  "@wix/domains_registered-domains": "1.0.10"
27
27
  },
28
28
  "devDependencies": {
@@ -48,5 +48,5 @@
48
48
  "fqdn": ""
49
49
  }
50
50
  },
51
- "falconPackageHash": "a027074b53b8e50d9e87dd02759cb897b15b466b2be39bff48a5a862"
51
+ "falconPackageHash": "4ea528d4aacdba83c0d74c2a697505da800b47a588f3ed4fc8519f06"
52
52
  }
@@ -783,6 +783,10 @@ interface DnssecInfo {
783
783
  */
784
784
  digest?: string;
785
785
  }
786
+ interface DnsRecordsChangedEvent {
787
+ domainName?: string;
788
+ changeTime?: Date;
789
+ }
786
790
  interface DomainRemovedEvent {
787
791
  /**
788
792
  * Domain name including TLD.
@@ -1101,6 +1105,7 @@ type context$3_CreateDnsZoneResponseNonNullableFields = CreateDnsZoneResponseNon
1101
1105
  type context$3_DeleteDnsZoneRequest = DeleteDnsZoneRequest;
1102
1106
  type context$3_DeleteDnsZoneResponse = DeleteDnsZoneResponse;
1103
1107
  type context$3_DnsRecord = DnsRecord;
1108
+ type context$3_DnsRecordsChangedEvent = DnsRecordsChangedEvent;
1104
1109
  type context$3_DnsZone = DnsZone;
1105
1110
  type context$3_DnsZoneNonNullableFields = DnsZoneNonNullableFields;
1106
1111
  type context$3_DnssecInfo = DnssecInfo;
@@ -1123,7 +1128,7 @@ declare const context$3_getDnsZone: typeof getDnsZone;
1123
1128
  declare const context$3_previewDnsZone: typeof previewDnsZone;
1124
1129
  declare const context$3_updateDnsZone: typeof updateDnsZone;
1125
1130
  declare namespace context$3 {
1126
- 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_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 };
1131
+ 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 };
1127
1132
  }
1128
1133
 
1129
1134
  /**
@@ -1925,11 +1930,7 @@ interface DomainAvailability {
1925
1930
  * when `false` is returned.
1926
1931
  */
1927
1932
  available?: boolean;
1928
- /**
1929
- * Indicates whether the domain is a premium domain. Premium domains often
1930
- * have higher prices due to their perceived value or demand. A value of
1931
- * `true` means the domain is classified as premium.
1932
- */
1933
+ /** Whether the domain has a higher price due to its perceived value or demand. */
1933
1934
  premium?: boolean;
1934
1935
  }
1935
1936
  interface CheckDomainAvailabilityRequest {
@@ -1991,11 +1992,7 @@ declare namespace context$1 {
1991
1992
  interface DomainSuggestion {
1992
1993
  /** Suggested domain name including TLD. */
1993
1994
  domain?: string;
1994
- /**
1995
- * Indicates whether the domain is a premium domain. Premium domains often
1996
- * have higher prices due to their perceived value or demand. A value of
1997
- * `true` means the domain is classified as premium.
1998
- */
1995
+ /** Whether the domain has a higher price due to its perceived value or demand. */
1999
1996
  premium?: boolean;
2000
1997
  }
2001
1998
  interface SuggestDomainsRequest {
@@ -2018,18 +2015,18 @@ interface SuggestDomainsRequest {
2018
2015
  */
2019
2016
  tlds?: string[];
2020
2017
  /**
2021
- * Number of domain suggestions to return.
2018
+ * Number of domain suggestions to return. __Deprecated__: This field will be
2019
+ * removed on March 1, 2025. Use `paging.limit` instead.
2022
2020
  *
2023
2021
  * Min: `1`
2024
2022
  * Max: `20`
2025
2023
  * Default: `10`
2026
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2027
- * @deprecated Number of domain suggestions to return.
2024
+ * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
2025
+ * removed on March 1, 2025. Use `paging.limit` instead.
2028
2026
  *
2029
2027
  * Min: `1`
2030
2028
  * Max: `20`
2031
2029
  * Default: `10`
2032
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2033
2030
  * @replacedBy paging.limit
2034
2031
  * @targetRemovalDate 2025-03-01
2035
2032
  */
@@ -2037,18 +2034,17 @@ interface SuggestDomainsRequest {
2037
2034
  /** Cursor paging options. */
2038
2035
  paging?: CursorPaging;
2039
2036
  /**
2040
- * Maximum length of domain name in suggestions.
2037
+ * Maximum number of characters for the domain name, excluding the TLD.
2041
2038
  *
2042
2039
  * Min: `3`
2043
2040
  * Max: `63`
2044
- * Default: `No max`
2045
- * Note: max length is only for the SLD (not including TLD).
2041
+ * Default: `63`
2046
2042
  */
2047
2043
  maxLength?: number | null;
2048
2044
  }
2049
2045
  interface CursorPaging {
2050
2046
  /**
2051
- * Number of domains to load.
2047
+ * Maximum number of domains to return in the results.
2052
2048
  *
2053
2049
  * Min: `0`
2054
2050
  * Max: `20`
@@ -2106,18 +2102,18 @@ interface SuggestDomainsOptions {
2106
2102
  */
2107
2103
  tlds?: string[];
2108
2104
  /**
2109
- * Number of domain suggestions to return.
2105
+ * Number of domain suggestions to return. __Deprecated__: This field will be
2106
+ * removed on March 1, 2025. Use `paging.limit` instead.
2110
2107
  *
2111
2108
  * Min: `1`
2112
2109
  * Max: `20`
2113
2110
  * Default: `10`
2114
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2115
- * @deprecated Number of domain suggestions to return.
2111
+ * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
2112
+ * removed on March 1, 2025. Use `paging.limit` instead.
2116
2113
  *
2117
2114
  * Min: `1`
2118
2115
  * Max: `20`
2119
2116
  * Default: `10`
2120
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2121
2117
  * @replacedBy paging.limit
2122
2118
  * @targetRemovalDate 2025-03-01
2123
2119
  */
@@ -2125,12 +2121,11 @@ interface SuggestDomainsOptions {
2125
2121
  /** Cursor paging options. */
2126
2122
  paging?: CursorPaging;
2127
2123
  /**
2128
- * Maximum length of domain name in suggestions.
2124
+ * Maximum number of characters for the domain name, excluding the TLD.
2129
2125
  *
2130
2126
  * Min: `3`
2131
2127
  * Max: `63`
2132
- * Default: `No max`
2133
- * Note: max length is only for the SLD (not including TLD).
2128
+ * Default: `63`
2134
2129
  */
2135
2130
  maxLength?: number | null;
2136
2131
  }
@@ -783,6 +783,10 @@ interface DnssecInfo {
783
783
  */
784
784
  digest?: string;
785
785
  }
786
+ interface DnsRecordsChangedEvent {
787
+ domainName?: string;
788
+ changeTime?: Date;
789
+ }
786
790
  interface DomainRemovedEvent {
787
791
  /**
788
792
  * Domain name including TLD.
@@ -1101,6 +1105,7 @@ type index_d$3_CreateDnsZoneResponseNonNullableFields = CreateDnsZoneResponseNon
1101
1105
  type index_d$3_DeleteDnsZoneRequest = DeleteDnsZoneRequest;
1102
1106
  type index_d$3_DeleteDnsZoneResponse = DeleteDnsZoneResponse;
1103
1107
  type index_d$3_DnsRecord = DnsRecord;
1108
+ type index_d$3_DnsRecordsChangedEvent = DnsRecordsChangedEvent;
1104
1109
  type index_d$3_DnsZone = DnsZone;
1105
1110
  type index_d$3_DnsZoneNonNullableFields = DnsZoneNonNullableFields;
1106
1111
  type index_d$3_DnssecInfo = DnssecInfo;
@@ -1123,7 +1128,7 @@ declare const index_d$3_getDnsZone: typeof getDnsZone;
1123
1128
  declare const index_d$3_previewDnsZone: typeof previewDnsZone;
1124
1129
  declare const index_d$3_updateDnsZone: typeof updateDnsZone;
1125
1130
  declare namespace index_d$3 {
1126
- export { type ActionEvent$1 as ActionEvent, type index_d$3_CreateDnsZoneRequest as CreateDnsZoneRequest, type index_d$3_CreateDnsZoneResponse as CreateDnsZoneResponse, type index_d$3_CreateDnsZoneResponseNonNullableFields as CreateDnsZoneResponseNonNullableFields, type index_d$3_DeleteDnsZoneRequest as DeleteDnsZoneRequest, type index_d$3_DeleteDnsZoneResponse as DeleteDnsZoneResponse, type index_d$3_DnsRecord as DnsRecord, type index_d$3_DnsZone as DnsZone, type index_d$3_DnsZoneNonNullableFields as DnsZoneNonNullableFields, type index_d$3_DnssecInfo as DnssecInfo, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$3_DomainRemovedEvent as DomainRemovedEvent, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type index_d$3_GetDnsZoneRequest as GetDnsZoneRequest, type index_d$3_GetDnsZoneResponse as GetDnsZoneResponse, type index_d$3_GetDnsZoneResponseNonNullableFields as GetDnsZoneResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type index_d$3_PreviewDnsZoneRequest as PreviewDnsZoneRequest, type index_d$3_PreviewDnsZoneResponse as PreviewDnsZoneResponse, type index_d$3_PreviewDnsZoneResponseNonNullableFields as PreviewDnsZoneResponseNonNullableFields, index_d$3_RecordType as RecordType, type RestoreInfo$1 as RestoreInfo, type index_d$3_UpdateDnsZoneOptions as UpdateDnsZoneOptions, type index_d$3_UpdateDnsZoneRequest as UpdateDnsZoneRequest, type index_d$3_UpdateDnsZoneResponse as UpdateDnsZoneResponse, type index_d$3_UpdateDnsZoneResponseNonNullableFields as UpdateDnsZoneResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, index_d$3_createDnsZone as createDnsZone, index_d$3_deleteDnsZone as deleteDnsZone, index_d$3_getDnsZone as getDnsZone, index_d$3_previewDnsZone as previewDnsZone, index_d$3_updateDnsZone as updateDnsZone };
1131
+ export { type ActionEvent$1 as ActionEvent, type index_d$3_CreateDnsZoneRequest as CreateDnsZoneRequest, type index_d$3_CreateDnsZoneResponse as CreateDnsZoneResponse, type index_d$3_CreateDnsZoneResponseNonNullableFields as CreateDnsZoneResponseNonNullableFields, type index_d$3_DeleteDnsZoneRequest as DeleteDnsZoneRequest, type index_d$3_DeleteDnsZoneResponse as DeleteDnsZoneResponse, type index_d$3_DnsRecord as DnsRecord, type index_d$3_DnsRecordsChangedEvent as DnsRecordsChangedEvent, type index_d$3_DnsZone as DnsZone, type index_d$3_DnsZoneNonNullableFields as DnsZoneNonNullableFields, type index_d$3_DnssecInfo as DnssecInfo, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$3_DomainRemovedEvent as DomainRemovedEvent, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type index_d$3_GetDnsZoneRequest as GetDnsZoneRequest, type index_d$3_GetDnsZoneResponse as GetDnsZoneResponse, type index_d$3_GetDnsZoneResponseNonNullableFields as GetDnsZoneResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type index_d$3_PreviewDnsZoneRequest as PreviewDnsZoneRequest, type index_d$3_PreviewDnsZoneResponse as PreviewDnsZoneResponse, type index_d$3_PreviewDnsZoneResponseNonNullableFields as PreviewDnsZoneResponseNonNullableFields, index_d$3_RecordType as RecordType, type RestoreInfo$1 as RestoreInfo, type index_d$3_UpdateDnsZoneOptions as UpdateDnsZoneOptions, type index_d$3_UpdateDnsZoneRequest as UpdateDnsZoneRequest, type index_d$3_UpdateDnsZoneResponse as UpdateDnsZoneResponse, type index_d$3_UpdateDnsZoneResponseNonNullableFields as UpdateDnsZoneResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, index_d$3_createDnsZone as createDnsZone, index_d$3_deleteDnsZone as deleteDnsZone, index_d$3_getDnsZone as getDnsZone, index_d$3_previewDnsZone as previewDnsZone, index_d$3_updateDnsZone as updateDnsZone };
1127
1132
  }
1128
1133
 
1129
1134
  /**
@@ -1925,11 +1930,7 @@ interface DomainAvailability {
1925
1930
  * when `false` is returned.
1926
1931
  */
1927
1932
  available?: boolean;
1928
- /**
1929
- * Indicates whether the domain is a premium domain. Premium domains often
1930
- * have higher prices due to their perceived value or demand. A value of
1931
- * `true` means the domain is classified as premium.
1932
- */
1933
+ /** Whether the domain has a higher price due to its perceived value or demand. */
1933
1934
  premium?: boolean;
1934
1935
  }
1935
1936
  interface CheckDomainAvailabilityRequest {
@@ -1991,11 +1992,7 @@ declare namespace index_d$1 {
1991
1992
  interface DomainSuggestion {
1992
1993
  /** Suggested domain name including TLD. */
1993
1994
  domain?: string;
1994
- /**
1995
- * Indicates whether the domain is a premium domain. Premium domains often
1996
- * have higher prices due to their perceived value or demand. A value of
1997
- * `true` means the domain is classified as premium.
1998
- */
1995
+ /** Whether the domain has a higher price due to its perceived value or demand. */
1999
1996
  premium?: boolean;
2000
1997
  }
2001
1998
  interface SuggestDomainsRequest {
@@ -2018,18 +2015,18 @@ interface SuggestDomainsRequest {
2018
2015
  */
2019
2016
  tlds?: string[];
2020
2017
  /**
2021
- * Number of domain suggestions to return.
2018
+ * Number of domain suggestions to return. __Deprecated__: This field will be
2019
+ * removed on March 1, 2025. Use `paging.limit` instead.
2022
2020
  *
2023
2021
  * Min: `1`
2024
2022
  * Max: `20`
2025
2023
  * Default: `10`
2026
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2027
- * @deprecated Number of domain suggestions to return.
2024
+ * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
2025
+ * removed on March 1, 2025. Use `paging.limit` instead.
2028
2026
  *
2029
2027
  * Min: `1`
2030
2028
  * Max: `20`
2031
2029
  * Default: `10`
2032
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2033
2030
  * @replacedBy paging.limit
2034
2031
  * @targetRemovalDate 2025-03-01
2035
2032
  */
@@ -2037,18 +2034,17 @@ interface SuggestDomainsRequest {
2037
2034
  /** Cursor paging options. */
2038
2035
  paging?: CursorPaging;
2039
2036
  /**
2040
- * Maximum length of domain name in suggestions.
2037
+ * Maximum number of characters for the domain name, excluding the TLD.
2041
2038
  *
2042
2039
  * Min: `3`
2043
2040
  * Max: `63`
2044
- * Default: `No max`
2045
- * Note: max length is only for the SLD (not including TLD).
2041
+ * Default: `63`
2046
2042
  */
2047
2043
  maxLength?: number | null;
2048
2044
  }
2049
2045
  interface CursorPaging {
2050
2046
  /**
2051
- * Number of domains to load.
2047
+ * Maximum number of domains to return in the results.
2052
2048
  *
2053
2049
  * Min: `0`
2054
2050
  * Max: `20`
@@ -2106,18 +2102,18 @@ interface SuggestDomainsOptions {
2106
2102
  */
2107
2103
  tlds?: string[];
2108
2104
  /**
2109
- * Number of domain suggestions to return.
2105
+ * Number of domain suggestions to return. __Deprecated__: This field will be
2106
+ * removed on March 1, 2025. Use `paging.limit` instead.
2110
2107
  *
2111
2108
  * Min: `1`
2112
2109
  * Max: `20`
2113
2110
  * Default: `10`
2114
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2115
- * @deprecated Number of domain suggestions to return.
2111
+ * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
2112
+ * removed on March 1, 2025. Use `paging.limit` instead.
2116
2113
  *
2117
2114
  * Min: `1`
2118
2115
  * Max: `20`
2119
2116
  * Default: `10`
2120
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2121
2117
  * @replacedBy paging.limit
2122
2118
  * @targetRemovalDate 2025-03-01
2123
2119
  */
@@ -2125,12 +2121,11 @@ interface SuggestDomainsOptions {
2125
2121
  /** Cursor paging options. */
2126
2122
  paging?: CursorPaging;
2127
2123
  /**
2128
- * Maximum length of domain name in suggestions.
2124
+ * Maximum number of characters for the domain name, excluding the TLD.
2129
2125
  *
2130
2126
  * Min: `3`
2131
2127
  * Max: `63`
2132
- * Default: `No max`
2133
- * Note: max length is only for the SLD (not including TLD).
2128
+ * Default: `63`
2134
2129
  */
2135
2130
  maxLength?: number | null;
2136
2131
  }
@@ -2261,11 +2261,7 @@ interface DomainAvailability$1 {
2261
2261
  * when `false` is returned.
2262
2262
  */
2263
2263
  available?: boolean;
2264
- /**
2265
- * Indicates whether the domain is a premium domain. Premium domains often
2266
- * have higher prices due to their perceived value or demand. A value of
2267
- * `true` means the domain is classified as premium.
2268
- */
2264
+ /** Whether the domain has a higher price due to its perceived value or demand. */
2269
2265
  premium?: boolean;
2270
2266
  }
2271
2267
  interface CheckDomainAvailabilityRequest$1 {
@@ -2300,11 +2296,7 @@ interface DomainAvailability {
2300
2296
  * when `false` is returned.
2301
2297
  */
2302
2298
  available?: boolean;
2303
- /**
2304
- * Indicates whether the domain is a premium domain. Premium domains often
2305
- * have higher prices due to their perceived value or demand. A value of
2306
- * `true` means the domain is classified as premium.
2307
- */
2299
+ /** Whether the domain has a higher price due to its perceived value or demand. */
2308
2300
  premium?: boolean;
2309
2301
  }
2310
2302
  interface CheckDomainAvailabilityRequest {
@@ -2350,11 +2342,7 @@ declare namespace meta$1 {
2350
2342
  interface DomainSuggestion$1 {
2351
2343
  /** Suggested domain name including TLD. */
2352
2344
  domain?: string;
2353
- /**
2354
- * Indicates whether the domain is a premium domain. Premium domains often
2355
- * have higher prices due to their perceived value or demand. A value of
2356
- * `true` means the domain is classified as premium.
2357
- */
2345
+ /** Whether the domain has a higher price due to its perceived value or demand. */
2358
2346
  premium?: boolean;
2359
2347
  }
2360
2348
  interface SuggestDomainsRequest$1 {
@@ -2377,18 +2365,18 @@ interface SuggestDomainsRequest$1 {
2377
2365
  */
2378
2366
  tlds?: string[];
2379
2367
  /**
2380
- * Number of domain suggestions to return.
2368
+ * Number of domain suggestions to return. __Deprecated__: This field will be
2369
+ * removed on March 1, 2025. Use `paging.limit` instead.
2381
2370
  *
2382
2371
  * Min: `1`
2383
2372
  * Max: `20`
2384
2373
  * Default: `10`
2385
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2386
- * @deprecated Number of domain suggestions to return.
2374
+ * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
2375
+ * removed on March 1, 2025. Use `paging.limit` instead.
2387
2376
  *
2388
2377
  * Min: `1`
2389
2378
  * Max: `20`
2390
2379
  * Default: `10`
2391
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2392
2380
  * @replacedBy paging.limit
2393
2381
  * @targetRemovalDate 2025-03-01
2394
2382
  */
@@ -2396,18 +2384,17 @@ interface SuggestDomainsRequest$1 {
2396
2384
  /** Cursor paging options. */
2397
2385
  paging?: CursorPaging$1;
2398
2386
  /**
2399
- * Maximum length of domain name in suggestions.
2387
+ * Maximum number of characters for the domain name, excluding the TLD.
2400
2388
  *
2401
2389
  * Min: `3`
2402
2390
  * Max: `63`
2403
- * Default: `No max`
2404
- * Note: max length is only for the SLD (not including TLD).
2391
+ * Default: `63`
2405
2392
  */
2406
2393
  maxLength?: number | null;
2407
2394
  }
2408
2395
  interface CursorPaging$1 {
2409
2396
  /**
2410
- * Number of domains to load.
2397
+ * Maximum number of domains to return in the results.
2411
2398
  *
2412
2399
  * Min: `0`
2413
2400
  * Max: `20`
@@ -2457,11 +2444,7 @@ interface SuggestDomainsResponseNonNullableFields$1 {
2457
2444
  interface DomainSuggestion {
2458
2445
  /** Suggested domain name including TLD. */
2459
2446
  domain?: string;
2460
- /**
2461
- * Indicates whether the domain is a premium domain. Premium domains often
2462
- * have higher prices due to their perceived value or demand. A value of
2463
- * `true` means the domain is classified as premium.
2464
- */
2447
+ /** Whether the domain has a higher price due to its perceived value or demand. */
2465
2448
  premium?: boolean;
2466
2449
  }
2467
2450
  interface SuggestDomainsRequest {
@@ -2484,18 +2467,18 @@ interface SuggestDomainsRequest {
2484
2467
  */
2485
2468
  tlds?: string[];
2486
2469
  /**
2487
- * Number of domain suggestions to return.
2470
+ * Number of domain suggestions to return. __Deprecated__: This field will be
2471
+ * removed on March 1, 2025. Use `paging.limit` instead.
2488
2472
  *
2489
2473
  * Min: `1`
2490
2474
  * Max: `20`
2491
2475
  * Default: `10`
2492
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2493
- * @deprecated Number of domain suggestions to return.
2476
+ * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
2477
+ * removed on March 1, 2025. Use `paging.limit` instead.
2494
2478
  *
2495
2479
  * Min: `1`
2496
2480
  * Max: `20`
2497
2481
  * Default: `10`
2498
- * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead.
2499
2482
  * @replacedBy paging.limit
2500
2483
  * @targetRemovalDate 2025-03-01
2501
2484
  */
@@ -2503,18 +2486,17 @@ interface SuggestDomainsRequest {
2503
2486
  /** Cursor paging options. */
2504
2487
  paging?: CursorPaging;
2505
2488
  /**
2506
- * Maximum length of domain name in suggestions.
2489
+ * Maximum number of characters for the domain name, excluding the TLD.
2507
2490
  *
2508
2491
  * Min: `3`
2509
2492
  * Max: `63`
2510
- * Default: `No max`
2511
- * Note: max length is only for the SLD (not including TLD).
2493
+ * Default: `63`
2512
2494
  */
2513
2495
  maxLength?: number | null;
2514
2496
  }
2515
2497
  interface CursorPaging {
2516
2498
  /**
2517
- * Number of domains to load.
2499
+ * Maximum number of domains to return in the results.
2518
2500
  *
2519
2501
  * Min: `0`
2520
2502
  * Max: `20`