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

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

@@ -1,196 +0,0 @@
-/**
- * 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.
-     * @format HOSTNAME
-     */
-    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.
-     * @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. */
-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.
-     * @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[];
-}
-export 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. */
-export interface SubdomainRecords {
-    /**
-     * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
-     * @readonly
-     * @maxSize 2
-     */
-    cnameRecords?: CnameRecord[];
-}
-export 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;
-}
-export 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 */
-export type ConnectionTypeWithLiterals = ConnectionType | 'UNKNOWN_CONNECTION_TYPE' | 'POINTING' | 'NAMESERVERS' | 'HIDDEN';
-export interface GetSetupInfoResponse {
-    /** Retrieved setup information. */
-    domainSetupInfo?: ConnectedDomainSetupInfo;
-}
-export interface PreCreateConnectedDomainRequest {
-    /**
-     * Domain name including TLD
-     * @format HOSTNAME
-     */
-    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.
-     * @format HOSTNAME
-     */
-    connectedDomainId: string;
-}
-export interface GetConnectedDomainSetupInfoResponse {
-    /** Retrieved setup information. */
-    connectedDomainSetupInfo?: ConnectedDomainSetupInfo;
-}

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

@@ -1,12 +0,0 @@
-export var ConnectionType;
-(function (ConnectionType) {
-    /** There is no information about the connection type. */
-    ConnectionType["UNKNOWN_CONNECTION_TYPE"] = "UNKNOWN_CONNECTION_TYPE";
-    /** The domain is connected by pointing. Wix doesn't manage DNS information. */
-    ConnectionType["POINTING"] = "POINTING";
-    /** The domain is connected by nameservers. Wix manages DNS information. */
-    ConnectionType["NAMESERVERS"] = "NAMESERVERS";
-    /** The domain isn't visible to site visitors. */
-    ConnectionType["HIDDEN"] = "HIDDEN";
-})(ConnectionType || (ConnectionType = {}));
-//# sourceMappingURL=premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.types.js.map

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

@@ -1 +0,0 @@
-{"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":"AA0KA,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,yDAAyD;IACzD,qEAAmD,CAAA;IACnD,+EAA+E;IAC/E,uCAAqB,CAAA;IACrB,2EAA2E;IAC3E,6CAA2B,CAAA;IAC3B,iDAAiD;IACjD,mCAAiB,CAAA;AACnB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB"}

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

@@ -1,215 +0,0 @@
-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.
- */
-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.
-     * @format HOSTNAME
-     */
-    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.
-     * @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. */
-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.
-     * @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[];
-}
-export 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. */
-export interface SubdomainRecords {
-    /**
-     * [Canonical Name records](https://en.wikipedia.org/wiki/CNAME_record).
-     * @readonly
-     * @maxSize 2
-     */
-    cnameRecords?: CnameRecord[];
-}
-export 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;
-}
-export 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 */
-export type ConnectionTypeWithLiterals = ConnectionType | 'UNKNOWN_CONNECTION_TYPE' | 'POINTING' | 'NAMESERVERS' | 'HIDDEN';
-export interface GetSetupInfoResponse {
-    /** Retrieved setup information. */
-    domainSetupInfo?: ConnectedDomainSetupInfo;
-}
-export interface PreCreateConnectedDomainRequest {
-    /**
-     * Domain name including TLD
-     * @format HOSTNAME
-     */
-    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.
-     * @format HOSTNAME
-     */
-    connectedDomainId: string;
-}
-export 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
- */
-export declare function getConnectedDomainSetupInfo(connectedDomainId: string): Promise<NonNullablePaths<ConnectedDomainSetupInfo, ConnectedDomainSetupInfoNonNullablePaths>>;
-export {};

package/build/internal/es/src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js

@@ -1,54 +0,0 @@
-import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
-import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
-import * as ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfo from './premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.http.js';
-export var ConnectionType;
-(function (ConnectionType) {
-    /** There is no information about the connection type. */
-    ConnectionType["UNKNOWN_CONNECTION_TYPE"] = "UNKNOWN_CONNECTION_TYPE";
-    /** The domain is connected by pointing. Wix doesn't manage DNS information. */
-    ConnectionType["POINTING"] = "POINTING";
-    /** The domain is connected by nameservers. Wix manages DNS information. */
-    ConnectionType["NAMESERVERS"] = "NAMESERVERS";
-    /** The domain isn't visible to site visitors. */
-    ConnectionType["HIDDEN"] = "HIDDEN";
-})(ConnectionType || (ConnectionType = {}));
-/**
- * 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 async function getConnectedDomainSetupInfo(connectedDomainId) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        connectedDomainId: connectedDomainId,
-    });
-    const reqOpts = ambassadorWixPremiumDomainsV1ConnectedDomainSetupInfo.getConnectedDomainSetupInfo(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data)
-            ?.connectedDomainSetupInfo;
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { connectedDomainId: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['connectedDomainId']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-//# sourceMappingURL=premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.js","sourceRoot":"","sources":["../../../../src/premium-domains-v1-connected-domain-setup-info-connected-domain-setup-info.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,qDAAqD,MAAM,sFAAsF,CAAC;AA4K9J,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,yDAAyD;IACzD,qEAAmD,CAAA;IACnD,+EAA+E;IAC/E,uCAAqB,CAAA;IACrB,2EAA2E;IAC3E,6CAA2B,CAAA;IAC3B,iDAAiD;IACjD,mCAAiB,CAAA;AACnB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB;AAwDD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,iBAAyB;IAOzB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,iBAAiB,EAAE,iBAAiB;KACrC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,qDAAqD,CAAC,2BAA2B,CAC/E,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,wBAAyB,CAAC;IAChC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;YACvD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,mBAAmB,CAAC,CACtB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}