@wix/domains 1.0.13 → 1.0.15

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.13",
3
+ "version": "1.0.15",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -19,10 +19,10 @@
19
19
  ],
20
20
  "dependencies": {
21
21
  "@wix/domains_connected-domain-setup-info": "1.0.2",
22
- "@wix/domains_connected-domains": "1.0.4",
22
+ "@wix/domains_connected-domains": "1.0.5",
23
23
  "@wix/domains_domain-availability": "1.0.2",
24
24
  "@wix/domains_domain-dns": "1.0.2",
25
- "@wix/domains_domain-suggestions": "1.0.5",
25
+ "@wix/domains_domain-suggestions": "1.0.6",
26
26
  "@wix/domains_registered-domains": "1.0.4"
27
27
  },
28
28
  "devDependencies": {
@@ -47,5 +47,5 @@
47
47
  "fqdn": ""
48
48
  }
49
49
  },
50
- "falconPackageHash": "a0629c46fee883918cc8df2e1df953035b8e1fc49d644dc1046d7f1a"
50
+ "falconPackageHash": "76e67db6d1963166b5cbd013c7561d2623053b74b9861b46d678f1f9"
51
51
  }
@@ -131,9 +131,9 @@ interface DeleteConnectedDomainResponse {
131
131
  }
132
132
  interface ListConnectedDomainsRequest {
133
133
  /** Cursor paging options. */
134
- paging?: CursorPaging$1;
134
+ paging?: CursorPaging$2;
135
135
  }
136
- interface CursorPaging$1 {
136
+ interface CursorPaging$2 {
137
137
  /**
138
138
  * Number of domains to load.
139
139
  *
@@ -152,15 +152,15 @@ interface CursorPaging$1 {
152
152
  }
153
153
  interface ListConnectedDomainsResponse {
154
154
  /** Metadata about the returned list of connected domains. */
155
- pagingMetadata?: CursorPagingMetadata$1;
155
+ pagingMetadata?: CursorPagingMetadata$2;
156
156
  /** Retrieved connected domains. */
157
157
  connectedDomains?: ConnectedDomain[];
158
158
  }
159
- interface CursorPagingMetadata$1 {
159
+ interface CursorPagingMetadata$2 {
160
160
  /** Number of domains returned in the response. */
161
161
  count?: number | null;
162
162
  /** Offset that was requested. */
163
- cursors?: Cursors$1;
163
+ cursors?: Cursors$2;
164
164
  /**
165
165
  * Indicates if there are more results after the current page.
166
166
  * If `true`, another page of results can be retrieved.
@@ -168,7 +168,7 @@ interface CursorPagingMetadata$1 {
168
168
  */
169
169
  hasNext?: boolean | null;
170
170
  }
171
- interface Cursors$1 {
171
+ interface Cursors$2 {
172
172
  /** Cursor pointing to next page in the list of results. */
173
173
  next?: string | null;
174
174
  /** Cursor pointing to previous page in the list of results. */
@@ -226,6 +226,9 @@ interface DomainEventBodyOneOf$2 {
226
226
  interface EntityCreatedEvent$2 {
227
227
  entity?: string;
228
228
  }
229
+ interface RestoreInfo {
230
+ deletedDate?: Date;
231
+ }
229
232
  interface EntityUpdatedEvent$2 {
230
233
  /**
231
234
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
@@ -378,7 +381,7 @@ interface ConnectedDomainRemovedEnvelope {
378
381
  }
379
382
  interface ListConnectedDomainsOptions {
380
383
  /** Cursor paging options. */
381
- paging?: CursorPaging$1;
384
+ paging?: CursorPaging$2;
382
385
  }
383
386
 
384
387
  interface HttpClient {
@@ -469,12 +472,13 @@ type index_d$5_ListConnectedDomainsOptions = ListConnectedDomainsOptions;
469
472
  type index_d$5_ListConnectedDomainsRequest = ListConnectedDomainsRequest;
470
473
  type index_d$5_ListConnectedDomainsResponse = ListConnectedDomainsResponse;
471
474
  type index_d$5_ListConnectedDomainsResponseNonNullableFields = ListConnectedDomainsResponseNonNullableFields;
475
+ type index_d$5_RestoreInfo = RestoreInfo;
472
476
  declare const index_d$5_createConnectedDomain: typeof createConnectedDomain;
473
477
  declare const index_d$5_getConnectedDomain: typeof getConnectedDomain;
474
478
  declare const index_d$5_listConnectedDomains: typeof listConnectedDomains;
475
479
  declare const index_d$5_onConnectedDomainRemoved: typeof onConnectedDomainRemoved;
476
480
  declare namespace index_d$5 {
477
- export { type ActionEvent$2 as ActionEvent, AssignmentType$1 as AssignmentType, type index_d$5_BaseEventMetadata as BaseEventMetadata, type index_d$5_ConnectedDomain as ConnectedDomain, type index_d$5_ConnectedDomainRemovedEnvelope as ConnectedDomainRemovedEnvelope, ConnectionType$1 as ConnectionType, type index_d$5_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type index_d$5_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type index_d$5_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type index_d$5_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type index_d$5_DeleteConnectedDomainResponse as DeleteConnectedDomainResponse, DnsPropagationStatus$1 as DnsPropagationStatus, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type DomainRemovedEvent$1 as DomainRemovedEvent, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$5_EventMetadata as EventMetadata, type index_d$5_GetConnectedDomainRequest as GetConnectedDomainRequest, type index_d$5_GetConnectedDomainResponse as GetConnectedDomainResponse, type index_d$5_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$5_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type index_d$5_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type index_d$5_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type index_d$5_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type RedirectAssignmentInfo$1 as RedirectAssignmentInfo, type SiteInfo$1 as SiteInfo, type SiteInfoAssignmentInfoOneOf$1 as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$2 as WebhookIdentityType, __metadata$5 as __metadata, index_d$5_createConnectedDomain as createConnectedDomain, index_d$5_getConnectedDomain as getConnectedDomain, index_d$5_listConnectedDomains as listConnectedDomains, index_d$5_onConnectedDomainRemoved as onConnectedDomainRemoved };
481
+ export { type ActionEvent$2 as ActionEvent, AssignmentType$1 as AssignmentType, type index_d$5_BaseEventMetadata as BaseEventMetadata, type index_d$5_ConnectedDomain as ConnectedDomain, type index_d$5_ConnectedDomainRemovedEnvelope as ConnectedDomainRemovedEnvelope, ConnectionType$1 as ConnectionType, type index_d$5_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type index_d$5_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type index_d$5_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type Cursors$2 as Cursors, type index_d$5_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type index_d$5_DeleteConnectedDomainResponse as DeleteConnectedDomainResponse, DnsPropagationStatus$1 as DnsPropagationStatus, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type DomainRemovedEvent$1 as DomainRemovedEvent, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$5_EventMetadata as EventMetadata, type index_d$5_GetConnectedDomainRequest as GetConnectedDomainRequest, type index_d$5_GetConnectedDomainResponse as GetConnectedDomainResponse, type index_d$5_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$5_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type index_d$5_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type index_d$5_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type index_d$5_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type RedirectAssignmentInfo$1 as RedirectAssignmentInfo, type index_d$5_RestoreInfo as RestoreInfo, type SiteInfo$1 as SiteInfo, type SiteInfoAssignmentInfoOneOf$1 as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$2 as WebhookIdentityType, __metadata$5 as __metadata, index_d$5_createConnectedDomain as createConnectedDomain, index_d$5_getConnectedDomain as getConnectedDomain, index_d$5_listConnectedDomains as listConnectedDomains, index_d$5_onConnectedDomainRemoved as onConnectedDomainRemoved };
478
482
  }
479
483
 
480
484
  /**
@@ -1501,9 +1505,9 @@ interface GetRegisteredDomainResponse {
1501
1505
  }
1502
1506
  interface ListRegisteredDomainsRequest {
1503
1507
  /** Cursor paging options. */
1504
- paging?: CursorPaging;
1508
+ paging?: CursorPaging$1;
1505
1509
  }
1506
- interface CursorPaging {
1510
+ interface CursorPaging$1 {
1507
1511
  /**
1508
1512
  * Number of domains to load.
1509
1513
  *
@@ -1522,15 +1526,15 @@ interface CursorPaging {
1522
1526
  }
1523
1527
  interface ListRegisteredDomainsResponse {
1524
1528
  /** Metadata about the returned list of registered domains. */
1525
- pagingMetadata?: CursorPagingMetadata;
1529
+ pagingMetadata?: CursorPagingMetadata$1;
1526
1530
  /** Retrieved registered domains. */
1527
1531
  registeredDomains?: RegisteredDomain[];
1528
1532
  }
1529
- interface CursorPagingMetadata {
1533
+ interface CursorPagingMetadata$1 {
1530
1534
  /** Number of domains returned in the response. */
1531
1535
  count?: number | null;
1532
1536
  /** Offset that was requested. */
1533
- cursors?: Cursors;
1537
+ cursors?: Cursors$1;
1534
1538
  /**
1535
1539
  * Indicates if there are more results after the current page.
1536
1540
  * If `true`, another page of results can be retrieved.
@@ -1538,7 +1542,7 @@ interface CursorPagingMetadata {
1538
1542
  */
1539
1543
  hasNext?: boolean | null;
1540
1544
  }
1541
- interface Cursors {
1545
+ interface Cursors$1 {
1542
1546
  /** Cursor pointing to next page in the list of results. */
1543
1547
  next?: string | null;
1544
1548
  /** Cursor pointing to previous page in the list of results. */
@@ -1918,7 +1922,7 @@ interface RedeemRegisteredDomainResponseNonNullableFields {
1918
1922
  }
1919
1923
  interface ListRegisteredDomainsOptions {
1920
1924
  /** Cursor paging options. */
1921
- paging?: CursorPaging;
1925
+ paging?: CursorPaging$1;
1922
1926
  }
1923
1927
 
1924
1928
  declare const __metadata$2: {
@@ -2055,9 +2059,6 @@ type index_d$2_Contacts = Contacts;
2055
2059
  type index_d$2_CreateRegisteredDomainRequest = CreateRegisteredDomainRequest;
2056
2060
  type index_d$2_CreateRegisteredDomainResponse = CreateRegisteredDomainResponse;
2057
2061
  type index_d$2_CreateRegisteredDomainResponseNonNullableFields = CreateRegisteredDomainResponseNonNullableFields;
2058
- type index_d$2_CursorPaging = CursorPaging;
2059
- type index_d$2_CursorPagingMetadata = CursorPagingMetadata;
2060
- type index_d$2_Cursors = Cursors;
2061
2062
  type index_d$2_DeleteRegisteredDomainByIdRequest = DeleteRegisteredDomainByIdRequest;
2062
2063
  type index_d$2_DeleteRegisteredDomainByIdResponse = DeleteRegisteredDomainByIdResponse;
2063
2064
  type index_d$2_DnsPropagationStatus = DnsPropagationStatus;
@@ -2105,7 +2106,7 @@ declare const index_d$2_getRegisteredDomain: typeof getRegisteredDomain;
2105
2106
  declare const index_d$2_listRegisteredDomains: typeof listRegisteredDomains;
2106
2107
  declare const index_d$2_redeemRegisteredDomain: typeof redeemRegisteredDomain;
2107
2108
  declare namespace index_d$2 {
2108
- export { type index_d$2_ActionEvent as ActionEvent, index_d$2_AssignmentType as AssignmentType, type index_d$2_ContactData as ContactData, type index_d$2_Contacts as Contacts, type index_d$2_CreateRegisteredDomainRequest as CreateRegisteredDomainRequest, type index_d$2_CreateRegisteredDomainResponse as CreateRegisteredDomainResponse, type index_d$2_CreateRegisteredDomainResponseNonNullableFields as CreateRegisteredDomainResponseNonNullableFields, type index_d$2_CursorPaging as CursorPaging, type index_d$2_CursorPagingMetadata as CursorPagingMetadata, type index_d$2_Cursors as Cursors, type index_d$2_DeleteRegisteredDomainByIdRequest as DeleteRegisteredDomainByIdRequest, type index_d$2_DeleteRegisteredDomainByIdResponse as DeleteRegisteredDomainByIdResponse, index_d$2_DnsPropagationStatus as DnsPropagationStatus, type index_d$2_DomainEvent as DomainEvent, type index_d$2_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d$2_EntityCreatedEvent as EntityCreatedEvent, type index_d$2_EntityDeletedEvent as EntityDeletedEvent, type index_d$2_EntityUpdatedEvent as EntityUpdatedEvent, type index_d$2_Expired as Expired, type index_d$2_FailedRegistrationInfo as FailedRegistrationInfo, index_d$2_FailureCode as FailureCode, type index_d$2_GetRegisteredDomainRequest as GetRegisteredDomainRequest, type index_d$2_GetRegisteredDomainResponse as GetRegisteredDomainResponse, type index_d$2_GetRegisteredDomainResponseNonNullableFields as GetRegisteredDomainResponseNonNullableFields, index_d$2_ICANNConfirmationStatus as ICANNConfirmationStatus, type index_d$2_ICANNConfirmationStatusInfo as ICANNConfirmationStatusInfo, type index_d$2_ICANNConfirmationStatusInfoStatusOneOf as ICANNConfirmationStatusInfoStatusOneOf, type index_d$2_IdentificationData as IdentificationData, type index_d$2_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d$2_LatestAttempt as LatestAttempt, type index_d$2_ListRegisteredDomainsOptions as ListRegisteredDomainsOptions, type index_d$2_ListRegisteredDomainsRequest as ListRegisteredDomainsRequest, type index_d$2_ListRegisteredDomainsResponse as ListRegisteredDomainsResponse, type index_d$2_ListRegisteredDomainsResponseNonNullableFields as ListRegisteredDomainsResponseNonNullableFields, type index_d$2_MessageEnvelope as MessageEnvelope, type index_d$2_Pending as Pending, type index_d$2_PendingRegistrationInfo as PendingRegistrationInfo, type index_d$2_RedeemRegisteredDomainRequest as RedeemRegisteredDomainRequest, type index_d$2_RedeemRegisteredDomainResponse as RedeemRegisteredDomainResponse, type index_d$2_RedeemRegisteredDomainResponseNonNullableFields as RedeemRegisteredDomainResponseNonNullableFields, type index_d$2_RedirectAssignmentInfo as RedirectAssignmentInfo, type index_d$2_RegisteredDomain as RegisteredDomain, type index_d$2_RegisteredDomainStatusInfoOneOf as RegisteredDomainStatusInfoOneOf, type index_d$2_SiteInfo as SiteInfo, type index_d$2_SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOf, index_d$2_Status as Status, index_d$2_WebhookIdentityType as WebhookIdentityType, __metadata$2 as __metadata, index_d$2_createRegisteredDomain as createRegisteredDomain, index_d$2_getRegisteredDomain as getRegisteredDomain, index_d$2_listRegisteredDomains as listRegisteredDomains, index_d$2_redeemRegisteredDomain as redeemRegisteredDomain };
2109
+ export { type index_d$2_ActionEvent as ActionEvent, index_d$2_AssignmentType as AssignmentType, type index_d$2_ContactData as ContactData, type index_d$2_Contacts as Contacts, type index_d$2_CreateRegisteredDomainRequest as CreateRegisteredDomainRequest, type index_d$2_CreateRegisteredDomainResponse as CreateRegisteredDomainResponse, type index_d$2_CreateRegisteredDomainResponseNonNullableFields as CreateRegisteredDomainResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type Cursors$1 as Cursors, type index_d$2_DeleteRegisteredDomainByIdRequest as DeleteRegisteredDomainByIdRequest, type index_d$2_DeleteRegisteredDomainByIdResponse as DeleteRegisteredDomainByIdResponse, index_d$2_DnsPropagationStatus as DnsPropagationStatus, type index_d$2_DomainEvent as DomainEvent, type index_d$2_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d$2_EntityCreatedEvent as EntityCreatedEvent, type index_d$2_EntityDeletedEvent as EntityDeletedEvent, type index_d$2_EntityUpdatedEvent as EntityUpdatedEvent, type index_d$2_Expired as Expired, type index_d$2_FailedRegistrationInfo as FailedRegistrationInfo, index_d$2_FailureCode as FailureCode, type index_d$2_GetRegisteredDomainRequest as GetRegisteredDomainRequest, type index_d$2_GetRegisteredDomainResponse as GetRegisteredDomainResponse, type index_d$2_GetRegisteredDomainResponseNonNullableFields as GetRegisteredDomainResponseNonNullableFields, index_d$2_ICANNConfirmationStatus as ICANNConfirmationStatus, type index_d$2_ICANNConfirmationStatusInfo as ICANNConfirmationStatusInfo, type index_d$2_ICANNConfirmationStatusInfoStatusOneOf as ICANNConfirmationStatusInfoStatusOneOf, type index_d$2_IdentificationData as IdentificationData, type index_d$2_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d$2_LatestAttempt as LatestAttempt, type index_d$2_ListRegisteredDomainsOptions as ListRegisteredDomainsOptions, type index_d$2_ListRegisteredDomainsRequest as ListRegisteredDomainsRequest, type index_d$2_ListRegisteredDomainsResponse as ListRegisteredDomainsResponse, type index_d$2_ListRegisteredDomainsResponseNonNullableFields as ListRegisteredDomainsResponseNonNullableFields, type index_d$2_MessageEnvelope as MessageEnvelope, type index_d$2_Pending as Pending, type index_d$2_PendingRegistrationInfo as PendingRegistrationInfo, type index_d$2_RedeemRegisteredDomainRequest as RedeemRegisteredDomainRequest, type index_d$2_RedeemRegisteredDomainResponse as RedeemRegisteredDomainResponse, type index_d$2_RedeemRegisteredDomainResponseNonNullableFields as RedeemRegisteredDomainResponseNonNullableFields, type index_d$2_RedirectAssignmentInfo as RedirectAssignmentInfo, type index_d$2_RegisteredDomain as RegisteredDomain, type index_d$2_RegisteredDomainStatusInfoOneOf as RegisteredDomainStatusInfoOneOf, type index_d$2_SiteInfo as SiteInfo, type index_d$2_SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOf, index_d$2_Status as Status, index_d$2_WebhookIdentityType as WebhookIdentityType, __metadata$2 as __metadata, index_d$2_createRegisteredDomain as createRegisteredDomain, index_d$2_getRegisteredDomain as getRegisteredDomain, index_d$2_listRegisteredDomains as listRegisteredDomains, index_d$2_redeemRegisteredDomain as redeemRegisteredDomain };
2109
2110
  }
2110
2111
 
2111
2112
  interface DomainAvailability {
@@ -2182,12 +2183,60 @@ interface SuggestDomainsRequest {
2182
2183
  * Min: `1`
2183
2184
  * Max: `20`
2184
2185
  * Default: `10`
2186
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2187
+ * @deprecated Number of domain suggestions to return.
2188
+ *
2189
+ * Min: `1`
2190
+ * Max: `20`
2191
+ * Default: `10`
2192
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2193
+ * @replacedBy paging.limit
2194
+ * @targetRemovalDate 2025-03-01
2195
+ */
2196
+ limit?: number | null;
2197
+ /** Cursor paging options. */
2198
+ paging?: CursorPaging;
2199
+ }
2200
+ interface CursorPaging {
2201
+ /**
2202
+ * Number of domains to load.
2203
+ *
2204
+ * Min: `0`
2205
+ * Max: `20`
2185
2206
  */
2186
2207
  limit?: number | null;
2208
+ /**
2209
+ * Pointer to the next or previous page in the list of results.
2210
+ *
2211
+ * You can get the relevant cursor token
2212
+ * from the `pagingMetadata` object in the previous call's response.
2213
+ * Not relevant for the first request.
2214
+ */
2215
+ cursor?: string | null;
2187
2216
  }
2188
2217
  interface SuggestDomainsResponse {
2189
2218
  /** List of suggested available domains. */
2190
2219
  suggestions?: DomainSuggestion[];
2220
+ /** Metadata about the returned list of suggested domains. */
2221
+ pagingMetadata?: CursorPagingMetadata;
2222
+ }
2223
+ interface CursorPagingMetadata {
2224
+ /** Number of domains returned in the response. */
2225
+ count?: number | null;
2226
+ /** Offset that was requested. */
2227
+ cursors?: Cursors;
2228
+ /**
2229
+ * Indicates if there are more results after the current page.
2230
+ * If `true`, another page of results can be retrieved.
2231
+ * If `false`, this is the last page.
2232
+ */
2233
+ hasNext?: boolean | null;
2234
+ }
2235
+ interface Cursors {
2236
+ /** Cursor pointing to next page in the list of results. */
2237
+ next?: string | null;
2238
+ /** Cursor pointing to previous page in the list of results. */
2239
+ prev?: string | null;
2191
2240
  }
2192
2241
  interface SuggestDomainsResponseNonNullableFields {
2193
2242
  suggestions: {
@@ -2211,8 +2260,19 @@ interface SuggestDomainsOptions {
2211
2260
  * Min: `1`
2212
2261
  * Max: `20`
2213
2262
  * Default: `10`
2263
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2264
+ * @deprecated Number of domain suggestions to return.
2265
+ *
2266
+ * Min: `1`
2267
+ * Max: `20`
2268
+ * Default: `10`
2269
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2270
+ * @replacedBy paging.limit
2271
+ * @targetRemovalDate 2025-03-01
2214
2272
  */
2215
2273
  limit?: number | null;
2274
+ /** Cursor paging options. */
2275
+ paging?: CursorPaging;
2216
2276
  }
2217
2277
 
2218
2278
  declare const __metadata: {
@@ -2220,6 +2280,9 @@ declare const __metadata: {
2220
2280
  };
2221
2281
  declare function suggestDomains(httpClient: HttpClient): (query: string, options?: SuggestDomainsOptions) => Promise<SuggestDomainsResponse & SuggestDomainsResponseNonNullableFields>;
2222
2282
 
2283
+ type index_d_CursorPaging = CursorPaging;
2284
+ type index_d_CursorPagingMetadata = CursorPagingMetadata;
2285
+ type index_d_Cursors = Cursors;
2223
2286
  type index_d_DomainSuggestion = DomainSuggestion;
2224
2287
  type index_d_SuggestDomainsOptions = SuggestDomainsOptions;
2225
2288
  type index_d_SuggestDomainsRequest = SuggestDomainsRequest;
@@ -2228,7 +2291,7 @@ type index_d_SuggestDomainsResponseNonNullableFields = SuggestDomainsResponseNon
2228
2291
  declare const index_d___metadata: typeof __metadata;
2229
2292
  declare const index_d_suggestDomains: typeof suggestDomains;
2230
2293
  declare namespace index_d {
2231
- export { type index_d_DomainSuggestion as DomainSuggestion, type index_d_SuggestDomainsOptions as SuggestDomainsOptions, type index_d_SuggestDomainsRequest as SuggestDomainsRequest, type index_d_SuggestDomainsResponse as SuggestDomainsResponse, type index_d_SuggestDomainsResponseNonNullableFields as SuggestDomainsResponseNonNullableFields, index_d___metadata as __metadata, index_d_suggestDomains as suggestDomains };
2294
+ export { type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_Cursors as Cursors, type index_d_DomainSuggestion as DomainSuggestion, type index_d_SuggestDomainsOptions as SuggestDomainsOptions, type index_d_SuggestDomainsRequest as SuggestDomainsRequest, type index_d_SuggestDomainsResponse as SuggestDomainsResponse, type index_d_SuggestDomainsResponseNonNullableFields as SuggestDomainsResponseNonNullableFields, index_d___metadata as __metadata, index_d_suggestDomains as suggestDomains };
2232
2295
  }
2233
2296
 
2234
2297
  export { index_d$4 as connectedDomainSetupInfo, index_d$5 as connectedDomains, index_d$1 as domainAvailability, index_d$3 as domainDns, index_d as domainSuggestions, index_d$2 as registeredDomains };
@@ -118,9 +118,9 @@ interface GetConnectedDomainResponse$1 {
118
118
  }
119
119
  interface ListConnectedDomainsRequest$1 {
120
120
  /** Cursor paging options. */
121
- paging?: CursorPaging$3;
121
+ paging?: CursorPaging$5;
122
122
  }
123
- interface CursorPaging$3 {
123
+ interface CursorPaging$5 {
124
124
  /**
125
125
  * Number of domains to load.
126
126
  *
@@ -139,15 +139,15 @@ interface CursorPaging$3 {
139
139
  }
140
140
  interface ListConnectedDomainsResponse$1 {
141
141
  /** Metadata about the returned list of connected domains. */
142
- pagingMetadata?: CursorPagingMetadata$3;
142
+ pagingMetadata?: CursorPagingMetadata$5;
143
143
  /** Retrieved connected domains. */
144
144
  connectedDomains?: ConnectedDomain$1[];
145
145
  }
146
- interface CursorPagingMetadata$3 {
146
+ interface CursorPagingMetadata$5 {
147
147
  /** Number of domains returned in the response. */
148
148
  count?: number | null;
149
149
  /** Offset that was requested. */
150
- cursors?: Cursors$3;
150
+ cursors?: Cursors$5;
151
151
  /**
152
152
  * Indicates if there are more results after the current page.
153
153
  * If `true`, another page of results can be retrieved.
@@ -155,7 +155,7 @@ interface CursorPagingMetadata$3 {
155
155
  */
156
156
  hasNext?: boolean | null;
157
157
  }
158
- interface Cursors$3 {
158
+ interface Cursors$5 {
159
159
  /** Cursor pointing to next page in the list of results. */
160
160
  next?: string | null;
161
161
  /** Cursor pointing to previous page in the list of results. */
@@ -327,9 +327,9 @@ interface GetConnectedDomainResponse {
327
327
  }
328
328
  interface ListConnectedDomainsRequest {
329
329
  /** Cursor paging options. */
330
- paging?: CursorPaging$2;
330
+ paging?: CursorPaging$4;
331
331
  }
332
- interface CursorPaging$2 {
332
+ interface CursorPaging$4 {
333
333
  /**
334
334
  * Number of domains to load.
335
335
  *
@@ -348,15 +348,15 @@ interface CursorPaging$2 {
348
348
  }
349
349
  interface ListConnectedDomainsResponse {
350
350
  /** Metadata about the returned list of connected domains. */
351
- pagingMetadata?: CursorPagingMetadata$2;
351
+ pagingMetadata?: CursorPagingMetadata$4;
352
352
  /** Retrieved connected domains. */
353
353
  connectedDomains?: ConnectedDomain[];
354
354
  }
355
- interface CursorPagingMetadata$2 {
355
+ interface CursorPagingMetadata$4 {
356
356
  /** Number of domains returned in the response. */
357
357
  count?: number | null;
358
358
  /** Offset that was requested. */
359
- cursors?: Cursors$2;
359
+ cursors?: Cursors$4;
360
360
  /**
361
361
  * Indicates if there are more results after the current page.
362
362
  * If `true`, another page of results can be retrieved.
@@ -364,7 +364,7 @@ interface CursorPagingMetadata$2 {
364
364
  */
365
365
  hasNext?: boolean | null;
366
366
  }
367
- interface Cursors$2 {
367
+ interface Cursors$4 {
368
368
  /** Cursor pointing to next page in the list of results. */
369
369
  next?: string | null;
370
370
  /** Cursor pointing to previous page in the list of results. */
@@ -1598,9 +1598,9 @@ interface GetRegisteredDomainResponse$1 {
1598
1598
  }
1599
1599
  interface ListRegisteredDomainsRequest$1 {
1600
1600
  /** Cursor paging options. */
1601
- paging?: CursorPaging$1;
1601
+ paging?: CursorPaging$3;
1602
1602
  }
1603
- interface CursorPaging$1 {
1603
+ interface CursorPaging$3 {
1604
1604
  /**
1605
1605
  * Number of domains to load.
1606
1606
  *
@@ -1619,15 +1619,15 @@ interface CursorPaging$1 {
1619
1619
  }
1620
1620
  interface ListRegisteredDomainsResponse$1 {
1621
1621
  /** Metadata about the returned list of registered domains. */
1622
- pagingMetadata?: CursorPagingMetadata$1;
1622
+ pagingMetadata?: CursorPagingMetadata$3;
1623
1623
  /** Retrieved registered domains. */
1624
1624
  registeredDomains?: RegisteredDomain$1[];
1625
1625
  }
1626
- interface CursorPagingMetadata$1 {
1626
+ interface CursorPagingMetadata$3 {
1627
1627
  /** Number of domains returned in the response. */
1628
1628
  count?: number | null;
1629
1629
  /** Offset that was requested. */
1630
- cursors?: Cursors$1;
1630
+ cursors?: Cursors$3;
1631
1631
  /**
1632
1632
  * Indicates if there are more results after the current page.
1633
1633
  * If `true`, another page of results can be retrieved.
@@ -1635,7 +1635,7 @@ interface CursorPagingMetadata$1 {
1635
1635
  */
1636
1636
  hasNext?: boolean | null;
1637
1637
  }
1638
- interface Cursors$1 {
1638
+ interface Cursors$3 {
1639
1639
  /** Cursor pointing to next page in the list of results. */
1640
1640
  next?: string | null;
1641
1641
  /** Cursor pointing to previous page in the list of results. */
@@ -2310,9 +2310,9 @@ interface GetRegisteredDomainResponse {
2310
2310
  }
2311
2311
  interface ListRegisteredDomainsRequest {
2312
2312
  /** Cursor paging options. */
2313
- paging?: CursorPaging;
2313
+ paging?: CursorPaging$2;
2314
2314
  }
2315
- interface CursorPaging {
2315
+ interface CursorPaging$2 {
2316
2316
  /**
2317
2317
  * Number of domains to load.
2318
2318
  *
@@ -2331,15 +2331,15 @@ interface CursorPaging {
2331
2331
  }
2332
2332
  interface ListRegisteredDomainsResponse {
2333
2333
  /** Metadata about the returned list of registered domains. */
2334
- pagingMetadata?: CursorPagingMetadata;
2334
+ pagingMetadata?: CursorPagingMetadata$2;
2335
2335
  /** Retrieved registered domains. */
2336
2336
  registeredDomains?: RegisteredDomain[];
2337
2337
  }
2338
- interface CursorPagingMetadata {
2338
+ interface CursorPagingMetadata$2 {
2339
2339
  /** Number of domains returned in the response. */
2340
2340
  count?: number | null;
2341
2341
  /** Offset that was requested. */
2342
- cursors?: Cursors;
2342
+ cursors?: Cursors$2;
2343
2343
  /**
2344
2344
  * Indicates if there are more results after the current page.
2345
2345
  * If `true`, another page of results can be retrieved.
@@ -2347,7 +2347,7 @@ interface CursorPagingMetadata {
2347
2347
  */
2348
2348
  hasNext?: boolean | null;
2349
2349
  }
2350
- interface Cursors {
2350
+ interface Cursors$2 {
2351
2351
  /** Cursor pointing to next page in the list of results. */
2352
2352
  next?: string | null;
2353
2353
  /** Cursor pointing to previous page in the list of results. */
@@ -2748,12 +2748,60 @@ interface SuggestDomainsRequest$1 {
2748
2748
  * Min: `1`
2749
2749
  * Max: `20`
2750
2750
  * Default: `10`
2751
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2752
+ * @deprecated Number of domain suggestions to return.
2753
+ *
2754
+ * Min: `1`
2755
+ * Max: `20`
2756
+ * Default: `10`
2757
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2758
+ * @replacedBy paging.limit
2759
+ * @targetRemovalDate 2025-03-01
2760
+ */
2761
+ limit?: number | null;
2762
+ /** Cursor paging options. */
2763
+ paging?: CursorPaging$1;
2764
+ }
2765
+ interface CursorPaging$1 {
2766
+ /**
2767
+ * Number of domains to load.
2768
+ *
2769
+ * Min: `0`
2770
+ * Max: `20`
2751
2771
  */
2752
2772
  limit?: number | null;
2773
+ /**
2774
+ * Pointer to the next or previous page in the list of results.
2775
+ *
2776
+ * You can get the relevant cursor token
2777
+ * from the `pagingMetadata` object in the previous call's response.
2778
+ * Not relevant for the first request.
2779
+ */
2780
+ cursor?: string | null;
2753
2781
  }
2754
2782
  interface SuggestDomainsResponse$1 {
2755
2783
  /** List of suggested available domains. */
2756
2784
  suggestions?: DomainSuggestion$1[];
2785
+ /** Metadata about the returned list of suggested domains. */
2786
+ pagingMetadata?: CursorPagingMetadata$1;
2787
+ }
2788
+ interface CursorPagingMetadata$1 {
2789
+ /** Number of domains returned in the response. */
2790
+ count?: number | null;
2791
+ /** Offset that was requested. */
2792
+ cursors?: Cursors$1;
2793
+ /**
2794
+ * Indicates if there are more results after the current page.
2795
+ * If `true`, another page of results can be retrieved.
2796
+ * If `false`, this is the last page.
2797
+ */
2798
+ hasNext?: boolean | null;
2799
+ }
2800
+ interface Cursors$1 {
2801
+ /** Cursor pointing to next page in the list of results. */
2802
+ next?: string | null;
2803
+ /** Cursor pointing to previous page in the list of results. */
2804
+ prev?: string | null;
2757
2805
  }
2758
2806
  interface SuggestDomainsResponseNonNullableFields$1 {
2759
2807
  suggestions: {
@@ -2790,12 +2838,60 @@ interface SuggestDomainsRequest {
2790
2838
  * Min: `1`
2791
2839
  * Max: `20`
2792
2840
  * Default: `10`
2841
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2842
+ * @deprecated Number of domain suggestions to return.
2843
+ *
2844
+ * Min: `1`
2845
+ * Max: `20`
2846
+ * Default: `10`
2847
+ * Note: limit field is deprecated from Aug 1, 2024, use `paging.limit` instead
2848
+ * @replacedBy paging.limit
2849
+ * @targetRemovalDate 2025-03-01
2850
+ */
2851
+ limit?: number | null;
2852
+ /** Cursor paging options. */
2853
+ paging?: CursorPaging;
2854
+ }
2855
+ interface CursorPaging {
2856
+ /**
2857
+ * Number of domains to load.
2858
+ *
2859
+ * Min: `0`
2860
+ * Max: `20`
2793
2861
  */
2794
2862
  limit?: number | null;
2863
+ /**
2864
+ * Pointer to the next or previous page in the list of results.
2865
+ *
2866
+ * You can get the relevant cursor token
2867
+ * from the `pagingMetadata` object in the previous call's response.
2868
+ * Not relevant for the first request.
2869
+ */
2870
+ cursor?: string | null;
2795
2871
  }
2796
2872
  interface SuggestDomainsResponse {
2797
2873
  /** List of suggested available domains. */
2798
2874
  suggestions?: DomainSuggestion[];
2875
+ /** Metadata about the returned list of suggested domains. */
2876
+ pagingMetadata?: CursorPagingMetadata;
2877
+ }
2878
+ interface CursorPagingMetadata {
2879
+ /** Number of domains returned in the response. */
2880
+ count?: number | null;
2881
+ /** Offset that was requested. */
2882
+ cursors?: Cursors;
2883
+ /**
2884
+ * Indicates if there are more results after the current page.
2885
+ * If `true`, another page of results can be retrieved.
2886
+ * If `false`, this is the last page.
2887
+ */
2888
+ hasNext?: boolean | null;
2889
+ }
2890
+ interface Cursors {
2891
+ /** Cursor pointing to next page in the list of results. */
2892
+ next?: string | null;
2893
+ /** Cursor pointing to previous page in the list of results. */
2894
+ prev?: string | null;
2799
2895
  }
2800
2896
  interface SuggestDomainsResponseNonNullableFields {
2801
2897
  suggestions: {