@wix/domains 1.0.53 → 1.0.55

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