@wix/domains 1.0.0

package/type-bundles/meta.bundle.d.ts

@@ -0,0 +1,1453 @@
+/**
+ * A registered domain is a domain that Wix has registered on behalf of a customer
+ * with an external registar.
+ */
+interface RegisteredDomain$1 extends RegisteredDomainStatusInfoOneOf$1 {
+    /**
+     * Information about a domain that hasn't been successfully registered
+     * yet. Includes the timestamp of the latest registration attempt.
+     * @readonly
+     */
+    pendingRegistrationInfo?: PendingRegistrationInfo$1;
+    /**
+     * Information about a domain that couldn't be registered. Includes
+     * failure code and message.
+     * @readonly
+     */
+    failedRegistrationInfo?: FailedRegistrationInfo$1;
+    /**
+     * Domain ID. Identical to `domain`.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Name of the domain including TLD.
+     * Subdomains aren't supported. You can only register a root domain.
+     * Domain name and TLD must be separated by a dot. For example,
+     * `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
+     * supported.
+     *
+     * Min: 3 characters
+     * Max: 63 characters
+     */
+    domain?: string;
+    /**
+     * ID of the product instance from the
+     * [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
+     * that belongs to the `registeredDomain` object.
+     * Your account must own a product that supports the chosen TLD, regardless of
+     * whether you want to assign the domain to a site or keep it floating. If
+     * you want to assign the domain to a site, the relevant site must also
+     * own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
+     * for more information about how to become a reseller and a list of available
+     * product IDs.
+     */
+    productInstanceId?: string;
+    /**
+     * Date and time the `registeredDomain` object was created in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the `registeredDomain` object was last updated in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /**
+     * Revision number, which increments by 1 each time the registered domain
+     * is updated. To prevent conflicting changes, the current revision must be
+     * passed when updating the registered domain.
+     *
+     * Ignored when creating a registered domain.
+     */
+    revision?: string | null;
+    /**
+     * Information about the Wix site the domain is connected to and whether the
+     * domain is assigned as the primary domain or a redirect.
+     */
+    siteInfo?: SiteInfo$1;
+    /**
+     * Contact details for the registrant, admin, and tech support of the registered domain.
+     * You can read more about which
+     * [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
+     * are implemented.
+     */
+    contacts?: Contacts$1;
+    /**
+     * Status of the registered domain.
+     *
+     * + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
+     * + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
+     * + `"ACTIVE"`: The domain has been registered successfully and is active.
+     * + `"FAILED_REGISTRATION"`: Wix has tried to register the domain, but has stopped the process due to too many failed attempts. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
+     * + `"CANCELED"`: The domain has been canceled and isn't active any longer.
+     * @readonly
+     */
+    status?: Status$1;
+    /**
+     * ICANN confirmation status.
+     *
+     * + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
+     * + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
+     * + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
+     * + `"EXPIRED"`: The domain hasn't been confirmed by all contacts before the ICANN confirmation process expired. The domain isn't active and a new confirmation process must be started. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
+     * @readonly
+     */
+    icannConfirmationStatus?: ICANNConfirmationStatus$1;
+    /**
+     * Details about the ICANN confirmation status.
+     * @readonly
+     */
+    icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo$1;
+    /**
+     * DNS propagation status.
+     *
+     * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
+     * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
+     * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
+     * + `"FAILED"`: The domain's DNS propagation process has failed.
+     * @readonly
+     */
+    dnsPropagationStatus?: DnsPropagationStatus$1;
+    /**
+     * Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
+     * format.
+     * @readonly
+     */
+    expirationDate?: Date;
+}
+/** @oneof */
+interface RegisteredDomainStatusInfoOneOf$1 {
+    /**
+     * Information about a domain that hasn't been successfully registered
+     * yet. Includes the timestamp of the latest registration attempt.
+     * @readonly
+     */
+    pendingRegistrationInfo?: PendingRegistrationInfo$1;
+    /**
+     * Information about a domain that couldn't be registered. Includes
+     * failure code and message.
+     * @readonly
+     */
+    failedRegistrationInfo?: FailedRegistrationInfo$1;
+}
+interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
+    /**
+     * Extra details if `{"assignmentType": `"REDIRECT"}`.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo$1;
+    /**
+     * ID of the site to which the domain is assigned.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Whether the domain is assigned as the primary domain or a redirect.
+     * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
+     * __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
+     * in the request of the Create Registered Domain call.
+     *
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
+     * + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
+     * + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
+     */
+    assignmentType?: AssignmentType$1;
+}
+/** @oneof */
+interface SiteInfoAssignmentInfoOneOf$1 {
+    /**
+     * Extra details if `{"assignmentType": `"REDIRECT"}`.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo$1;
+}
+declare enum AssignmentType$1 {
+    UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
+    PRIMARY = "PRIMARY",
+    REDIRECT = "REDIRECT"
+}
+interface RedirectAssignmentInfo$1 {
+    /**
+     * Primary domain the redirect points to.
+     * @readonly
+     */
+    primaryDomain?: string;
+}
+interface Contacts$1 {
+    /** Contact information for the domain registrant. */
+    registrant?: ContactData$1;
+    /** Contact information for the domain admin. */
+    admin?: ContactData$1;
+    /** Contact information for the tech support of the domain. */
+    tech?: ContactData$1;
+}
+interface ContactData$1 {
+    /**
+     * First name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    firstName?: string;
+    /**
+     * Last name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    lastName?: string;
+    /**
+     * Email address.  Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * and a single `@` are supported. Wix doesn't validate that the email address
+     * exists.
+     *
+     * Min: 3 characters
+     * Max: 64 characters before the `@` and 63 after
+     */
+    email?: string;
+    /**
+     * Address details, including street name and house number. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    address?: string;
+    /**
+     * City. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    city?: string;
+    /**
+     * Subdivision code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     * __Required__ for these countries:
+     * `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
+     * `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
+     * `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
+     * `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
+     * `"TW"`, `"UA"`, `"US"`, `”ZA”`.
+     *
+     * Min: 2 characters
+     * Max: 2 characters
+     */
+    subdivisionCode?: string | null;
+    /**
+     * Postal code. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 16 characters
+     */
+    postalCode?: string | null;
+    /**
+     * Country code in
+     * [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
+     * format. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported. Wix doesn't validate that the postal code is valid for the
+     * given country.
+     *
+     * Min: 2 characters
+     * Max: 2 characters
+     */
+    countryCode?: string;
+    /**
+     * Phone number. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported. For example, `+15551234567`. Wix doesn't validate that the
+     * phone number belongs to the specified country.
+     *
+     * Min: 2 characters
+     * Max: 20 characters
+     */
+    phone?: string;
+    /**
+     * Company name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Max: 2 characters
+     * Max: 64 characters
+     */
+    company?: string | null;
+}
+declare enum Status$1 {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    PENDING_REGISTRATION = "PENDING_REGISTRATION",
+    ACTIVE = "ACTIVE",
+    FAILED_REGISTRATION = "FAILED_REGISTRATION",
+    CANCELED = "CANCELED"
+}
+interface PendingRegistrationInfo$1 {
+    /**
+     * Information about the latest attempt to register
+     * the domain. Wix tries to register the domain several times if the
+     * first attempt is unsuccessful. You can contact the
+     * [Wix B2B team](mailto:bizdev@wix.com)
+     * for more information about the number of attempts and their timing.
+     * @readonly
+     */
+    latestAttempt?: LatestAttempt$1;
+}
+interface LatestAttempt$1 {
+    /**
+     * Number of the latest attempt to register the domain.
+     * @readonly
+     */
+    number?: number;
+    /**
+     * Date and time of the latest domain registration attempt in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    timestamp?: Date;
+}
+interface FailedRegistrationInfo$1 {
+    /**
+     * Failure code.
+     *
+     * + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
+     * + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
+     * @readonly
+     */
+    code?: FailureCode$1;
+    /**
+     * Failure message.
+     * @readonly
+     */
+    message?: string;
+}
+declare enum FailureCode$1 {
+    UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
+    OTHER = "OTHER"
+}
+/**
+ * he confirmation status types, a record:
+ * starts at pending
+ * ends either at confirmed_by_all or expired
+ */
+declare enum ICANNConfirmationStatus$1 {
+    UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
+    PENDING = "PENDING",
+    CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
+    EXPIRED = "EXPIRED"
+}
+interface ICANNConfirmationStatusInfo$1 extends ICANNConfirmationStatusInfoStatusOneOf$1 {
+    /** Details about domains with `"PENDING"` ICANN confirmation status. */
+    pending?: Pending$1;
+    /** Details about domains with `"EXPIRED"` ICANN confirmation status. */
+    expired?: Expired$1;
+}
+/** @oneof */
+interface ICANNConfirmationStatusInfoStatusOneOf$1 {
+    /** Details about domains with `"PENDING"` ICANN confirmation status. */
+    pending?: Pending$1;
+    /** Details about domains with `"EXPIRED"` ICANN confirmation status. */
+    expired?: Expired$1;
+}
+interface Pending$1 {
+    /**
+     * Expiration date of the ICANN confirmation process in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
+     * before this date or the domain won't be active.
+     */
+    expirationDate?: Date;
+    /**
+     * Email addresses of the contacts who haven't confirmed the domain with ICANN
+     * yet.
+     */
+    notConfirmedBy?: string[];
+}
+interface Expired$1 {
+    /**
+     * Email addresses of the contacts who haven't confirmed the domain with ICANN
+     * in time.
+     */
+    notConfirmedBy?: string[];
+}
+declare enum DnsPropagationStatus$1 {
+    UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    IN_PROGRESS = "IN_PROGRESS"
+}
+interface CreateRegisteredDomainRequest$1 {
+    /** Information about the domain to register including contact details. */
+    registeredDomain: RegisteredDomain$1;
+}
+interface CreateRegisteredDomainResponse$1 {
+    /** Created registered domain. */
+    registeredDomain?: RegisteredDomain$1;
+}
+interface GetRegisteredDomainRequest$1 {
+    /** ID of the registered domain to retrieve. */
+    registeredDomainId: string;
+}
+interface GetRegisteredDomainResponse$1 {
+    /** Retrieved registered domain. */
+    registeredDomain?: RegisteredDomain$1;
+}
+interface ListRegisteredDomainsRequest$1 {
+    /** Cursor paging options. */
+    paging?: CursorPaging$1;
+}
+interface CursorPaging$1 {
+    /**
+     * Number of domains to load.
+     *
+     * Min: `0`
+     * Max: `100`
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface ListRegisteredDomainsResponse$1 {
+    /** Metadata about the returned list of registered domains. */
+    pagingMetadata?: CursorPagingMetadata$1;
+    /** Retrieved registered domains. */
+    registeredDomains?: RegisteredDomain$1[];
+}
+interface CursorPagingMetadata$1 {
+    /** Number of domains returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors$1;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors$1 {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface RedeemRegisteredDomainRequest$1 {
+    /**
+     * ID of the registered domain to redeem. Identical to the domain name
+     * including TLD.
+     */
+    registeredDomainId: string;
+}
+interface RedeemRegisteredDomainResponse$1 {
+    /** Registered domain to redeem. */
+    registeredDomain?: RegisteredDomain$1;
+}
+interface CreateRegisteredDomainResponseNonNullableFields$1 {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode$1;
+            message: string;
+        };
+        id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$1;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status$1;
+        icannConfirmationStatus: ICANNConfirmationStatus$1;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus$1;
+    };
+}
+interface GetRegisteredDomainResponseNonNullableFields$1 {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode$1;
+            message: string;
+        };
+        id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$1;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status$1;
+        icannConfirmationStatus: ICANNConfirmationStatus$1;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus$1;
+    };
+}
+interface ListRegisteredDomainsResponseNonNullableFields$1 {
+    registeredDomains: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode$1;
+            message: string;
+        };
+        id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$1;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status$1;
+        icannConfirmationStatus: ICANNConfirmationStatus$1;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus$1;
+    }[];
+}
+interface RedeemRegisteredDomainResponseNonNullableFields$1 {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode$1;
+            message: string;
+        };
+        id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$1;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status$1;
+        icannConfirmationStatus: ICANNConfirmationStatus$1;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus$1;
+    };
+}
+
+/**
+ * A registered domain is a domain that Wix has registered on behalf of a customer
+ * with an external registar.
+ */
+interface RegisteredDomain extends RegisteredDomainStatusInfoOneOf {
+    /**
+     * Information about a domain that hasn't been successfully registered
+     * yet. Includes the timestamp of the latest registration attempt.
+     * @readonly
+     */
+    pendingRegistrationInfo?: PendingRegistrationInfo;
+    /**
+     * Information about a domain that couldn't be registered. Includes
+     * failure code and message.
+     * @readonly
+     */
+    failedRegistrationInfo?: FailedRegistrationInfo;
+    /**
+     * Domain ID. Identical to `domain`.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Name of the domain including TLD.
+     * Subdomains aren't supported. You can only register a root domain.
+     * Domain name and TLD must be separated by a dot. For example,
+     * `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
+     * supported.
+     *
+     * Min: 3 characters
+     * Max: 63 characters
+     */
+    domain?: string;
+    /**
+     * ID of the product instance from the
+     * [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
+     * that belongs to the `registeredDomain` object.
+     * Your account must own a product that supports the chosen TLD, regardless of
+     * whether you want to assign the domain to a site or keep it floating. If
+     * you want to assign the domain to a site, the relevant site must also
+     * own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
+     * for more information about how to become a reseller and a list of available
+     * product IDs.
+     */
+    productInstanceId?: string;
+    /**
+     * Date and time the `registeredDomain` object was created in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the `registeredDomain` object was last updated in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Revision number, which increments by 1 each time the registered domain
+     * is updated. To prevent conflicting changes, the current revision must be
+     * passed when updating the registered domain.
+     *
+     * Ignored when creating a registered domain.
+     */
+    revision?: string | null;
+    /**
+     * Information about the Wix site the domain is connected to and whether the
+     * domain is assigned as the primary domain or a redirect.
+     */
+    siteInfo?: SiteInfo;
+    /**
+     * Contact details for the registrant, admin, and tech support of the registered domain.
+     * You can read more about which
+     * [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
+     * are implemented.
+     */
+    contacts?: Contacts;
+    /**
+     * Status of the registered domain.
+     *
+     * + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
+     * + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
+     * + `"ACTIVE"`: The domain has been registered successfully and is active.
+     * + `"FAILED_REGISTRATION"`: Wix has tried to register the domain, but has stopped the process due to too many failed attempts. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
+     * + `"CANCELED"`: The domain has been canceled and isn't active any longer.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * ICANN confirmation status.
+     *
+     * + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
+     * + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
+     * + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
+     * + `"EXPIRED"`: The domain hasn't been confirmed by all contacts before the ICANN confirmation process expired. The domain isn't active and a new confirmation process must be started. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
+     * @readonly
+     */
+    icannConfirmationStatus?: ICANNConfirmationStatus;
+    /**
+     * Details about the ICANN confirmation status.
+     * @readonly
+     */
+    icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo;
+    /**
+     * DNS propagation status.
+     *
+     * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
+     * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
+     * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
+     * + `"FAILED"`: The domain's DNS propagation process has failed.
+     * @readonly
+     */
+    dnsPropagationStatus?: DnsPropagationStatus;
+    /**
+     * Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
+     * format.
+     * @readonly
+     */
+    expirationDate?: Date;
+}
+/** @oneof */
+interface RegisteredDomainStatusInfoOneOf {
+    /**
+     * Information about a domain that hasn't been successfully registered
+     * yet. Includes the timestamp of the latest registration attempt.
+     * @readonly
+     */
+    pendingRegistrationInfo?: PendingRegistrationInfo;
+    /**
+     * Information about a domain that couldn't be registered. Includes
+     * failure code and message.
+     * @readonly
+     */
+    failedRegistrationInfo?: FailedRegistrationInfo;
+}
+interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
+    /**
+     * Extra details if `{"assignmentType": `"REDIRECT"}`.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo;
+    /**
+     * ID of the site to which the domain is assigned.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Whether the domain is assigned as the primary domain or a redirect.
+     * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
+     * __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
+     * in the request of the Create Registered Domain call.
+     *
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
+     * + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
+     * + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
+     */
+    assignmentType?: AssignmentType;
+}
+/** @oneof */
+interface SiteInfoAssignmentInfoOneOf {
+    /**
+     * Extra details if `{"assignmentType": `"REDIRECT"}`.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo;
+}
+declare enum AssignmentType {
+    UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
+    PRIMARY = "PRIMARY",
+    REDIRECT = "REDIRECT"
+}
+interface RedirectAssignmentInfo {
+    /**
+     * Primary domain the redirect points to.
+     * @readonly
+     */
+    primaryDomain?: string;
+}
+interface Contacts {
+    /** Contact information for the domain registrant. */
+    registrant?: ContactData;
+    /** Contact information for the domain admin. */
+    admin?: ContactData;
+    /** Contact information for the tech support of the domain. */
+    tech?: ContactData;
+}
+interface ContactData {
+    /**
+     * First name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    firstName?: string;
+    /**
+     * Last name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    lastName?: string;
+    /**
+     * Email address.  Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * and a single `@` are supported. Wix doesn't validate that the email address
+     * exists.
+     *
+     * Min: 3 characters
+     * Max: 64 characters before the `@` and 63 after
+     */
+    email?: string;
+    /**
+     * Address details, including street name and house number. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    address?: string;
+    /**
+     * City. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    city?: string;
+    /**
+     * Subdivision code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     * __Required__ for these countries:
+     * `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
+     * `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
+     * `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
+     * `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
+     * `"TW"`, `"UA"`, `"US"`, `”ZA”`.
+     *
+     * Min: 2 characters
+     * Max: 2 characters
+     */
+    subdivisionCode?: string | null;
+    /**
+     * Postal code. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 16 characters
+     */
+    postalCode?: string | null;
+    /**
+     * Country code in
+     * [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
+     * format. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported. Wix doesn't validate that the postal code is valid for the
+     * given country.
+     *
+     * Min: 2 characters
+     * Max: 2 characters
+     */
+    countryCode?: string;
+    /**
+     * Phone number. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported. For example, `+15551234567`. Wix doesn't validate that the
+     * phone number belongs to the specified country.
+     *
+     * Min: 2 characters
+     * Max: 20 characters
+     */
+    phone?: string;
+    /**
+     * Company name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Max: 2 characters
+     * Max: 64 characters
+     */
+    company?: string | null;
+}
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    PENDING_REGISTRATION = "PENDING_REGISTRATION",
+    ACTIVE = "ACTIVE",
+    FAILED_REGISTRATION = "FAILED_REGISTRATION",
+    CANCELED = "CANCELED"
+}
+interface PendingRegistrationInfo {
+    /**
+     * Information about the latest attempt to register
+     * the domain. Wix tries to register the domain several times if the
+     * first attempt is unsuccessful. You can contact the
+     * [Wix B2B team](mailto:bizdev@wix.com)
+     * for more information about the number of attempts and their timing.
+     * @readonly
+     */
+    latestAttempt?: LatestAttempt;
+}
+interface LatestAttempt {
+    /**
+     * Number of the latest attempt to register the domain.
+     * @readonly
+     */
+    number?: number;
+    /**
+     * Date and time of the latest domain registration attempt in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    timestamp?: Date;
+}
+interface FailedRegistrationInfo {
+    /**
+     * Failure code.
+     *
+     * + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
+     * + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
+     * @readonly
+     */
+    code?: FailureCode;
+    /**
+     * Failure message.
+     * @readonly
+     */
+    message?: string;
+}
+declare enum FailureCode {
+    UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
+    OTHER = "OTHER"
+}
+/**
+ * he confirmation status types, a record:
+ * starts at pending
+ * ends either at confirmed_by_all or expired
+ */
+declare enum ICANNConfirmationStatus {
+    UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
+    PENDING = "PENDING",
+    CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
+    EXPIRED = "EXPIRED"
+}
+interface ICANNConfirmationStatusInfo extends ICANNConfirmationStatusInfoStatusOneOf {
+    /** Details about domains with `"PENDING"` ICANN confirmation status. */
+    pending?: Pending;
+    /** Details about domains with `"EXPIRED"` ICANN confirmation status. */
+    expired?: Expired;
+}
+/** @oneof */
+interface ICANNConfirmationStatusInfoStatusOneOf {
+    /** Details about domains with `"PENDING"` ICANN confirmation status. */
+    pending?: Pending;
+    /** Details about domains with `"EXPIRED"` ICANN confirmation status. */
+    expired?: Expired;
+}
+interface Pending {
+    /**
+     * Expiration date of the ICANN confirmation process in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
+     * before this date or the domain won't be active.
+     */
+    expirationDate?: Date;
+    /**
+     * Email addresses of the contacts who haven't confirmed the domain with ICANN
+     * yet.
+     */
+    notConfirmedBy?: string[];
+}
+interface Expired {
+    /**
+     * Email addresses of the contacts who haven't confirmed the domain with ICANN
+     * in time.
+     */
+    notConfirmedBy?: string[];
+}
+declare enum DnsPropagationStatus {
+    UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    IN_PROGRESS = "IN_PROGRESS"
+}
+interface CreateRegisteredDomainRequest {
+    /** Information about the domain to register including contact details. */
+    registeredDomain: RegisteredDomain;
+}
+interface CreateRegisteredDomainResponse {
+    /** Created registered domain. */
+    registeredDomain?: RegisteredDomain;
+}
+interface GetRegisteredDomainRequest {
+    /** ID of the registered domain to retrieve. */
+    registeredDomainId: string;
+}
+interface GetRegisteredDomainResponse {
+    /** Retrieved registered domain. */
+    registeredDomain?: RegisteredDomain;
+}
+interface ListRegisteredDomainsRequest {
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Number of domains to load.
+     *
+     * Min: `0`
+     * Max: `100`
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface ListRegisteredDomainsResponse {
+    /** Metadata about the returned list of registered domains. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Retrieved registered domains. */
+    registeredDomains?: RegisteredDomain[];
+}
+interface CursorPagingMetadata {
+    /** Number of domains returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface RedeemRegisteredDomainRequest {
+    /**
+     * ID of the registered domain to redeem. Identical to the domain name
+     * including TLD.
+     */
+    registeredDomainId: string;
+}
+interface RedeemRegisteredDomainResponse {
+    /** Registered domain to redeem. */
+    registeredDomain?: RegisteredDomain;
+}
+interface CreateRegisteredDomainResponseNonNullableFields {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    };
+}
+interface GetRegisteredDomainResponseNonNullableFields {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    };
+}
+interface ListRegisteredDomainsResponseNonNullableFields {
+    registeredDomains: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    }[];
+}
+interface RedeemRegisteredDomainResponseNonNullableFields {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    };
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createRegisteredDomain(): __PublicMethodMetaInfo<'POST', {}, CreateRegisteredDomainRequest, CreateRegisteredDomainRequest$1, CreateRegisteredDomainResponse & CreateRegisteredDomainResponseNonNullableFields, CreateRegisteredDomainResponse$1 & CreateRegisteredDomainResponseNonNullableFields$1>;
+declare function getRegisteredDomain(): __PublicMethodMetaInfo<'GET', {
+    registeredDomainId: string;
+}, GetRegisteredDomainRequest, GetRegisteredDomainRequest$1, GetRegisteredDomainResponse & GetRegisteredDomainResponseNonNullableFields, GetRegisteredDomainResponse$1 & GetRegisteredDomainResponseNonNullableFields$1>;
+declare function listRegisteredDomains(): __PublicMethodMetaInfo<'GET', {}, ListRegisteredDomainsRequest, ListRegisteredDomainsRequest$1, ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields, ListRegisteredDomainsResponse$1 & ListRegisteredDomainsResponseNonNullableFields$1>;
+declare function redeemRegisteredDomain(): __PublicMethodMetaInfo<'POST', {
+    registeredDomainId: string;
+}, RedeemRegisteredDomainRequest, RedeemRegisteredDomainRequest$1, RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields, RedeemRegisteredDomainResponse$1 & RedeemRegisteredDomainResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_createRegisteredDomain: typeof createRegisteredDomain;
+declare const meta_getRegisteredDomain: typeof getRegisteredDomain;
+declare const meta_listRegisteredDomains: typeof listRegisteredDomains;
+declare const meta_redeemRegisteredDomain: typeof redeemRegisteredDomain;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createRegisteredDomain as createRegisteredDomain, meta_getRegisteredDomain as getRegisteredDomain, meta_listRegisteredDomains as listRegisteredDomains, meta_redeemRegisteredDomain as redeemRegisteredDomain };
+}
+
+export { meta as registeredDomains };