@wix/domains 1.0.52 → 1.0.54

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.
@@ -1,1501 +0,0 @@
1
- /** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
2
- interface ConnectedDomain$1 {
3
- /**
4
- * ID of the connected domain. Identical to the domain name including TLD.
5
- * @readonly
6
- */
7
- id?: string;
8
- /**
9
- * Domain name including TLD.
10
- * Both root domains and subdomains are supported.
11
- */
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
- */
21
- connectionType?: ConnectionType$1;
22
- /**
23
- * Information about the site to which the domain is assigned, and whether
24
- * it's the primary domain or a redirect.
25
- */
26
- siteInfo?: SiteInfo$1;
27
- /**
28
- * Whether the site owner receives standard email notifications from Wix about
29
- * the connected domain.
30
- *
31
- * Default: `false`
32
- */
33
- suppressNotifications?: boolean;
34
- /**
35
- * 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
- * @readonly
42
- */
43
- dnsPropagationStatus?: DnsPropagationStatus$1;
44
- /**
45
- * Date and time the `connectedDomain` object was created in
46
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
47
- * @readonly
48
- */
49
- createdDate?: Date | null;
50
- /**
51
- * Date and time the `connectedDomain` object was last updated in
52
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
53
- * @readonly
54
- */
55
- updatedDate?: Date | null;
56
- }
57
- declare enum ConnectionType$1 {
58
- /** Used by sub domain */
59
- UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
60
- POINTING = "POINTING",
61
- 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
- */
67
- HIDDEN = "HIDDEN"
68
- }
69
- interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
70
- /**
71
- * Redirect information, relevant when `assignmentType` = `REDIRECT`.
72
- * @readonly
73
- */
74
- redirectInfo?: RedirectAssignmentInfo$1;
75
- /**
76
- * ID of the site to which the domain is assigned.
77
- * @readonly
78
- */
79
- id?: string | null;
80
- /**
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.
85
- * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
86
- */
87
- assignmentType?: AssignmentType$1;
88
- }
89
- /** @oneof */
90
- interface SiteInfoAssignmentInfoOneOf$1 {
91
- /**
92
- * Redirect information, relevant when `assignmentType` = `REDIRECT`.
93
- * @readonly
94
- */
95
- redirectInfo?: RedirectAssignmentInfo$1;
96
- }
97
- declare enum AssignmentType$1 {
98
- UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
99
- PRIMARY = "PRIMARY",
100
- REDIRECT = "REDIRECT"
101
- }
102
- interface RedirectAssignmentInfo$1 {
103
- /**
104
- * Primary domain to which this domain will redirect.
105
- * @readonly
106
- */
107
- primaryDomain?: string;
108
- }
109
- declare enum DnsPropagationStatus$1 {
110
- UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
111
- COMPLETED = "COMPLETED",
112
- FAILED = "FAILED",
113
- IN_PROGRESS = "IN_PROGRESS"
114
- }
115
- interface CreateConnectedDomainRequest$1 {
116
- /** Domain to connect. */
117
- connectedDomain: ConnectedDomain$1;
118
- }
119
- interface CreateConnectedDomainResponse$1 {
120
- /** Connected domain. */
121
- connectedDomain?: ConnectedDomain$1;
122
- }
123
- interface GetConnectedDomainRequest$1 {
124
- /** ID of the connected domain. Identical to the domain name including TLD. */
125
- connectedDomainId: string;
126
- }
127
- interface GetConnectedDomainResponse$1 {
128
- /** Retrieved connected domain. */
129
- connectedDomain?: ConnectedDomain$1;
130
- }
131
- interface DeleteConnectedDomainRequest$1 {
132
- /** ID of the connected domain to delete. Identical to the domain name including TLD. */
133
- connectedDomainId: string;
134
- }
135
- interface DeleteConnectedDomainResponse$1 {
136
- }
137
- interface ListConnectedDomainsRequest$1 {
138
- /** Cursor paging options. */
139
- paging?: CursorPaging$3;
140
- }
141
- interface CursorPaging$3 {
142
- /**
143
- * Number of domains to load.
144
- *
145
- * Min: `0`
146
- * Max: `100`
147
- */
148
- limit?: number | null;
149
- /**
150
- * Pointer to the next or previous page in the list of results.
151
- *
152
- * You can get the relevant cursor token
153
- * from the `pagingMetadata` object in the previous call's response.
154
- * Not relevant for the first request.
155
- */
156
- cursor?: string | null;
157
- }
158
- interface ListConnectedDomainsResponse$1 {
159
- /** Metadata about the returned list of connected domains. */
160
- pagingMetadata?: CursorPagingMetadata$3;
161
- /** Retrieved connected domains. */
162
- connectedDomains?: ConnectedDomain$1[];
163
- }
164
- interface CursorPagingMetadata$3 {
165
- /** Number of domains returned in the response. */
166
- count?: number | null;
167
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
168
- cursors?: Cursors$3;
169
- /**
170
- * Indicates if there are more results after the current page.
171
- * If `true`, another page of results can be retrieved.
172
- * If `false`, this is the last page.
173
- */
174
- hasNext?: boolean | null;
175
- }
176
- interface Cursors$3 {
177
- /** Cursor pointing to next page in the list of results. */
178
- next?: string | null;
179
- /** Cursor pointing to previous page in the list of results. */
180
- prev?: string | null;
181
- }
182
- interface RedirectAssignmentInfoNonNullableFields$1 {
183
- primaryDomain: string;
184
- }
185
- interface SiteInfoNonNullableFields$1 {
186
- redirectInfo?: RedirectAssignmentInfoNonNullableFields$1;
187
- assignmentType: AssignmentType$1;
188
- }
189
- interface ConnectedDomainNonNullableFields$1 {
190
- id: string;
191
- domain: string;
192
- connectionType: ConnectionType$1;
193
- siteInfo?: SiteInfoNonNullableFields$1;
194
- suppressNotifications: boolean;
195
- dnsPropagationStatus: DnsPropagationStatus$1;
196
- }
197
- interface CreateConnectedDomainResponseNonNullableFields$1 {
198
- connectedDomain?: ConnectedDomainNonNullableFields$1;
199
- }
200
- interface GetConnectedDomainResponseNonNullableFields$1 {
201
- connectedDomain?: ConnectedDomainNonNullableFields$1;
202
- }
203
- interface ListConnectedDomainsResponseNonNullableFields$1 {
204
- connectedDomains: ConnectedDomainNonNullableFields$1[];
205
- }
206
-
207
- /** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
208
- interface ConnectedDomain {
209
- /**
210
- * ID of the connected domain. Identical to the domain name including TLD.
211
- * @readonly
212
- */
213
- _id?: string;
214
- /**
215
- * Domain name including TLD.
216
- * Both root domains and subdomains are supported.
217
- */
218
- 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
- */
227
- connectionType?: ConnectionType;
228
- /**
229
- * Information about the site to which the domain is assigned, and whether
230
- * it's the primary domain or a redirect.
231
- */
232
- siteInfo?: SiteInfo;
233
- /**
234
- * Whether the site owner receives standard email notifications from Wix about
235
- * the connected domain.
236
- *
237
- * Default: `false`
238
- */
239
- suppressNotifications?: boolean;
240
- /**
241
- * 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
- * @readonly
248
- */
249
- dnsPropagationStatus?: DnsPropagationStatus;
250
- /**
251
- * Date and time the `connectedDomain` object was created in
252
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
253
- * @readonly
254
- */
255
- _createdDate?: Date | null;
256
- /**
257
- * Date and time the `connectedDomain` object was last updated in
258
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
259
- * @readonly
260
- */
261
- _updatedDate?: Date | null;
262
- }
263
- declare enum ConnectionType {
264
- /** Used by sub domain */
265
- UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
266
- POINTING = "POINTING",
267
- 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
- */
273
- HIDDEN = "HIDDEN"
274
- }
275
- interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
276
- /**
277
- * Redirect information, relevant when `assignmentType` = `REDIRECT`.
278
- * @readonly
279
- */
280
- redirectInfo?: RedirectAssignmentInfo;
281
- /**
282
- * ID of the site to which the domain is assigned.
283
- * @readonly
284
- */
285
- _id?: string | null;
286
- /**
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.
291
- * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
292
- */
293
- assignmentType?: AssignmentType;
294
- }
295
- /** @oneof */
296
- interface SiteInfoAssignmentInfoOneOf {
297
- /**
298
- * Redirect information, relevant when `assignmentType` = `REDIRECT`.
299
- * @readonly
300
- */
301
- redirectInfo?: RedirectAssignmentInfo;
302
- }
303
- declare enum AssignmentType {
304
- UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
305
- PRIMARY = "PRIMARY",
306
- REDIRECT = "REDIRECT"
307
- }
308
- interface RedirectAssignmentInfo {
309
- /**
310
- * Primary domain to which this domain will redirect.
311
- * @readonly
312
- */
313
- primaryDomain?: string;
314
- }
315
- declare enum DnsPropagationStatus {
316
- UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
317
- COMPLETED = "COMPLETED",
318
- FAILED = "FAILED",
319
- IN_PROGRESS = "IN_PROGRESS"
320
- }
321
- interface CreateConnectedDomainRequest {
322
- /** Domain to connect. */
323
- connectedDomain: ConnectedDomain;
324
- }
325
- interface CreateConnectedDomainResponse {
326
- /** Connected domain. */
327
- connectedDomain?: ConnectedDomain;
328
- }
329
- interface GetConnectedDomainRequest {
330
- /** ID of the connected domain. Identical to the domain name including TLD. */
331
- connectedDomainId: string;
332
- }
333
- interface GetConnectedDomainResponse {
334
- /** Retrieved connected domain. */
335
- connectedDomain?: ConnectedDomain;
336
- }
337
- interface DeleteConnectedDomainRequest {
338
- /** ID of the connected domain to delete. Identical to the domain name including TLD. */
339
- connectedDomainId: string;
340
- }
341
- interface DeleteConnectedDomainResponse {
342
- }
343
- interface ListConnectedDomainsRequest {
344
- /** Cursor paging options. */
345
- paging?: CursorPaging$2;
346
- }
347
- interface CursorPaging$2 {
348
- /**
349
- * Number of domains to load.
350
- *
351
- * Min: `0`
352
- * Max: `100`
353
- */
354
- limit?: number | null;
355
- /**
356
- * Pointer to the next or previous page in the list of results.
357
- *
358
- * You can get the relevant cursor token
359
- * from the `pagingMetadata` object in the previous call's response.
360
- * Not relevant for the first request.
361
- */
362
- cursor?: string | null;
363
- }
364
- interface ListConnectedDomainsResponse {
365
- /** Metadata about the returned list of connected domains. */
366
- pagingMetadata?: CursorPagingMetadata$2;
367
- /** Retrieved connected domains. */
368
- connectedDomains?: ConnectedDomain[];
369
- }
370
- interface CursorPagingMetadata$2 {
371
- /** Number of domains returned in the response. */
372
- count?: number | null;
373
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
374
- cursors?: Cursors$2;
375
- /**
376
- * Indicates if there are more results after the current page.
377
- * If `true`, another page of results can be retrieved.
378
- * If `false`, this is the last page.
379
- */
380
- hasNext?: boolean | null;
381
- }
382
- interface Cursors$2 {
383
- /** Cursor pointing to next page in the list of results. */
384
- next?: string | null;
385
- /** Cursor pointing to previous page in the list of results. */
386
- prev?: string | null;
387
- }
388
- interface RedirectAssignmentInfoNonNullableFields {
389
- primaryDomain: string;
390
- }
391
- interface SiteInfoNonNullableFields {
392
- redirectInfo?: RedirectAssignmentInfoNonNullableFields;
393
- assignmentType: AssignmentType;
394
- }
395
- interface ConnectedDomainNonNullableFields {
396
- _id: string;
397
- domain: string;
398
- connectionType: ConnectionType;
399
- siteInfo?: SiteInfoNonNullableFields;
400
- suppressNotifications: boolean;
401
- dnsPropagationStatus: DnsPropagationStatus;
402
- }
403
- interface CreateConnectedDomainResponseNonNullableFields {
404
- connectedDomain?: ConnectedDomainNonNullableFields;
405
- }
406
- interface GetConnectedDomainResponseNonNullableFields {
407
- connectedDomain?: ConnectedDomainNonNullableFields;
408
- }
409
- interface ListConnectedDomainsResponseNonNullableFields {
410
- connectedDomains: ConnectedDomainNonNullableFields[];
411
- }
412
-
413
- type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
414
- getUrl: (context: any) => string;
415
- httpMethod: K;
416
- path: string;
417
- pathParams: M;
418
- __requestType: T;
419
- __originalRequestType: S;
420
- __responseType: Q;
421
- __originalResponseType: R;
422
- };
423
- declare function createConnectedDomain(): __PublicMethodMetaInfo$4<'POST', {}, CreateConnectedDomainRequest, CreateConnectedDomainRequest$1, CreateConnectedDomainResponse & CreateConnectedDomainResponseNonNullableFields, CreateConnectedDomainResponse$1 & CreateConnectedDomainResponseNonNullableFields$1>;
424
- declare function getConnectedDomain(): __PublicMethodMetaInfo$4<'GET', {
425
- connectedDomainId: string;
426
- }, GetConnectedDomainRequest, GetConnectedDomainRequest$1, GetConnectedDomainResponse & GetConnectedDomainResponseNonNullableFields, GetConnectedDomainResponse$1 & GetConnectedDomainResponseNonNullableFields$1>;
427
- declare function deleteConnectedDomain(): __PublicMethodMetaInfo$4<'DELETE', {
428
- connectedDomainId: string;
429
- }, DeleteConnectedDomainRequest, DeleteConnectedDomainRequest$1, DeleteConnectedDomainResponse, DeleteConnectedDomainResponse$1>;
430
- declare function listConnectedDomains(): __PublicMethodMetaInfo$4<'GET', {}, ListConnectedDomainsRequest, ListConnectedDomainsRequest$1, ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields, ListConnectedDomainsResponse$1 & ListConnectedDomainsResponseNonNullableFields$1>;
431
-
432
- declare const meta$4_createConnectedDomain: typeof createConnectedDomain;
433
- declare const meta$4_deleteConnectedDomain: typeof deleteConnectedDomain;
434
- declare const meta$4_getConnectedDomain: typeof getConnectedDomain;
435
- declare const meta$4_listConnectedDomains: typeof listConnectedDomains;
436
- declare namespace meta$4 {
437
- export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_createConnectedDomain as createConnectedDomain, meta$4_deleteConnectedDomain as deleteConnectedDomain, meta$4_getConnectedDomain as getConnectedDomain, meta$4_listConnectedDomains as listConnectedDomains };
438
- }
439
-
440
- /**
441
- * A `connectedDomainSetupInfo` object holds information the connected domain's
442
- * external registrar and some DNS records. You can use this information to guide
443
- * the site owner through the domain's setup process.
444
- */
445
- interface ConnectedDomainSetupInfo$1 extends ConnectedDomainSetupInfoDnsRecordsOneOf$1 {
446
- /**
447
- * Information about domains connected using nameservers. Available only for
448
- * `{"connectionType": "NAMESERVERS"}`.
449
- */
450
- nameserverRecord?: NameserverRecord$1;
451
- /**
452
- * Information about domains connected by pointing. Available only for
453
- * `{"connectionType": "POINTING"}`.
454
- * @readonly
455
- */
456
- pointingRecords?: PointingRecords$1;
457
- /**
458
- * Information about subdomains. Available only for subdomains.
459
- * @readonly
460
- */
461
- subdomainRecords?: SubdomainRecords$1;
462
- /** ID of the connected domain. Identical to the domain name including TLD. */
463
- connectedDomainId?: string;
464
- /**
465
- * Information about the external domain registrar including current name
466
- * servers.
467
- */
468
- registrar?: Registrar$1;
469
- }
470
- /** @oneof */
471
- interface ConnectedDomainSetupInfoDnsRecordsOneOf$1 {
472
- /**
473
- * Information about domains connected using nameservers. Available only for
474
- * `{"connectionType": "NAMESERVERS"}`.
475
- */
476
- nameserverRecord?: NameserverRecord$1;
477
- /**
478
- * Information about domains connected by pointing. Available only for
479
- * `{"connectionType": "POINTING"}`.
480
- * @readonly
481
- */
482
- pointingRecords?: PointingRecords$1;
483
- /**
484
- * Information about subdomains. Available only for subdomains.
485
- * @readonly
486
- */
487
- subdomainRecords?: SubdomainRecords$1;
488
- }
489
- interface Registrar$1 {
490
- /**
491
- * Name of the external domain registrar. For subdomains it's the registrar of the root domain.
492
- * @readonly
493
- */
494
- name?: string | null;
495
- /**
496
- * Values of the current name server records. In case you connect an external
497
- * domain using name servers, site owners must replace these current name servers
498
- * with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
499
- * during the initial domain setup.
500
- * The replacement can't be performed through Wix APIs, you must use the
501
- * infrastructure of the external domain registrar. Read more about
502
- * [connecting domains using nameservers](https://dev.wix.com/api/rest/account-level-apis/connected-domains/sample-flows#account-level-apis_connected-domains_sample-flows_connect-an-external-domain-using-nameservers).
503
- * @readonly
504
- */
505
- nameServers?: string[];
506
- }
507
- /** Information about domains connected by nameservers. */
508
- interface NameserverRecord$1 {
509
- /**
510
- * Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
511
- * @readonly
512
- */
513
- nsRecord?: NsRecord$1;
514
- }
515
- interface NsRecord$1 {
516
- /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
517
- hostName?: string;
518
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
519
- ttl?: number;
520
- /** DNS record values. */
521
- values?: string[];
522
- }
523
- /** Information about domains connected by pointing. */
524
- interface PointingRecords$1 {
525
- /**
526
- * [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).
527
- * @readonly
528
- */
529
- aRecord?: ARecord$1;
530
- /**
531
- * [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).
532
- * @readonly
533
- */
534
- cnameRecord?: CnameRecord$1;
535
- }
536
- interface ARecord$1 {
537
- /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
538
- hostName?: string;
539
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
540
- ttl?: number;
541
- /** DNS record values. */
542
- values?: string[];
543
- }
544
- interface CnameRecord$1 {
545
- /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
546
- hostName?: string;
547
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
548
- ttl?: number;
549
- /** DNS record value. */
550
- value?: string;
551
- }
552
- /** Information about subdomains. */
553
- interface SubdomainRecords$1 {
554
- /**
555
- * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
556
- * @readonly
557
- */
558
- cnameRecords?: CnameRecord$1[];
559
- }
560
- interface GetConnectedDomainSetupInfoRequest$1 {
561
- /**
562
- * ID of the connected domain to retrieve setup information for.
563
- * Identical to the domain name including TLD.
564
- */
565
- connectedDomainId: string;
566
- }
567
- interface GetConnectedDomainSetupInfoResponse$1 {
568
- /** Retrieved setup information. */
569
- connectedDomainSetupInfo?: ConnectedDomainSetupInfo$1;
570
- }
571
- interface NsRecordNonNullableFields$1 {
572
- hostName: string;
573
- ttl: number;
574
- values: string[];
575
- }
576
- interface NameserverRecordNonNullableFields$1 {
577
- nsRecord?: NsRecordNonNullableFields$1;
578
- }
579
- interface ARecordNonNullableFields$1 {
580
- hostName: string;
581
- ttl: number;
582
- values: string[];
583
- }
584
- interface CnameRecordNonNullableFields$1 {
585
- hostName: string;
586
- ttl: number;
587
- value: string;
588
- }
589
- interface PointingRecordsNonNullableFields$1 {
590
- aRecord?: ARecordNonNullableFields$1;
591
- cnameRecord?: CnameRecordNonNullableFields$1;
592
- }
593
- interface SubdomainRecordsNonNullableFields$1 {
594
- cnameRecords: CnameRecordNonNullableFields$1[];
595
- }
596
- interface RegistrarNonNullableFields$1 {
597
- nameServers: string[];
598
- }
599
- interface ConnectedDomainSetupInfoNonNullableFields$1 {
600
- nameserverRecord?: NameserverRecordNonNullableFields$1;
601
- pointingRecords?: PointingRecordsNonNullableFields$1;
602
- subdomainRecords?: SubdomainRecordsNonNullableFields$1;
603
- connectedDomainId: string;
604
- registrar?: RegistrarNonNullableFields$1;
605
- }
606
- interface GetConnectedDomainSetupInfoResponseNonNullableFields$1 {
607
- connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields$1;
608
- }
609
-
610
- /**
611
- * A `connectedDomainSetupInfo` object holds information the connected domain's
612
- * external registrar and some DNS records. You can use this information to guide
613
- * the site owner through the domain's setup process.
614
- */
615
- interface ConnectedDomainSetupInfo extends ConnectedDomainSetupInfoDnsRecordsOneOf {
616
- /**
617
- * Information about domains connected using nameservers. Available only for
618
- * `{"connectionType": "NAMESERVERS"}`.
619
- */
620
- nameserverRecord?: NameserverRecord;
621
- /**
622
- * Information about domains connected by pointing. Available only for
623
- * `{"connectionType": "POINTING"}`.
624
- * @readonly
625
- */
626
- pointingRecords?: PointingRecords;
627
- /**
628
- * Information about subdomains. Available only for subdomains.
629
- * @readonly
630
- */
631
- subdomainRecords?: SubdomainRecords;
632
- /** ID of the connected domain. Identical to the domain name including TLD. */
633
- connectedDomainId?: string;
634
- /**
635
- * Information about the external domain registrar including current name
636
- * servers.
637
- */
638
- registrar?: Registrar;
639
- }
640
- /** @oneof */
641
- interface ConnectedDomainSetupInfoDnsRecordsOneOf {
642
- /**
643
- * Information about domains connected using nameservers. Available only for
644
- * `{"connectionType": "NAMESERVERS"}`.
645
- */
646
- nameserverRecord?: NameserverRecord;
647
- /**
648
- * Information about domains connected by pointing. Available only for
649
- * `{"connectionType": "POINTING"}`.
650
- * @readonly
651
- */
652
- pointingRecords?: PointingRecords;
653
- /**
654
- * Information about subdomains. Available only for subdomains.
655
- * @readonly
656
- */
657
- subdomainRecords?: SubdomainRecords;
658
- }
659
- interface Registrar {
660
- /**
661
- * Name of the external domain registrar. For subdomains it's the registrar of the root domain.
662
- * @readonly
663
- */
664
- name?: string | null;
665
- /**
666
- * Values of the current name server records. In case you connect an external
667
- * domain using name servers, site owners must replace these current name servers
668
- * with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
669
- * during the initial domain setup.
670
- * The replacement can't be performed through Wix APIs, you must use the
671
- * infrastructure of the external domain registrar. Read more about
672
- * [connecting domains using nameservers](https://dev.wix.com/api/rest/account-level-apis/connected-domains/sample-flows#account-level-apis_connected-domains_sample-flows_connect-an-external-domain-using-nameservers).
673
- * @readonly
674
- */
675
- nameServers?: string[];
676
- }
677
- /** Information about domains connected by nameservers. */
678
- interface NameserverRecord {
679
- /**
680
- * Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
681
- * @readonly
682
- */
683
- nsRecord?: NsRecord;
684
- }
685
- interface NsRecord {
686
- /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
687
- hostName?: string;
688
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
689
- ttl?: number;
690
- /** DNS record values. */
691
- values?: string[];
692
- }
693
- /** Information about domains connected by pointing. */
694
- interface PointingRecords {
695
- /**
696
- * [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).
697
- * @readonly
698
- */
699
- aRecord?: ARecord;
700
- /**
701
- * [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).
702
- * @readonly
703
- */
704
- cnameRecord?: CnameRecord;
705
- }
706
- interface ARecord {
707
- /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
708
- hostName?: string;
709
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
710
- ttl?: number;
711
- /** DNS record values. */
712
- values?: string[];
713
- }
714
- interface CnameRecord {
715
- /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
716
- hostName?: string;
717
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
718
- ttl?: number;
719
- /** DNS record value. */
720
- value?: string;
721
- }
722
- /** Information about subdomains. */
723
- interface SubdomainRecords {
724
- /**
725
- * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
726
- * @readonly
727
- */
728
- cnameRecords?: CnameRecord[];
729
- }
730
- interface GetConnectedDomainSetupInfoRequest {
731
- /**
732
- * ID of the connected domain to retrieve setup information for.
733
- * Identical to the domain name including TLD.
734
- */
735
- connectedDomainId: string;
736
- }
737
- interface GetConnectedDomainSetupInfoResponse {
738
- /** Retrieved setup information. */
739
- connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
740
- }
741
- interface NsRecordNonNullableFields {
742
- hostName: string;
743
- ttl: number;
744
- values: string[];
745
- }
746
- interface NameserverRecordNonNullableFields {
747
- nsRecord?: NsRecordNonNullableFields;
748
- }
749
- interface ARecordNonNullableFields {
750
- hostName: string;
751
- ttl: number;
752
- values: string[];
753
- }
754
- interface CnameRecordNonNullableFields {
755
- hostName: string;
756
- ttl: number;
757
- value: string;
758
- }
759
- interface PointingRecordsNonNullableFields {
760
- aRecord?: ARecordNonNullableFields;
761
- cnameRecord?: CnameRecordNonNullableFields;
762
- }
763
- interface SubdomainRecordsNonNullableFields {
764
- cnameRecords: CnameRecordNonNullableFields[];
765
- }
766
- interface RegistrarNonNullableFields {
767
- nameServers: string[];
768
- }
769
- interface ConnectedDomainSetupInfoNonNullableFields {
770
- nameserverRecord?: NameserverRecordNonNullableFields;
771
- pointingRecords?: PointingRecordsNonNullableFields;
772
- subdomainRecords?: SubdomainRecordsNonNullableFields;
773
- connectedDomainId: string;
774
- registrar?: RegistrarNonNullableFields;
775
- }
776
- interface GetConnectedDomainSetupInfoResponseNonNullableFields {
777
- connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields;
778
- }
779
-
780
- type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
781
- getUrl: (context: any) => string;
782
- httpMethod: K;
783
- path: string;
784
- pathParams: M;
785
- __requestType: T;
786
- __originalRequestType: S;
787
- __responseType: Q;
788
- __originalResponseType: R;
789
- };
790
- declare function getConnectedDomainSetupInfo(): __PublicMethodMetaInfo$3<'GET', {
791
- connectedDomainId: string;
792
- }, GetConnectedDomainSetupInfoRequest, GetConnectedDomainSetupInfoRequest$1, GetConnectedDomainSetupInfoResponse & GetConnectedDomainSetupInfoResponseNonNullableFields, GetConnectedDomainSetupInfoResponse$1 & GetConnectedDomainSetupInfoResponseNonNullableFields$1>;
793
-
794
- declare const meta$3_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
795
- declare namespace meta$3 {
796
- export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
797
- }
798
-
799
- /** DNS zones hold information about the records that map a domain's URL to an IP address. */
800
- interface DnsZone$1 {
801
- /** Domain name including the TLD. Both root domains and subdomains are supported. */
802
- domainName?: string;
803
- /**
804
- * DNS records. You can only set up a single `record` object per DNS record
805
- * type. If you want to specify multiple values for the same record type, you
806
- * must save them in the `values` for the relevant type.
807
- *
808
- * Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
809
- * Max: 5000 DNS records
810
- */
811
- records?: DnsRecord$1[];
812
- /**
813
- * ID of the Dns Zone. Identical to the domain name including TLD.
814
- * @readonly
815
- */
816
- id?: string;
817
- /**
818
- * Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions)
819
- * are enabled.
820
- *
821
- * Default: `false`
822
- */
823
- dnssecEnabled?: boolean;
824
- /**
825
- * Information about [DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions).
826
- * Available only if `{"dnssecEnabled": true}`.
827
- * @readonly
828
- */
829
- dnssecInfo?: DnssecInfo$1;
830
- }
831
- 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
- */
848
- type?: RecordType$1;
849
- /**
850
- * Host name. Can be a subdomain. For example, `domain.com` or
851
- * `mail.domain.com`. Equal to the domain name, except for `CNAME` records.
852
- */
853
- hostName?: string;
854
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
855
- ttl?: number;
856
- /**
857
- * DNS record values. Wix limits DNS records to 50 values per type. External
858
- * providers may support a different maximum number of DNS records for a
859
- * specific type, Wix doesn't validate that you don't exceed these external
860
- * limits.
861
- *
862
- * Max: 50 records
863
- */
864
- values?: string[];
865
- }
866
- declare enum RecordType$1 {
867
- UNKNOWN = "UNKNOWN",
868
- A = "A",
869
- AAAA = "AAAA",
870
- NS = "NS",
871
- SOA = "SOA",
872
- CNAME = "CNAME",
873
- MX = "MX",
874
- TXT = "TXT",
875
- SPF = "SPF",
876
- SRV = "SRV",
877
- PTR = "PTR",
878
- NAPTR = "NAPTR"
879
- }
880
- interface DnssecInfo$1 {
881
- /**
882
- * Unique 16-bit identifier for a [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
883
- * record that allows efficient DNSSEC validation in zones with multiple keys.
884
- */
885
- keyTag?: number;
886
- /**
887
- * Cryptographic hash of the [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
888
- * record that's included in the delegation signer (DS) record and ensures secure
889
- * DNSSEC validation.
890
- */
891
- digest?: string;
892
- }
893
- interface CreateDnsZoneRequest$1 {
894
- /** DNS zone to create. */
895
- dnsZone: DnsZone$1;
896
- }
897
- interface CreateDnsZoneResponse$1 {
898
- /** Created DNS zone. */
899
- dnsZone?: DnsZone$1;
900
- }
901
- interface GetDnsZoneRequest$1 {
902
- /** Domain to retrieve the DNS zone for. */
903
- domainName: string;
904
- }
905
- interface GetDnsZoneResponse$1 {
906
- /** Retrieved DNS zone. */
907
- dnsZone?: DnsZone$1;
908
- }
909
- interface UpdateDnsZoneRequest$1 {
910
- /** Domain to update the DNS zone for. Must include the TLD. */
911
- domainName: string;
912
- /**
913
- * DNS records to add to the DNS zone.
914
- *
915
- * Max: 10 additions
916
- */
917
- additions?: DnsRecord$1[];
918
- /**
919
- * DNS records to remove from the DNS zone.
920
- *
921
- * Max: 10 deletions
922
- */
923
- deletions?: DnsRecord$1[];
924
- /** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
925
- dnssecEnabled?: boolean | null;
926
- }
927
- interface UpdateDnsZoneResponse$1 {
928
- /** Updated DNS zone. */
929
- dnsZone?: DnsZone$1;
930
- }
931
- interface DeleteDnsZoneRequest$1 {
932
- /** Domain name to delete the DNS zone for. */
933
- domainName: string;
934
- }
935
- interface DeleteDnsZoneResponse$1 {
936
- }
937
- interface PreviewDnsZoneRequest$1 {
938
- /** Domain name to generate a DNS zone preview for. */
939
- domainName: string;
940
- }
941
- interface PreviewDnsZoneResponse$1 {
942
- /**
943
- * DNS zone preview.
944
- *
945
- * Includes calculated `A`, `CNAME`, `NS` and `SOA` records.
946
- */
947
- dnsZone?: DnsZone$1;
948
- }
949
- interface DnsRecordNonNullableFields$1 {
950
- type: RecordType$1;
951
- hostName: string;
952
- ttl: number;
953
- values: string[];
954
- }
955
- interface DnssecInfoNonNullableFields$1 {
956
- keyTag: number;
957
- digest: string;
958
- }
959
- interface DnsZoneNonNullableFields$1 {
960
- domainName: string;
961
- records: DnsRecordNonNullableFields$1[];
962
- id: string;
963
- dnssecEnabled: boolean;
964
- dnssecInfo?: DnssecInfoNonNullableFields$1;
965
- }
966
- interface CreateDnsZoneResponseNonNullableFields$1 {
967
- dnsZone?: DnsZoneNonNullableFields$1;
968
- }
969
- interface GetDnsZoneResponseNonNullableFields$1 {
970
- dnsZone?: DnsZoneNonNullableFields$1;
971
- }
972
- interface UpdateDnsZoneResponseNonNullableFields$1 {
973
- dnsZone?: DnsZoneNonNullableFields$1;
974
- }
975
- interface PreviewDnsZoneResponseNonNullableFields$1 {
976
- dnsZone?: DnsZoneNonNullableFields$1;
977
- }
978
-
979
- /** DNS zones hold information about the records that map a domain's URL to an IP address. */
980
- interface DnsZone {
981
- /** Domain name including the TLD. Both root domains and subdomains are supported. */
982
- domainName?: string;
983
- /**
984
- * DNS records. You can only set up a single `record` object per DNS record
985
- * type. If you want to specify multiple values for the same record type, you
986
- * must save them in the `values` for the relevant type.
987
- *
988
- * Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
989
- * Max: 5000 DNS records
990
- */
991
- records?: DnsRecord[];
992
- /**
993
- * ID of the Dns Zone. Identical to the domain name including TLD.
994
- * @readonly
995
- */
996
- _id?: string;
997
- /**
998
- * Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions)
999
- * are enabled.
1000
- *
1001
- * Default: `false`
1002
- */
1003
- dnssecEnabled?: boolean;
1004
- /**
1005
- * Information about [DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions).
1006
- * Available only if `{"dnssecEnabled": true}`.
1007
- * @readonly
1008
- */
1009
- dnssecInfo?: DnssecInfo;
1010
- }
1011
- 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
- */
1028
- type?: RecordType;
1029
- /**
1030
- * Host name. Can be a subdomain. For example, `domain.com` or
1031
- * `mail.domain.com`. Equal to the domain name, except for `CNAME` records.
1032
- */
1033
- hostName?: string;
1034
- /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
1035
- ttl?: number;
1036
- /**
1037
- * DNS record values. Wix limits DNS records to 50 values per type. External
1038
- * providers may support a different maximum number of DNS records for a
1039
- * specific type, Wix doesn't validate that you don't exceed these external
1040
- * limits.
1041
- *
1042
- * Max: 50 records
1043
- */
1044
- values?: string[];
1045
- }
1046
- declare enum RecordType {
1047
- UNKNOWN = "UNKNOWN",
1048
- A = "A",
1049
- AAAA = "AAAA",
1050
- NS = "NS",
1051
- SOA = "SOA",
1052
- CNAME = "CNAME",
1053
- MX = "MX",
1054
- TXT = "TXT",
1055
- SPF = "SPF",
1056
- SRV = "SRV",
1057
- PTR = "PTR",
1058
- NAPTR = "NAPTR"
1059
- }
1060
- interface DnssecInfo {
1061
- /**
1062
- * Unique 16-bit identifier for a [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
1063
- * record that allows efficient DNSSEC validation in zones with multiple keys.
1064
- */
1065
- keyTag?: number;
1066
- /**
1067
- * Cryptographic hash of the [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys)
1068
- * record that's included in the delegation signer (DS) record and ensures secure
1069
- * DNSSEC validation.
1070
- */
1071
- digest?: string;
1072
- }
1073
- interface CreateDnsZoneRequest {
1074
- /** DNS zone to create. */
1075
- dnsZone: DnsZone;
1076
- }
1077
- interface CreateDnsZoneResponse {
1078
- /** Created DNS zone. */
1079
- dnsZone?: DnsZone;
1080
- }
1081
- interface GetDnsZoneRequest {
1082
- /** Domain to retrieve the DNS zone for. */
1083
- domainName: string;
1084
- }
1085
- interface GetDnsZoneResponse {
1086
- /** Retrieved DNS zone. */
1087
- dnsZone?: DnsZone;
1088
- }
1089
- interface UpdateDnsZoneRequest {
1090
- /** Domain to update the DNS zone for. Must include the TLD. */
1091
- domainName: string;
1092
- /**
1093
- * DNS records to add to the DNS zone.
1094
- *
1095
- * Max: 10 additions
1096
- */
1097
- additions?: DnsRecord[];
1098
- /**
1099
- * DNS records to remove from the DNS zone.
1100
- *
1101
- * Max: 10 deletions
1102
- */
1103
- deletions?: DnsRecord[];
1104
- /** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
1105
- dnssecEnabled?: boolean | null;
1106
- }
1107
- interface UpdateDnsZoneResponse {
1108
- /** Updated DNS zone. */
1109
- dnsZone?: DnsZone;
1110
- }
1111
- interface DeleteDnsZoneRequest {
1112
- /** Domain name to delete the DNS zone for. */
1113
- domainName: string;
1114
- }
1115
- interface DeleteDnsZoneResponse {
1116
- }
1117
- interface PreviewDnsZoneRequest {
1118
- /** Domain name to generate a DNS zone preview for. */
1119
- domainName: string;
1120
- }
1121
- interface PreviewDnsZoneResponse {
1122
- /**
1123
- * DNS zone preview.
1124
- *
1125
- * Includes calculated `A`, `CNAME`, `NS` and `SOA` records.
1126
- */
1127
- dnsZone?: DnsZone;
1128
- }
1129
- interface DnsRecordNonNullableFields {
1130
- type: RecordType;
1131
- hostName: string;
1132
- ttl: number;
1133
- values: string[];
1134
- }
1135
- interface DnssecInfoNonNullableFields {
1136
- keyTag: number;
1137
- digest: string;
1138
- }
1139
- interface DnsZoneNonNullableFields {
1140
- domainName: string;
1141
- records: DnsRecordNonNullableFields[];
1142
- _id: string;
1143
- dnssecEnabled: boolean;
1144
- dnssecInfo?: DnssecInfoNonNullableFields;
1145
- }
1146
- interface CreateDnsZoneResponseNonNullableFields {
1147
- dnsZone?: DnsZoneNonNullableFields;
1148
- }
1149
- interface GetDnsZoneResponseNonNullableFields {
1150
- dnsZone?: DnsZoneNonNullableFields;
1151
- }
1152
- interface UpdateDnsZoneResponseNonNullableFields {
1153
- dnsZone?: DnsZoneNonNullableFields;
1154
- }
1155
- interface PreviewDnsZoneResponseNonNullableFields {
1156
- dnsZone?: DnsZoneNonNullableFields;
1157
- }
1158
-
1159
- type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1160
- getUrl: (context: any) => string;
1161
- httpMethod: K;
1162
- path: string;
1163
- pathParams: M;
1164
- __requestType: T;
1165
- __originalRequestType: S;
1166
- __responseType: Q;
1167
- __originalResponseType: R;
1168
- };
1169
- declare function createDnsZone(): __PublicMethodMetaInfo$2<'POST', {}, CreateDnsZoneRequest, CreateDnsZoneRequest$1, CreateDnsZoneResponse & CreateDnsZoneResponseNonNullableFields, CreateDnsZoneResponse$1 & CreateDnsZoneResponseNonNullableFields$1>;
1170
- declare function getDnsZone(): __PublicMethodMetaInfo$2<'GET', {
1171
- domainName: string;
1172
- }, GetDnsZoneRequest, GetDnsZoneRequest$1, GetDnsZoneResponse & GetDnsZoneResponseNonNullableFields, GetDnsZoneResponse$1 & GetDnsZoneResponseNonNullableFields$1>;
1173
- declare function updateDnsZone(): __PublicMethodMetaInfo$2<'PATCH', {
1174
- domainName: string;
1175
- }, UpdateDnsZoneRequest, UpdateDnsZoneRequest$1, UpdateDnsZoneResponse & UpdateDnsZoneResponseNonNullableFields, UpdateDnsZoneResponse$1 & UpdateDnsZoneResponseNonNullableFields$1>;
1176
- declare function deleteDnsZone(): __PublicMethodMetaInfo$2<'DELETE', {
1177
- domainName: string;
1178
- }, DeleteDnsZoneRequest, DeleteDnsZoneRequest$1, DeleteDnsZoneResponse, DeleteDnsZoneResponse$1>;
1179
- declare function previewDnsZone(): __PublicMethodMetaInfo$2<'GET', {
1180
- domainName: string;
1181
- }, PreviewDnsZoneRequest, PreviewDnsZoneRequest$1, PreviewDnsZoneResponse & PreviewDnsZoneResponseNonNullableFields, PreviewDnsZoneResponse$1 & PreviewDnsZoneResponseNonNullableFields$1>;
1182
-
1183
- declare const meta$2_createDnsZone: typeof createDnsZone;
1184
- declare const meta$2_deleteDnsZone: typeof deleteDnsZone;
1185
- declare const meta$2_getDnsZone: typeof getDnsZone;
1186
- declare const meta$2_previewDnsZone: typeof previewDnsZone;
1187
- declare const meta$2_updateDnsZone: typeof updateDnsZone;
1188
- declare namespace meta$2 {
1189
- export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_createDnsZone as createDnsZone, meta$2_deleteDnsZone as deleteDnsZone, meta$2_getDnsZone as getDnsZone, meta$2_previewDnsZone as previewDnsZone, meta$2_updateDnsZone as updateDnsZone };
1190
- }
1191
-
1192
- interface DomainAvailability$1 {
1193
- /** Domain name including TLD. For example, `my-new-domain.com`. */
1194
- domain?: string;
1195
- /**
1196
- * Whether the domain is available for purchase. You can purchase the
1197
- * domain in case the boolean is `true`. The domain is already taken
1198
- * when `false` is returned.
1199
- */
1200
- available?: boolean;
1201
- /** Whether the domain has a higher price due to its perceived value or demand. */
1202
- premium?: boolean;
1203
- }
1204
- interface CheckDomainAvailabilityRequest$1 {
1205
- /**
1206
- * Domain name. Must include the TLD. For example, `my-new-domain.com`. Only
1207
- * alphanumeric characters, hyphens, and dots are supported.
1208
- *
1209
- * Min: 3 characters
1210
- * Max: 63 characters
1211
- */
1212
- domain: string;
1213
- }
1214
- interface CheckDomainAvailabilityResponse$1 {
1215
- /** Information about the domain's availability. */
1216
- availability?: DomainAvailability$1;
1217
- }
1218
- interface DomainAvailabilityNonNullableFields$1 {
1219
- domain: string;
1220
- available: boolean;
1221
- premium: boolean;
1222
- }
1223
- interface CheckDomainAvailabilityResponseNonNullableFields$1 {
1224
- availability?: DomainAvailabilityNonNullableFields$1;
1225
- }
1226
-
1227
- interface DomainAvailability {
1228
- /** Domain name including TLD. For example, `my-new-domain.com`. */
1229
- domain?: string;
1230
- /**
1231
- * Whether the domain is available for purchase. You can purchase the
1232
- * domain in case the boolean is `true`. The domain is already taken
1233
- * when `false` is returned.
1234
- */
1235
- available?: boolean;
1236
- /** Whether the domain has a higher price due to its perceived value or demand. */
1237
- premium?: boolean;
1238
- }
1239
- interface CheckDomainAvailabilityRequest {
1240
- /**
1241
- * Domain name. Must include the TLD. For example, `my-new-domain.com`. Only
1242
- * alphanumeric characters, hyphens, and dots are supported.
1243
- *
1244
- * Min: 3 characters
1245
- * Max: 63 characters
1246
- */
1247
- domain: string;
1248
- }
1249
- interface CheckDomainAvailabilityResponse {
1250
- /** Information about the domain's availability. */
1251
- availability?: DomainAvailability;
1252
- }
1253
- interface DomainAvailabilityNonNullableFields {
1254
- domain: string;
1255
- available: boolean;
1256
- premium: boolean;
1257
- }
1258
- interface CheckDomainAvailabilityResponseNonNullableFields {
1259
- availability?: DomainAvailabilityNonNullableFields;
1260
- }
1261
-
1262
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1263
- getUrl: (context: any) => string;
1264
- httpMethod: K;
1265
- path: string;
1266
- pathParams: M;
1267
- __requestType: T;
1268
- __originalRequestType: S;
1269
- __responseType: Q;
1270
- __originalResponseType: R;
1271
- };
1272
- declare function checkDomainAvailability(): __PublicMethodMetaInfo$1<'GET', {}, CheckDomainAvailabilityRequest, CheckDomainAvailabilityRequest$1, CheckDomainAvailabilityResponse & CheckDomainAvailabilityResponseNonNullableFields, CheckDomainAvailabilityResponse$1 & CheckDomainAvailabilityResponseNonNullableFields$1>;
1273
-
1274
- declare const meta$1_checkDomainAvailability: typeof checkDomainAvailability;
1275
- declare namespace meta$1 {
1276
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_checkDomainAvailability as checkDomainAvailability };
1277
- }
1278
-
1279
- interface DomainSuggestion$1 {
1280
- /** Suggested domain name including TLD. */
1281
- domain?: string;
1282
- /** Whether the domain has a higher price due to its perceived value or demand. */
1283
- premium?: boolean;
1284
- }
1285
- interface SuggestDomainsRequest$1 {
1286
- /**
1287
- * Input to base your domain suggestions on. May include
1288
- * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
1289
- *
1290
- * Min: 3 characters
1291
- * Max: 100 characters
1292
- */
1293
- query: string;
1294
- /**
1295
- * [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
1296
- * not include the dot. For example, `com`, not `.com`. Not all TLDs can be
1297
- * connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
1298
- * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
1299
- * information.
1300
- *
1301
- * Max: 10 TLDs
1302
- */
1303
- tlds?: string[];
1304
- /**
1305
- * Number of domain suggestions to return. __Deprecated__: This field will be
1306
- * removed on March 1, 2025. Use `paging.limit` instead.
1307
- *
1308
- * Min: `1`
1309
- * Max: `20`
1310
- * Default: `10`
1311
- * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
1312
- * removed on March 1, 2025. Use `paging.limit` instead.
1313
- *
1314
- * Min: `1`
1315
- * Max: `20`
1316
- * Default: `10`
1317
- * @replacedBy paging.limit
1318
- * @targetRemovalDate 2025-03-01
1319
- */
1320
- limit?: number | null;
1321
- /** Cursor paging options. */
1322
- paging?: CursorPaging$1;
1323
- /**
1324
- * Maximum number of characters for the domain name, excluding the TLD.
1325
- *
1326
- * Min: `3`
1327
- * Max: `63`
1328
- * Default: `63`
1329
- */
1330
- maxLength?: number | null;
1331
- }
1332
- interface CursorPaging$1 {
1333
- /**
1334
- * Maximum number of domains to return in the results.
1335
- *
1336
- * Min: `0`
1337
- * Max: `20`
1338
- */
1339
- limit?: number | null;
1340
- /**
1341
- * Pointer to the next or previous page in the list of results.
1342
- *
1343
- * You can get the relevant cursor token
1344
- * from the `pagingMetadata` object in the previous call's response.
1345
- * Not relevant for the first request.
1346
- */
1347
- cursor?: string | null;
1348
- }
1349
- interface SuggestDomainsResponse$1 {
1350
- /** List of suggested available domains. */
1351
- suggestions?: DomainSuggestion$1[];
1352
- /** Metadata about the returned list of suggested domains. */
1353
- pagingMetadata?: CursorPagingMetadata$1;
1354
- }
1355
- interface CursorPagingMetadata$1 {
1356
- /** Number of domains returned in the response. */
1357
- count?: number | null;
1358
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1359
- cursors?: Cursors$1;
1360
- /**
1361
- * Indicates if there are more results after the current page.
1362
- * If `true`, another page of results can be retrieved.
1363
- * If `false`, this is the last page.
1364
- */
1365
- hasNext?: boolean | null;
1366
- }
1367
- interface Cursors$1 {
1368
- /** Cursor pointing to next page in the list of results. */
1369
- next?: string | null;
1370
- /** Cursor pointing to previous page in the list of results. */
1371
- prev?: string | null;
1372
- }
1373
- interface DomainSuggestionNonNullableFields$1 {
1374
- domain: string;
1375
- premium: boolean;
1376
- }
1377
- interface SuggestDomainsResponseNonNullableFields$1 {
1378
- suggestions: DomainSuggestionNonNullableFields$1[];
1379
- }
1380
-
1381
- interface DomainSuggestion {
1382
- /** Suggested domain name including TLD. */
1383
- domain?: string;
1384
- /** Whether the domain has a higher price due to its perceived value or demand. */
1385
- premium?: boolean;
1386
- }
1387
- interface SuggestDomainsRequest {
1388
- /**
1389
- * Input to base your domain suggestions on. May include
1390
- * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
1391
- *
1392
- * Min: 3 characters
1393
- * Max: 100 characters
1394
- */
1395
- query: string;
1396
- /**
1397
- * [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
1398
- * not include the dot. For example, `com`, not `.com`. Not all TLDs can be
1399
- * connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
1400
- * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
1401
- * information.
1402
- *
1403
- * Max: 10 TLDs
1404
- */
1405
- tlds?: string[];
1406
- /**
1407
- * Number of domain suggestions to return. __Deprecated__: This field will be
1408
- * removed on March 1, 2025. Use `paging.limit` instead.
1409
- *
1410
- * Min: `1`
1411
- * Max: `20`
1412
- * Default: `10`
1413
- * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
1414
- * removed on March 1, 2025. Use `paging.limit` instead.
1415
- *
1416
- * Min: `1`
1417
- * Max: `20`
1418
- * Default: `10`
1419
- * @replacedBy paging.limit
1420
- * @targetRemovalDate 2025-03-01
1421
- */
1422
- limit?: number | null;
1423
- /** Cursor paging options. */
1424
- paging?: CursorPaging;
1425
- /**
1426
- * Maximum number of characters for the domain name, excluding the TLD.
1427
- *
1428
- * Min: `3`
1429
- * Max: `63`
1430
- * Default: `63`
1431
- */
1432
- maxLength?: number | null;
1433
- }
1434
- interface CursorPaging {
1435
- /**
1436
- * Maximum number of domains to return in the results.
1437
- *
1438
- * Min: `0`
1439
- * Max: `20`
1440
- */
1441
- limit?: number | null;
1442
- /**
1443
- * Pointer to the next or previous page in the list of results.
1444
- *
1445
- * You can get the relevant cursor token
1446
- * from the `pagingMetadata` object in the previous call's response.
1447
- * Not relevant for the first request.
1448
- */
1449
- cursor?: string | null;
1450
- }
1451
- interface SuggestDomainsResponse {
1452
- /** List of suggested available domains. */
1453
- suggestions?: DomainSuggestion[];
1454
- /** Metadata about the returned list of suggested domains. */
1455
- pagingMetadata?: CursorPagingMetadata;
1456
- }
1457
- interface CursorPagingMetadata {
1458
- /** Number of domains returned in the response. */
1459
- count?: number | null;
1460
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1461
- cursors?: Cursors;
1462
- /**
1463
- * Indicates if there are more results after the current page.
1464
- * If `true`, another page of results can be retrieved.
1465
- * If `false`, this is the last page.
1466
- */
1467
- hasNext?: boolean | null;
1468
- }
1469
- interface Cursors {
1470
- /** Cursor pointing to next page in the list of results. */
1471
- next?: string | null;
1472
- /** Cursor pointing to previous page in the list of results. */
1473
- prev?: string | null;
1474
- }
1475
- interface DomainSuggestionNonNullableFields {
1476
- domain: string;
1477
- premium: boolean;
1478
- }
1479
- interface SuggestDomainsResponseNonNullableFields {
1480
- suggestions: DomainSuggestionNonNullableFields[];
1481
- }
1482
-
1483
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1484
- getUrl: (context: any) => string;
1485
- httpMethod: K;
1486
- path: string;
1487
- pathParams: M;
1488
- __requestType: T;
1489
- __originalRequestType: S;
1490
- __responseType: Q;
1491
- __originalResponseType: R;
1492
- };
1493
- declare function suggestDomains(): __PublicMethodMetaInfo<'GET', {}, SuggestDomainsRequest, SuggestDomainsRequest$1, SuggestDomainsResponse & SuggestDomainsResponseNonNullableFields, SuggestDomainsResponse$1 & SuggestDomainsResponseNonNullableFields$1>;
1494
-
1495
- type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
1496
- declare const meta_suggestDomains: typeof suggestDomains;
1497
- declare namespace meta {
1498
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_suggestDomains as suggestDomains };
1499
- }
1500
-
1501
- export { meta$3 as connectedDomainSetupInfo, meta$4 as connectedDomains, meta$1 as domainAvailability, meta$2 as domainDns, meta as domainSuggestions };