@wix/auto_sdk_domains_dns-propagation 1.0.0

package/build/es/index.typings.d.mts

@@ -0,0 +1,372 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * The DNS (Domain Name System) propagation object contains information for a domain.
+ * Tracks whether the DNS records are correctly configured and propagated globally.
+ * Learn more [about DNS propagation](https://support.wix.com/en/article/about-domain-propagation).
+ */
+interface DnsPropagation extends DnsPropagationStatusInfoOneOf {
+    /**
+     * Details about DNS propagation failure, including which record types failed.
+     * Only present when `status` is `FAILED`.
+     * @readonly
+     */
+    failureInfo?: FailedStatusInfo;
+    /**
+     * ID of the DNS propagation. Identical to the domain name, including the [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology) (top-level domain).
+     * @format HOSTNAME
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Domain name, including the [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology). Both root domains and subdomains are supported.
+     * @format HOSTNAME
+     */
+    domain?: string;
+    /**
+     * Revision number, which increments by 1 each time the DNS propagation
+     * is updated. Ignored when creating a DNS propagation.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the DNS propagation was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the DNS propagation was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Current status of the DNS propagation. Can take up to 3 days to complete.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * Whether Wix name servers were detected among the domain's name servers.
+     * For subdomains, this value matches the root domain's setting.
+     * @readonly
+     */
+    dnsResolverIncludesWixNs?: boolean | null;
+}
+/** @oneof */
+interface DnsPropagationStatusInfoOneOf {
+    /**
+     * Details about DNS propagation failure, including which record types failed.
+     * Only present when `status` is `FAILED`.
+     * @readonly
+     */
+    failureInfo?: FailedStatusInfo;
+}
+declare enum Status {
+    /** DNS propagation completed successfully. All required DNS records are properly configured and propagated. */
+    SUCCEEDED = "SUCCEEDED",
+    /** DNS propagation failed. One or more DNS records are incorrectly configured or haven't propagated. */
+    FAILED = "FAILED",
+    /** DNS propagation is in progress. Check again later for updated status. */
+    IN_PROGRESS = "IN_PROGRESS"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'SUCCEEDED' | 'FAILED' | 'IN_PROGRESS';
+interface FailedStatusInfo {
+    /**
+     * The DNS record types that failed propagation.
+     *
+     * Max: 3 invalid records
+     * @readonly
+     */
+    invalidRecords?: InvalidRecordWithLiterals[];
+    /**
+     * Details about the A record for which the DNS propagation has failed.
+     * Includes all expected and current values of the A record.
+     * @readonly
+     */
+    invalidARecordInfo?: InvalidRecordInfo;
+    /**
+     * Details about the NS (nameserver) record for which the DNS propagation has failed.
+     * Includes all expected and current values of the NS record.
+     * @readonly
+     */
+    invalidNsRecordInfo?: InvalidRecordInfo;
+    /**
+     * Details about the CNAME record for which the DNS propagation has failed.
+     * Includes all expected and current values of the CNAME records.
+     * @readonly
+     */
+    invalidCnameRecordInfo?: InvalidRecordInfo;
+}
+declare enum InvalidRecord {
+    /** The propagation of the A record has failed. */
+    INVALID_A_RECORD = "INVALID_A_RECORD",
+    /** The propagation of the NS record has failed. */
+    INVALID_NS_RECORD = "INVALID_NS_RECORD",
+    /** The propagation of at least one CNAME record has failed. */
+    INVALID_CNAME_RECORD = "INVALID_CNAME_RECORD"
+}
+/** @enumType */
+type InvalidRecordWithLiterals = InvalidRecord | 'INVALID_A_RECORD' | 'INVALID_NS_RECORD' | 'INVALID_CNAME_RECORD';
+interface InvalidRecordInfo {
+    /**
+     * The DNS records that should be configured in the external database. Note that there can only be a single A and NS record.
+     *
+     * Max: 10 DNS records
+     * @maxSize 10
+     * @readonly
+     */
+    expectedDnsRecords?: DnsRecord[];
+    /**
+     * DNS records currently configured in the external database. Note that there can only be a single A and NS record.
+     * @maxSize 10
+     * @readonly
+     */
+    actualDnsRecords?: DnsRecord[];
+}
+interface DnsRecord {
+    /**
+     * Hostname for the DNS record. For example, `domain.com` or `mail.domain.com`. Supports both root domains and subdomains.
+     * @format HOSTNAME
+     * @readonly
+     */
+    hostName?: string;
+    /**
+     * Values associated with the DNS record. For example, IP addresses for A records or server names for NS records.
+     *
+     * Min: 1 value
+     * Max: 10 values
+     * @minSize 1
+     * @maxSize 10
+     * @readonly
+     */
+    values?: string[];
+}
+interface CreateDnsPropagationRequest {
+    /** DNS propagation to create. */
+    dnsPropagation?: DnsPropagation;
+}
+interface CreateDnsPropagationResponse {
+    /** Created DNS propagation. */
+    dnsPropagation?: DnsPropagation;
+}
+interface GetDnsPropagationRequest {
+    /**
+     * ID of the DNS propagation to retrieve. Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).
+     * @format HOSTNAME
+     */
+    dnsPropagationId: string;
+}
+interface GetDnsPropagationResponse {
+    /** Retrieved DNS propagation. */
+    dnsPropagation?: DnsPropagation;
+}
+interface CheckDnsPropagationRequest {
+    /**
+     * ID of the DNS propagation to check the propagation status for.
+     * Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).
+     * @format HOSTNAME
+     */
+    dnsPropagationId?: string;
+}
+interface CheckDnsPropagationResponse {
+    /** Retrieved DNS propagation with current status. */
+    dnsPropagation?: DnsPropagation;
+}
+interface ScheduleDnsPropagationChecksRequest {
+    /**
+     * ID of the DNS propagation to schedule a check for.
+     * Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).
+     * @format HOSTNAME
+     */
+    dnsPropagationId?: string;
+}
+interface ScheduleDnsPropagationChecksResponse {
+}
+interface SyncDnsPropagationDomainRequest {
+    /**
+     * ID of the DNS propagation to synchronize.
+     * Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).
+     * @format HOSTNAME
+     */
+    dnsPropagationId?: string;
+    /**
+     * Whether to perform a dry run without making actual changes.
+     *
+     * If true, reports sync issues without applying any fixes.
+     * If false, attempts to resolve detected issues.
+     *
+     * Default: `false`
+     */
+    dryRunEnabled?: boolean | null;
+}
+interface SyncDnsPropagationDomainResponse {
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/**
+ * Retrieves DNS propagation status for a domain.
+ *
+ * Use this method to check if DNS records are properly configured and propagated after connecting a custom domain,
+ * during domain setup to see required DNS records, or to monitor ongoing propagation status after making DNS changes.
+ * @param dnsPropagationId - ID of the DNS propagation to retrieve. Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dnsPropagationId
+ * @permissionId DOMAINS.READ_DNS_PROPAGATION
+ * @returns Retrieved DNS propagation.
+ * @fqn com.wixpress.premium.domain.propagation.v1.DnsPropagationService.GetDnsPropagation
+ */
+declare function getDnsPropagation(dnsPropagationId: string): Promise<NonNullablePaths<DnsPropagation, `failureInfo.invalidRecords` | `failureInfo.invalidARecordInfo.expectedDnsRecords` | `failureInfo.invalidARecordInfo.expectedDnsRecords.${number}.hostName` | `failureInfo.invalidARecordInfo.actualDnsRecords` | `_id` | `domain` | `status`, 6>>;
+
+export { type AccountInfo, type ActionEvent, type CheckDnsPropagationRequest, type CheckDnsPropagationResponse, type CreateDnsPropagationRequest, type CreateDnsPropagationResponse, type DnsPropagation, type DnsPropagationStatusInfoOneOf, type DnsRecord, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailedStatusInfo, type GetDnsPropagationRequest, type GetDnsPropagationResponse, type IdentificationData, type IdentificationDataIdOneOf, InvalidRecord, type InvalidRecordInfo, type InvalidRecordWithLiterals, type MessageEnvelope, type RestoreInfo, type ScheduleDnsPropagationChecksRequest, type ScheduleDnsPropagationChecksResponse, Status, type StatusWithLiterals, type SyncDnsPropagationDomainRequest, type SyncDnsPropagationDomainResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getDnsPropagation };

package/build/es/index.typings.mjs

@@ -0,0 +1,122 @@
+// src/premium-domains-v1-dns-propagation-dns-propagation.universal.ts
+import { transformError as sdkTransformError } from "@wix/sdk-runtime/transform-error";
+import {
+  renameKeysFromSDKRequestToRESTRequest,
+  renameKeysFromRESTResponseToSDKResponse
+} from "@wix/sdk-runtime/rename-all-nested-keys";
+
+// src/premium-domains-v1-dns-propagation-dns-propagation.http.ts
+import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
+import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
+import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
+function resolveComWixpressPremiumDomainPropagationV1DnsPropagationServiceUrl(opts) {
+  const domainToMappings = {
+    "www.wixapis.com": [
+      {
+        srcPath: "/premium/domains/v1/dns-propagations",
+        destPath: "/v1/dns-propagations"
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/premium/domains/v1/dns-propagations",
+        destPath: "/v1/dns-propagations"
+      }
+    ],
+    _: [
+      {
+        srcPath: "/premium/domains/v1/dns-propagations",
+        destPath: "/v1/dns-propagations"
+      }
+    ]
+  };
+  return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_domains_dns-propagation";
+function getDnsPropagation(payload) {
+  function __getDnsPropagation({ host }) {
+    const metadata = {
+      entityFqdn: "wix.premium.domains.v1.dns_propagation",
+      method: "GET",
+      methodFqn: "com.wixpress.premium.domain.propagation.v1.DnsPropagationService.GetDnsPropagation",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveComWixpressPremiumDomainPropagationV1DnsPropagationServiceUrl(
+        {
+          protoPath: "/v1/dns-propagations/{dnsPropagationId}",
+          data: payload,
+          host
+        }
+      ),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "dnsPropagation.createdDate" },
+            { path: "dnsPropagation.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getDnsPropagation;
+}
+
+// src/premium-domains-v1-dns-propagation-dns-propagation.universal.ts
+var Status = /* @__PURE__ */ ((Status2) => {
+  Status2["SUCCEEDED"] = "SUCCEEDED";
+  Status2["FAILED"] = "FAILED";
+  Status2["IN_PROGRESS"] = "IN_PROGRESS";
+  return Status2;
+})(Status || {});
+var InvalidRecord = /* @__PURE__ */ ((InvalidRecord2) => {
+  InvalidRecord2["INVALID_A_RECORD"] = "INVALID_A_RECORD";
+  InvalidRecord2["INVALID_NS_RECORD"] = "INVALID_NS_RECORD";
+  InvalidRecord2["INVALID_CNAME_RECORD"] = "INVALID_CNAME_RECORD";
+  return InvalidRecord2;
+})(InvalidRecord || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+async function getDnsPropagation2(dnsPropagationId) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    dnsPropagationId
+  });
+  const reqOpts = getDnsPropagation(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data)?.dnsPropagation;
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { dnsPropagationId: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["dnsPropagationId"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+export {
+  InvalidRecord,
+  Status,
+  WebhookIdentityType,
+  getDnsPropagation2 as getDnsPropagation
+};
+//# sourceMappingURL=index.typings.mjs.map

package/build/es/index.typings.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/premium-domains-v1-dns-propagation-dns-propagation.universal.ts","../../src/premium-domains-v1-dns-propagation-dns-propagation.http.ts"],"sourcesContent":["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 ambassadorWixPremiumDomainsV1DnsPropagation from './premium-domains-v1-dns-propagation-dns-propagation.http.js';\n\n/**\n * The DNS (Domain Name System) propagation object contains information for a domain.\n * Tracks whether the DNS records are correctly configured and propagated globally.\n * Learn more [about DNS propagation](https://support.wix.com/en/article/about-domain-propagation).\n */\nexport interface DnsPropagation extends DnsPropagationStatusInfoOneOf {\n  /**\n   * Details about DNS propagation failure, including which record types failed.\n   * Only present when `status` is `FAILED`.\n   * @readonly\n   */\n  failureInfo?: FailedStatusInfo;\n  /**\n   * ID of the DNS propagation. Identical to the domain name, including the [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology) (top-level domain).\n   * @format HOSTNAME\n   * @readonly\n   */\n  _id?: string;\n  /**\n   * Domain name, including the [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology). Both root domains and subdomains are supported.\n   * @format HOSTNAME\n   */\n  domain?: string;\n  /**\n   * Revision number, which increments by 1 each time the DNS propagation\n   * is updated. Ignored when creating a DNS propagation.\n   * @readonly\n   */\n  revision?: string | null;\n  /**\n   * Date and time the DNS propagation was created.\n   * @readonly\n   */\n  _createdDate?: Date | null;\n  /**\n   * Date and time the DNS propagation was updated.\n   * @readonly\n   */\n  _updatedDate?: Date | null;\n  /**\n   * Current status of the DNS propagation. Can take up to 3 days to complete.\n   * @readonly\n   */\n  status?: StatusWithLiterals;\n  /**\n   * Whether Wix name servers were detected among the domain's name servers.\n   * For subdomains, this value matches the root domain's setting.\n   * @readonly\n   */\n  dnsResolverIncludesWixNs?: boolean | null;\n}\n\n/** @oneof */\nexport interface DnsPropagationStatusInfoOneOf {\n  /**\n   * Details about DNS propagation failure, including which record types failed.\n   * Only present when `status` is `FAILED`.\n   * @readonly\n   */\n  failureInfo?: FailedStatusInfo;\n}\n\nexport enum Status {\n  /** DNS propagation completed successfully. All required DNS records are properly configured and propagated. */\n  SUCCEEDED = 'SUCCEEDED',\n  /** DNS propagation failed. One or more DNS records are incorrectly configured or haven't propagated. */\n  FAILED = 'FAILED',\n  /** DNS propagation is in progress. Check again later for updated status. */\n  IN_PROGRESS = 'IN_PROGRESS',\n}\n\n/** @enumType */\nexport type StatusWithLiterals =\n  | Status\n  | 'SUCCEEDED'\n  | 'FAILED'\n  | 'IN_PROGRESS';\n\nexport interface FailedStatusInfo {\n  /**\n   * The DNS record types that failed propagation.\n   *\n   * Max: 3 invalid records\n   * @readonly\n   */\n  invalidRecords?: InvalidRecordWithLiterals[];\n  /**\n   * Details about the A record for which the DNS propagation has failed.\n   * Includes all expected and current values of the A record.\n   * @readonly\n   */\n  invalidARecordInfo?: InvalidRecordInfo;\n  /**\n   * Details about the NS (nameserver) record for which the DNS propagation has failed.\n   * Includes all expected and current values of the NS record.\n   * @readonly\n   */\n  invalidNsRecordInfo?: InvalidRecordInfo;\n  /**\n   * Details about the CNAME record for which the DNS propagation has failed.\n   * Includes all expected and current values of the CNAME records.\n   * @readonly\n   */\n  invalidCnameRecordInfo?: InvalidRecordInfo;\n}\n\nexport enum InvalidRecord {\n  /** The propagation of the A record has failed. */\n  INVALID_A_RECORD = 'INVALID_A_RECORD',\n  /** The propagation of the NS record has failed. */\n  INVALID_NS_RECORD = 'INVALID_NS_RECORD',\n  /** The propagation of at least one CNAME record has failed. */\n  INVALID_CNAME_RECORD = 'INVALID_CNAME_RECORD',\n}\n\n/** @enumType */\nexport type InvalidRecordWithLiterals =\n  | InvalidRecord\n  | 'INVALID_A_RECORD'\n  | 'INVALID_NS_RECORD'\n  | 'INVALID_CNAME_RECORD';\n\nexport interface InvalidRecordInfo {\n  /**\n   * The DNS records that should be configured in the external database. Note that there can only be a single A and NS record.\n   *\n   * Max: 10 DNS records\n   * @maxSize 10\n   * @readonly\n   */\n  expectedDnsRecords?: DnsRecord[];\n  /**\n   * DNS records currently configured in the external database. Note that there can only be a single A and NS record.\n   * @maxSize 10\n   * @readonly\n   */\n  actualDnsRecords?: DnsRecord[];\n}\n\nexport interface DnsRecord {\n  /**\n   * Hostname for the DNS record. For example, `domain.com` or `mail.domain.com`. Supports both root domains and subdomains.\n   * @format HOSTNAME\n   * @readonly\n   */\n  hostName?: string;\n  /**\n   * Values associated with the DNS record. For example, IP addresses for A records or server names for NS records.\n   *\n   * Min: 1 value\n   * Max: 10 values\n   * @minSize 1\n   * @maxSize 10\n   * @readonly\n   */\n  values?: string[];\n}\n\nexport interface CreateDnsPropagationRequest {\n  /** DNS propagation to create. */\n  dnsPropagation?: DnsPropagation;\n}\n\nexport interface CreateDnsPropagationResponse {\n  /** Created DNS propagation. */\n  dnsPropagation?: DnsPropagation;\n}\n\nexport interface GetDnsPropagationRequest {\n  /**\n   * ID of the DNS propagation to retrieve. Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).\n   * @format HOSTNAME\n   */\n  dnsPropagationId: string;\n}\n\nexport interface GetDnsPropagationResponse {\n  /** Retrieved DNS propagation. */\n  dnsPropagation?: DnsPropagation;\n}\n\nexport interface CheckDnsPropagationRequest {\n  /**\n   * ID of the DNS propagation to check the propagation status for.\n   * Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).\n   * @format HOSTNAME\n   */\n  dnsPropagationId?: string;\n}\n\nexport interface CheckDnsPropagationResponse {\n  /** Retrieved DNS propagation with current status. */\n  dnsPropagation?: DnsPropagation;\n}\n\nexport interface ScheduleDnsPropagationChecksRequest {\n  /**\n   * ID of the DNS propagation to schedule a check for.\n   * Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).\n   * @format HOSTNAME\n   */\n  dnsPropagationId?: string;\n}\n\nexport interface ScheduleDnsPropagationChecksResponse {}\n\nexport interface SyncDnsPropagationDomainRequest {\n  /**\n   * ID of the DNS propagation to synchronize.\n   * Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).\n   * @format HOSTNAME\n   */\n  dnsPropagationId?: string;\n  /**\n   * Whether to perform a dry run without making actual changes.\n   *\n   * If true, reports sync issues without applying any fixes.\n   * If false, attempts to resolve detected issues.\n   *\n   * Default: `false`\n   */\n  dryRunEnabled?: boolean | null;\n}\n\nexport interface SyncDnsPropagationDomainResponse {}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n  /** Details related to the account */\n  accountInfo?: AccountInfo;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface AccountInfo {\n  /**\n   * ID of the Wix account associated with the event.\n   * @format GUID\n   */\n  accountId?: string | null;\n  /**\n   * ID of the parent Wix account. Only included when accountId belongs to a child account.\n   * @format GUID\n   */\n  parentAccountId?: string | null;\n  /**\n   * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.\n   * @format GUID\n   */\n  siteId?: string | null;\n}\n\n/**\n * Retrieves DNS propagation status for a domain.\n *\n * Use this method to check if DNS records are properly configured and propagated after connecting a custom domain,\n * during domain setup to see required DNS records, or to monitor ongoing propagation status after making DNS changes.\n * @param dnsPropagationId - ID of the DNS propagation to retrieve. Identical to the domain name, including [TLD](https://dev.wix.com/docs/api-reference/account-level/domains/dns-propagation/introduction#terminology).\n * @public\n * @documentationMaturity preview\n * @requiredField dnsPropagationId\n * @permissionId DOMAINS.READ_DNS_PROPAGATION\n * @returns Retrieved DNS propagation.\n * @fqn com.wixpress.premium.domain.propagation.v1.DnsPropagationService.GetDnsPropagation\n */\nexport async function getDnsPropagation(\n  dnsPropagationId: string\n): Promise<\n  NonNullablePaths<\n    DnsPropagation,\n    | `failureInfo.invalidRecords`\n    | `failureInfo.invalidARecordInfo.expectedDnsRecords`\n    | `failureInfo.invalidARecordInfo.expectedDnsRecords.${number}.hostName`\n    | `failureInfo.invalidARecordInfo.actualDnsRecords`\n    | `_id`\n    | `domain`\n    | `status`,\n    6\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    dnsPropagationId: dnsPropagationId,\n  });\n\n  const reqOpts =\n    ambassadorWixPremiumDomainsV1DnsPropagation.getDnsPropagation(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)\n      ?.dnsPropagation!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { dnsPropagationId: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['dnsPropagationId']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveComWixpressPremiumDomainPropagationV1DnsPropagationServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www.wixapis.com': [\n      {\n        srcPath: '/premium/domains/v1/dns-propagations',\n        destPath: '/v1/dns-propagations',\n      },\n    ],\n    '*.dev.wix-code.com': [\n      {\n        srcPath: '/premium/domains/v1/dns-propagations',\n        destPath: '/v1/dns-propagations',\n      },\n    ],\n    _: [\n      {\n        srcPath: '/premium/domains/v1/dns-propagations',\n        destPath: '/v1/dns-propagations',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_domains_dns-propagation';\n\n/**\n * Retrieves DNS propagation status for a domain.\n *\n * Use this method to check if DNS records are properly configured and propagated after connecting a custom domain,\n * during domain setup to see required DNS records, or to monitor ongoing propagation status after making DNS changes.\n */\nexport function getDnsPropagation(payload: object): RequestOptionsFactory<any> {\n  function __getDnsPropagation({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.premium.domains.v1.dns_propagation',\n      method: 'GET' as any,\n      methodFqn:\n        'com.wixpress.premium.domain.propagation.v1.DnsPropagationService.GetDnsPropagation',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveComWixpressPremiumDomainPropagationV1DnsPropagationServiceUrl(\n        {\n          protoPath: '/v1/dns-propagations/{dnsPropagationId}',\n          data: payload,\n          host,\n        }\n      ),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'dnsPropagation.createdDate' },\n              { path: 'dnsPropagation.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getDnsPropagation;\n}\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,qEACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAQd,SAAS,kBAAkB,SAA6C;AAC7E,WAAS,oBAAoB,EAAE,KAAK,GAAQ;AAC1C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK;AAAA,QACH;AAAA,UACE,WAAW;AAAA,UACX,MAAM;AAAA,UACN;AAAA,QACF;AAAA,MACF;AAAA,MACA,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,6BAA6B;AAAA,YACrC,EAAE,MAAM,6BAA6B;AAAA,UACvC;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADPO,IAAK,SAAL,kBAAKC,YAAL;AAEL,EAAAA,QAAA,eAAY;AAEZ,EAAAA,QAAA,YAAS;AAET,EAAAA,QAAA,iBAAc;AANJ,SAAAA;AAAA,GAAA;AA4CL,IAAK,gBAAL,kBAAKC,mBAAL;AAEL,EAAAA,eAAA,sBAAmB;AAEnB,EAAAA,eAAA,uBAAoB;AAEpB,EAAAA,eAAA,0BAAuB;AANb,SAAAA;AAAA,GAAA;AAiQL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAgDZ,eAAsBC,mBACpB,kBAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UACwC,kBAAkB,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI,GACtD;AAAA,EACN,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,kBAAkB,OAAO;AAAA,QACrD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,kBAAkB;AAAA,IACrB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["payload","Status","InvalidRecord","WebhookIdentityType","getDnsPropagation"]}