@wix/auto_sdk_domains_transfer-in-validations 1.0.0 → 1.0.1
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 +18 -8
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +37 -22
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +19 -14
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +18 -8
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +37 -22
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +19 -14
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +18 -8
- package/build/internal/cjs/index.typings.d.ts +37 -22
- package/build/internal/cjs/meta.d.ts +19 -14
- package/build/internal/es/index.d.mts +18 -8
- package/build/internal/es/index.typings.d.mts +37 -22
- package/build/internal/es/meta.d.mts +19 -14
- package/package.json +2 -2
|
@@ -1,76 +1,86 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
-
/** A validation result contains the outcome of a domain
|
|
3
|
+
/** A domain transfer in validation result contains the outcome of checking a domain, or its authorization code, before transferring the domain to Wix from another registrar. An empty `violations` list means the domain passed every check. Otherwise, each violation identifies an issue the Wix user must resolve before the transfer can start. */
|
|
4
4
|
interface DomainTransferInValidationResult {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Validated domain name, including the TLD. For example, `example.com`.
|
|
7
7
|
* @format HOSTNAME
|
|
8
8
|
* @readonly
|
|
9
9
|
*/
|
|
10
10
|
_id?: string | null;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Issues that prevent the transfer. Empty if the domain passed every check.
|
|
13
13
|
* @maxSize 100
|
|
14
14
|
*/
|
|
15
15
|
violations?: ViolationWithLiterals[];
|
|
16
16
|
}
|
|
17
17
|
declare enum Violation {
|
|
18
|
+
/** Unknown violation. */
|
|
18
19
|
UNKNOWN_VIOLATION = "UNKNOWN_VIOLATION",
|
|
19
|
-
/** Domain
|
|
20
|
+
/** Domain isn't registered, or the current registrar can't confirm that it can be transferred. */
|
|
20
21
|
DOMAIN_NOT_FOUND = "DOMAIN_NOT_FOUND",
|
|
21
|
-
/** Authorization code isn't valid for this domain. */
|
|
22
|
+
/** Authorization code isn't valid for this domain. The Wix user must request a new code from the current registrar. */
|
|
22
23
|
DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID = "DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID",
|
|
23
|
-
/** TLD doesn't support transfers to Wix. */
|
|
24
|
+
/** Domain's TLD doesn't support transfers to Wix. */
|
|
24
25
|
DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED = "DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED",
|
|
25
|
-
/** A transfer
|
|
26
|
+
/** A transfer to Wix is already in progress for this domain. */
|
|
26
27
|
DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST = "DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST",
|
|
27
28
|
/** Domain is already registered with Wix. */
|
|
28
29
|
DOMAIN_ALREADY_TAKEN = "DOMAIN_ALREADY_TAKEN",
|
|
29
|
-
/**
|
|
30
|
+
/** Domain is a premium domain. Premium domains can't be transferred to Wix. */
|
|
30
31
|
TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED = "TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED",
|
|
31
32
|
/** Domain is locked with a `clientTransferProhibited` status. The Wix user must unlock it at the current registrar. */
|
|
32
33
|
DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED = "DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED",
|
|
33
|
-
/** Domain was registered less than 60 days ago. */
|
|
34
|
+
/** Domain was registered or last transferred less than 60 days ago. */
|
|
34
35
|
DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS = "DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS"
|
|
35
36
|
}
|
|
36
37
|
/** @enumType */
|
|
37
38
|
type ViolationWithLiterals = Violation | 'UNKNOWN_VIOLATION' | 'DOMAIN_NOT_FOUND' | 'DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID' | 'DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST' | 'DOMAIN_ALREADY_TAKEN' | 'TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED' | 'DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS';
|
|
38
39
|
interface ValidateAuthorizationCodeRequest {
|
|
39
40
|
/**
|
|
40
|
-
* Domain name to validate. For example, `
|
|
41
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
42
|
+
*
|
|
43
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
41
44
|
* @format HOSTNAME
|
|
42
45
|
* @readonly
|
|
43
46
|
*/
|
|
44
47
|
domain: string;
|
|
45
48
|
/**
|
|
46
|
-
* Authorization code
|
|
49
|
+
* Authorization code from the domain's current registrar. Also known as an EPP code or transfer code.
|
|
47
50
|
* @maxLength 225
|
|
48
51
|
*/
|
|
49
52
|
authorizationCode: string;
|
|
50
53
|
}
|
|
51
54
|
interface ValidateAuthorizationCodeResponse {
|
|
52
|
-
/** Validation result
|
|
55
|
+
/** Validation result, including any violations found. */
|
|
53
56
|
validationResult?: DomainTransferInValidationResult;
|
|
54
57
|
}
|
|
55
58
|
interface ValidateDomainTransferabilityRequest {
|
|
56
59
|
/**
|
|
57
|
-
* Domain name to validate. For example, `
|
|
60
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
61
|
+
*
|
|
62
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
58
63
|
* @format HOSTNAME
|
|
59
64
|
* @immutable
|
|
60
65
|
*/
|
|
61
66
|
domain: string;
|
|
62
67
|
}
|
|
63
68
|
interface ValidateDomainTransferabilityResponse {
|
|
64
|
-
/** Validation result
|
|
69
|
+
/** Validation result, including any violations found. */
|
|
65
70
|
validationResult?: DomainTransferInValidationResult;
|
|
66
71
|
}
|
|
67
72
|
/**
|
|
68
|
-
* Validates an authorization code for a domain to
|
|
73
|
+
* Validates an authorization code for transferring a domain to Wix.
|
|
69
74
|
*
|
|
70
|
-
* Checks
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
75
|
+
* Checks with the domain's current registrar whether the authorization code is valid for the specified domain. Call this method before starting a transfer to catch invalid or expired codes early.
|
|
76
|
+
*
|
|
77
|
+
* Validation problems are returned in `validationResult.violations`, not as errors. If the code isn't valid, the list includes `DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID`.
|
|
78
|
+
*
|
|
79
|
+
* To check whether the domain itself can be transferred, call [Validate Domain Transferability](https://dev.wix.com/docs/api-reference/account-level/domains/domain-transfer-in/validate-domain-transferability).
|
|
80
|
+
* @param domain - Domain name to validate, including the TLD. For example, `example.com`.
|
|
81
|
+
*
|
|
82
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
83
|
+
* @param authorizationCode - Authorization code from the domain's current registrar. Also known as an EPP code or transfer code.
|
|
74
84
|
* @public
|
|
75
85
|
* @documentationMaturity preview
|
|
76
86
|
* @requiredField authorizationCode
|
|
@@ -82,9 +92,14 @@ declare function validateAuthorizationCode(domain: string, authorizationCode: st
|
|
|
82
92
|
/**
|
|
83
93
|
* Validates whether a domain can be transferred to Wix.
|
|
84
94
|
*
|
|
85
|
-
* Checks domain
|
|
86
|
-
*
|
|
87
|
-
*
|
|
95
|
+
* Checks the domain against every transfer requirement in a single call: TLD support, premium status, whether the domain is already registered with Wix, and whether a transfer is already in progress. Call this method before starting a transfer to confirm eligibility.
|
|
96
|
+
*
|
|
97
|
+
* Validation problems are returned in `validationResult.violations`, not as errors. A domain can fail several checks at once, so the list can contain more than one violation. An empty list means the domain can be transferred.
|
|
98
|
+
*
|
|
99
|
+
* To validate the authorization code for the transfer, call [Validate Authorization Code](https://dev.wix.com/docs/api-reference/account-level/domains/domain-transfer-in/validate-authorization-code).
|
|
100
|
+
* @param domain - Domain name to validate, including the TLD. For example, `example.com`.
|
|
101
|
+
*
|
|
102
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
88
103
|
* @public
|
|
89
104
|
* @documentationMaturity preview
|
|
90
105
|
* @requiredField domain
|
|
@@ -1,68 +1,73 @@
|
|
|
1
1
|
import { ValidateAuthorizationCodeRequest as ValidateAuthorizationCodeRequest$1, ValidateAuthorizationCodeResponse as ValidateAuthorizationCodeResponse$1, ValidateDomainTransferabilityRequest as ValidateDomainTransferabilityRequest$1, ValidateDomainTransferabilityResponse as ValidateDomainTransferabilityResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
|
-
/** A validation result contains the outcome of a domain
|
|
4
|
+
/** A domain transfer in validation result contains the outcome of checking a domain, or its authorization code, before transferring the domain to Wix from another registrar. An empty `violations` list means the domain passed every check. Otherwise, each violation identifies an issue the Wix user must resolve before the transfer can start. */
|
|
5
5
|
interface DomainTransferInValidationResult {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Validated domain name, including the TLD. For example, `example.com`.
|
|
8
8
|
* @format HOSTNAME
|
|
9
9
|
* @readonly
|
|
10
10
|
*/
|
|
11
11
|
id?: string | null;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Issues that prevent the transfer. Empty if the domain passed every check.
|
|
14
14
|
* @maxSize 100
|
|
15
15
|
*/
|
|
16
16
|
violations?: ViolationWithLiterals[];
|
|
17
17
|
}
|
|
18
18
|
declare enum Violation {
|
|
19
|
+
/** Unknown violation. */
|
|
19
20
|
UNKNOWN_VIOLATION = "UNKNOWN_VIOLATION",
|
|
20
|
-
/** Domain
|
|
21
|
+
/** Domain isn't registered, or the current registrar can't confirm that it can be transferred. */
|
|
21
22
|
DOMAIN_NOT_FOUND = "DOMAIN_NOT_FOUND",
|
|
22
|
-
/** Authorization code isn't valid for this domain. */
|
|
23
|
+
/** Authorization code isn't valid for this domain. The Wix user must request a new code from the current registrar. */
|
|
23
24
|
DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID = "DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID",
|
|
24
|
-
/** TLD doesn't support transfers to Wix. */
|
|
25
|
+
/** Domain's TLD doesn't support transfers to Wix. */
|
|
25
26
|
DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED = "DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED",
|
|
26
|
-
/** A transfer
|
|
27
|
+
/** A transfer to Wix is already in progress for this domain. */
|
|
27
28
|
DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST = "DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST",
|
|
28
29
|
/** Domain is already registered with Wix. */
|
|
29
30
|
DOMAIN_ALREADY_TAKEN = "DOMAIN_ALREADY_TAKEN",
|
|
30
|
-
/**
|
|
31
|
+
/** Domain is a premium domain. Premium domains can't be transferred to Wix. */
|
|
31
32
|
TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED = "TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED",
|
|
32
33
|
/** Domain is locked with a `clientTransferProhibited` status. The Wix user must unlock it at the current registrar. */
|
|
33
34
|
DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED = "DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED",
|
|
34
|
-
/** Domain was registered less than 60 days ago. */
|
|
35
|
+
/** Domain was registered or last transferred less than 60 days ago. */
|
|
35
36
|
DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS = "DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS"
|
|
36
37
|
}
|
|
37
38
|
/** @enumType */
|
|
38
39
|
type ViolationWithLiterals = Violation | 'UNKNOWN_VIOLATION' | 'DOMAIN_NOT_FOUND' | 'DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID' | 'DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST' | 'DOMAIN_ALREADY_TAKEN' | 'TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED' | 'DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS';
|
|
39
40
|
interface ValidateAuthorizationCodeRequest {
|
|
40
41
|
/**
|
|
41
|
-
* Domain name to validate. For example, `
|
|
42
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
43
|
+
*
|
|
44
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
42
45
|
* @format HOSTNAME
|
|
43
46
|
* @readonly
|
|
44
47
|
*/
|
|
45
48
|
domain: string;
|
|
46
49
|
/**
|
|
47
|
-
* Authorization code
|
|
50
|
+
* Authorization code from the domain's current registrar. Also known as an EPP code or transfer code.
|
|
48
51
|
* @maxLength 225
|
|
49
52
|
*/
|
|
50
53
|
authorizationCode: string;
|
|
51
54
|
}
|
|
52
55
|
interface ValidateAuthorizationCodeResponse {
|
|
53
|
-
/** Validation result
|
|
56
|
+
/** Validation result, including any violations found. */
|
|
54
57
|
validationResult?: DomainTransferInValidationResult;
|
|
55
58
|
}
|
|
56
59
|
interface ValidateDomainTransferabilityRequest {
|
|
57
60
|
/**
|
|
58
|
-
* Domain name to validate. For example, `
|
|
61
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
62
|
+
*
|
|
63
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
59
64
|
* @format HOSTNAME
|
|
60
65
|
* @immutable
|
|
61
66
|
*/
|
|
62
67
|
domain: string;
|
|
63
68
|
}
|
|
64
69
|
interface ValidateDomainTransferabilityResponse {
|
|
65
|
-
/** Validation result
|
|
70
|
+
/** Validation result, including any violations found. */
|
|
66
71
|
validationResult?: DomainTransferInValidationResult;
|
|
67
72
|
}
|
|
68
73
|
|
|
@@ -5,12 +5,17 @@ export { DomainTransferInValidationResult, ValidateAuthorizationCodeRequest, Val
|
|
|
5
5
|
declare function validateAuthorizationCode$1(httpClient: HttpClient): ValidateAuthorizationCodeSignature;
|
|
6
6
|
interface ValidateAuthorizationCodeSignature {
|
|
7
7
|
/**
|
|
8
|
-
* Validates an authorization code for a domain to
|
|
8
|
+
* Validates an authorization code for transferring a domain to Wix.
|
|
9
9
|
*
|
|
10
|
-
* Checks
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* Checks with the domain's current registrar whether the authorization code is valid for the specified domain. Call this method before starting a transfer to catch invalid or expired codes early.
|
|
11
|
+
*
|
|
12
|
+
* Validation problems are returned in `validationResult.violations`, not as errors. If the code isn't valid, the list includes `DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID`.
|
|
13
|
+
*
|
|
14
|
+
* To check whether the domain itself can be transferred, call [Validate Domain Transferability](https://dev.wix.com/docs/api-reference/account-level/domains/domain-transfer-in/validate-domain-transferability).
|
|
15
|
+
* @param - Domain name to validate, including the TLD. For example, `example.com`.
|
|
16
|
+
*
|
|
17
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
18
|
+
* @param - Authorization code from the domain's current registrar. Also known as an EPP code or transfer code.
|
|
14
19
|
*/
|
|
15
20
|
(domain: string, authorizationCode: string): Promise<NonNullablePaths<ValidateAuthorizationCodeResponse, `validationResult.violations`, 1>>;
|
|
16
21
|
}
|
|
@@ -19,9 +24,14 @@ interface ValidateDomainTransferabilitySignature {
|
|
|
19
24
|
/**
|
|
20
25
|
* Validates whether a domain can be transferred to Wix.
|
|
21
26
|
*
|
|
22
|
-
* Checks domain
|
|
23
|
-
*
|
|
24
|
-
*
|
|
27
|
+
* Checks the domain against every transfer requirement in a single call: TLD support, premium status, whether the domain is already registered with Wix, and whether a transfer is already in progress. Call this method before starting a transfer to confirm eligibility.
|
|
28
|
+
*
|
|
29
|
+
* Validation problems are returned in `validationResult.violations`, not as errors. A domain can fail several checks at once, so the list can contain more than one violation. An empty list means the domain can be transferred.
|
|
30
|
+
*
|
|
31
|
+
* To validate the authorization code for the transfer, call [Validate Authorization Code](https://dev.wix.com/docs/api-reference/account-level/domains/domain-transfer-in/validate-authorization-code).
|
|
32
|
+
* @param - Domain name to validate, including the TLD. For example, `example.com`.
|
|
33
|
+
*
|
|
34
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
25
35
|
*/
|
|
26
36
|
(domain: string): Promise<NonNullablePaths<ValidateDomainTransferabilityResponse, `validationResult.violations`, 1>>;
|
|
27
37
|
}
|
|
@@ -1,76 +1,86 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
-
/** A validation result contains the outcome of a domain
|
|
3
|
+
/** A domain transfer in validation result contains the outcome of checking a domain, or its authorization code, before transferring the domain to Wix from another registrar. An empty `violations` list means the domain passed every check. Otherwise, each violation identifies an issue the Wix user must resolve before the transfer can start. */
|
|
4
4
|
interface DomainTransferInValidationResult {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Validated domain name, including the TLD. For example, `example.com`.
|
|
7
7
|
* @format HOSTNAME
|
|
8
8
|
* @readonly
|
|
9
9
|
*/
|
|
10
10
|
_id?: string | null;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Issues that prevent the transfer. Empty if the domain passed every check.
|
|
13
13
|
* @maxSize 100
|
|
14
14
|
*/
|
|
15
15
|
violations?: ViolationWithLiterals[];
|
|
16
16
|
}
|
|
17
17
|
declare enum Violation {
|
|
18
|
+
/** Unknown violation. */
|
|
18
19
|
UNKNOWN_VIOLATION = "UNKNOWN_VIOLATION",
|
|
19
|
-
/** Domain
|
|
20
|
+
/** Domain isn't registered, or the current registrar can't confirm that it can be transferred. */
|
|
20
21
|
DOMAIN_NOT_FOUND = "DOMAIN_NOT_FOUND",
|
|
21
|
-
/** Authorization code isn't valid for this domain. */
|
|
22
|
+
/** Authorization code isn't valid for this domain. The Wix user must request a new code from the current registrar. */
|
|
22
23
|
DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID = "DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID",
|
|
23
|
-
/** TLD doesn't support transfers to Wix. */
|
|
24
|
+
/** Domain's TLD doesn't support transfers to Wix. */
|
|
24
25
|
DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED = "DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED",
|
|
25
|
-
/** A transfer
|
|
26
|
+
/** A transfer to Wix is already in progress for this domain. */
|
|
26
27
|
DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST = "DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST",
|
|
27
28
|
/** Domain is already registered with Wix. */
|
|
28
29
|
DOMAIN_ALREADY_TAKEN = "DOMAIN_ALREADY_TAKEN",
|
|
29
|
-
/**
|
|
30
|
+
/** Domain is a premium domain. Premium domains can't be transferred to Wix. */
|
|
30
31
|
TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED = "TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED",
|
|
31
32
|
/** Domain is locked with a `clientTransferProhibited` status. The Wix user must unlock it at the current registrar. */
|
|
32
33
|
DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED = "DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED",
|
|
33
|
-
/** Domain was registered less than 60 days ago. */
|
|
34
|
+
/** Domain was registered or last transferred less than 60 days ago. */
|
|
34
35
|
DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS = "DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS"
|
|
35
36
|
}
|
|
36
37
|
/** @enumType */
|
|
37
38
|
type ViolationWithLiterals = Violation | 'UNKNOWN_VIOLATION' | 'DOMAIN_NOT_FOUND' | 'DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID' | 'DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST' | 'DOMAIN_ALREADY_TAKEN' | 'TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED' | 'DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS';
|
|
38
39
|
interface ValidateAuthorizationCodeRequest {
|
|
39
40
|
/**
|
|
40
|
-
* Domain name to validate. For example, `
|
|
41
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
42
|
+
*
|
|
43
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
41
44
|
* @format HOSTNAME
|
|
42
45
|
* @readonly
|
|
43
46
|
*/
|
|
44
47
|
domain: string;
|
|
45
48
|
/**
|
|
46
|
-
* Authorization code
|
|
49
|
+
* Authorization code from the domain's current registrar. Also known as an EPP code or transfer code.
|
|
47
50
|
* @maxLength 225
|
|
48
51
|
*/
|
|
49
52
|
authorizationCode: string;
|
|
50
53
|
}
|
|
51
54
|
interface ValidateAuthorizationCodeResponse {
|
|
52
|
-
/** Validation result
|
|
55
|
+
/** Validation result, including any violations found. */
|
|
53
56
|
validationResult?: DomainTransferInValidationResult;
|
|
54
57
|
}
|
|
55
58
|
interface ValidateDomainTransferabilityRequest {
|
|
56
59
|
/**
|
|
57
|
-
* Domain name to validate. For example, `
|
|
60
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
61
|
+
*
|
|
62
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
58
63
|
* @format HOSTNAME
|
|
59
64
|
* @immutable
|
|
60
65
|
*/
|
|
61
66
|
domain: string;
|
|
62
67
|
}
|
|
63
68
|
interface ValidateDomainTransferabilityResponse {
|
|
64
|
-
/** Validation result
|
|
69
|
+
/** Validation result, including any violations found. */
|
|
65
70
|
validationResult?: DomainTransferInValidationResult;
|
|
66
71
|
}
|
|
67
72
|
/**
|
|
68
|
-
* Validates an authorization code for a domain to
|
|
73
|
+
* Validates an authorization code for transferring a domain to Wix.
|
|
69
74
|
*
|
|
70
|
-
* Checks
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
75
|
+
* Checks with the domain's current registrar whether the authorization code is valid for the specified domain. Call this method before starting a transfer to catch invalid or expired codes early.
|
|
76
|
+
*
|
|
77
|
+
* Validation problems are returned in `validationResult.violations`, not as errors. If the code isn't valid, the list includes `DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID`.
|
|
78
|
+
*
|
|
79
|
+
* To check whether the domain itself can be transferred, call [Validate Domain Transferability](https://dev.wix.com/docs/api-reference/account-level/domains/domain-transfer-in/validate-domain-transferability).
|
|
80
|
+
* @param domain - Domain name to validate, including the TLD. For example, `example.com`.
|
|
81
|
+
*
|
|
82
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
83
|
+
* @param authorizationCode - Authorization code from the domain's current registrar. Also known as an EPP code or transfer code.
|
|
74
84
|
* @public
|
|
75
85
|
* @documentationMaturity preview
|
|
76
86
|
* @requiredField authorizationCode
|
|
@@ -82,9 +92,14 @@ declare function validateAuthorizationCode(domain: string, authorizationCode: st
|
|
|
82
92
|
/**
|
|
83
93
|
* Validates whether a domain can be transferred to Wix.
|
|
84
94
|
*
|
|
85
|
-
* Checks domain
|
|
86
|
-
*
|
|
87
|
-
*
|
|
95
|
+
* Checks the domain against every transfer requirement in a single call: TLD support, premium status, whether the domain is already registered with Wix, and whether a transfer is already in progress. Call this method before starting a transfer to confirm eligibility.
|
|
96
|
+
*
|
|
97
|
+
* Validation problems are returned in `validationResult.violations`, not as errors. A domain can fail several checks at once, so the list can contain more than one violation. An empty list means the domain can be transferred.
|
|
98
|
+
*
|
|
99
|
+
* To validate the authorization code for the transfer, call [Validate Authorization Code](https://dev.wix.com/docs/api-reference/account-level/domains/domain-transfer-in/validate-authorization-code).
|
|
100
|
+
* @param domain - Domain name to validate, including the TLD. For example, `example.com`.
|
|
101
|
+
*
|
|
102
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
88
103
|
* @public
|
|
89
104
|
* @documentationMaturity preview
|
|
90
105
|
* @requiredField domain
|
|
@@ -1,68 +1,73 @@
|
|
|
1
1
|
import { ValidateAuthorizationCodeRequest as ValidateAuthorizationCodeRequest$1, ValidateAuthorizationCodeResponse as ValidateAuthorizationCodeResponse$1, ValidateDomainTransferabilityRequest as ValidateDomainTransferabilityRequest$1, ValidateDomainTransferabilityResponse as ValidateDomainTransferabilityResponse$1 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
|
-
/** A validation result contains the outcome of a domain
|
|
4
|
+
/** A domain transfer in validation result contains the outcome of checking a domain, or its authorization code, before transferring the domain to Wix from another registrar. An empty `violations` list means the domain passed every check. Otherwise, each violation identifies an issue the Wix user must resolve before the transfer can start. */
|
|
5
5
|
interface DomainTransferInValidationResult {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Validated domain name, including the TLD. For example, `example.com`.
|
|
8
8
|
* @format HOSTNAME
|
|
9
9
|
* @readonly
|
|
10
10
|
*/
|
|
11
11
|
id?: string | null;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Issues that prevent the transfer. Empty if the domain passed every check.
|
|
14
14
|
* @maxSize 100
|
|
15
15
|
*/
|
|
16
16
|
violations?: ViolationWithLiterals[];
|
|
17
17
|
}
|
|
18
18
|
declare enum Violation {
|
|
19
|
+
/** Unknown violation. */
|
|
19
20
|
UNKNOWN_VIOLATION = "UNKNOWN_VIOLATION",
|
|
20
|
-
/** Domain
|
|
21
|
+
/** Domain isn't registered, or the current registrar can't confirm that it can be transferred. */
|
|
21
22
|
DOMAIN_NOT_FOUND = "DOMAIN_NOT_FOUND",
|
|
22
|
-
/** Authorization code isn't valid for this domain. */
|
|
23
|
+
/** Authorization code isn't valid for this domain. The Wix user must request a new code from the current registrar. */
|
|
23
24
|
DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID = "DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID",
|
|
24
|
-
/** TLD doesn't support transfers to Wix. */
|
|
25
|
+
/** Domain's TLD doesn't support transfers to Wix. */
|
|
25
26
|
DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED = "DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED",
|
|
26
|
-
/** A transfer
|
|
27
|
+
/** A transfer to Wix is already in progress for this domain. */
|
|
27
28
|
DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST = "DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST",
|
|
28
29
|
/** Domain is already registered with Wix. */
|
|
29
30
|
DOMAIN_ALREADY_TAKEN = "DOMAIN_ALREADY_TAKEN",
|
|
30
|
-
/**
|
|
31
|
+
/** Domain is a premium domain. Premium domains can't be transferred to Wix. */
|
|
31
32
|
TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED = "TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED",
|
|
32
33
|
/** Domain is locked with a `clientTransferProhibited` status. The Wix user must unlock it at the current registrar. */
|
|
33
34
|
DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED = "DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED",
|
|
34
|
-
/** Domain was registered less than 60 days ago. */
|
|
35
|
+
/** Domain was registered or last transferred less than 60 days ago. */
|
|
35
36
|
DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS = "DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS"
|
|
36
37
|
}
|
|
37
38
|
/** @enumType */
|
|
38
39
|
type ViolationWithLiterals = Violation | 'UNKNOWN_VIOLATION' | 'DOMAIN_NOT_FOUND' | 'DOMAIN_TRANSFER_IN_AUTHORIZATION_CODE_NOT_VALID' | 'DOMAIN_TRANSFER_IN_TLD_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_REQUEST_ALREADY_EXIST' | 'DOMAIN_ALREADY_TAKEN' | 'TRANSFER_IN_PREMIUM_DOMAIN_NOT_SUPPORTED' | 'DOMAIN_TRANSFER_IN_CLIENT_TRANSFER_PROHIBITED' | 'DOMAIN_TRANSFER_IN_CREATION_DATE_LESS_THAN_60_DAYS';
|
|
39
40
|
interface ValidateAuthorizationCodeRequest {
|
|
40
41
|
/**
|
|
41
|
-
* Domain name to validate. For example, `
|
|
42
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
43
|
+
*
|
|
44
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
42
45
|
* @format HOSTNAME
|
|
43
46
|
* @readonly
|
|
44
47
|
*/
|
|
45
48
|
domain: string;
|
|
46
49
|
/**
|
|
47
|
-
* Authorization code
|
|
50
|
+
* Authorization code from the domain's current registrar. Also known as an EPP code or transfer code.
|
|
48
51
|
* @maxLength 225
|
|
49
52
|
*/
|
|
50
53
|
authorizationCode: string;
|
|
51
54
|
}
|
|
52
55
|
interface ValidateAuthorizationCodeResponse {
|
|
53
|
-
/** Validation result
|
|
56
|
+
/** Validation result, including any violations found. */
|
|
54
57
|
validationResult?: DomainTransferInValidationResult;
|
|
55
58
|
}
|
|
56
59
|
interface ValidateDomainTransferabilityRequest {
|
|
57
60
|
/**
|
|
58
|
-
* Domain name to validate. For example, `
|
|
61
|
+
* Domain name to validate, including the TLD. For example, `example.com`.
|
|
62
|
+
*
|
|
63
|
+
* A leading `www.` is removed and the name is converted to lowercase before validation. Subdomains aren't supported.
|
|
59
64
|
* @format HOSTNAME
|
|
60
65
|
* @immutable
|
|
61
66
|
*/
|
|
62
67
|
domain: string;
|
|
63
68
|
}
|
|
64
69
|
interface ValidateDomainTransferabilityResponse {
|
|
65
|
-
/** Validation result
|
|
70
|
+
/** Validation result, including any violations found. */
|
|
66
71
|
validationResult?: DomainTransferInValidationResult;
|
|
67
72
|
}
|
|
68
73
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_domains_transfer-in-validations",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/",
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"fqdn": "wix.premium.domains.v1.domain_transfer_in_validation_result"
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
|
-
"falconPackageHash": "
|
|
53
|
+
"falconPackageHash": "db358ed736f2494ed16556fb184c86d34c8e3d9a6b1194f8651693c9"
|
|
54
54
|
}
|