@wix/auto_sdk_domains_connected-domain-setup-info 1.0.7 → 1.0.8

package/build/cjs/index.d.ts

@@ -1 +1,23 @@
-export * from './src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.context.js';
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { ConnectedDomainSetupInfo } from './index.typings.js';
+export { ARecord, CanChangeDomainOwnerRequest, CanChangeDomainOwnerResponse, CnameRecord, ConnectedDomainSetupInfoDnsRecordsOneOf, ConnectionType, GetConnectedDomainSetupInfoRequest, GetConnectedDomainSetupInfoResponse, GetSetupInfoRequest, GetSetupInfoResponse, NameserverRecord, NsRecord, PointingRecords, PreCreateConnectedDomainRequest, PreCreateConnectedDomainResponse, Registrar, SubdomainRecords } from './index.typings.js';
+
+declare function getConnectedDomainSetupInfo$1(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>;
+}
+
+declare const getConnectedDomainSetupInfo: MaybeContext<BuildRESTFunction<typeof getConnectedDomainSetupInfo$1> & typeof getConnectedDomainSetupInfo$1>;
+
+export { ConnectedDomainSetupInfo, getConnectedDomainSetupInfo };

package/build/cjs/index.js

@@ -1,18 +1,199 @@
 "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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.context.js"), exports);
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  ConnectionType: () => ConnectionType,
+  getConnectedDomainSetupInfo: () => getConnectedDomainSetupInfo4
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.ts
+var import_transform_error = require("@wix/sdk-runtime/transform-error");
+var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
+
+// src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_rest_modules2 = 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"
+      },
+      {
+        srcPath: "/premium/domains/v1/connected-domains",
+        destPath: "/v1/connected-domains"
+      },
+      {
+        srcPath: "/premium/domains/v1/connected-domain-setup-info",
+        destPath: "/v1/connected-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"
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/premium/domains/v1/connected-domains",
+        destPath: "/v1/connected-domains"
+      },
+      {
+        srcPath: "/premium/domains/v1/connected-domain-setup-info",
+        destPath: "/v1/connected-domain-setup-info"
+      }
+    ],
+    _: [
+      {
+        srcPath: "/premium/domains/v1/connected-domains",
+        destPath: "/v1/connected-domains"
+      },
+      {
+        srcPath: "/premium/domains/v1/connected-domain-setup-info",
+        destPath: "/v1/connected-domain-setup-info"
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_domains_connected-domain-setup-info";
+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, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __getConnectedDomainSetupInfo;
+}
+
+// src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.ts
+var ConnectionType = /* @__PURE__ */ ((ConnectionType2) => {
+  ConnectionType2["UNKNOWN_CONNECTION_TYPE"] = "UNKNOWN_CONNECTION_TYPE";
+  ConnectionType2["POINTING"] = "POINTING";
+  ConnectionType2["NAMESERVERS"] = "NAMESERVERS";
+  ConnectionType2["HIDDEN"] = "HIDDEN";
+  return ConnectionType2;
+})(ConnectionType || {});
+async function getConnectedDomainSetupInfo2(connectedDomainId) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    connectedDomainId
+  });
+  const reqOpts = getConnectedDomainSetupInfo(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data)?.connectedDomainSetupInfo;
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { connectedDomainId: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["connectedDomainId"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+
+// src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.ts
+function getConnectedDomainSetupInfo3(httpClient) {
+  return (connectedDomainId) => getConnectedDomainSetupInfo2(
+    connectedDomainId,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+
+// src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.context.ts
+var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
+var getConnectedDomainSetupInfo4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getConnectedDomainSetupInfo3);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ConnectionType,
+  getConnectedDomainSetupInfo
+});
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8HAA4G"}
+{"version":3,"sources":["../../index.ts","../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.ts","../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.ts","../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.ts","../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.context.ts"],"sourcesContent":["export * from './src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.context.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfo from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.js';\n\n/**\n * A `connectedDomainSetupInfo` object holds information the connected domain's\n * external registrar and some DNS records. You can use this information to guide\n * the site owner through the domain's setup process.\n */\nexport interface ConnectedDomainSetupInfo\n  extends ConnectedDomainSetupInfoDnsRecordsOneOf {\n  /**\n   * Information about domains connected using nameservers. Available only for\n   * `{\"connectionType\": \"NAMESERVERS\"}`.\n   */\n  nameserverRecord?: NameserverRecord;\n  /**\n   * Information about domains connected by pointing.  Available only for\n   * `{\"connectionType\": \"POINTING\"}`.\n   * @readonly\n   */\n  pointingRecords?: PointingRecords;\n  /**\n   * Information about subdomains.  Available only for subdomains.\n   * @readonly\n   */\n  subdomainRecords?: SubdomainRecords;\n  /**\n   * ID of the connected domain. Identical to the domain name including TLD.\n   * @format HOSTNAME\n   */\n  connectedDomainId?: string;\n  /**\n   * Information about the external domain registrar including current name\n   * servers.\n   */\n  registrar?: Registrar;\n}\n\n/** @oneof */\nexport interface ConnectedDomainSetupInfoDnsRecordsOneOf {\n  /**\n   * Information about domains connected using nameservers. Available only for\n   * `{\"connectionType\": \"NAMESERVERS\"}`.\n   */\n  nameserverRecord?: NameserverRecord;\n  /**\n   * Information about domains connected by pointing.  Available only for\n   * `{\"connectionType\": \"POINTING\"}`.\n   * @readonly\n   */\n  pointingRecords?: PointingRecords;\n  /**\n   * Information about subdomains.  Available only for subdomains.\n   * @readonly\n   */\n  subdomainRecords?: SubdomainRecords;\n}\n\nexport interface Registrar {\n  /**\n   * Name of the external domain registrar. For subdomains it's the registrar of the root domain.\n   * @readonly\n   */\n  name?: string | null;\n  /**\n   * Values of the current name server records. In case you connect an external\n   * domain using name servers, site owners must replace these current name servers\n   * with the new name servers found in `connectedDomainSetupInfo.nameserverRecord.nsRecord.values`\n   * during the initial domain setup.\n   * The replacement can't be performed through Wix APIs, you must use the\n   * infrastructure of the external domain registrar. Read more about\n   * [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).\n   * @readonly\n   */\n  nameServers?: string[];\n}\n\n/** Information about domains connected by nameservers. */\nexport interface NameserverRecord {\n  /**\n   * Default [nameserver record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#NS).\n   * @readonly\n   */\n  nsRecord?: NsRecord;\n}\n\nexport interface NsRecord {\n  /**\n   * Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain.\n   * @format HOSTNAME\n   */\n  hostName?: string;\n  /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */\n  ttl?: number;\n  /**\n   * DNS record values.\n   * @minSize 1\n   * @maxSize 10\n   */\n  values?: string[];\n}\n\n/** Information about domains connected by pointing. */\nexport interface PointingRecords {\n  /**\n   * [Address record](https://en.wikipedia.org/wiki/List_of_DNS_record_types#A).\n   * @readonly\n   */\n  aRecord?: ARecord;\n  /**\n   * [Canonical Name record](https://en.wikipedia.org/wiki/CNAME_record).\n   * @readonly\n   */\n  cnameRecord?: CnameRecord;\n}\n\nexport interface ARecord {\n  /**\n   * Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain.\n   * @format HOSTNAME\n   */\n  hostName?: string;\n  /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */\n  ttl?: number;\n  /**\n   * DNS record values.\n   * @minSize 1\n   * @maxSize 10\n   */\n  values?: string[];\n}\n\nexport interface CnameRecord {\n  /**\n   * Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain.\n   * @format HOSTNAME\n   */\n  hostName?: string;\n  /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */\n  ttl?: number;\n  /** DNS record value. */\n  value?: string;\n}\n\n/** Information about subdomains. */\nexport interface SubdomainRecords {\n  /**\n   * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).\n   * @readonly\n   * @maxSize 2\n   */\n  cnameRecords?: CnameRecord[];\n}\n\nexport interface GetSetupInfoRequest {\n  /**\n   * Domain name including TLD\n   * @format HOSTNAME\n   */\n  domain?: string;\n  /**\n   * How the domain should be to connected the Wix site.\n   *\n   * + `\"UNKNOWN_CONNECTION_TYPE\"`: supported only for subdomain.\n   * + `\"POINTING\"`: Get domain or subdomain setup by pointing\n   * + `\"NAMESERVERS\"`: Get domain setup by nameservers\n   * + `\"HIDDEN\"`: supported only for subdomain.\n   */\n  connectionType?: ConnectionTypeWithLiterals;\n  /** Whether to return registrar information or not. Default is false. */\n  includeRegistrar?: boolean;\n}\n\nexport enum ConnectionType {\n  /** There is no information about the connection type. */\n  UNKNOWN_CONNECTION_TYPE = 'UNKNOWN_CONNECTION_TYPE',\n  /** The domain is connected by pointing. Wix doesn't manage DNS information. */\n  POINTING = 'POINTING',\n  /** The domain is connected by nameservers. Wix manages DNS information. */\n  NAMESERVERS = 'NAMESERVERS',\n  /** The domain isn't visible to site visitors. */\n  HIDDEN = 'HIDDEN',\n}\n\n/** @enumType */\nexport type ConnectionTypeWithLiterals =\n  | ConnectionType\n  | 'UNKNOWN_CONNECTION_TYPE'\n  | 'POINTING'\n  | 'NAMESERVERS'\n  | 'HIDDEN';\n\nexport interface GetSetupInfoResponse {\n  /** Retrieved setup information. */\n  domainSetupInfo?: ConnectedDomainSetupInfo;\n}\n\nexport interface PreCreateConnectedDomainRequest {\n  /**\n   * Domain name including TLD\n   * @format HOSTNAME\n   */\n  domain?: string;\n}\n\nexport interface PreCreateConnectedDomainResponse {}\n\nexport interface CanChangeDomainOwnerRequest {\n  /**\n   * Domain name including TLD\n   * @format HOSTNAME\n   */\n  domain?: string;\n}\n\nexport interface CanChangeDomainOwnerResponse {\n  /** Whether the domain owner can be changed. */\n  canChangeOwner?: boolean;\n}\n\nexport interface GetConnectedDomainSetupInfoRequest {\n  /**\n   * ID of the connected domain to retrieve setup information for.\n   * Identical to the domain name including TLD.\n   * @format HOSTNAME\n   */\n  connectedDomainId: string;\n}\n\nexport interface GetConnectedDomainSetupInfoResponse {\n  /** Retrieved setup information. */\n  connectedDomainSetupInfo?: ConnectedDomainSetupInfo;\n}\n\ntype ConnectedDomainSetupInfoNonNullablePaths =\n  | `nameserverRecord.nsRecord.hostName`\n  | `nameserverRecord.nsRecord.ttl`\n  | `nameserverRecord.nsRecord.values`\n  | `pointingRecords.aRecord.hostName`\n  | `pointingRecords.aRecord.ttl`\n  | `pointingRecords.aRecord.values`\n  | `pointingRecords.cnameRecord.hostName`\n  | `pointingRecords.cnameRecord.ttl`\n  | `pointingRecords.cnameRecord.value`\n  | `subdomainRecords.cnameRecords`\n  | `subdomainRecords.cnameRecords.${number}.hostName`\n  | `subdomainRecords.cnameRecords.${number}.ttl`\n  | `subdomainRecords.cnameRecords.${number}.value`\n  | `connectedDomainId`\n  | `registrar.nameServers`;\n\n/**\n * Retrieves information for the initial setup of a connected domain.\n *\n *\n * You must pass the relevant Wix account ID in the header of the call.\n *\n * > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.\n * @param connectedDomainId - ID of the connected domain to retrieve setup information for.\n * Identical to the domain name including TLD.\n * @public\n * @requiredField connectedDomainId\n * @permissionId DOMAINS.READ_CONNECTED_DOMAINS\n * @returns Retrieved setup information.\n * @fqn com.wixpress.premium.domain.connected.ConnectedDomainSetupInfoService.GetConnectedDomainSetupInfo\n */\nexport async function getConnectedDomainSetupInfo(\n  connectedDomainId: string\n): Promise<\n  NonNullablePaths<\n    ConnectedDomainSetupInfo,\n    ConnectedDomainSetupInfoNonNullablePaths\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    connectedDomainId: connectedDomainId,\n  });\n\n  const reqOpts =\n    ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfo.getConnectedDomainSetupInfo(\n      payload\n    );\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)\n      ?.connectedDomainSetupInfo!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { connectedDomainId: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['connectedDomainId']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveComWixpressPremiumDomainConnectedConnectedDomainSetupInfoServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/domains/v1/connected-domains',\n        destPath: '/v1/connected-domains',\n      },\n      {\n        srcPath: '/domains/v1/connected-domain-setup-info',\n        destPath: '/v1/connected-domain-setup-info',\n      },\n      {\n        srcPath: '/v1/domain-setup-info',\n        destPath: '/v1/domain-setup-info',\n      },\n      {\n        srcPath: '/premium/domains/v1/connected-domains',\n        destPath: '/v1/connected-domains',\n      },\n      {\n        srcPath: '/premium/domains/v1/connected-domain-setup-info',\n        destPath: '/v1/connected-domain-setup-info',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/v1/connected-domains',\n        destPath: '/v1/connected-domains',\n      },\n      {\n        srcPath: '/v1/connected-domain-setup-info',\n        destPath: '/v1/connected-domain-setup-info',\n      },\n      {\n        srcPath: '/v1/domain-setup-info',\n        destPath: '/v1/domain-setup-info',\n      },\n    ],\n    'www._base_domain_': [\n      {\n        srcPath: '/v1/connected-domains',\n        destPath: '/v1/connected-domains',\n      },\n      {\n        srcPath: '/v1/connected-domain-setup-info',\n        destPath: '/v1/connected-domain-setup-info',\n      },\n      {\n        srcPath: '/v1/domain-setup-info',\n        destPath: '/v1/domain-setup-info',\n      },\n    ],\n    'premium._base_domain_': [\n      {\n        srcPath: '/v1/connected-domains',\n        destPath: '/v1/connected-domains',\n      },\n      {\n        srcPath: '/v1/connected-domain-setup-info',\n        destPath: '/v1/connected-domain-setup-info',\n      },\n      {\n        srcPath: '/v1/domain-setup-info',\n        destPath: '/v1/domain-setup-info',\n      },\n    ],\n    '*.dev.wix-code.com': [\n      {\n        srcPath: '/premium/domains/v1/connected-domains',\n        destPath: '/v1/connected-domains',\n      },\n      {\n        srcPath: '/premium/domains/v1/connected-domain-setup-info',\n        destPath: '/v1/connected-domain-setup-info',\n      },\n    ],\n    _: [\n      {\n        srcPath: '/premium/domains/v1/connected-domains',\n        destPath: '/v1/connected-domains',\n      },\n      {\n        srcPath: '/premium/domains/v1/connected-domain-setup-info',\n        destPath: '/v1/connected-domain-setup-info',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_domains_connected-domain-setup-info';\n\n/**\n * Retrieves information for the initial setup of a connected domain.\n *\n *\n * You must pass the relevant Wix account ID in the header of the call.\n *\n * > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.\n */\nexport function getConnectedDomainSetupInfo(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __getConnectedDomainSetupInfo({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.premium.domains.v1.connected_domain_setup_info',\n      method: 'GET' as any,\n      methodFqn:\n        'com.wixpress.premium.domain.connected.ConnectedDomainSetupInfoService.GetConnectedDomainSetupInfo',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressPremiumDomainConnectedConnectedDomainSetupInfoServiceUrl(\n        {\n          protoPath: '/v1/connected-domain-setup-info/{connectedDomainId}',\n          data: payload,\n          host,\n        }\n      ),\n      params: toURLSearchParams(payload),\n    };\n\n    return metadata;\n  }\n\n  return __getConnectedDomainSetupInfo;\n}\n","import { HttpClient } from '@wix/sdk-types';\nimport {\n  ConnectedDomainSetupInfo,\n  getConnectedDomainSetupInfo as universalGetConnectedDomainSetupInfo,\n} from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/domains' };\n\nexport function getConnectedDomainSetupInfo(\n  httpClient: HttpClient\n): GetConnectedDomainSetupInfoSignature {\n  return (connectedDomainId: string) =>\n    universalGetConnectedDomainSetupInfo(\n      connectedDomainId,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface GetConnectedDomainSetupInfoSignature {\n  /**\n   * Retrieves information for the initial setup of a connected domain.\n   *\n   *\n   * You must pass the relevant Wix account ID in the header of the call.\n   *\n   * > __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.\n   * @param - ID of the connected domain to retrieve setup information for.\n   * Identical to the domain name including TLD.\n   * @returns Retrieved setup information.\n   */\n  (connectedDomainId: string): Promise<ConnectedDomainSetupInfo>;\n}\n\nexport {\n  ARecord,\n  CanChangeDomainOwnerRequest,\n  CanChangeDomainOwnerResponse,\n  CnameRecord,\n  ConnectedDomainSetupInfo,\n  ConnectedDomainSetupInfoDnsRecordsOneOf,\n  ConnectionType,\n  GetConnectedDomainSetupInfoRequest,\n  GetConnectedDomainSetupInfoResponse,\n  GetSetupInfoRequest,\n  GetSetupInfoResponse,\n  NameserverRecord,\n  NsRecord,\n  PointingRecords,\n  PreCreateConnectedDomainRequest,\n  PreCreateConnectedDomainResponse,\n  Registrar,\n  SubdomainRecords,\n} from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';\n","import { getConnectedDomainSetupInfo as publicGetConnectedDomainSetupInfo } from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const getConnectedDomainSetupInfo: MaybeContext<\n  BuildRESTFunction<typeof publicGetConnectedDomainSetupInfo> &\n    typeof publicGetConnectedDomainSetupInfo\n> = /*#__PURE__*/ createRESTModule(publicGetConnectedDomainSetupInfo);\n\nexport { ConnectionType } from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';\nexport {\n  ConnectedDomainSetupInfo,\n  ConnectedDomainSetupInfoDnsRecordsOneOf,\n  Registrar,\n  NameserverRecord,\n  NsRecord,\n  PointingRecords,\n  ARecord,\n  CnameRecord,\n  SubdomainRecords,\n  GetSetupInfoRequest,\n  GetSetupInfoResponse,\n  PreCreateConnectedDomainRequest,\n  PreCreateConnectedDomainResponse,\n  CanChangeDomainOwnerRequest,\n  CanChangeDomainOwnerResponse,\n  GetConnectedDomainSetupInfoRequest,\n  GetConnectedDomainSetupInfoResponse,\n} from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,qCAAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,IAAAC,uBAA2B;AAI3B,SAAS,2EACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAUd,SAAS,4BACd,SAC4B;AAC5B,WAAS,8BAA8B,EAAE,KAAK,GAAQ;AACpD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK;AAAA,QACH;AAAA,UACE,WAAW;AAAA,UACX,MAAM;AAAA,UACN;AAAA,QACF;AAAA,MACF;AAAA,MACA,YAAQ,uCAAkB,OAAO;AAAA,IACnC;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;AD8CO,IAAK,iBAAL,kBAAKC,oBAAL;AAEL,EAAAA,gBAAA,6BAA0B;AAE1B,EAAAA,gBAAA,cAAW;AAEX,EAAAA,gBAAA,iBAAc;AAEd,EAAAA,gBAAA,YAAS;AARC,SAAAA;AAAA,GAAA;AA6FZ,eAAsBC,6BACpB,mBAMA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UACkD;AAAA,IACpD;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI,GACtD;AAAA,EACN,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,mBAAmB,OAAO;AAAA,QACtD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,mBAAmB;AAAA,IACtB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AEnTO,SAASC,6BACd,YACsC;AACtC,SAAO,CAAC,sBACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;AChBA,IAAAC,uBAAiC;AAG1B,IAAMC,+BAGK,2DAAiBA,4BAAiC;","names":["getConnectedDomainSetupInfo","import_rest_modules","ConnectionType","getConnectedDomainSetupInfo","sdkTransformError","getConnectedDomainSetupInfo","import_rest_modules","getConnectedDomainSetupInfo"]}

package/build/cjs/index.typings.d.ts

@@ -1 +1,228 @@
-export * from './src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js';
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * 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.
+     * @format HOSTNAME
+     */
+    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.
+     * @format HOSTNAME
+     */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /**
+     * DNS record values.
+     * @minSize 1
+     * @maxSize 10
+     */
+    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.
+     * @format HOSTNAME
+     */
+    hostName?: string;
+    /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */
+    ttl?: number;
+    /**
+     * DNS record values.
+     * @minSize 1
+     * @maxSize 10
+     */
+    values?: string[];
+}
+interface CnameRecord {
+    /**
+     * Domain host name. For example `domain.com` or `mail.domain.com`. Can be a subdomain.
+     * @format HOSTNAME
+     */
+    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
+     * @maxSize 2
+     */
+    cnameRecords?: CnameRecord[];
+}
+interface GetSetupInfoRequest {
+    /**
+     * Domain name including TLD
+     * @format HOSTNAME
+     */
+    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?: ConnectionTypeWithLiterals;
+    /** Whether to return registrar information or not. Default is false. */
+    includeRegistrar?: boolean;
+}
+declare enum ConnectionType {
+    /** There is no information about the connection type. */
+    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
+    /** The domain is connected by pointing. Wix doesn't manage DNS information. */
+    POINTING = "POINTING",
+    /** The domain is connected by nameservers. Wix manages DNS information. */
+    NAMESERVERS = "NAMESERVERS",
+    /** The domain isn't visible to site visitors. */
+    HIDDEN = "HIDDEN"
+}
+/** @enumType */
+type ConnectionTypeWithLiterals = ConnectionType | 'UNKNOWN_CONNECTION_TYPE' | 'POINTING' | 'NAMESERVERS' | 'HIDDEN';
+interface GetSetupInfoResponse {
+    /** Retrieved setup information. */
+    domainSetupInfo?: ConnectedDomainSetupInfo;
+}
+interface PreCreateConnectedDomainRequest {
+    /**
+     * Domain name including TLD
+     * @format HOSTNAME
+     */
+    domain?: string;
+}
+interface PreCreateConnectedDomainResponse {
+}
+interface CanChangeDomainOwnerRequest {
+    /**
+     * Domain name including TLD
+     * @format HOSTNAME
+     */
+    domain?: string;
+}
+interface CanChangeDomainOwnerResponse {
+    /** Whether the domain owner can be changed. */
+    canChangeOwner?: boolean;
+}
+interface GetConnectedDomainSetupInfoRequest {
+    /**
+     * ID of the connected domain to retrieve setup information for.
+     * Identical to the domain name including TLD.
+     * @format HOSTNAME
+     */
+    connectedDomainId: string;
+}
+interface GetConnectedDomainSetupInfoResponse {
+    /** Retrieved setup information. */
+    connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
+}
+type ConnectedDomainSetupInfoNonNullablePaths = `nameserverRecord.nsRecord.hostName` | `nameserverRecord.nsRecord.ttl` | `nameserverRecord.nsRecord.values` | `pointingRecords.aRecord.hostName` | `pointingRecords.aRecord.ttl` | `pointingRecords.aRecord.values` | `pointingRecords.cnameRecord.hostName` | `pointingRecords.cnameRecord.ttl` | `pointingRecords.cnameRecord.value` | `subdomainRecords.cnameRecords` | `subdomainRecords.cnameRecords.${number}.hostName` | `subdomainRecords.cnameRecords.${number}.ttl` | `subdomainRecords.cnameRecords.${number}.value` | `connectedDomainId` | `registrar.nameServers`;
+/**
+ * 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
+ */
+declare function getConnectedDomainSetupInfo(connectedDomainId: string): Promise<NonNullablePaths<ConnectedDomainSetupInfo, ConnectedDomainSetupInfoNonNullablePaths>>;
+
+export { type ARecord, type CanChangeDomainOwnerRequest, type CanChangeDomainOwnerResponse, type CnameRecord, type ConnectedDomainSetupInfo, type ConnectedDomainSetupInfoDnsRecordsOneOf, ConnectionType, type ConnectionTypeWithLiterals, type GetConnectedDomainSetupInfoRequest, type GetConnectedDomainSetupInfoResponse, type GetSetupInfoRequest, type GetSetupInfoResponse, type NameserverRecord, type NsRecord, type PointingRecords, type PreCreateConnectedDomainRequest, type PreCreateConnectedDomainResponse, type Registrar, type SubdomainRecords, getConnectedDomainSetupInfo };