@wix/domains 1.0.0 → 1.0.1

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

@@ -1,3 +1,1194 @@
+/** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
+interface ConnectedDomain$1 {
+    /**
+     * ID of the connected domain. Identical to the domain name including TLD.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Domain name including TLD.
+     * Both root domains and subdomains are supported.
+     */
+    domain?: string;
+    /**
+     * How the domain is connected to the Wix site.
+     *
+     * + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
+     * + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
+     * + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
+     * + `"HIDDEN"`: The domain isn't visible to site visitors.
+     */
+    connectionType?: ConnectionType$1;
+    /**
+     * Information about the site to which the domain is assigned to and whether
+     * it's the primary domain or a redirect.
+     */
+    siteInfo?: SiteInfo$3;
+    /**
+     * Whether the site owner receives standard email notifications from Wix about
+     * the connected domain.
+     *
+     * Default: `false`
+     */
+    suppressNotifications?: boolean;
+    /**
+     * 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$3;
+}
+declare enum ConnectionType$1 {
+    /** Used by sub domain */
+    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
+    POINTING = "POINTING",
+    NAMESERVERS = "NAMESERVERS",
+    /**
+     * internal used by photography company.
+     * when a customer creates a photo album, each album has its sub domain and this sub domain
+     * is not visible in my domains page.
+     */
+    HIDDEN = "HIDDEN"
+}
+interface SiteInfo$3 extends SiteInfoAssignmentInfoOneOf$3 {
+    /**
+     * Extra details in case assignment type is redirect.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo$3;
+    /**
+     * ID of the site the domain is assigned to, will be taken from context.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * The assignment type the relationship will be based on:
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type
+     * + `"PRIMARY"`: There can only be one primary domain per site, the result of this assignment type is that the domain will lead directly to a site.
+     * + `"REDIRECT"`: There can be multiple redirect domains. the result of this assignment type is that the redirects will lead to the primary domain
+     * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
+     */
+    assignmentType?: AssignmentType$3;
+}
+/** @oneof */
+interface SiteInfoAssignmentInfoOneOf$3 {
+    /**
+     * Extra details in case assignment type is redirect.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo$3;
+}
+declare enum AssignmentType$3 {
+    UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
+    PRIMARY = "PRIMARY",
+    REDIRECT = "REDIRECT"
+}
+interface RedirectAssignmentInfo$3 {
+    /**
+     * Primary domain the redirect points to.
+     * @readonly
+     */
+    primaryDomain?: string;
+}
+declare enum DnsPropagationStatus$3 {
+    UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    IN_PROGRESS = "IN_PROGRESS"
+}
+interface CreateConnectedDomainRequest$1 {
+    /** Domain to connect. */
+    connectedDomain: ConnectedDomain$1;
+}
+interface CreateConnectedDomainResponse$1 {
+    /** Connected domain. */
+    connectedDomain?: ConnectedDomain$1;
+}
+interface GetConnectedDomainRequest$1 {
+    /** ID of the connected domain. Identical to the domain name including TLD. */
+    connectedDomainId: string;
+}
+interface GetConnectedDomainResponse$1 {
+    /** Retrieved connected domain. */
+    connectedDomain?: ConnectedDomain$1;
+}
+interface ListConnectedDomainsRequest$1 {
+    /** Cursor paging options. */
+    paging?: CursorPaging$3;
+}
+interface CursorPaging$3 {
+    /**
+     * 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 ListConnectedDomainsResponse$1 {
+    /** Metadata about the returned list of connected domains. */
+    pagingMetadata?: CursorPagingMetadata$3;
+    /** Retrieved connected domains. */
+    connectedDomains?: ConnectedDomain$1[];
+}
+interface CursorPagingMetadata$3 {
+    /** Number of domains returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors$3;
+    /**
+     * 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$3 {
+    /** 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 CreateConnectedDomainResponseNonNullableFields$1 {
+    connectedDomain?: {
+        id: string;
+        domain: string;
+        connectionType: ConnectionType$1;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$3;
+        };
+        suppressNotifications: boolean;
+        dnsPropagationStatus: DnsPropagationStatus$3;
+    };
+}
+interface GetConnectedDomainResponseNonNullableFields$1 {
+    connectedDomain?: {
+        id: string;
+        domain: string;
+        connectionType: ConnectionType$1;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$3;
+        };
+        suppressNotifications: boolean;
+        dnsPropagationStatus: DnsPropagationStatus$3;
+    };
+}
+interface ListConnectedDomainsResponseNonNullableFields$1 {
+    connectedDomains: {
+        id: string;
+        domain: string;
+        connectionType: ConnectionType$1;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$3;
+        };
+        suppressNotifications: boolean;
+        dnsPropagationStatus: DnsPropagationStatus$3;
+    }[];
+}
+
+/** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */
+interface ConnectedDomain {
+    /**
+     * ID of the connected domain. Identical to the domain name including TLD.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Domain name including TLD.
+     * Both root domains and subdomains are supported.
+     */
+    domain?: string;
+    /**
+     * How the domain is connected to the Wix site.
+     *
+     * + `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
+     * + `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
+     * + `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
+     * + `"HIDDEN"`: The domain isn't visible to site visitors.
+     */
+    connectionType?: ConnectionType;
+    /**
+     * Information about the site to which the domain is assigned to and whether
+     * it's the primary domain or a redirect.
+     */
+    siteInfo?: SiteInfo$2;
+    /**
+     * Whether the site owner receives standard email notifications from Wix about
+     * the connected domain.
+     *
+     * Default: `false`
+     */
+    suppressNotifications?: boolean;
+    /**
+     * 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$2;
+}
+declare enum ConnectionType {
+    /** Used by sub domain */
+    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
+    POINTING = "POINTING",
+    NAMESERVERS = "NAMESERVERS",
+    /**
+     * internal used by photography company.
+     * when a customer creates a photo album, each album has its sub domain and this sub domain
+     * is not visible in my domains page.
+     */
+    HIDDEN = "HIDDEN"
+}
+interface SiteInfo$2 extends SiteInfoAssignmentInfoOneOf$2 {
+    /**
+     * Extra details in case assignment type is redirect.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo$2;
+    /**
+     * ID of the site the domain is assigned to, will be taken from context.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * The assignment type the relationship will be based on:
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type
+     * + `"PRIMARY"`: There can only be one primary domain per site, the result of this assignment type is that the domain will lead directly to a site.
+     * + `"REDIRECT"`: There can be multiple redirect domains. the result of this assignment type is that the redirects will lead to the primary domain
+     * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
+     */
+    assignmentType?: AssignmentType$2;
+}
+/** @oneof */
+interface SiteInfoAssignmentInfoOneOf$2 {
+    /**
+     * Extra details in case assignment type is redirect.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo$2;
+}
+declare enum AssignmentType$2 {
+    UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
+    PRIMARY = "PRIMARY",
+    REDIRECT = "REDIRECT"
+}
+interface RedirectAssignmentInfo$2 {
+    /**
+     * Primary domain the redirect points to.
+     * @readonly
+     */
+    primaryDomain?: string;
+}
+declare enum DnsPropagationStatus$2 {
+    UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    IN_PROGRESS = "IN_PROGRESS"
+}
+interface CreateConnectedDomainRequest {
+    /** Domain to connect. */
+    connectedDomain: ConnectedDomain;
+}
+interface CreateConnectedDomainResponse {
+    /** Connected domain. */
+    connectedDomain?: ConnectedDomain;
+}
+interface GetConnectedDomainRequest {
+    /** ID of the connected domain. Identical to the domain name including TLD. */
+    connectedDomainId: string;
+}
+interface GetConnectedDomainResponse {
+    /** Retrieved connected domain. */
+    connectedDomain?: ConnectedDomain;
+}
+interface ListConnectedDomainsRequest {
+    /** Cursor paging options. */
+    paging?: CursorPaging$2;
+}
+interface CursorPaging$2 {
+    /**
+     * 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 ListConnectedDomainsResponse {
+    /** Metadata about the returned list of connected domains. */
+    pagingMetadata?: CursorPagingMetadata$2;
+    /** Retrieved connected domains. */
+    connectedDomains?: ConnectedDomain[];
+}
+interface CursorPagingMetadata$2 {
+    /** Number of domains returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors$2;
+    /**
+     * 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$2 {
+    /** 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 CreateConnectedDomainResponseNonNullableFields {
+    connectedDomain?: {
+        _id: string;
+        domain: string;
+        connectionType: ConnectionType;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$2;
+        };
+        suppressNotifications: boolean;
+        dnsPropagationStatus: DnsPropagationStatus$2;
+    };
+}
+interface GetConnectedDomainResponseNonNullableFields {
+    connectedDomain?: {
+        _id: string;
+        domain: string;
+        connectionType: ConnectionType;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$2;
+        };
+        suppressNotifications: boolean;
+        dnsPropagationStatus: DnsPropagationStatus$2;
+    };
+}
+interface ListConnectedDomainsResponseNonNullableFields {
+    connectedDomains: {
+        _id: string;
+        domain: string;
+        connectionType: ConnectionType;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType$2;
+        };
+        suppressNotifications: boolean;
+        dnsPropagationStatus: DnsPropagationStatus$2;
+    }[];
+}
+
+type __PublicMethodMetaInfo$3<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 createConnectedDomain(): __PublicMethodMetaInfo$3<'POST', {}, CreateConnectedDomainRequest, CreateConnectedDomainRequest$1, CreateConnectedDomainResponse & CreateConnectedDomainResponseNonNullableFields, CreateConnectedDomainResponse$1 & CreateConnectedDomainResponseNonNullableFields$1>;
+declare function getConnectedDomain(): __PublicMethodMetaInfo$3<'GET', {
+    connectedDomainId: string;
+}, GetConnectedDomainRequest, GetConnectedDomainRequest$1, GetConnectedDomainResponse & GetConnectedDomainResponseNonNullableFields, GetConnectedDomainResponse$1 & GetConnectedDomainResponseNonNullableFields$1>;
+declare function listConnectedDomains(): __PublicMethodMetaInfo$3<'GET', {}, ListConnectedDomainsRequest, ListConnectedDomainsRequest$1, ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields, ListConnectedDomainsResponse$1 & ListConnectedDomainsResponseNonNullableFields$1>;
+
+declare const meta$3_createConnectedDomain: typeof createConnectedDomain;
+declare const meta$3_getConnectedDomain: typeof getConnectedDomain;
+declare const meta$3_listConnectedDomains: typeof listConnectedDomains;
+declare namespace meta$3 {
+  export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_createConnectedDomain as createConnectedDomain, meta$3_getConnectedDomain as getConnectedDomain, meta$3_listConnectedDomains as listConnectedDomains };
+}
+
+/**
+ * A `connectedDomainSetupInfo` object holds information the connected domain's
+ * external registrar and some DNS records. You can use this information to guide
+ * the site owner through the domain's setup process.
+ */
+interface ConnectedDomainSetupInfo$1 extends ConnectedDomainSetupInfoDnsRecordsOneOf$1 {
+    /**
+     * Information about domains connected using nameservers. Available only for
+     * `{"connectionType": "NAMESERVERS"}`.
+     */
+    nameserverRecord?: NameserverRecord$1;
+    /**
+     * Information about domains connected by pointing.  Available only for
+     * `{"connectionType": "POINTING"}`.
+     * @readonly
+     */
+    pointingRecords?: PointingRecords$1;
+    /**
+     * Information about subdomains.  Available only for subdomains.
+     * @readonly
+     */
+    subdomainRecords?: SubdomainRecords$1;
+    /** ID of the connected domain. Identical to the domain name including TLD. */
+    connectedDomainId?: string;
+    /**
+     * Information about the external domain registrar including current name
+     * servers.
+     */
+    registrar?: Registrar$1;
+}
+/** @oneof */
+interface ConnectedDomainSetupInfoDnsRecordsOneOf$1 {
+    /**
+     * Information about domains connected using nameservers. Available only for
+     * `{"connectionType": "NAMESERVERS"}`.
+     */
+    nameserverRecord?: NameserverRecord$1;
+    /**
+     * Information about domains connected by pointing.  Available only for
+     * `{"connectionType": "POINTING"}`.
+     * @readonly
+     */
+    pointingRecords?: PointingRecords$1;
+    /**
+     * Information about subdomains.  Available only for subdomains.
+     * @readonly
+     */
+    subdomainRecords?: SubdomainRecords$1;
+}
+interface Registrar$1 {
+    /**
+     * Name of the external domain registrar. For subdomains it's the registrar of the root domain.
+     * @readonly
+     */
+    name?: string | null;
+    /**
+     * Values of the current name server records. In case you connect an external
+     * domain using name servers, site owners must replace these current name servers
+     * with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
+     * during the initial domain setup.
+     * The replacement can't be performed through Wix APIs, you must use the
+     * infrastructure of the external domain registrar. Read more about
+     * [connecting domains using nameservers](https://dev.wix.com/api/rest/account-level-apis/connected-domains/sample-flows#account-level-apis_connected-domains_sample-flows_connect-an-external-domain-using-nameservers).
+     * @readonly
+     */
+    nameServers?: string[];
+}
+/** Information about domains connected by nameservers. */
+interface NameserverRecord$1 {
+    /**
+     * Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
+     * @readonly
+     */
+    nsRecord?: NsRecord$1;
+}
+interface NsRecord$1 {
+    /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /** DNS record values. */
+    values?: string[];
+}
+/** Information about domains connected by pointing. */
+interface PointingRecords$1 {
+    /**
+     * [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).
+     * @readonly
+     */
+    aRecord?: ARecord$1;
+    /**
+     * [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).
+     * @readonly
+     */
+    cnameRecord?: CnameRecord$1;
+}
+interface ARecord$1 {
+    /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /** DNS record values. */
+    values?: string[];
+}
+interface CnameRecord$1 {
+    /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /** DNS record value. */
+    value?: string;
+}
+/** Information about subdomains. */
+interface SubdomainRecords$1 {
+    /**
+     * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
+     * @readonly
+     */
+    cnameRecords?: CnameRecord$1[];
+}
+interface GetConnectedDomainSetupInfoRequest$1 {
+    /**
+     * ID of the connected domain to retrieve setup information for.
+     * Identical to the domain name including TLD.
+     */
+    connectedDomainId: string;
+}
+interface GetConnectedDomainSetupInfoResponse$1 {
+    /** Retrieved setup information. */
+    connectedDomainSetupInfo?: ConnectedDomainSetupInfo$1;
+}
+interface GetConnectedDomainSetupInfoResponseNonNullableFields$1 {
+    connectedDomainSetupInfo?: {
+        nameserverRecord?: {
+            nsRecord?: {
+                hostName: string;
+                ttl: number;
+                values: string[];
+            };
+        };
+        pointingRecords?: {
+            aRecord?: {
+                hostName: string;
+                ttl: number;
+                values: string[];
+            };
+            cnameRecord?: {
+                hostName: string;
+                ttl: number;
+                value: string;
+            };
+        };
+        subdomainRecords?: {
+            cnameRecords: {
+                hostName: string;
+                ttl: number;
+                value: string;
+            }[];
+        };
+        connectedDomainId: string;
+        registrar?: {
+            nameServers: string[];
+        };
+    };
+}
+
+/**
+ * A `connectedDomainSetupInfo` object holds information the connected domain's
+ * external registrar and some DNS records. You can use this information to guide
+ * the site owner through the domain's setup process.
+ */
+interface ConnectedDomainSetupInfo extends ConnectedDomainSetupInfoDnsRecordsOneOf {
+    /**
+     * Information about domains connected using nameservers. Available only for
+     * `{"connectionType": "NAMESERVERS"}`.
+     */
+    nameserverRecord?: NameserverRecord;
+    /**
+     * Information about domains connected by pointing.  Available only for
+     * `{"connectionType": "POINTING"}`.
+     * @readonly
+     */
+    pointingRecords?: PointingRecords;
+    /**
+     * Information about subdomains.  Available only for subdomains.
+     * @readonly
+     */
+    subdomainRecords?: SubdomainRecords;
+    /** ID of the connected domain. Identical to the domain name including TLD. */
+    connectedDomainId?: string;
+    /**
+     * Information about the external domain registrar including current name
+     * servers.
+     */
+    registrar?: Registrar;
+}
+/** @oneof */
+interface ConnectedDomainSetupInfoDnsRecordsOneOf {
+    /**
+     * Information about domains connected using nameservers. Available only for
+     * `{"connectionType": "NAMESERVERS"}`.
+     */
+    nameserverRecord?: NameserverRecord;
+    /**
+     * Information about domains connected by pointing.  Available only for
+     * `{"connectionType": "POINTING"}`.
+     * @readonly
+     */
+    pointingRecords?: PointingRecords;
+    /**
+     * Information about subdomains.  Available only for subdomains.
+     * @readonly
+     */
+    subdomainRecords?: SubdomainRecords;
+}
+interface Registrar {
+    /**
+     * Name of the external domain registrar. For subdomains it's the registrar of the root domain.
+     * @readonly
+     */
+    name?: string | null;
+    /**
+     * Values of the current name server records. In case you connect an external
+     * domain using name servers, site owners must replace these current name servers
+     * with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`
+     * during the initial domain setup.
+     * The replacement can't be performed through Wix APIs, you must use the
+     * infrastructure of the external domain registrar. Read more about
+     * [connecting domains using nameservers](https://dev.wix.com/api/rest/account-level-apis/connected-domains/sample-flows#account-level-apis_connected-domains_sample-flows_connect-an-external-domain-using-nameservers).
+     * @readonly
+     */
+    nameServers?: string[];
+}
+/** Information about domains connected by nameservers. */
+interface NameserverRecord {
+    /**
+     * Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
+     * @readonly
+     */
+    nsRecord?: NsRecord;
+}
+interface NsRecord {
+    /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /** DNS record values. */
+    values?: string[];
+}
+/** Information about domains connected by pointing. */
+interface PointingRecords {
+    /**
+     * [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).
+     * @readonly
+     */
+    aRecord?: ARecord;
+    /**
+     * [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).
+     * @readonly
+     */
+    cnameRecord?: CnameRecord;
+}
+interface ARecord {
+    /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /** DNS record values. */
+    values?: string[];
+}
+interface CnameRecord {
+    /** Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain. */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /** DNS record value. */
+    value?: string;
+}
+/** Information about subdomains. */
+interface SubdomainRecords {
+    /**
+     * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
+     * @readonly
+     */
+    cnameRecords?: CnameRecord[];
+}
+interface GetConnectedDomainSetupInfoRequest {
+    /**
+     * ID of the connected domain to retrieve setup information for.
+     * Identical to the domain name including TLD.
+     */
+    connectedDomainId: string;
+}
+interface GetConnectedDomainSetupInfoResponse {
+    /** Retrieved setup information. */
+    connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
+}
+interface GetConnectedDomainSetupInfoResponseNonNullableFields {
+    connectedDomainSetupInfo?: {
+        nameserverRecord?: {
+            nsRecord?: {
+                hostName: string;
+                ttl: number;
+                values: string[];
+            };
+        };
+        pointingRecords?: {
+            aRecord?: {
+                hostName: string;
+                ttl: number;
+                values: string[];
+            };
+            cnameRecord?: {
+                hostName: string;
+                ttl: number;
+                value: string;
+            };
+        };
+        subdomainRecords?: {
+            cnameRecords: {
+                hostName: string;
+                ttl: number;
+                value: string;
+            }[];
+        };
+        connectedDomainId: string;
+        registrar?: {
+            nameServers: string[];
+        };
+    };
+}
+
+type __PublicMethodMetaInfo$2<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 getConnectedDomainSetupInfo(): __PublicMethodMetaInfo$2<'GET', {
+    connectedDomainId: string;
+}, GetConnectedDomainSetupInfoRequest, GetConnectedDomainSetupInfoRequest$1, GetConnectedDomainSetupInfoResponse & GetConnectedDomainSetupInfoResponseNonNullableFields, GetConnectedDomainSetupInfoResponse$1 & GetConnectedDomainSetupInfoResponseNonNullableFields$1>;
+
+declare const meta$2_getConnectedDomainSetupInfo: typeof getConnectedDomainSetupInfo;
+declare namespace meta$2 {
+  export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_getConnectedDomainSetupInfo as getConnectedDomainSetupInfo };
+}
+
+/** DNS zones hold information about the records that map a domain's URL to an IP address. */
+interface DnsZone$1 {
+    /** Domain name including the TLD. Both root domains and subdomains are supported. */
+    domainName?: string;
+    /**
+     * DNS records. You can only set up a single `record` object per DNS record
+     * type. If you want to specify multiple values for the same record type, you
+     * must save them in the `values` for the relevant type.
+     *
+     * Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
+     * Max: 5000 DNS records
+     */
+    records?: DnsRecord$1[];
+    /**
+     * ID of the Dns Zone. Identical to the domain name including TLD.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) are enabled.
+     *
+     * Default: `false`
+     */
+    dnssecEnabled?: boolean;
+}
+interface DnsRecord$1 {
+    /**
+     * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
+     *
+     * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
+     * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
+     * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
+     * + `NS`: Name server record. Describes which server contains the actual DNS record.
+     * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
+     * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
+     * + `MX`: MX record. Directs emails to mail servers.
+     * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
+     * + `SPF`: SPF record. Used for email authentication.
+     * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
+     * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
+     * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
+     */
+    type?: RecordType$1;
+    /**
+     * Host name. Can be a subdomain. For example, `domain.com` or
+     * `mail.domain.com`. Equal to the domain name, except for `CNAME` records.
+     */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /**
+     * DNS record values. Wix limits DNS records to 50 values per type. External
+     * providers may support a different maximum number of DNS records for a
+     * specific type, Wix doesn't validate that you don't exceed these external
+     * limits.
+     *
+     * Max: 50 records
+     */
+    values?: string[];
+}
+declare enum RecordType$1 {
+    UNKNOWN = "UNKNOWN",
+    A = "A",
+    AAAA = "AAAA",
+    NS = "NS",
+    SOA = "SOA",
+    CNAME = "CNAME",
+    MX = "MX",
+    TXT = "TXT",
+    SPF = "SPF",
+    SRV = "SRV",
+    PTR = "PTR",
+    NAPTR = "NAPTR"
+}
+interface CreateDnsZoneRequest$1 {
+    /** DNS zone to create. */
+    dnsZone: DnsZone$1;
+}
+interface CreateDnsZoneResponse$1 {
+    /** Created DNS zone. */
+    dnsZone?: DnsZone$1;
+}
+interface GetDnsZoneRequest$1 {
+    /** Domain to retrieve the DNS zone for. */
+    domainName: string;
+}
+interface GetDnsZoneResponse$1 {
+    /** Retrieved DNS zone. */
+    dnsZone?: DnsZone$1;
+}
+interface UpdateDnsZoneRequest$1 {
+    /** Domain to update the DNS zone for. Must include the TLD. */
+    domainName: string;
+    /**
+     * DNS records to add to the DNS zone.
+     *
+     * Max: 10 additions
+     */
+    additions?: DnsRecord$1[];
+    /**
+     * DNS records to remove from the DNS zone.
+     *
+     * Max: 10 deletions
+     */
+    deletions?: DnsRecord$1[];
+    /** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
+    dnssecEnabled?: boolean | null;
+}
+interface UpdateDnsZoneResponse$1 {
+    /** Updated DNS zone. */
+    dnsZone?: DnsZone$1;
+}
+interface DeleteDnsZoneRequest$1 {
+    /** Domain name to delete the DNS zone for. */
+    domainName: string;
+}
+interface DeleteDnsZoneResponse$1 {
+}
+interface PreviewDnsZoneRequest$1 {
+    /** Domain name to generate a DNS zone preview for. */
+    domainName: string;
+}
+interface PreviewDnsZoneResponse$1 {
+    /**
+     * DNS zone preview.
+     *
+     * Includes calculated `A`, `CNAME`, `NS` and `SOA` records.
+     */
+    dnsZone?: DnsZone$1;
+}
+interface CreateDnsZoneResponseNonNullableFields$1 {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType$1;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        id: string;
+        dnssecEnabled: boolean;
+    };
+}
+interface GetDnsZoneResponseNonNullableFields$1 {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType$1;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        id: string;
+        dnssecEnabled: boolean;
+    };
+}
+interface UpdateDnsZoneResponseNonNullableFields$1 {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType$1;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        id: string;
+        dnssecEnabled: boolean;
+    };
+}
+interface PreviewDnsZoneResponseNonNullableFields$1 {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType$1;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        id: string;
+        dnssecEnabled: boolean;
+    };
+}
+
+/** DNS zones hold information about the records that map a domain's URL to an IP address. */
+interface DnsZone {
+    /** Domain name including the TLD. Both root domains and subdomains are supported. */
+    domainName?: string;
+    /**
+     * DNS records. You can only set up a single `record` object per DNS record
+     * type. If you want to specify multiple values for the same record type, you
+     * must save them in the `values` for the relevant type.
+     *
+     * Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records
+     * Max: 5000 DNS records
+     */
+    records?: DnsRecord[];
+    /**
+     * ID of the Dns Zone. Identical to the domain name including TLD.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) are enabled.
+     *
+     * Default: `false`
+     */
+    dnssecEnabled?: boolean;
+}
+interface DnsRecord {
+    /**
+     * [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types).
+     *
+     * + `UNKNOWN`: Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`.
+     * + `A`: Address record. Most fundamental type of DNS record that indicates the IP address of a given domain.
+     * + `AAAA`: Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6).
+     * + `NS`: Name server record. Describes which server contains the actual DNS record.
+     * + `SOA`: [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds adminstrative information about the zone.
+     * + `CNAME`: [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name.
+     * + `MX`: MX record. Directs emails to mail servers.
+     * + `TXT`: [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human readable descriptions.
+     * + `SPF`: SPF record. Used for email authentication.
+     * + `SRV`: [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location.
+     * + `PTR`: Pointer record. Specifies which host is supported for a given IP address.
+     * + `NAPTR`: [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications.
+     */
+    type?: RecordType;
+    /**
+     * Host name. Can be a subdomain. For example, `domain.com` or
+     * `mail.domain.com`. Equal to the domain name, except for `CNAME` records.
+     */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /**
+     * DNS record values. Wix limits DNS records to 50 values per type. External
+     * providers may support a different maximum number of DNS records for a
+     * specific type, Wix doesn't validate that you don't exceed these external
+     * limits.
+     *
+     * Max: 50 records
+     */
+    values?: string[];
+}
+declare enum RecordType {
+    UNKNOWN = "UNKNOWN",
+    A = "A",
+    AAAA = "AAAA",
+    NS = "NS",
+    SOA = "SOA",
+    CNAME = "CNAME",
+    MX = "MX",
+    TXT = "TXT",
+    SPF = "SPF",
+    SRV = "SRV",
+    PTR = "PTR",
+    NAPTR = "NAPTR"
+}
+interface CreateDnsZoneRequest {
+    /** DNS zone to create. */
+    dnsZone: DnsZone;
+}
+interface CreateDnsZoneResponse {
+    /** Created DNS zone. */
+    dnsZone?: DnsZone;
+}
+interface GetDnsZoneRequest {
+    /** Domain to retrieve the DNS zone for. */
+    domainName: string;
+}
+interface GetDnsZoneResponse {
+    /** Retrieved DNS zone. */
+    dnsZone?: DnsZone;
+}
+interface UpdateDnsZoneRequest {
+    /** Domain to update the DNS zone for. Must include the TLD. */
+    domainName: string;
+    /**
+     * DNS records to add to the DNS zone.
+     *
+     * Max: 10 additions
+     */
+    additions?: DnsRecord[];
+    /**
+     * DNS records to remove from the DNS zone.
+     *
+     * Max: 10 deletions
+     */
+    deletions?: DnsRecord[];
+    /** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */
+    dnssecEnabled?: boolean | null;
+}
+interface UpdateDnsZoneResponse {
+    /** Updated DNS zone. */
+    dnsZone?: DnsZone;
+}
+interface DeleteDnsZoneRequest {
+    /** Domain name to delete the DNS zone for. */
+    domainName: string;
+}
+interface DeleteDnsZoneResponse {
+}
+interface PreviewDnsZoneRequest {
+    /** Domain name to generate a DNS zone preview for. */
+    domainName: string;
+}
+interface PreviewDnsZoneResponse {
+    /**
+     * DNS zone preview.
+     *
+     * Includes calculated `A`, `CNAME`, `NS` and `SOA` records.
+     */
+    dnsZone?: DnsZone;
+}
+interface CreateDnsZoneResponseNonNullableFields {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        _id: string;
+        dnssecEnabled: boolean;
+    };
+}
+interface GetDnsZoneResponseNonNullableFields {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        _id: string;
+        dnssecEnabled: boolean;
+    };
+}
+interface UpdateDnsZoneResponseNonNullableFields {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        _id: string;
+        dnssecEnabled: boolean;
+    };
+}
+interface PreviewDnsZoneResponseNonNullableFields {
+    dnsZone?: {
+        domainName: string;
+        records: {
+            type: RecordType;
+            hostName: string;
+            ttl: number;
+            values: string[];
+        }[];
+        _id: string;
+        dnssecEnabled: boolean;
+    };
+}
+
+type __PublicMethodMetaInfo$1<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 createDnsZone(): __PublicMethodMetaInfo$1<'POST', {}, CreateDnsZoneRequest, CreateDnsZoneRequest$1, CreateDnsZoneResponse & CreateDnsZoneResponseNonNullableFields, CreateDnsZoneResponse$1 & CreateDnsZoneResponseNonNullableFields$1>;
+declare function getDnsZone(): __PublicMethodMetaInfo$1<'GET', {
+    domainName: string;
+}, GetDnsZoneRequest, GetDnsZoneRequest$1, GetDnsZoneResponse & GetDnsZoneResponseNonNullableFields, GetDnsZoneResponse$1 & GetDnsZoneResponseNonNullableFields$1>;
+declare function updateDnsZone(): __PublicMethodMetaInfo$1<'PATCH', {
+    domainName: string;
+}, UpdateDnsZoneRequest, UpdateDnsZoneRequest$1, UpdateDnsZoneResponse & UpdateDnsZoneResponseNonNullableFields, UpdateDnsZoneResponse$1 & UpdateDnsZoneResponseNonNullableFields$1>;
+declare function deleteDnsZone(): __PublicMethodMetaInfo$1<'DELETE', {
+    domainName: string;
+}, DeleteDnsZoneRequest, DeleteDnsZoneRequest$1, DeleteDnsZoneResponse, DeleteDnsZoneResponse$1>;
+declare function previewDnsZone(): __PublicMethodMetaInfo$1<'GET', {
+    domainName: string;
+}, PreviewDnsZoneRequest, PreviewDnsZoneRequest$1, PreviewDnsZoneResponse & PreviewDnsZoneResponseNonNullableFields, PreviewDnsZoneResponse$1 & PreviewDnsZoneResponseNonNullableFields$1>;
+
+declare const meta$1_createDnsZone: typeof createDnsZone;
+declare const meta$1_deleteDnsZone: typeof deleteDnsZone;
+declare const meta$1_getDnsZone: typeof getDnsZone;
+declare const meta$1_previewDnsZone: typeof previewDnsZone;
+declare const meta$1_updateDnsZone: typeof updateDnsZone;
+declare namespace meta$1 {
+  export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_createDnsZone as createDnsZone, meta$1_deleteDnsZone as deleteDnsZone, meta$1_getDnsZone as getDnsZone, meta$1_previewDnsZone as previewDnsZone, meta$1_updateDnsZone as updateDnsZone };
+}
+
 /**
  * A registered domain is a domain that Wix has registered on behalf of a customer
  * with an external registar.
@@ -1450,4 +2641,4 @@ 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 };
+export { meta$2 as connectedDomainSetupInfo, meta$3 as connectedDomains, meta$1 as domainDns, meta as registeredDomains };