@wix/auto_sdk_domains_connected-domain-setup-info 1.0.0

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnectedDomainSetupInfo = void 0;
+const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
+const rest_modules_2 = require("@wix/sdk-runtime/rest-modules");
+function resolveComWixpressPremiumDomainConnectedConnectedDomainSetupInfoServiceUrl(opts) {
+    const domainToMappings = {
+        'www.wixapis.com': [
+            {
+                srcPath: '/domains/v1/connected-domains',
+                destPath: '/v1/connected-domains',
+            },
+            {
+                srcPath: '/domains/v1/connected-domain-setup-info',
+                destPath: '/v1/connected-domain-setup-info',
+            },
+            {
+                srcPath: '/v1/domain-setup-info',
+                destPath: '/v1/domain-setup-info',
+            },
+        ],
+        'manage._base_domain_': [
+            {
+                srcPath: '/v1/connected-domains',
+                destPath: '/v1/connected-domains',
+            },
+            {
+                srcPath: '/v1/connected-domain-setup-info',
+                destPath: '/v1/connected-domain-setup-info',
+            },
+            {
+                srcPath: '/v1/domain-setup-info',
+                destPath: '/v1/domain-setup-info',
+            },
+        ],
+        'www._base_domain_': [
+            {
+                srcPath: '/v1/connected-domains',
+                destPath: '/v1/connected-domains',
+            },
+            {
+                srcPath: '/v1/connected-domain-setup-info',
+                destPath: '/v1/connected-domain-setup-info',
+            },
+            {
+                srcPath: '/v1/domain-setup-info',
+                destPath: '/v1/domain-setup-info',
+            },
+        ],
+        'premium._base_domain_': [
+            {
+                srcPath: '/v1/connected-domains',
+                destPath: '/v1/connected-domains',
+            },
+            {
+                srcPath: '/v1/connected-domain-setup-info',
+                destPath: '/v1/connected-domain-setup-info',
+            },
+            {
+                srcPath: '/v1/domain-setup-info',
+                destPath: '/v1/domain-setup-info',
+            },
+        ],
+    };
+    return (0, rest_modules_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+const PACKAGE_NAME = '@wix/auto_sdk_domains_connected-domain-setup-info';
+/**
+ * Retrieves information for the initial setup of a connected domain.
+ *
+ *
+ * You must pass the relevant Wix account ID in the header of the call.
+ *
+ * > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ */
+function getConnectedDomainSetupInfo(payload) {
+    function __getConnectedDomainSetupInfo({ host }) {
+        const metadata = {
+            entityFqdn: 'wix.premium.domains.v1.connected_domain_setup_info',
+            method: 'GET',
+            methodFqn: 'com.wixpress.premium.domain.connected.ConnectedDomainSetupInfoService.GetConnectedDomainSetupInfo',
+            packageName: PACKAGE_NAME,
+            url: resolveComWixpressPremiumDomainConnectedConnectedDomainSetupInfoServiceUrl({
+                protoPath: '/v1/connected-domain-setup-info/{connectedDomainId}',
+                data: payload,
+                host,
+            }),
+            params: (0, rest_modules_1.toURLSearchParams)(payload),
+        };
+        return metadata;
+    }
+    return __getConnectedDomainSetupInfo;
+}
+exports.getConnectedDomainSetupInfo = getConnectedDomainSetupInfo;
+//# sourceMappingURL=premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.js.map

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.js","sourceRoot":"","sources":["../../../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,gEAA2D;AAI3D,SAAS,0EAA0E,CACjF,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,uBAAuB;aAClC;YACD;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,iCAAiC;aAC5C;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,uBAAuB;aAClC;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,iCAAiC;aAC5C;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,uBAAuB;aAClC;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,iCAAiC;aAC5C;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,uBAAuB;aAClC;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,iCAAiC;aAC5C;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,uBAAuB;aAClC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,mDAAmD,CAAC;AAEzE;;;;;;;GAOG;AACH,SAAgB,2BAA2B,CACzC,OAAe;IAEf,SAAS,6BAA6B,CAAC,EAAE,IAAI,EAAO;QAClD,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,oDAAoD;YAChE,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,mGAAmG;YACrG,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,0EAA0E,CAC7E;gBACE,SAAS,EAAE,qDAAqD;gBAChE,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CACF;YACD,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,6BAA6B,CAAC;AACvC,CAAC;AAxBD,kEAwBC"}

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.meta.d.ts

@@ -0,0 +1,15 @@
+import * as ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoTypes from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.js';
+import * as ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoUniversalTypes from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';
+export 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;
+};
+export declare function getConnectedDomainSetupInfo(): __PublicMethodMetaInfo<'GET', {
+    connectedDomainId: string;
+}, ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoUniversalTypes.GetConnectedDomainSetupInfoRequest, ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoTypes.GetConnectedDomainSetupInfoRequest, ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoUniversalTypes.GetConnectedDomainSetupInfoResponse & ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoUniversalTypes.GetConnectedDomainSetupInfoResponseNonNullableFields, ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoTypes.GetConnectedDomainSetupInfoResponse & ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfoTypes.GetConnectedDomainSetupInfoResponseNonNullableFields>;

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.meta.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnectedDomainSetupInfo = void 0;
+const ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfo = __importStar(require("./premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.js"));
+function getConnectedDomainSetupInfo() {
+    const payload = { connectedDomainId: ':connectedDomainId' };
+    const getRequestOptions = ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfo.getConnectedDomainSetupInfo(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'GET',
+        path: '/v1/connected-domain-setup-info/{connectedDomainId}',
+        pathParams: { connectedDomainId: 'connectedDomainId' },
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.getConnectedDomainSetupInfo = getConnectedDomainSetupInfo;
+//# sourceMappingURL=premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.meta.js.map

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.meta.js","sourceRoot":"","sources":["../../../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4KAA8J;AAsB9J,SAAgB,2BAA2B;IAUzC,MAAM,OAAO,GAAG,EAAE,iBAAiB,EAAE,oBAAoB,EAAS,CAAC;IAEnE,MAAM,iBAAiB,GACrB,qDAAqD,CAAC,2BAA2B,CAC/E,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,qDAAqD;QAC3D,UAAU,EAAE,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;QACtD,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAhCD,kEAgCC"}

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.d.ts

@@ -0,0 +1,21 @@
+import { HttpClient } from '@wix/sdk-types';
+import { ConnectedDomainSetupInfo, ConnectedDomainSetupInfoNonNullableFields } from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getConnectedDomainSetupInfo(httpClient: HttpClient): GetConnectedDomainSetupInfoSignature;
+interface GetConnectedDomainSetupInfoSignature {
+    /**
+     * Retrieves information for the initial setup of a connected domain.
+     *
+     *
+     * You must pass the relevant Wix account ID in the header of the call.
+     *
+     * > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
+     * @param - ID of the connected domain to retrieve setup information for.
+     * Identical to the domain name including TLD.
+     * @returns Retrieved setup information.
+     */
+    (connectedDomainId: string): Promise<ConnectedDomainSetupInfo & ConnectedDomainSetupInfoNonNullableFields>;
+}
+export { ARecord, CnameRecord, ConnectedDomainSetupInfo, ConnectedDomainSetupInfoDnsRecordsOneOf, ConnectedDomainSetupInfoNonNullableFields, ConnectionType, GetConnectedDomainSetupInfoRequest, GetConnectedDomainSetupInfoResponse, GetConnectedDomainSetupInfoResponseNonNullableFields, GetSetupInfoRequest, GetSetupInfoResponse, NameserverRecord, NsRecord, PointingRecords, PreCreateConnectedDomainRequest, PreCreateConnectedDomainResponse, Registrar, SubdomainRecords, } from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionType = exports.getConnectedDomainSetupInfo = exports.__metadata = void 0;
+const premium_domains_v1_connected_domain_setup_info_connected_domain_setup_info_universal_js_1 = require("./premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js");
+exports.__metadata = { PACKAGE_NAME: '@wix/domains' };
+function getConnectedDomainSetupInfo(httpClient) {
+    return (connectedDomainId) => (0, premium_domains_v1_connected_domain_setup_info_connected_domain_setup_info_universal_js_1.getConnectedDomainSetupInfo)(connectedDomainId, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getConnectedDomainSetupInfo = getConnectedDomainSetupInfo;
+var premium_domains_v1_connected_domain_setup_info_connected_domain_setup_info_universal_js_2 = require("./premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js");
+Object.defineProperty(exports, "ConnectionType", { enumerable: true, get: function () { return premium_domains_v1_connected_domain_setup_info_connected_domain_setup_info_universal_js_2.ConnectionType; } });
+//# sourceMappingURL=premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.js.map

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.js","sourceRoot":"","sources":["../../../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.ts"],"names":[],"mappings":";;;AACA,uMAImG;AAEtF,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAE3D,SAAgB,2BAA2B,CACzC,UAAsB;IAEtB,OAAO,CAAC,iBAAyB,EAAE,EAAE,CACnC,IAAA,qHAAoC,EAClC,iBAAiB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,kEASC;AAmBD,qMAmBmG;AAbjG,yLAAA,cAAc,OAAA"}

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.d.ts

@@ -0,0 +1,207 @@
+/**
+ * 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.
+ */
+export 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 */
+export 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;
+}
+export 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. */
+export interface NameserverRecord {
+    /**
+     * Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
+     * @readonly
+     */
+    nsRecord?: NsRecord;
+}
+export 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. */
+export 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;
+}
+export 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[];
+}
+export 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. */
+export interface SubdomainRecords {
+    /**
+     * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
+     * @readonly
+     */
+    cnameRecords?: CnameRecord[];
+}
+export interface GetSetupInfoRequest {
+    /** Domain name including TLD */
+    domain?: string;
+    /**
+     * How the domain should be to connected the Wix site.
+     *
+     * + `"UNKNOWN_CONNECTION_TYPE"`: supported only for subdomain.
+     * + `"POINTING"`: Get domain or subdomain setup by pointing
+     * + `"NAMESERVERS"`: Get domain setup by nameservers
+     * + `"HIDDEN"`: supported only for subdomain.
+     */
+    connectionType?: ConnectionType;
+    /** Whether to return registrar information or not. Default is false. */
+    includeRegistrar?: boolean;
+}
+export 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"
+}
+export interface GetSetupInfoResponse {
+    /** Retrieved setup information. */
+    domainSetupInfo?: ConnectedDomainSetupInfo;
+}
+export interface PreCreateConnectedDomainRequest {
+    /** Domain name including TLD */
+    domain?: string;
+}
+export interface PreCreateConnectedDomainResponse {
+}
+export interface GetConnectedDomainSetupInfoRequest {
+    /**
+     * ID of the connected domain to retrieve setup information for.
+     * Identical to the domain name including TLD.
+     */
+    connectedDomainId: string;
+}
+export interface GetConnectedDomainSetupInfoResponse {
+    /** Retrieved setup information. */
+    connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
+}
+interface NsRecordNonNullableFields {
+    hostName: string;
+    ttl: number;
+    values: string[];
+}
+interface NameserverRecordNonNullableFields {
+    nsRecord?: NsRecordNonNullableFields;
+}
+interface ARecordNonNullableFields {
+    hostName: string;
+    ttl: number;
+    values: string[];
+}
+interface CnameRecordNonNullableFields {
+    hostName: string;
+    ttl: number;
+    value: string;
+}
+interface PointingRecordsNonNullableFields {
+    aRecord?: ARecordNonNullableFields;
+    cnameRecord?: CnameRecordNonNullableFields;
+}
+interface SubdomainRecordsNonNullableFields {
+    cnameRecords: CnameRecordNonNullableFields[];
+}
+interface RegistrarNonNullableFields {
+    nameServers: string[];
+}
+interface ConnectedDomainSetupInfoNonNullableFields {
+    nameserverRecord?: NameserverRecordNonNullableFields;
+    pointingRecords?: PointingRecordsNonNullableFields;
+    subdomainRecords?: SubdomainRecordsNonNullableFields;
+    connectedDomainId: string;
+    registrar?: RegistrarNonNullableFields;
+}
+export interface GetConnectedDomainSetupInfoResponseNonNullableFields {
+    connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields;
+}
+export {};

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionType = void 0;
+var ConnectionType;
+(function (ConnectionType) {
+    /** Used by sub domain */
+    ConnectionType["UNKNOWN_CONNECTION_TYPE"] = "UNKNOWN_CONNECTION_TYPE";
+    ConnectionType["POINTING"] = "POINTING";
+    ConnectionType["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.
+     */
+    ConnectionType["HIDDEN"] = "HIDDEN";
+})(ConnectionType || (exports.ConnectionType = ConnectionType = {}));
+//# sourceMappingURL=premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.js.map

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.js","sourceRoot":"","sources":["../../../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.ts"],"names":[],"mappings":";;;AAkJA,IAAY,cAWX;AAXD,WAAY,cAAc;IACxB,yBAAyB;IACzB,qEAAmD,CAAA;IACnD,uCAAqB,CAAA;IACrB,6CAA2B,CAAA;IAC3B;;;;OAIG;IACH,mCAAiB,CAAA;AACnB,CAAC,EAXW,cAAc,8BAAd,cAAc,QAWzB"}

package/build/internal/cjs/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.d.ts

@@ -0,0 +1,223 @@
+/**
+ * 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.
+ */
+export 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 */
+export 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;
+}
+export 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. */
+export interface NameserverRecord {
+    /**
+     * Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).
+     * @readonly
+     */
+    nsRecord?: NsRecord;
+}
+export 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. */
+export 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;
+}
+export 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[];
+}
+export 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. */
+export interface SubdomainRecords {
+    /**
+     * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
+     * @readonly
+     */
+    cnameRecords?: CnameRecord[];
+}
+export interface GetSetupInfoRequest {
+    /** Domain name including TLD */
+    domain?: string;
+    /**
+     * How the domain should be to connected the Wix site.
+     *
+     * + `"UNKNOWN_CONNECTION_TYPE"`: supported only for subdomain.
+     * + `"POINTING"`: Get domain or subdomain setup by pointing
+     * + `"NAMESERVERS"`: Get domain setup by nameservers
+     * + `"HIDDEN"`: supported only for subdomain.
+     */
+    connectionType?: ConnectionType;
+    /** Whether to return registrar information or not. Default is false. */
+    includeRegistrar?: boolean;
+}
+export 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"
+}
+export interface GetSetupInfoResponse {
+    /** Retrieved setup information. */
+    domainSetupInfo?: ConnectedDomainSetupInfo;
+}
+export interface PreCreateConnectedDomainRequest {
+    /** Domain name including TLD */
+    domain?: string;
+}
+export interface PreCreateConnectedDomainResponse {
+}
+export interface GetConnectedDomainSetupInfoRequest {
+    /**
+     * ID of the connected domain to retrieve setup information for.
+     * Identical to the domain name including TLD.
+     */
+    connectedDomainId: string;
+}
+export interface GetConnectedDomainSetupInfoResponse {
+    /** Retrieved setup information. */
+    connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
+}
+interface NsRecordNonNullableFields {
+    hostName: string;
+    ttl: number;
+    values: string[];
+}
+interface NameserverRecordNonNullableFields {
+    nsRecord?: NsRecordNonNullableFields;
+}
+interface ARecordNonNullableFields {
+    hostName: string;
+    ttl: number;
+    values: string[];
+}
+interface CnameRecordNonNullableFields {
+    hostName: string;
+    ttl: number;
+    value: string;
+}
+interface PointingRecordsNonNullableFields {
+    aRecord?: ARecordNonNullableFields;
+    cnameRecord?: CnameRecordNonNullableFields;
+}
+interface SubdomainRecordsNonNullableFields {
+    cnameRecords: CnameRecordNonNullableFields[];
+}
+interface RegistrarNonNullableFields {
+    nameServers: string[];
+}
+export interface ConnectedDomainSetupInfoNonNullableFields {
+    nameserverRecord?: NameserverRecordNonNullableFields;
+    pointingRecords?: PointingRecordsNonNullableFields;
+    subdomainRecords?: SubdomainRecordsNonNullableFields;
+    connectedDomainId: string;
+    registrar?: RegistrarNonNullableFields;
+}
+export interface GetConnectedDomainSetupInfoResponseNonNullableFields {
+    connectedDomainSetupInfo?: ConnectedDomainSetupInfoNonNullableFields;
+}
+/**
+ * Retrieves information for the initial setup of a connected domain.
+ *
+ *
+ * You must pass the relevant Wix account ID in the header of the call.
+ *
+ * > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @param connectedDomainId - ID of the connected domain to retrieve setup information for.
+ * Identical to the domain name including TLD.
+ * @public
+ * @requiredField connectedDomainId
+ * @permissionId DOMAINS.READ_CONNECTED_DOMAINS
+ * @returns Retrieved setup information.
+ * @fqn com.wixpress.premium.domain.connected.ConnectedDomainSetupInfoService.GetConnectedDomainSetupInfo
+ */
+export declare function getConnectedDomainSetupInfo(connectedDomainId: string): Promise<ConnectedDomainSetupInfo & ConnectedDomainSetupInfoNonNullableFields>;
+export {};