@wix/domains 1.0.25 → 1.0.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +7 -6
- package/build/cjs/index.js +12 -6
- package/build/cjs/index.js.map +1 -1
- package/build/es/index.d.ts +7 -6
- package/build/es/index.js +7 -6
- package/build/es/index.js.map +1 -1
- package/package.json +10 -9
- package/type-bundles/context.bundle.d.ts +337 -55
- package/type-bundles/index.bundle.d.ts +337 -55
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import * as connectedDomains from '@wix/domains_connected-domains';
|
|
2
|
+
import * as connectedDomainSetupInfo from '@wix/domains_connected-domain-setup-info';
|
|
3
|
+
import * as domainDns from '@wix/domains_domain-dns';
|
|
4
|
+
import * as registeredDomains from '@wix/domains_registered-domains';
|
|
5
|
+
import * as domainAvailability from '@wix/domains_domain-availability';
|
|
6
|
+
import * as domainSuggestions from '@wix/domains_domain-suggestions';
|
|
7
|
+
export { connectedDomains, connectedDomainSetupInfo, domainDns, registeredDomains, domainAvailability, domainSuggestions, };
|
package/build/cjs/index.js
CHANGED
|
@@ -24,10 +24,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
24
24
|
};
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
26
|
exports.domainSuggestions = exports.domainAvailability = exports.registeredDomains = exports.domainDns = exports.connectedDomainSetupInfo = exports.connectedDomains = void 0;
|
|
27
|
-
|
|
28
|
-
exports.
|
|
29
|
-
|
|
30
|
-
exports.
|
|
31
|
-
|
|
32
|
-
exports.
|
|
27
|
+
const connectedDomains = __importStar(require("@wix/domains_connected-domains"));
|
|
28
|
+
exports.connectedDomains = connectedDomains;
|
|
29
|
+
const connectedDomainSetupInfo = __importStar(require("@wix/domains_connected-domain-setup-info"));
|
|
30
|
+
exports.connectedDomainSetupInfo = connectedDomainSetupInfo;
|
|
31
|
+
const domainDns = __importStar(require("@wix/domains_domain-dns"));
|
|
32
|
+
exports.domainDns = domainDns;
|
|
33
|
+
const registeredDomains = __importStar(require("@wix/domains_registered-domains"));
|
|
34
|
+
exports.registeredDomains = registeredDomains;
|
|
35
|
+
const domainAvailability = __importStar(require("@wix/domains_domain-availability"));
|
|
36
|
+
exports.domainAvailability = domainAvailability;
|
|
37
|
+
const domainSuggestions = __importStar(require("@wix/domains_domain-suggestions"));
|
|
38
|
+
exports.domainSuggestions = domainSuggestions;
|
|
33
39
|
//# sourceMappingURL=index.js.map
|
package/build/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iFAAmE;AAQjE,4CAAgB;AAPlB,mGAAqF;AAQnF,4DAAwB;AAP1B,mEAAqD;AAQnD,8BAAS;AAPX,mFAAqE;AAQnE,8CAAiB;AAPnB,qFAAuE;AAQrE,gDAAkB;AAPpB,mFAAqE;AAQnE,8CAAiB"}
|
package/build/es/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import * as connectedDomains from '@wix/domains_connected-domains';
|
|
2
|
+
import * as connectedDomainSetupInfo from '@wix/domains_connected-domain-setup-info';
|
|
3
|
+
import * as domainDns from '@wix/domains_domain-dns';
|
|
4
|
+
import * as registeredDomains from '@wix/domains_registered-domains';
|
|
5
|
+
import * as domainAvailability from '@wix/domains_domain-availability';
|
|
6
|
+
import * as domainSuggestions from '@wix/domains_domain-suggestions';
|
|
7
|
+
export { connectedDomains, connectedDomainSetupInfo, domainDns, registeredDomains, domainAvailability, domainSuggestions, };
|
package/build/es/index.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import * as connectedDomains from '@wix/domains_connected-domains';
|
|
2
|
+
import * as connectedDomainSetupInfo from '@wix/domains_connected-domain-setup-info';
|
|
3
|
+
import * as domainDns from '@wix/domains_domain-dns';
|
|
4
|
+
import * as registeredDomains from '@wix/domains_registered-domains';
|
|
5
|
+
import * as domainAvailability from '@wix/domains_domain-availability';
|
|
6
|
+
import * as domainSuggestions from '@wix/domains_domain-suggestions';
|
|
7
|
+
export { connectedDomains, connectedDomainSetupInfo, domainDns, registeredDomains, domainAvailability, domainSuggestions, };
|
|
7
8
|
//# sourceMappingURL=index.js.map
|
package/build/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,gCAAgC,CAAC;AACnE,OAAO,KAAK,wBAAwB,MAAM,0CAA0C,CAAC;AACrF,OAAO,KAAK,SAAS,MAAM,yBAAyB,CAAC;AACrD,OAAO,KAAK,iBAAiB,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,kBAAkB,MAAM,kCAAkC,CAAC;AACvE,OAAO,KAAK,iBAAiB,MAAM,iCAAiC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,gCAAgC,CAAC;AACnE,OAAO,KAAK,wBAAwB,MAAM,0CAA0C,CAAC;AACrF,OAAO,KAAK,SAAS,MAAM,yBAAyB,CAAC;AACrD,OAAO,KAAK,iBAAiB,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,kBAAkB,MAAM,kCAAkC,CAAC;AACvE,OAAO,KAAK,iBAAiB,MAAM,iCAAiC,CAAC;AAErE,OAAO,EACL,gBAAgB,EAChB,wBAAwB,EACxB,SAAS,EACT,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,GAClB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/domains",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.27",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -18,12 +18,12 @@
|
|
|
18
18
|
"type-bundles"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@wix/domains_connected-domain-setup-info": "1.0.
|
|
22
|
-
"@wix/domains_connected-domains": "1.0.
|
|
23
|
-
"@wix/domains_domain-availability": "1.0.
|
|
24
|
-
"@wix/domains_domain-dns": "1.0.
|
|
25
|
-
"@wix/domains_domain-suggestions": "1.0.
|
|
26
|
-
"@wix/domains_registered-domains": "1.0.
|
|
21
|
+
"@wix/domains_connected-domain-setup-info": "1.0.12",
|
|
22
|
+
"@wix/domains_connected-domains": "1.0.12",
|
|
23
|
+
"@wix/domains_domain-availability": "1.0.7",
|
|
24
|
+
"@wix/domains_domain-dns": "1.0.7",
|
|
25
|
+
"@wix/domains_domain-suggestions": "1.0.12",
|
|
26
|
+
"@wix/domains_registered-domains": "1.0.10"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"glob": "^10.4.1",
|
|
@@ -32,8 +32,9 @@
|
|
|
32
32
|
"typescript": "^5.3.2"
|
|
33
33
|
},
|
|
34
34
|
"scripts": {
|
|
35
|
-
"build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
|
|
35
|
+
"build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
|
|
36
36
|
"build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
|
|
37
|
+
"build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
|
|
37
38
|
"test": ":"
|
|
38
39
|
},
|
|
39
40
|
"wix": {
|
|
@@ -47,5 +48,5 @@
|
|
|
47
48
|
"fqdn": ""
|
|
48
49
|
}
|
|
49
50
|
},
|
|
50
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "263edaf2a42eeaa95fa1b6f1ad5c595710976a4565333af10c414ac9"
|
|
51
52
|
}
|
|
@@ -1,3 +1,37 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
|
|
28
|
+
declare global {
|
|
29
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
30
|
+
interface SymbolConstructor {
|
|
31
|
+
readonly observable: symbol;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
1
35
|
/** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
|
|
2
36
|
interface ConnectedDomain {
|
|
3
37
|
/**
|
|
@@ -313,46 +347,78 @@ interface ListConnectedDomainsOptions {
|
|
|
313
347
|
paging?: CursorPaging$2;
|
|
314
348
|
}
|
|
315
349
|
|
|
316
|
-
|
|
317
|
-
interface
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
350
|
+
declare function createConnectedDomain$1(httpClient: HttpClient): CreateConnectedDomainSignature;
|
|
351
|
+
interface CreateConnectedDomainSignature {
|
|
352
|
+
/**
|
|
353
|
+
* Creates a `connectedDomain` object and starts the domain connection process. It may take up to 48 hours for the DNS changes to take effect.
|
|
354
|
+
*
|
|
355
|
+
* You must pass the relevant Wix account ID in the header of the call. You may also pass a Wix site ID in the header.
|
|
356
|
+
*
|
|
357
|
+
* You can only connect external domains using this endpoint. Domains purchased and billed through Wix can't be connected via this endpoint to a Wix site. For those domains use the [Registered Domains API](/registeredDomains/Introduction) instead.
|
|
358
|
+
*
|
|
359
|
+
* You can connect both root domains and subdomains to Wix sites.
|
|
360
|
+
*
|
|
361
|
+
* The domain can be assigned as a primary domain or a redirect. You can read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains). If you connect a domain as `"PRIMARY"` to a Wix site, the existing primary domain automatically becomes unassigned.
|
|
362
|
+
*
|
|
363
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
364
|
+
* @param - Domain to connect.
|
|
365
|
+
* @returns Connected domain.
|
|
366
|
+
*/
|
|
367
|
+
(connectedDomain: ConnectedDomain): Promise<ConnectedDomain & ConnectedDomainNonNullableFields>;
|
|
321
368
|
}
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
369
|
+
declare function getConnectedDomain$1(httpClient: HttpClient): GetConnectedDomainSignature;
|
|
370
|
+
interface GetConnectedDomainSignature {
|
|
371
|
+
/**
|
|
372
|
+
* Retrieves a connected domain.
|
|
373
|
+
*
|
|
374
|
+
*
|
|
375
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
376
|
+
*
|
|
377
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
378
|
+
* @param - ID of the connected domain. Identical to the domain name including TLD.
|
|
379
|
+
* @returns Retrieved connected domain.
|
|
380
|
+
*/
|
|
381
|
+
(connectedDomainId: string): Promise<ConnectedDomain & ConnectedDomainNonNullableFields>;
|
|
382
|
+
}
|
|
383
|
+
declare function deleteConnectedDomain$1(httpClient: HttpClient): DeleteConnectedDomainSignature;
|
|
384
|
+
interface DeleteConnectedDomainSignature {
|
|
385
|
+
/**
|
|
386
|
+
* Deletes a `connectedDomain` object and removes related DNS records from
|
|
387
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
388
|
+
*
|
|
389
|
+
*
|
|
390
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
391
|
+
*
|
|
392
|
+
* If you delete a `"PRIMARY"` domain, the site automatically uses the standard
|
|
393
|
+
* URL for free Wix sites. Read more about
|
|
394
|
+
* [URLs of free Wix sites](https://support.wix.com/en/article/changing-your-free-wix-url-8591528).
|
|
395
|
+
*
|
|
396
|
+
* When you delete a subdomain, its CNAME record is deleted from Google's Cloud DNS.
|
|
397
|
+
*
|
|
398
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
399
|
+
* @param - ID of the connected domain to delete. Identical to the domain name including TLD.
|
|
400
|
+
*/
|
|
401
|
+
(connectedDomainId: string): Promise<void>;
|
|
402
|
+
}
|
|
403
|
+
declare function listConnectedDomains$1(httpClient: HttpClient): ListConnectedDomainsSignature;
|
|
404
|
+
interface ListConnectedDomainsSignature {
|
|
405
|
+
/**
|
|
406
|
+
* Retrieves a list of up to 100 connected domains.
|
|
407
|
+
*
|
|
408
|
+
*
|
|
409
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
410
|
+
*
|
|
411
|
+
* The retrieved domains are sorted by `createdDate` in descending order.
|
|
412
|
+
*
|
|
413
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
414
|
+
*/
|
|
415
|
+
(options?: ListConnectedDomainsOptions | undefined): Promise<ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields>;
|
|
348
416
|
}
|
|
349
417
|
|
|
350
|
-
declare
|
|
351
|
-
|
|
352
|
-
declare const
|
|
353
|
-
declare const
|
|
354
|
-
declare const deleteConnectedDomain: ReturnType<typeof createRESTModule$5<typeof publicDeleteConnectedDomain>>;
|
|
355
|
-
declare const listConnectedDomains: ReturnType<typeof createRESTModule$5<typeof publicListConnectedDomains>>;
|
|
418
|
+
declare const createConnectedDomain: BuildRESTFunction<typeof createConnectedDomain$1> & typeof createConnectedDomain$1;
|
|
419
|
+
declare const getConnectedDomain: BuildRESTFunction<typeof getConnectedDomain$1> & typeof getConnectedDomain$1;
|
|
420
|
+
declare const deleteConnectedDomain: BuildRESTFunction<typeof deleteConnectedDomain$1> & typeof deleteConnectedDomain$1;
|
|
421
|
+
declare const listConnectedDomains: BuildRESTFunction<typeof listConnectedDomains$1> & typeof listConnectedDomains$1;
|
|
356
422
|
|
|
357
423
|
type context$5_ConnectedDomain = ConnectedDomain;
|
|
358
424
|
type context$5_ConnectedDomainNonNullableFields = ConnectedDomainNonNullableFields;
|
|
@@ -527,6 +593,12 @@ interface GetSetupInfoResponse {
|
|
|
527
593
|
/** Retrieved setup information. */
|
|
528
594
|
domainSetupInfo?: ConnectedDomainSetupInfo;
|
|
529
595
|
}
|
|
596
|
+
interface PreCreateConnectedDomainRequest {
|
|
597
|
+
/** Domain name including TLD */
|
|
598
|
+
domain?: string;
|
|
599
|
+
}
|
|
600
|
+
interface PreCreateConnectedDomainResponse {
|
|
601
|
+
}
|
|
530
602
|
interface GetConnectedDomainSetupInfoRequest {
|
|
531
603
|
/**
|
|
532
604
|
* ID of the connected domain to retrieve setup information for.
|
|
@@ -577,9 +649,22 @@ interface GetConnectedDomainSetupInfoResponseNonNullableFields {
|
|
|
577
649
|
connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields;
|
|
578
650
|
}
|
|
579
651
|
|
|
580
|
-
declare function
|
|
652
|
+
declare function getConnectedDomainSetupInfo$1(httpClient: HttpClient): GetConnectedDomainSetupInfoSignature;
|
|
653
|
+
interface GetConnectedDomainSetupInfoSignature {
|
|
654
|
+
/**
|
|
655
|
+
* Retrieves information for the initial setup of a connected domain.
|
|
656
|
+
*
|
|
657
|
+
*
|
|
658
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
659
|
+
*
|
|
660
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
661
|
+
* @param - ID of the connected domain to retrieve setup information for.
|
|
662
|
+
* Identical to the domain name including TLD.
|
|
663
|
+
*/
|
|
664
|
+
(connectedDomainId: string): Promise<GetConnectedDomainSetupInfoResponse & GetConnectedDomainSetupInfoResponseNonNullableFields>;
|
|
665
|
+
}
|
|
581
666
|
|
|
582
|
-
declare const getConnectedDomainSetupInfo:
|
|
667
|
+
declare const getConnectedDomainSetupInfo: BuildRESTFunction<typeof getConnectedDomainSetupInfo$1> & typeof getConnectedDomainSetupInfo$1;
|
|
583
668
|
|
|
584
669
|
type context$4_ARecord = ARecord;
|
|
585
670
|
type context$4_CnameRecord = CnameRecord;
|
|
@@ -595,11 +680,13 @@ type context$4_GetSetupInfoResponse = GetSetupInfoResponse;
|
|
|
595
680
|
type context$4_NameserverRecord = NameserverRecord;
|
|
596
681
|
type context$4_NsRecord = NsRecord;
|
|
597
682
|
type context$4_PointingRecords = PointingRecords;
|
|
683
|
+
type context$4_PreCreateConnectedDomainRequest = PreCreateConnectedDomainRequest;
|
|
684
|
+
type context$4_PreCreateConnectedDomainResponse = PreCreateConnectedDomainResponse;
|
|
598
685
|
type context$4_Registrar = Registrar;
|
|
599
686
|
type context$4_SubdomainRecords = SubdomainRecords;
|
|
600
687
|
declare const context$4_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
|
|
601
688
|
declare namespace context$4 {
|
|
602
|
-
export { type context$4_ARecord as ARecord, type context$4_CnameRecord as CnameRecord, type context$4_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type context$4_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, context$4_ConnectionType as ConnectionType, type context$4_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type context$4_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type context$4_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type context$4_GetSetupInfoRequest as GetSetupInfoRequest, type context$4_GetSetupInfoResponse as GetSetupInfoResponse, type context$4_NameserverRecord as NameserverRecord, type context$4_NsRecord as NsRecord, type context$4_PointingRecords as PointingRecords, type context$4_Registrar as Registrar, type context$4_SubdomainRecords as SubdomainRecords, context$4_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
689
|
+
export { type context$4_ARecord as ARecord, type context$4_CnameRecord as CnameRecord, type context$4_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type context$4_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, context$4_ConnectionType as ConnectionType, type context$4_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type context$4_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type context$4_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type context$4_GetSetupInfoRequest as GetSetupInfoRequest, type context$4_GetSetupInfoResponse as GetSetupInfoResponse, type context$4_NameserverRecord as NameserverRecord, type context$4_NsRecord as NsRecord, type context$4_PointingRecords as PointingRecords, type context$4_PreCreateConnectedDomainRequest as PreCreateConnectedDomainRequest, type context$4_PreCreateConnectedDomainResponse as PreCreateConnectedDomainResponse, type context$4_Registrar as Registrar, type context$4_SubdomainRecords as SubdomainRecords, context$4_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
603
690
|
}
|
|
604
691
|
|
|
605
692
|
/** DNS zones hold information about the records that map a domain's URL to an IP address. */
|
|
@@ -915,13 +1002,98 @@ interface UpdateDnsZoneOptions {
|
|
|
915
1002
|
dnssecEnabled?: boolean | null;
|
|
916
1003
|
}
|
|
917
1004
|
|
|
918
|
-
declare function
|
|
1005
|
+
declare function createDnsZone$1(httpClient: HttpClient): CreateDnsZoneSignature;
|
|
1006
|
+
interface CreateDnsZoneSignature {
|
|
1007
|
+
/**
|
|
1008
|
+
* Creates a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1009
|
+
*
|
|
1010
|
+
*
|
|
1011
|
+
* If there is an existing DNS zone for the domain, it's deleted before
|
|
1012
|
+
* the new zone is created.
|
|
1013
|
+
*
|
|
1014
|
+
* The call is synchronous, that means it fails in case of an error on
|
|
1015
|
+
* Google's side.
|
|
1016
|
+
*
|
|
1017
|
+
* You can only set up a single `record` object per DNS record
|
|
1018
|
+
* type. If you want to specify multiple values for the same record type, you
|
|
1019
|
+
* must save them in the `values` for the relevant type.
|
|
1020
|
+
*
|
|
1021
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1022
|
+
* @param - DNS zone to create.
|
|
1023
|
+
* @returns Created DNS zone.
|
|
1024
|
+
*/
|
|
1025
|
+
(dnsZone: DnsZone): Promise<DnsZone & DnsZoneNonNullableFields>;
|
|
1026
|
+
}
|
|
1027
|
+
declare function getDnsZone$1(httpClient: HttpClient): GetDnsZoneSignature;
|
|
1028
|
+
interface GetDnsZoneSignature {
|
|
1029
|
+
/**
|
|
1030
|
+
* Retrieves the DNS zone belonging to the domain from
|
|
1031
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1032
|
+
*
|
|
1033
|
+
*
|
|
1034
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1035
|
+
* @param - Domain to retrieve the DNS zone for.
|
|
1036
|
+
* @returns Retrieved DNS zone.
|
|
1037
|
+
*/
|
|
1038
|
+
(domainName: string): Promise<DnsZone & DnsZoneNonNullableFields>;
|
|
1039
|
+
}
|
|
1040
|
+
declare function updateDnsZone$1(httpClient: HttpClient): UpdateDnsZoneSignature;
|
|
1041
|
+
interface UpdateDnsZoneSignature {
|
|
1042
|
+
/**
|
|
1043
|
+
* Adds DNS records to and removes DNS records from a DNS zone in
|
|
1044
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1045
|
+
*
|
|
1046
|
+
* The call is synchronous, that means it fails in case of an error on
|
|
1047
|
+
* Google's side.
|
|
1048
|
+
*
|
|
1049
|
+
* You can only set up a single `record` object per DNS record
|
|
1050
|
+
* type. If you want to specify multiple values for the same record type, you
|
|
1051
|
+
* must save them in the `values` for the relevant type. This means, you must
|
|
1052
|
+
* delete the relevant record and add a new `addition` object for this type
|
|
1053
|
+
* to the request, in case you want to add values for an existing DNS record
|
|
1054
|
+
* type.
|
|
1055
|
+
*
|
|
1056
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1057
|
+
* @param - Domain to update the DNS zone for. Must include the TLD.
|
|
1058
|
+
*/
|
|
1059
|
+
(domainName: string, options?: UpdateDnsZoneOptions | undefined): Promise<UpdateDnsZoneResponse & UpdateDnsZoneResponseNonNullableFields>;
|
|
1060
|
+
}
|
|
1061
|
+
declare function deleteDnsZone$1(httpClient: HttpClient): DeleteDnsZoneSignature;
|
|
1062
|
+
interface DeleteDnsZoneSignature {
|
|
1063
|
+
/**
|
|
1064
|
+
* Deletes a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1065
|
+
*
|
|
1066
|
+
*
|
|
1067
|
+
* The call is synchronous, that means it fails in case of an error on
|
|
1068
|
+
* Google's side.
|
|
1069
|
+
*
|
|
1070
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1071
|
+
* @param - Domain name to delete the DNS zone for.
|
|
1072
|
+
*/
|
|
1073
|
+
(domainName: string): Promise<void>;
|
|
1074
|
+
}
|
|
1075
|
+
declare function previewDnsZone$1(httpClient: HttpClient): PreviewDnsZoneSignature;
|
|
1076
|
+
interface PreviewDnsZoneSignature {
|
|
1077
|
+
/**
|
|
1078
|
+
* Generates a preview for a DNS zone based on
|
|
1079
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1080
|
+
*
|
|
1081
|
+
*
|
|
1082
|
+
* This includes calculating the `A`, `CNAME`, `NS` and `SOA` records.
|
|
1083
|
+
* You can use this information to configure a domain from an external
|
|
1084
|
+
* provider, before connecting it to a Wix site.
|
|
1085
|
+
*
|
|
1086
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1087
|
+
* @param - Domain name to generate a DNS zone preview for.
|
|
1088
|
+
*/
|
|
1089
|
+
(domainName: string): Promise<PreviewDnsZoneResponse & PreviewDnsZoneResponseNonNullableFields>;
|
|
1090
|
+
}
|
|
919
1091
|
|
|
920
|
-
declare const createDnsZone:
|
|
921
|
-
declare const getDnsZone:
|
|
922
|
-
declare const updateDnsZone:
|
|
923
|
-
declare const deleteDnsZone:
|
|
924
|
-
declare const previewDnsZone:
|
|
1092
|
+
declare const createDnsZone: BuildRESTFunction<typeof createDnsZone$1> & typeof createDnsZone$1;
|
|
1093
|
+
declare const getDnsZone: BuildRESTFunction<typeof getDnsZone$1> & typeof getDnsZone$1;
|
|
1094
|
+
declare const updateDnsZone: BuildRESTFunction<typeof updateDnsZone$1> & typeof updateDnsZone$1;
|
|
1095
|
+
declare const deleteDnsZone: BuildRESTFunction<typeof deleteDnsZone$1> & typeof deleteDnsZone$1;
|
|
1096
|
+
declare const previewDnsZone: BuildRESTFunction<typeof previewDnsZone$1> & typeof previewDnsZone$1;
|
|
925
1097
|
|
|
926
1098
|
type context$3_CreateDnsZoneRequest = CreateDnsZoneRequest;
|
|
927
1099
|
type context$3_CreateDnsZoneResponse = CreateDnsZoneResponse;
|
|
@@ -1604,12 +1776,85 @@ interface ListRegisteredDomainsOptions {
|
|
|
1604
1776
|
paging?: CursorPaging$1;
|
|
1605
1777
|
}
|
|
1606
1778
|
|
|
1607
|
-
declare function
|
|
1779
|
+
declare function createRegisteredDomain$1(httpClient: HttpClient): CreateRegisteredDomainSignature;
|
|
1780
|
+
interface CreateRegisteredDomainSignature {
|
|
1781
|
+
/**
|
|
1782
|
+
* Creates a registeredDomain object and starts the domain registration process that may take up to 48 hours to resolve.
|
|
1783
|
+
*
|
|
1784
|
+
* You must pass the relevant Wix account ID in the header of the call. You may also pass a Wix site ID in the header of the call. This assigns the domain to the site when the registration succeeds. If you don't provide a site ID, the domain is registered but not assigned to a Wix site. Information about the site is returned in the `siteInfo object`, while information about the account isn't returned.
|
|
1785
|
+
*
|
|
1786
|
+
* To register a domain and assign it to a site, the site must have an active [Premium plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683). However, if you just want to register a domain without connecting it to a site, the account doesn't need an active Premium plan. In both situations, the account must own a product that supports linking a domain with the chosen TLD. Use [Create Package](/packages/create-package) of the Resellers API to add the relevant Premium plan or product to your customer's site. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about the available product IDs.
|
|
1787
|
+
*
|
|
1788
|
+
* You can register domains for 1, 2, or 3 years, but you don't set the duration with this endpoint. Instead Wix chooses the registration length based on the billing cycle of the corresponding `productInstance` from the [Resellers API](/packages/Introduction). The [Create Registered Domain](/registeredDomains/create-registered-domains) call fails if the billing cycle of the relevant productInstance isn't 1, 2, or 3 years.
|
|
1789
|
+
*
|
|
1790
|
+
* You can only register a root domain. You can't register a subdomain.
|
|
1791
|
+
*
|
|
1792
|
+
* If you try to register a domain that isn't available for purchase or there is already a `registeredDomain` object for the specified domain, the call fails without creating a `registeredDomain` object or starting the registration process.
|
|
1793
|
+
*
|
|
1794
|
+
* Wix tries to register the domain several times, but stops if the process fails too often. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information about the number of attempts and their timing.
|
|
1795
|
+
*
|
|
1796
|
+
* Wix only checks formal requirements of each field in the `contacts` object, such as the maximum number of characters. Wix doesn't check whether the actual domain registrar has additional requirements, for example that the postal code is valid in the specified country. If there is such a mismatch between the request and the registrar's requirements, the call succeeds but the registration process can't succeed. Read more about [contact validations](https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-validations).
|
|
1797
|
+
*
|
|
1798
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1799
|
+
* @param - Information about the domain to register including contact details.
|
|
1800
|
+
* @returns Created registered domain.
|
|
1801
|
+
*/
|
|
1802
|
+
(registeredDomain: RegisteredDomain): Promise<RegisteredDomain & RegisteredDomainNonNullableFields>;
|
|
1803
|
+
}
|
|
1804
|
+
declare function getRegisteredDomain$1(httpClient: HttpClient): GetRegisteredDomainSignature;
|
|
1805
|
+
interface GetRegisteredDomainSignature {
|
|
1806
|
+
/**
|
|
1807
|
+
* Retrieves a registered domain.
|
|
1808
|
+
*
|
|
1809
|
+
*
|
|
1810
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
1811
|
+
*
|
|
1812
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1813
|
+
* @param - ID of the registered domain to retrieve.
|
|
1814
|
+
* @returns Retrieved registered domain.
|
|
1815
|
+
*/
|
|
1816
|
+
(registeredDomainId: string): Promise<RegisteredDomain & RegisteredDomainNonNullableFields>;
|
|
1817
|
+
}
|
|
1818
|
+
declare function listRegisteredDomains$1(httpClient: HttpClient): ListRegisteredDomainsSignature;
|
|
1819
|
+
interface ListRegisteredDomainsSignature {
|
|
1820
|
+
/**
|
|
1821
|
+
* Retrieves a list of up to 100 registered domains.
|
|
1822
|
+
*
|
|
1823
|
+
*
|
|
1824
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
1825
|
+
*
|
|
1826
|
+
* The retrieved domains are sorted by `createdDate` in descending order.
|
|
1827
|
+
*
|
|
1828
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1829
|
+
*/
|
|
1830
|
+
(options?: ListRegisteredDomainsOptions | undefined): Promise<ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields>;
|
|
1831
|
+
}
|
|
1832
|
+
declare function redeemRegisteredDomain$1(httpClient: HttpClient): RedeemRegisteredDomainSignature;
|
|
1833
|
+
interface RedeemRegisteredDomainSignature {
|
|
1834
|
+
/**
|
|
1835
|
+
* Redeems a registered domain that's currently in redemption.
|
|
1836
|
+
*
|
|
1837
|
+
*
|
|
1838
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
1839
|
+
*
|
|
1840
|
+
* It may take up to 7 days to complete the domain redemption. If the domain
|
|
1841
|
+
* is successfully redeemed, the new `expirationDate` is 1 year after the
|
|
1842
|
+
* original `expirationDate`.
|
|
1843
|
+
*
|
|
1844
|
+
* You can't redeem registered domains that haven't expired yet or have passed
|
|
1845
|
+
* the redemption period.
|
|
1846
|
+
*
|
|
1847
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1848
|
+
* @param - ID of the registered domain to redeem. Identical to the domain name
|
|
1849
|
+
* including TLD.
|
|
1850
|
+
*/
|
|
1851
|
+
(registeredDomainId: string): Promise<RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields>;
|
|
1852
|
+
}
|
|
1608
1853
|
|
|
1609
|
-
declare const createRegisteredDomain:
|
|
1610
|
-
declare const getRegisteredDomain:
|
|
1611
|
-
declare const listRegisteredDomains:
|
|
1612
|
-
declare const redeemRegisteredDomain:
|
|
1854
|
+
declare const createRegisteredDomain: BuildRESTFunction<typeof createRegisteredDomain$1> & typeof createRegisteredDomain$1;
|
|
1855
|
+
declare const getRegisteredDomain: BuildRESTFunction<typeof getRegisteredDomain$1> & typeof getRegisteredDomain$1;
|
|
1856
|
+
declare const listRegisteredDomains: BuildRESTFunction<typeof listRegisteredDomains$1> & typeof listRegisteredDomains$1;
|
|
1857
|
+
declare const redeemRegisteredDomain: BuildRESTFunction<typeof redeemRegisteredDomain$1> & typeof redeemRegisteredDomain$1;
|
|
1613
1858
|
|
|
1614
1859
|
type context$2_ActionEvent = ActionEvent;
|
|
1615
1860
|
type context$2_AssignmentType = AssignmentType;
|
|
@@ -1703,9 +1948,29 @@ interface CheckDomainAvailabilityResponseNonNullableFields {
|
|
|
1703
1948
|
availability?: DomainAvailabilityNonNullableFields;
|
|
1704
1949
|
}
|
|
1705
1950
|
|
|
1706
|
-
declare function
|
|
1951
|
+
declare function checkDomainAvailability$1(httpClient: HttpClient): CheckDomainAvailabilitySignature;
|
|
1952
|
+
interface CheckDomainAvailabilitySignature {
|
|
1953
|
+
/**
|
|
1954
|
+
* Checks whether the given domain is available for purchase.
|
|
1955
|
+
*
|
|
1956
|
+
*
|
|
1957
|
+
* You can purchase the specified domain in case the returned
|
|
1958
|
+
* `availability.available` boolean is `true`. The domain is already taken
|
|
1959
|
+
* when `false` is returned.
|
|
1960
|
+
*
|
|
1961
|
+
* The `domain` field must include the TLD. For example, `my-new-domain.com`.
|
|
1962
|
+
*
|
|
1963
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1964
|
+
* @param - Domain name. Must include the TLD. For example, `my-new-domain.com`. Only
|
|
1965
|
+
* alphanumeric characters, hyphens, and dots are supported.
|
|
1966
|
+
*
|
|
1967
|
+
* Min: 3 characters
|
|
1968
|
+
* Max: 63 characters
|
|
1969
|
+
*/
|
|
1970
|
+
(domain: string): Promise<CheckDomainAvailabilityResponse & CheckDomainAvailabilityResponseNonNullableFields>;
|
|
1971
|
+
}
|
|
1707
1972
|
|
|
1708
|
-
declare const checkDomainAvailability:
|
|
1973
|
+
declare const checkDomainAvailability: BuildRESTFunction<typeof checkDomainAvailability$1> & typeof checkDomainAvailability$1;
|
|
1709
1974
|
|
|
1710
1975
|
type context$1_CheckDomainAvailabilityRequest = CheckDomainAvailabilityRequest;
|
|
1711
1976
|
type context$1_CheckDomainAvailabilityResponse = CheckDomainAvailabilityResponse;
|
|
@@ -1838,9 +2103,26 @@ interface SuggestDomainsOptions {
|
|
|
1838
2103
|
paging?: CursorPaging;
|
|
1839
2104
|
}
|
|
1840
2105
|
|
|
1841
|
-
declare function
|
|
2106
|
+
declare function suggestDomains$1(httpClient: HttpClient): SuggestDomainsSignature;
|
|
2107
|
+
interface SuggestDomainsSignature {
|
|
2108
|
+
/**
|
|
2109
|
+
* Suggests domains that are available for purchase, based on the provided query input.
|
|
2110
|
+
*
|
|
2111
|
+
* You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchsase.
|
|
2112
|
+
*
|
|
2113
|
+
* The `tlds` must not include the dot. For example, `com` and not `.com`.
|
|
2114
|
+
*
|
|
2115
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
2116
|
+
* @param - Input to base your domain suggestions on. May include
|
|
2117
|
+
* letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
|
|
2118
|
+
*
|
|
2119
|
+
* Min: 3 characters
|
|
2120
|
+
* Max: 100 characters
|
|
2121
|
+
*/
|
|
2122
|
+
(query: string, options?: SuggestDomainsOptions | undefined): Promise<SuggestDomainsResponse & SuggestDomainsResponseNonNullableFields>;
|
|
2123
|
+
}
|
|
1842
2124
|
|
|
1843
|
-
declare const suggestDomains:
|
|
2125
|
+
declare const suggestDomains: BuildRESTFunction<typeof suggestDomains$1> & typeof suggestDomains$1;
|
|
1844
2126
|
|
|
1845
2127
|
type context_CursorPaging = CursorPaging;
|
|
1846
2128
|
type context_CursorPagingMetadata = CursorPagingMetadata;
|
|
@@ -1,3 +1,37 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
|
|
28
|
+
declare global {
|
|
29
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
30
|
+
interface SymbolConstructor {
|
|
31
|
+
readonly observable: symbol;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
1
35
|
/** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
|
|
2
36
|
interface ConnectedDomain {
|
|
3
37
|
/**
|
|
@@ -313,46 +347,78 @@ interface ListConnectedDomainsOptions {
|
|
|
313
347
|
paging?: CursorPaging$2;
|
|
314
348
|
}
|
|
315
349
|
|
|
316
|
-
|
|
317
|
-
interface
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
350
|
+
declare function createConnectedDomain$1(httpClient: HttpClient): CreateConnectedDomainSignature;
|
|
351
|
+
interface CreateConnectedDomainSignature {
|
|
352
|
+
/**
|
|
353
|
+
* Creates a `connectedDomain` object and starts the domain connection process. It may take up to 48 hours for the DNS changes to take effect.
|
|
354
|
+
*
|
|
355
|
+
* You must pass the relevant Wix account ID in the header of the call. You may also pass a Wix site ID in the header.
|
|
356
|
+
*
|
|
357
|
+
* You can only connect external domains using this endpoint. Domains purchased and billed through Wix can't be connected via this endpoint to a Wix site. For those domains use the [Registered Domains API](/registeredDomains/Introduction) instead.
|
|
358
|
+
*
|
|
359
|
+
* You can connect both root domains and subdomains to Wix sites.
|
|
360
|
+
*
|
|
361
|
+
* The domain can be assigned as a primary domain or a redirect. You can read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains). If you connect a domain as `"PRIMARY"` to a Wix site, the existing primary domain automatically becomes unassigned.
|
|
362
|
+
*
|
|
363
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
364
|
+
* @param - Domain to connect.
|
|
365
|
+
* @returns Connected domain.
|
|
366
|
+
*/
|
|
367
|
+
(connectedDomain: ConnectedDomain): Promise<ConnectedDomain & ConnectedDomainNonNullableFields>;
|
|
321
368
|
}
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
369
|
+
declare function getConnectedDomain$1(httpClient: HttpClient): GetConnectedDomainSignature;
|
|
370
|
+
interface GetConnectedDomainSignature {
|
|
371
|
+
/**
|
|
372
|
+
* Retrieves a connected domain.
|
|
373
|
+
*
|
|
374
|
+
*
|
|
375
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
376
|
+
*
|
|
377
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
378
|
+
* @param - ID of the connected domain. Identical to the domain name including TLD.
|
|
379
|
+
* @returns Retrieved connected domain.
|
|
380
|
+
*/
|
|
381
|
+
(connectedDomainId: string): Promise<ConnectedDomain & ConnectedDomainNonNullableFields>;
|
|
382
|
+
}
|
|
383
|
+
declare function deleteConnectedDomain$1(httpClient: HttpClient): DeleteConnectedDomainSignature;
|
|
384
|
+
interface DeleteConnectedDomainSignature {
|
|
385
|
+
/**
|
|
386
|
+
* Deletes a `connectedDomain` object and removes related DNS records from
|
|
387
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
388
|
+
*
|
|
389
|
+
*
|
|
390
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
391
|
+
*
|
|
392
|
+
* If you delete a `"PRIMARY"` domain, the site automatically uses the standard
|
|
393
|
+
* URL for free Wix sites. Read more about
|
|
394
|
+
* [URLs of free Wix sites](https://support.wix.com/en/article/changing-your-free-wix-url-8591528).
|
|
395
|
+
*
|
|
396
|
+
* When you delete a subdomain, its CNAME record is deleted from Google's Cloud DNS.
|
|
397
|
+
*
|
|
398
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
399
|
+
* @param - ID of the connected domain to delete. Identical to the domain name including TLD.
|
|
400
|
+
*/
|
|
401
|
+
(connectedDomainId: string): Promise<void>;
|
|
402
|
+
}
|
|
403
|
+
declare function listConnectedDomains$1(httpClient: HttpClient): ListConnectedDomainsSignature;
|
|
404
|
+
interface ListConnectedDomainsSignature {
|
|
405
|
+
/**
|
|
406
|
+
* Retrieves a list of up to 100 connected domains.
|
|
407
|
+
*
|
|
408
|
+
*
|
|
409
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
410
|
+
*
|
|
411
|
+
* The retrieved domains are sorted by `createdDate` in descending order.
|
|
412
|
+
*
|
|
413
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
414
|
+
*/
|
|
415
|
+
(options?: ListConnectedDomainsOptions | undefined): Promise<ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields>;
|
|
348
416
|
}
|
|
349
417
|
|
|
350
|
-
declare
|
|
351
|
-
|
|
352
|
-
declare const
|
|
353
|
-
declare const
|
|
354
|
-
declare const deleteConnectedDomain: ReturnType<typeof createRESTModule$5<typeof publicDeleteConnectedDomain>>;
|
|
355
|
-
declare const listConnectedDomains: ReturnType<typeof createRESTModule$5<typeof publicListConnectedDomains>>;
|
|
418
|
+
declare const createConnectedDomain: BuildRESTFunction<typeof createConnectedDomain$1> & typeof createConnectedDomain$1;
|
|
419
|
+
declare const getConnectedDomain: BuildRESTFunction<typeof getConnectedDomain$1> & typeof getConnectedDomain$1;
|
|
420
|
+
declare const deleteConnectedDomain: BuildRESTFunction<typeof deleteConnectedDomain$1> & typeof deleteConnectedDomain$1;
|
|
421
|
+
declare const listConnectedDomains: BuildRESTFunction<typeof listConnectedDomains$1> & typeof listConnectedDomains$1;
|
|
356
422
|
|
|
357
423
|
type index_d$5_ConnectedDomain = ConnectedDomain;
|
|
358
424
|
type index_d$5_ConnectedDomainNonNullableFields = ConnectedDomainNonNullableFields;
|
|
@@ -527,6 +593,12 @@ interface GetSetupInfoResponse {
|
|
|
527
593
|
/** Retrieved setup information. */
|
|
528
594
|
domainSetupInfo?: ConnectedDomainSetupInfo;
|
|
529
595
|
}
|
|
596
|
+
interface PreCreateConnectedDomainRequest {
|
|
597
|
+
/** Domain name including TLD */
|
|
598
|
+
domain?: string;
|
|
599
|
+
}
|
|
600
|
+
interface PreCreateConnectedDomainResponse {
|
|
601
|
+
}
|
|
530
602
|
interface GetConnectedDomainSetupInfoRequest {
|
|
531
603
|
/**
|
|
532
604
|
* ID of the connected domain to retrieve setup information for.
|
|
@@ -577,9 +649,22 @@ interface GetConnectedDomainSetupInfoResponseNonNullableFields {
|
|
|
577
649
|
connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields;
|
|
578
650
|
}
|
|
579
651
|
|
|
580
|
-
declare function
|
|
652
|
+
declare function getConnectedDomainSetupInfo$1(httpClient: HttpClient): GetConnectedDomainSetupInfoSignature;
|
|
653
|
+
interface GetConnectedDomainSetupInfoSignature {
|
|
654
|
+
/**
|
|
655
|
+
* Retrieves information for the initial setup of a connected domain.
|
|
656
|
+
*
|
|
657
|
+
*
|
|
658
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
659
|
+
*
|
|
660
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
661
|
+
* @param - ID of the connected domain to retrieve setup information for.
|
|
662
|
+
* Identical to the domain name including TLD.
|
|
663
|
+
*/
|
|
664
|
+
(connectedDomainId: string): Promise<GetConnectedDomainSetupInfoResponse & GetConnectedDomainSetupInfoResponseNonNullableFields>;
|
|
665
|
+
}
|
|
581
666
|
|
|
582
|
-
declare const getConnectedDomainSetupInfo:
|
|
667
|
+
declare const getConnectedDomainSetupInfo: BuildRESTFunction<typeof getConnectedDomainSetupInfo$1> & typeof getConnectedDomainSetupInfo$1;
|
|
583
668
|
|
|
584
669
|
type index_d$4_ARecord = ARecord;
|
|
585
670
|
type index_d$4_CnameRecord = CnameRecord;
|
|
@@ -595,11 +680,13 @@ type index_d$4_GetSetupInfoResponse = GetSetupInfoResponse;
|
|
|
595
680
|
type index_d$4_NameserverRecord = NameserverRecord;
|
|
596
681
|
type index_d$4_NsRecord = NsRecord;
|
|
597
682
|
type index_d$4_PointingRecords = PointingRecords;
|
|
683
|
+
type index_d$4_PreCreateConnectedDomainRequest = PreCreateConnectedDomainRequest;
|
|
684
|
+
type index_d$4_PreCreateConnectedDomainResponse = PreCreateConnectedDomainResponse;
|
|
598
685
|
type index_d$4_Registrar = Registrar;
|
|
599
686
|
type index_d$4_SubdomainRecords = SubdomainRecords;
|
|
600
687
|
declare const index_d$4_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
|
|
601
688
|
declare namespace index_d$4 {
|
|
602
|
-
export { type index_d$4_ARecord as ARecord, type index_d$4_CnameRecord as CnameRecord, type index_d$4_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type index_d$4_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, index_d$4_ConnectionType as ConnectionType, type index_d$4_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type index_d$4_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type index_d$4_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type index_d$4_GetSetupInfoRequest as GetSetupInfoRequest, type index_d$4_GetSetupInfoResponse as GetSetupInfoResponse, type index_d$4_NameserverRecord as NameserverRecord, type index_d$4_NsRecord as NsRecord, type index_d$4_PointingRecords as PointingRecords, type index_d$4_Registrar as Registrar, type index_d$4_SubdomainRecords as SubdomainRecords, index_d$4_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
689
|
+
export { type index_d$4_ARecord as ARecord, type index_d$4_CnameRecord as CnameRecord, type index_d$4_ConnectedDomainSetupInfo as ConnectedDomainSetupInfo, type index_d$4_ConnectedDomainSetupInfoDnsRecordsOneOf as ConnectedDomainSetupInfoDnsRecordsOneOf, index_d$4_ConnectionType as ConnectionType, type index_d$4_GetConnectedDomainSetupInfoRequest as GetConnectedDomainSetupInfoRequest, type index_d$4_GetConnectedDomainSetupInfoResponse as GetConnectedDomainSetupInfoResponse, type index_d$4_GetConnectedDomainSetupInfoResponseNonNullableFields as GetConnectedDomainSetupInfoResponseNonNullableFields, type index_d$4_GetSetupInfoRequest as GetSetupInfoRequest, type index_d$4_GetSetupInfoResponse as GetSetupInfoResponse, type index_d$4_NameserverRecord as NameserverRecord, type index_d$4_NsRecord as NsRecord, type index_d$4_PointingRecords as PointingRecords, type index_d$4_PreCreateConnectedDomainRequest as PreCreateConnectedDomainRequest, type index_d$4_PreCreateConnectedDomainResponse as PreCreateConnectedDomainResponse, type index_d$4_Registrar as Registrar, type index_d$4_SubdomainRecords as SubdomainRecords, index_d$4_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
|
|
603
690
|
}
|
|
604
691
|
|
|
605
692
|
/** DNS zones hold information about the records that map a domain's URL to an IP address. */
|
|
@@ -915,13 +1002,98 @@ interface UpdateDnsZoneOptions {
|
|
|
915
1002
|
dnssecEnabled?: boolean | null;
|
|
916
1003
|
}
|
|
917
1004
|
|
|
918
|
-
declare function
|
|
1005
|
+
declare function createDnsZone$1(httpClient: HttpClient): CreateDnsZoneSignature;
|
|
1006
|
+
interface CreateDnsZoneSignature {
|
|
1007
|
+
/**
|
|
1008
|
+
* Creates a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1009
|
+
*
|
|
1010
|
+
*
|
|
1011
|
+
* If there is an existing DNS zone for the domain, it's deleted before
|
|
1012
|
+
* the new zone is created.
|
|
1013
|
+
*
|
|
1014
|
+
* The call is synchronous, that means it fails in case of an error on
|
|
1015
|
+
* Google's side.
|
|
1016
|
+
*
|
|
1017
|
+
* You can only set up a single `record` object per DNS record
|
|
1018
|
+
* type. If you want to specify multiple values for the same record type, you
|
|
1019
|
+
* must save them in the `values` for the relevant type.
|
|
1020
|
+
*
|
|
1021
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1022
|
+
* @param - DNS zone to create.
|
|
1023
|
+
* @returns Created DNS zone.
|
|
1024
|
+
*/
|
|
1025
|
+
(dnsZone: DnsZone): Promise<DnsZone & DnsZoneNonNullableFields>;
|
|
1026
|
+
}
|
|
1027
|
+
declare function getDnsZone$1(httpClient: HttpClient): GetDnsZoneSignature;
|
|
1028
|
+
interface GetDnsZoneSignature {
|
|
1029
|
+
/**
|
|
1030
|
+
* Retrieves the DNS zone belonging to the domain from
|
|
1031
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1032
|
+
*
|
|
1033
|
+
*
|
|
1034
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1035
|
+
* @param - Domain to retrieve the DNS zone for.
|
|
1036
|
+
* @returns Retrieved DNS zone.
|
|
1037
|
+
*/
|
|
1038
|
+
(domainName: string): Promise<DnsZone & DnsZoneNonNullableFields>;
|
|
1039
|
+
}
|
|
1040
|
+
declare function updateDnsZone$1(httpClient: HttpClient): UpdateDnsZoneSignature;
|
|
1041
|
+
interface UpdateDnsZoneSignature {
|
|
1042
|
+
/**
|
|
1043
|
+
* Adds DNS records to and removes DNS records from a DNS zone in
|
|
1044
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1045
|
+
*
|
|
1046
|
+
* The call is synchronous, that means it fails in case of an error on
|
|
1047
|
+
* Google's side.
|
|
1048
|
+
*
|
|
1049
|
+
* You can only set up a single `record` object per DNS record
|
|
1050
|
+
* type. If you want to specify multiple values for the same record type, you
|
|
1051
|
+
* must save them in the `values` for the relevant type. This means, you must
|
|
1052
|
+
* delete the relevant record and add a new `addition` object for this type
|
|
1053
|
+
* to the request, in case you want to add values for an existing DNS record
|
|
1054
|
+
* type.
|
|
1055
|
+
*
|
|
1056
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1057
|
+
* @param - Domain to update the DNS zone for. Must include the TLD.
|
|
1058
|
+
*/
|
|
1059
|
+
(domainName: string, options?: UpdateDnsZoneOptions | undefined): Promise<UpdateDnsZoneResponse & UpdateDnsZoneResponseNonNullableFields>;
|
|
1060
|
+
}
|
|
1061
|
+
declare function deleteDnsZone$1(httpClient: HttpClient): DeleteDnsZoneSignature;
|
|
1062
|
+
interface DeleteDnsZoneSignature {
|
|
1063
|
+
/**
|
|
1064
|
+
* Deletes a DNS zone in [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1065
|
+
*
|
|
1066
|
+
*
|
|
1067
|
+
* The call is synchronous, that means it fails in case of an error on
|
|
1068
|
+
* Google's side.
|
|
1069
|
+
*
|
|
1070
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1071
|
+
* @param - Domain name to delete the DNS zone for.
|
|
1072
|
+
*/
|
|
1073
|
+
(domainName: string): Promise<void>;
|
|
1074
|
+
}
|
|
1075
|
+
declare function previewDnsZone$1(httpClient: HttpClient): PreviewDnsZoneSignature;
|
|
1076
|
+
interface PreviewDnsZoneSignature {
|
|
1077
|
+
/**
|
|
1078
|
+
* Generates a preview for a DNS zone based on
|
|
1079
|
+
* [Google's Cloud DNS](https://cloud.google.com/dns).
|
|
1080
|
+
*
|
|
1081
|
+
*
|
|
1082
|
+
* This includes calculating the `A`, `CNAME`, `NS` and `SOA` records.
|
|
1083
|
+
* You can use this information to configure a domain from an external
|
|
1084
|
+
* provider, before connecting it to a Wix site.
|
|
1085
|
+
*
|
|
1086
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1087
|
+
* @param - Domain name to generate a DNS zone preview for.
|
|
1088
|
+
*/
|
|
1089
|
+
(domainName: string): Promise<PreviewDnsZoneResponse & PreviewDnsZoneResponseNonNullableFields>;
|
|
1090
|
+
}
|
|
919
1091
|
|
|
920
|
-
declare const createDnsZone:
|
|
921
|
-
declare const getDnsZone:
|
|
922
|
-
declare const updateDnsZone:
|
|
923
|
-
declare const deleteDnsZone:
|
|
924
|
-
declare const previewDnsZone:
|
|
1092
|
+
declare const createDnsZone: BuildRESTFunction<typeof createDnsZone$1> & typeof createDnsZone$1;
|
|
1093
|
+
declare const getDnsZone: BuildRESTFunction<typeof getDnsZone$1> & typeof getDnsZone$1;
|
|
1094
|
+
declare const updateDnsZone: BuildRESTFunction<typeof updateDnsZone$1> & typeof updateDnsZone$1;
|
|
1095
|
+
declare const deleteDnsZone: BuildRESTFunction<typeof deleteDnsZone$1> & typeof deleteDnsZone$1;
|
|
1096
|
+
declare const previewDnsZone: BuildRESTFunction<typeof previewDnsZone$1> & typeof previewDnsZone$1;
|
|
925
1097
|
|
|
926
1098
|
type index_d$3_CreateDnsZoneRequest = CreateDnsZoneRequest;
|
|
927
1099
|
type index_d$3_CreateDnsZoneResponse = CreateDnsZoneResponse;
|
|
@@ -1604,12 +1776,85 @@ interface ListRegisteredDomainsOptions {
|
|
|
1604
1776
|
paging?: CursorPaging$1;
|
|
1605
1777
|
}
|
|
1606
1778
|
|
|
1607
|
-
declare function
|
|
1779
|
+
declare function createRegisteredDomain$1(httpClient: HttpClient): CreateRegisteredDomainSignature;
|
|
1780
|
+
interface CreateRegisteredDomainSignature {
|
|
1781
|
+
/**
|
|
1782
|
+
* Creates a registeredDomain object and starts the domain registration process that may take up to 48 hours to resolve.
|
|
1783
|
+
*
|
|
1784
|
+
* You must pass the relevant Wix account ID in the header of the call. You may also pass a Wix site ID in the header of the call. This assigns the domain to the site when the registration succeeds. If you don't provide a site ID, the domain is registered but not assigned to a Wix site. Information about the site is returned in the `siteInfo object`, while information about the account isn't returned.
|
|
1785
|
+
*
|
|
1786
|
+
* To register a domain and assign it to a site, the site must have an active [Premium plan](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683). However, if you just want to register a domain without connecting it to a site, the account doesn't need an active Premium plan. In both situations, the account must own a product that supports linking a domain with the chosen TLD. Use [Create Package](/packages/create-package) of the Resellers API to add the relevant Premium plan or product to your customer's site. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about the available product IDs.
|
|
1787
|
+
*
|
|
1788
|
+
* You can register domains for 1, 2, or 3 years, but you don't set the duration with this endpoint. Instead Wix chooses the registration length based on the billing cycle of the corresponding `productInstance` from the [Resellers API](/packages/Introduction). The [Create Registered Domain](/registeredDomains/create-registered-domains) call fails if the billing cycle of the relevant productInstance isn't 1, 2, or 3 years.
|
|
1789
|
+
*
|
|
1790
|
+
* You can only register a root domain. You can't register a subdomain.
|
|
1791
|
+
*
|
|
1792
|
+
* If you try to register a domain that isn't available for purchase or there is already a `registeredDomain` object for the specified domain, the call fails without creating a `registeredDomain` object or starting the registration process.
|
|
1793
|
+
*
|
|
1794
|
+
* Wix tries to register the domain several times, but stops if the process fails too often. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information about the number of attempts and their timing.
|
|
1795
|
+
*
|
|
1796
|
+
* Wix only checks formal requirements of each field in the `contacts` object, such as the maximum number of characters. Wix doesn't check whether the actual domain registrar has additional requirements, for example that the postal code is valid in the specified country. If there is such a mismatch between the request and the registrar's requirements, the call succeeds but the registration process can't succeed. Read more about [contact validations](https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-validations).
|
|
1797
|
+
*
|
|
1798
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1799
|
+
* @param - Information about the domain to register including contact details.
|
|
1800
|
+
* @returns Created registered domain.
|
|
1801
|
+
*/
|
|
1802
|
+
(registeredDomain: RegisteredDomain): Promise<RegisteredDomain & RegisteredDomainNonNullableFields>;
|
|
1803
|
+
}
|
|
1804
|
+
declare function getRegisteredDomain$1(httpClient: HttpClient): GetRegisteredDomainSignature;
|
|
1805
|
+
interface GetRegisteredDomainSignature {
|
|
1806
|
+
/**
|
|
1807
|
+
* Retrieves a registered domain.
|
|
1808
|
+
*
|
|
1809
|
+
*
|
|
1810
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
1811
|
+
*
|
|
1812
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1813
|
+
* @param - ID of the registered domain to retrieve.
|
|
1814
|
+
* @returns Retrieved registered domain.
|
|
1815
|
+
*/
|
|
1816
|
+
(registeredDomainId: string): Promise<RegisteredDomain & RegisteredDomainNonNullableFields>;
|
|
1817
|
+
}
|
|
1818
|
+
declare function listRegisteredDomains$1(httpClient: HttpClient): ListRegisteredDomainsSignature;
|
|
1819
|
+
interface ListRegisteredDomainsSignature {
|
|
1820
|
+
/**
|
|
1821
|
+
* Retrieves a list of up to 100 registered domains.
|
|
1822
|
+
*
|
|
1823
|
+
*
|
|
1824
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
1825
|
+
*
|
|
1826
|
+
* The retrieved domains are sorted by `createdDate` in descending order.
|
|
1827
|
+
*
|
|
1828
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1829
|
+
*/
|
|
1830
|
+
(options?: ListRegisteredDomainsOptions | undefined): Promise<ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields>;
|
|
1831
|
+
}
|
|
1832
|
+
declare function redeemRegisteredDomain$1(httpClient: HttpClient): RedeemRegisteredDomainSignature;
|
|
1833
|
+
interface RedeemRegisteredDomainSignature {
|
|
1834
|
+
/**
|
|
1835
|
+
* Redeems a registered domain that's currently in redemption.
|
|
1836
|
+
*
|
|
1837
|
+
*
|
|
1838
|
+
* You must pass the relevant Wix account ID in the header of the call.
|
|
1839
|
+
*
|
|
1840
|
+
* It may take up to 7 days to complete the domain redemption. If the domain
|
|
1841
|
+
* is successfully redeemed, the new `expirationDate` is 1 year after the
|
|
1842
|
+
* original `expirationDate`.
|
|
1843
|
+
*
|
|
1844
|
+
* You can't redeem registered domains that haven't expired yet or have passed
|
|
1845
|
+
* the redemption period.
|
|
1846
|
+
*
|
|
1847
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1848
|
+
* @param - ID of the registered domain to redeem. Identical to the domain name
|
|
1849
|
+
* including TLD.
|
|
1850
|
+
*/
|
|
1851
|
+
(registeredDomainId: string): Promise<RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields>;
|
|
1852
|
+
}
|
|
1608
1853
|
|
|
1609
|
-
declare const createRegisteredDomain:
|
|
1610
|
-
declare const getRegisteredDomain:
|
|
1611
|
-
declare const listRegisteredDomains:
|
|
1612
|
-
declare const redeemRegisteredDomain:
|
|
1854
|
+
declare const createRegisteredDomain: BuildRESTFunction<typeof createRegisteredDomain$1> & typeof createRegisteredDomain$1;
|
|
1855
|
+
declare const getRegisteredDomain: BuildRESTFunction<typeof getRegisteredDomain$1> & typeof getRegisteredDomain$1;
|
|
1856
|
+
declare const listRegisteredDomains: BuildRESTFunction<typeof listRegisteredDomains$1> & typeof listRegisteredDomains$1;
|
|
1857
|
+
declare const redeemRegisteredDomain: BuildRESTFunction<typeof redeemRegisteredDomain$1> & typeof redeemRegisteredDomain$1;
|
|
1613
1858
|
|
|
1614
1859
|
type index_d$2_ActionEvent = ActionEvent;
|
|
1615
1860
|
type index_d$2_AssignmentType = AssignmentType;
|
|
@@ -1703,9 +1948,29 @@ interface CheckDomainAvailabilityResponseNonNullableFields {
|
|
|
1703
1948
|
availability?: DomainAvailabilityNonNullableFields;
|
|
1704
1949
|
}
|
|
1705
1950
|
|
|
1706
|
-
declare function
|
|
1951
|
+
declare function checkDomainAvailability$1(httpClient: HttpClient): CheckDomainAvailabilitySignature;
|
|
1952
|
+
interface CheckDomainAvailabilitySignature {
|
|
1953
|
+
/**
|
|
1954
|
+
* Checks whether the given domain is available for purchase.
|
|
1955
|
+
*
|
|
1956
|
+
*
|
|
1957
|
+
* You can purchase the specified domain in case the returned
|
|
1958
|
+
* `availability.available` boolean is `true`. The domain is already taken
|
|
1959
|
+
* when `false` is returned.
|
|
1960
|
+
*
|
|
1961
|
+
* The `domain` field must include the TLD. For example, `my-new-domain.com`.
|
|
1962
|
+
*
|
|
1963
|
+
* > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1964
|
+
* @param - Domain name. Must include the TLD. For example, `my-new-domain.com`. Only
|
|
1965
|
+
* alphanumeric characters, hyphens, and dots are supported.
|
|
1966
|
+
*
|
|
1967
|
+
* Min: 3 characters
|
|
1968
|
+
* Max: 63 characters
|
|
1969
|
+
*/
|
|
1970
|
+
(domain: string): Promise<CheckDomainAvailabilityResponse & CheckDomainAvailabilityResponseNonNullableFields>;
|
|
1971
|
+
}
|
|
1707
1972
|
|
|
1708
|
-
declare const checkDomainAvailability:
|
|
1973
|
+
declare const checkDomainAvailability: BuildRESTFunction<typeof checkDomainAvailability$1> & typeof checkDomainAvailability$1;
|
|
1709
1974
|
|
|
1710
1975
|
type index_d$1_CheckDomainAvailabilityRequest = CheckDomainAvailabilityRequest;
|
|
1711
1976
|
type index_d$1_CheckDomainAvailabilityResponse = CheckDomainAvailabilityResponse;
|
|
@@ -1838,9 +2103,26 @@ interface SuggestDomainsOptions {
|
|
|
1838
2103
|
paging?: CursorPaging;
|
|
1839
2104
|
}
|
|
1840
2105
|
|
|
1841
|
-
declare function
|
|
2106
|
+
declare function suggestDomains$1(httpClient: HttpClient): SuggestDomainsSignature;
|
|
2107
|
+
interface SuggestDomainsSignature {
|
|
2108
|
+
/**
|
|
2109
|
+
* Suggests domains that are available for purchase, based on the provided query input.
|
|
2110
|
+
*
|
|
2111
|
+
* You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchsase.
|
|
2112
|
+
*
|
|
2113
|
+
* The `tlds` must not include the dot. For example, `com` and not `.com`.
|
|
2114
|
+
*
|
|
2115
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
2116
|
+
* @param - Input to base your domain suggestions on. May include
|
|
2117
|
+
* letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
|
|
2118
|
+
*
|
|
2119
|
+
* Min: 3 characters
|
|
2120
|
+
* Max: 100 characters
|
|
2121
|
+
*/
|
|
2122
|
+
(query: string, options?: SuggestDomainsOptions | undefined): Promise<SuggestDomainsResponse & SuggestDomainsResponseNonNullableFields>;
|
|
2123
|
+
}
|
|
1842
2124
|
|
|
1843
|
-
declare const suggestDomains:
|
|
2125
|
+
declare const suggestDomains: BuildRESTFunction<typeof suggestDomains$1> & typeof suggestDomains$1;
|
|
1844
2126
|
|
|
1845
2127
|
type index_d_CursorPaging = CursorPaging;
|
|
1846
2128
|
type index_d_CursorPagingMetadata = CursorPagingMetadata;
|