@wix/auto_sdk_email-subscriptions_email-subscriptions 1.0.4 → 1.0.6

package/build/es/index.typings.mjs

@@ -0,0 +1,380 @@
+// src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.ts
+import { transformError as sdkTransformError } from "@wix/sdk-runtime/transform-error";
+import {
+  renameKeysFromSDKRequestToRESTRequest,
+  renameKeysFromRESTResponseToSDKResponse
+} from "@wix/sdk-runtime/rename-all-nested-keys";
+
+// src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.ts
+import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
+import { transformSDKTimestampToRESTTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+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 resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl(opts) {
+  const domainToMappings = {
+    "editor._base_domain_": [
+      {
+        srcPath: "/_api/email-marketing/v1/email-subscriptions",
+        destPath: "/v1/email-subscriptions"
+      }
+    ],
+    "blocks._base_domain_": [
+      {
+        srcPath: "/_api/email-marketing/v1/email-subscriptions",
+        destPath: "/v1/email-subscriptions"
+      }
+    ],
+    "create.editorx": [
+      {
+        srcPath: "/_api/email-marketing/v1/email-subscriptions",
+        destPath: "/v1/email-subscriptions"
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/_api/email-marketing/v1/email-subscriptions",
+        destPath: "/v1/email-subscriptions"
+      }
+    ],
+    "www._base_domain_": [
+      {
+        srcPath: "/_api/email-marketing/v1/email-subscriptions",
+        destPath: "/v1/email-subscriptions"
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/email-marketing/v1/email-subscriptions",
+        destPath: "/v1/email-subscriptions"
+      },
+      {
+        srcPath: "/email-marketing/v1/email-subscriptions/unsubscribe-link",
+        destPath: "/v1/email-subscriptions/unsubscribe-link"
+      }
+    ]
+  };
+  return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_email-subscriptions_email-subscriptions";
+function getEmailSubscription(payload) {
+  function __getEmailSubscription({ host }) {
+    const metadata = {
+      entityFqdn: "wix.emailsubscriptions.v1.emailsubscription",
+      method: "GET",
+      methodFqn: "com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GetEmailSubscription",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+        protoPath: "/v1/email-subscriptions/{id}",
+        data: payload,
+        host
+      }),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "emailSubscription.createdDate" },
+            { path: "emailSubscription.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getEmailSubscription;
+}
+function queryEmailSubscriptions(payload) {
+  function __queryEmailSubscriptions({ host }) {
+    const metadata = {
+      entityFqdn: "wix.emailsubscriptions.v1.emailsubscription",
+      method: "POST",
+      methodFqn: "com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+        protoPath: "/v1/email-subscriptions/query",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "subscriptions.createdDate" },
+            { path: "subscriptions.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __queryEmailSubscriptions;
+}
+function upsertEmailSubscription(payload) {
+  function __upsertEmailSubscription({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [
+          { path: "subscription.createdDate" },
+          { path: "subscription.updatedDate" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.emailsubscriptions.v1.emailsubscription",
+      method: "POST",
+      methodFqn: "com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+        protoPath: "/v1/email-subscriptions",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "subscription.createdDate" },
+            { path: "subscription.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __upsertEmailSubscription;
+}
+function bulkUpsertEmailSubscription(payload) {
+  function __bulkUpsertEmailSubscription({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [
+          { path: "subscriptions.createdDate" },
+          { path: "subscriptions.updatedDate" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.emailsubscriptions.v1.emailsubscription",
+      method: "POST",
+      methodFqn: "com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+        protoPath: "/v1/email-subscriptions/bulk",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "results.emailSubscription.createdDate" },
+            { path: "results.emailSubscription.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __bulkUpsertEmailSubscription;
+}
+function generateUnsubscribeLink(payload) {
+  function __generateUnsubscribeLink({ host }) {
+    const metadata = {
+      entityFqdn: "wix.emailsubscriptions.v1.emailsubscription",
+      method: "POST",
+      methodFqn: "com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+        protoPath: "/v1/email-subscriptions/unsubscribe-link",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __generateUnsubscribeLink;
+}
+
+// src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.ts
+var SubscriptionEnumStatus = /* @__PURE__ */ ((SubscriptionEnumStatus2) => {
+  SubscriptionEnumStatus2["UNKNOWN"] = "UNKNOWN";
+  SubscriptionEnumStatus2["NOT_SET"] = "NOT_SET";
+  SubscriptionEnumStatus2["PENDING"] = "PENDING";
+  SubscriptionEnumStatus2["SUBSCRIBED"] = "SUBSCRIBED";
+  SubscriptionEnumStatus2["UNSUBSCRIBED"] = "UNSUBSCRIBED";
+  return SubscriptionEnumStatus2;
+})(SubscriptionEnumStatus || {});
+var Status = /* @__PURE__ */ ((Status2) => {
+  Status2["NOT_SET"] = "NOT_SET";
+  Status2["VALID"] = "VALID";
+  Status2["BOUNCED"] = "BOUNCED";
+  Status2["SPAM_COMPLAINT"] = "SPAM_COMPLAINT";
+  Status2["INACTIVE"] = "INACTIVE";
+  return Status2;
+})(Status || {});
+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 getEmailSubscription2(_id) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
+  const reqOpts = getEmailSubscription(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data)?.emailSubscription;
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { id: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["_id"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function queryEmailSubscriptions2(filter, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    filter,
+    paging: options?.paging
+  });
+  const reqOpts = queryEmailSubscriptions(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { filter: "$[0]", paging: "$[1].paging" },
+        singleArgumentUnchanged: false
+      },
+      ["filter", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function upsertEmailSubscription2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    subscription: options?.subscription
+  });
+  const reqOpts = upsertEmailSubscription(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { subscription: "$[0].subscription" },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function bulkUpsertEmailSubscription2(subscriptions) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    subscriptions
+  });
+  const reqOpts = bulkUpsertEmailSubscription(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { subscriptions: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["subscriptions"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function generateUnsubscribeLink2(emailAddress, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    emailAddress,
+    metadata: options?.metadata,
+    language: options?.language
+  });
+  const reqOpts = generateUnsubscribeLink(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          emailAddress: "$[0]",
+          metadata: "$[1].metadata",
+          language: "$[1].language"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["emailAddress", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+export {
+  Status,
+  SubscriptionEnumStatus,
+  WebhookIdentityType,
+  bulkUpsertEmailSubscription2 as bulkUpsertEmailSubscription,
+  generateUnsubscribeLink2 as generateUnsubscribeLink,
+  getEmailSubscription2 as getEmailSubscription,
+  queryEmailSubscriptions2 as queryEmailSubscriptions,
+  upsertEmailSubscription2 as upsertEmailSubscription
+};
+//# sourceMappingURL=index.typings.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.ts","../../src/emailsubscriptions-v1-emailsubscription-email-subscriptions.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 ambassadorWixEmailsubscriptionsV1Emailsubscription from './emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js';\n\nexport interface EmailSubscription {\n  /**\n   * Email subscription ID.\n   * @format GUID\n   * @readonly\n   */\n  _id?: string | null;\n  /**\n   * Email address.\n   * @format EMAIL\n   */\n  email?: string;\n  /**\n   * Indicates the recipient's opt-in or opt-out status\n   * for marketing emails.\n   *\n   * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.\n   * - `PENDING`: Subscription confirmation was requested,\n   * but recipient hasn't confirmed yet.\n   * - `SUBSCRIBED`: Recipient has opted in to marketing emails.\n   * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.\n   *\n   * Defaults to `NOT_SET`.\n   */\n  subscriptionStatus?: SubscriptionEnumStatusWithLiterals;\n  /**\n   * Indicates last reported status of sent emails.\n   *\n   * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.\n   * - `VALID`: Emails to this email address are being delivered successfully.\n   * - `BOUNCED`: The last email to the recipient bounced or was rejected.\n   * - `SPAM_COMPLAINT`: The recipient registered a spam complaint\n   * with their email provider.\n   * - `INACTIVE`: Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.)\n   * This status might impact subsequent emails sent to this address.\n   *\n   * Defaults to `NOT_SET`.\n   */\n  deliverabilityStatus?: StatusWithLiterals;\n  /**\n   * Date and time the email subscription was created.\n   * @readonly\n   */\n  _createdDate?: Date | null;\n  /**\n   * Date and time the email subscription was last updated.\n   * @readonly\n   */\n  _updatedDate?: Date | null;\n}\n\nexport enum SubscriptionEnumStatus {\n  UNKNOWN = 'UNKNOWN',\n  /** No Subscription exists */\n  NOT_SET = 'NOT_SET',\n  /** Pending Subscription */\n  PENDING = 'PENDING',\n  /** Subscribed */\n  SUBSCRIBED = 'SUBSCRIBED',\n  /** UnSubscribed */\n  UNSUBSCRIBED = 'UNSUBSCRIBED',\n}\n\n/** @enumType */\nexport type SubscriptionEnumStatusWithLiterals =\n  | SubscriptionEnumStatus\n  | 'UNKNOWN'\n  | 'NOT_SET'\n  | 'PENDING'\n  | 'SUBSCRIBED'\n  | 'UNSUBSCRIBED';\n\nexport enum Status {\n  NOT_SET = 'NOT_SET',\n  /** valid/deferral */\n  VALID = 'VALID',\n  /** bounced/rejected/invalid */\n  BOUNCED = 'BOUNCED',\n  /** spam/complaint */\n  SPAM_COMPLAINT = 'SPAM_COMPLAINT',\n  /** valid, but no activity reported */\n  INACTIVE = 'INACTIVE',\n}\n\n/** @enumType */\nexport type StatusWithLiterals =\n  | Status\n  | 'NOT_SET'\n  | 'VALID'\n  | 'BOUNCED'\n  | 'SPAM_COMPLAINT'\n  | 'INACTIVE';\n\n/** Triggered when an email subscription's status is changed. */\nexport interface EmailSubscriptionChanged {\n  /** Email subscription that changed. */\n  subscription?: EmailSubscription;\n}\n\nexport interface GetEmailSubscriptionRequest {\n  /** @format GUID */\n  _id: string;\n}\n\nexport interface GetEmailSubscriptionResponse {\n  /** Returned email subscription */\n  emailSubscription?: EmailSubscription;\n}\n\nexport interface UpdateEmailSubscriptionRequest {\n  /** Email subscription to update */\n  subscription?: EmailSubscription;\n}\n\nexport interface UpdateEmailSubscriptionResponse {\n  /** Updated email subscription */\n  subscription?: EmailSubscription;\n}\n\nexport interface QueryEmailSubscriptionsRequest {\n  /**\n   * Filter options.\n   * Currently, querying is supported on the `email` field\n   * with the `$in` array filter.\n   */\n  filter: Record<string, any> | null;\n  /**\n   * Pagination options. For more information, see\n   * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n   */\n  paging?: Paging;\n}\n\nexport interface Paging {\n  /** Number of items to load. */\n  limit?: number | null;\n  /** Number of items to skip in the current sort order. */\n  offset?: number | null;\n}\n\nexport interface QueryEmailSubscriptionsResponse {\n  /** List of subscribed emails that matched the query options. */\n  subscriptions?: EmailSubscription[];\n  /** Metadata for the paginated results. */\n  metadata?: PagingMetadata;\n}\n\nexport interface PagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null;\n  /** Offset that was requested. */\n  offset?: number | null;\n  /** Total number of items that match the query. */\n  total?: number | null;\n  /** Flag that indicates the server failed to calculate the `total` field. */\n  tooManyToCount?: boolean | null;\n}\n\nexport interface UpsertEmailSubscriptionRequest {\n  /** Email subscription to update or create. */\n  subscription?: EmailSubscription;\n}\n\nexport interface UpsertEmailSubscriptionResponse {\n  /** Updated or created email subscription. */\n  subscription?: EmailSubscription;\n}\n\nexport interface BulkUpsertEmailSubscriptionRequest {\n  /**\n   * List of email subscriptions to update or create.\n   * @minSize 1\n   * @maxSize 100\n   */\n  subscriptions: EmailSubscription[];\n}\n\nexport interface BulkUpsertEmailSubscriptionResponse {\n  /** List of updated or created email subscriptions. */\n  results?: BulkUpsertEmailSubscriptionResult[];\n  /** Numbers of successful and failed actions. */\n  metadata?: Metadata;\n}\n\nexport interface BulkUpsertEmailSubscriptionResult {\n  /** Position of the requested email subscription in the bulk array. */\n  originalIndex?: number;\n  /** New or updated email subscription. */\n  emailSubscription?: EmailSubscription;\n  /**\n   * Error information if the action failed.\n   * Omitted from successful actions.\n   */\n  error?: Error;\n}\n\nexport interface Error {\n  /** Error code. */\n  errorCode?: string;\n  /** Message that contains details about the error. */\n  message?: string;\n}\n\nexport interface Metadata {\n  /** Number of successful actions. */\n  totalSuccess?: number;\n  /** Number of failed actions. */\n  totalFailure?: number;\n}\n\nexport interface GenerateUnsubscribeLinkRequest {\n  /**\n   * Email address the unsubscribe link is for.\n   * @format EMAIL\n   */\n  emailAddress: string;\n  /** Arbitrary parameters for closing-the-loop. */\n  metadata?: Record<string, string>;\n  /**\n   * Language for displaying unsubscribe confirmation page.\n   *\n   * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n   *\n   * Default: `EN`\n   * @format LANGUAGE\n   */\n  language?: string | null;\n}\n\nexport interface GenerateUnsubscribeLinkResponse {\n  /** The unsubscribe link. */\n  link?: string;\n}\n\nexport interface RenderUnsubscribePageRequest {\n  /** Payload */\n  payload?: string;\n  /** Language */\n  language?: string | null;\n}\n\nexport interface RawHttpResponse {\n  body?: Uint8Array;\n  statusCode?: number | null;\n  headers?: HeadersEntry[];\n}\n\nexport interface HeadersEntry {\n  key?: string;\n  value?: string;\n}\n\nexport interface ConfirmUnsubscribeActionRequest {\n  /** Payload */\n  payload?: string;\n}\n\nexport interface Empty {}\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}\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 V1RenderUnsubscribePageRequest {\n  /** Payload */\n  payload?: string;\n  /** Language */\n  language?: string | null;\n}\n\nexport interface V1ConfirmUnsubscribeActionRequest {\n  /** Payload */\n  payload?: string;\n}\n\nexport interface BaseEventMetadata {\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}\n\nexport interface EmailsubscriptionEmailSubscriptionChangedEnvelope {\n  data: EmailSubscriptionChanged;\n  metadata: BaseEventMetadata;\n}\n\n/** @permissionScope Manage Stores\n * @permissionScopeId SCOPE.STORES.MANAGE-STORES\n * @permissionScope Manage Email Subscriptions\n * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS\n * @permissionId EMAIL_SUBSCRIPTIONS.VIEW\n * @webhook\n * @eventType com.wixpress.emailsubscriptions.v1.EmailSubscriptionChanged\n * @serviceIdentifier com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService\n * @slug email_subscription_changed\n * @documentationMaturity preview\n */\nexport declare function onEmailsubscriptionEmailSubscriptionChanged(\n  handler: (\n    event: EmailsubscriptionEmailSubscriptionChangedEnvelope\n  ) => void | Promise<void>\n): void;\n\n/**\n * Get Email Subscription\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId EMAIL_SUBSCRIPTIONS.VIEW\n * @applicableIdentity APP\n * @returns Returned email subscription\n * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GetEmailSubscription\n */\nexport async function getEmailSubscription(\n  _id: string\n): Promise<\n  NonNullablePaths<\n    EmailSubscription,\n    `email` | `subscriptionStatus` | `deliverabilityStatus`,\n    2\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });\n\n  const reqOpts =\n    ambassadorWixEmailsubscriptionsV1Emailsubscription.getEmailSubscription(\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      ?.emailSubscription!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { id: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['_id']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Retrieves email subscriptions,\n * given the provided paging, filtering, and sorting.\n *\n * Currently, querying is supported on the `email` field\n * with the `$in` array filter.\n * For example, to query for emails `\"me@my.com\"` and `\"you@your.org\"`,\n * the filter should be formed like this:\n *\n * ```json\n * { \"filter\": {\n * \"email\": {\n * \"$in\": [\"me@my.com\", \"you@your.org\"]\n * }\n * }\n * }\n * ```\n *\n * To learn how to query email subscriptions, see\n * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @param filter - Filter options.\n * Currently, querying is supported on the `email` field\n * with the `$in` array filter.\n * @public\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId EMAIL_SUBSCRIPTIONS.VIEW\n * @applicableIdentity APP\n * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions\n */\nexport async function queryEmailSubscriptions(\n  filter: Record<string, any>,\n  options?: QueryEmailSubscriptionsOptions\n): Promise<\n  NonNullablePaths<\n    QueryEmailSubscriptionsResponse,\n    | `subscriptions`\n    | `subscriptions.${number}.email`\n    | `subscriptions.${number}.subscriptionStatus`\n    | `subscriptions.${number}.deliverabilityStatus`,\n    4\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    filter: filter,\n    paging: options?.paging,\n  });\n\n  const reqOpts =\n    ambassadorWixEmailsubscriptionsV1Emailsubscription.queryEmailSubscriptions(\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  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { filter: '$[0]', paging: '$[1].paging' },\n        singleArgumentUnchanged: false,\n      },\n      ['filter', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface QueryEmailSubscriptionsOptions {\n  /**\n   * Pagination options. For more information, see\n   * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n   */\n  paging?: Paging;\n}\n\n/**\n * Updates or creates an email subscription for the requested email.\n *\n * An email subscription is returned in the response\n * whether it was updated or created.\n * @public\n * @documentationMaturity preview\n * @requiredField options.subscription.email\n * @permissionId EMAIL_SUBSCRIPTIONS.MODIFY\n * @applicableIdentity APP\n * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription\n */\nexport async function upsertEmailSubscription(\n  options?: NonNullablePaths<\n    UpsertEmailSubscriptionOptions,\n    `subscription.email`,\n    3\n  >\n): Promise<\n  NonNullablePaths<\n    UpsertEmailSubscriptionResponse,\n    | `subscription.email`\n    | `subscription.subscriptionStatus`\n    | `subscription.deliverabilityStatus`,\n    3\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    subscription: options?.subscription,\n  });\n\n  const reqOpts =\n    ambassadorWixEmailsubscriptionsV1Emailsubscription.upsertEmailSubscription(\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  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { subscription: '$[0].subscription' },\n        singleArgumentUnchanged: false,\n      },\n      ['options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface UpsertEmailSubscriptionOptions {\n  /** Email subscription to update or create. */\n  subscription?: EmailSubscription;\n}\n\n/**\n * Updates or creates multiple email subscriptions.\n * @param subscriptions - List of email subscriptions to update or create.\n * @public\n * @documentationMaturity preview\n * @requiredField subscriptions\n * @permissionId EMAIL_SUBSCRIPTIONS.MODIFY\n * @applicableIdentity APP\n * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription\n */\nexport async function bulkUpsertEmailSubscription(\n  subscriptions: EmailSubscription[]\n): Promise<\n  NonNullablePaths<\n    BulkUpsertEmailSubscriptionResponse,\n    | `results`\n    | `results.${number}.originalIndex`\n    | `results.${number}.emailSubscription.email`\n    | `results.${number}.emailSubscription.subscriptionStatus`\n    | `results.${number}.emailSubscription.deliverabilityStatus`\n    | `results.${number}.error.errorCode`\n    | `results.${number}.error.message`\n    | `metadata.totalSuccess`\n    | `metadata.totalFailure`,\n    5\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    subscriptions: subscriptions,\n  });\n\n  const reqOpts =\n    ambassadorWixEmailsubscriptionsV1Emailsubscription.bulkUpsertEmailSubscription(\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  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { subscriptions: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['subscriptions']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Creates an unsubscribe link to be shared with the relevant recipient.\n *\n * If someone clicks the **Unsubscribe** button on the confirmation page,\n * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.\n * @param emailAddress - Email address the unsubscribe link is for.\n * @public\n * @documentationMaturity preview\n * @requiredField emailAddress\n * @permissionId EMAIL_SUBSCRIPTIONS.VIEW\n * @applicableIdentity APP\n * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink\n */\nexport async function generateUnsubscribeLink(\n  emailAddress: string,\n  options?: GenerateUnsubscribeLinkOptions\n): Promise<NonNullablePaths<GenerateUnsubscribeLinkResponse, `link`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    emailAddress: emailAddress,\n    metadata: options?.metadata,\n    language: options?.language,\n  });\n\n  const reqOpts =\n    ambassadorWixEmailsubscriptionsV1Emailsubscription.generateUnsubscribeLink(\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  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {\n          emailAddress: '$[0]',\n          metadata: '$[1].metadata',\n          language: '$[1].language',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['emailAddress', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface GenerateUnsubscribeLinkOptions {\n  /** Arbitrary parameters for closing-the-loop. */\n  metadata?: Record<string, string>;\n  /**\n   * Language for displaying unsubscribe confirmation page.\n   *\n   * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n   *\n   * Default: `EN`\n   * @format LANGUAGE\n   */\n  language?: string | null;\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\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 resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'editor._base_domain_': [\n      {\n        srcPath: '/_api/email-marketing/v1/email-subscriptions',\n        destPath: '/v1/email-subscriptions',\n      },\n    ],\n    'blocks._base_domain_': [\n      {\n        srcPath: '/_api/email-marketing/v1/email-subscriptions',\n        destPath: '/v1/email-subscriptions',\n      },\n    ],\n    'create.editorx': [\n      {\n        srcPath: '/_api/email-marketing/v1/email-subscriptions',\n        destPath: '/v1/email-subscriptions',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/email-marketing/v1/email-subscriptions',\n        destPath: '/v1/email-subscriptions',\n      },\n    ],\n    'www._base_domain_': [\n      {\n        srcPath: '/_api/email-marketing/v1/email-subscriptions',\n        destPath: '/v1/email-subscriptions',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/email-marketing/v1/email-subscriptions',\n        destPath: '/v1/email-subscriptions',\n      },\n      {\n        srcPath: '/email-marketing/v1/email-subscriptions/unsubscribe-link',\n        destPath: '/v1/email-subscriptions/unsubscribe-link',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_email-subscriptions_email-subscriptions';\n\n/** Get Email Subscription */\nexport function getEmailSubscription(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __getEmailSubscription({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',\n      method: 'GET' as any,\n      methodFqn:\n        'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GetEmailSubscription',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({\n        protoPath: '/v1/email-subscriptions/{id}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'emailSubscription.createdDate' },\n              { path: 'emailSubscription.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getEmailSubscription;\n}\n\n/**\n * Retrieves email subscriptions,\n * given the provided paging, filtering, and sorting.\n *\n * Currently, querying is supported on the `email` field\n * with the `$in` array filter.\n * For example, to query for emails `\"me@my.com\"` and `\"you@your.org\"`,\n * the filter should be formed like this:\n *\n * ```json\n * { \"filter\": {\n * \"email\": {\n * \"$in\": [\"me@my.com\", \"you@your.org\"]\n * }\n * }\n * }\n * ```\n *\n * To learn how to query email subscriptions, see\n * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n */\nexport function queryEmailSubscriptions(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __queryEmailSubscriptions({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',\n      method: 'POST' as any,\n      methodFqn:\n        'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({\n        protoPath: '/v1/email-subscriptions/query',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'subscriptions.createdDate' },\n              { path: 'subscriptions.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __queryEmailSubscriptions;\n}\n\n/**\n * Updates or creates an email subscription for the requested email.\n *\n * An email subscription is returned in the response\n * whether it was updated or created.\n */\nexport function upsertEmailSubscription(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __upsertEmailSubscription({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [\n          { path: 'subscription.createdDate' },\n          { path: 'subscription.updatedDate' },\n        ],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',\n      method: 'POST' as any,\n      methodFqn:\n        'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({\n        protoPath: '/v1/email-subscriptions',\n        data: serializedData,\n        host,\n      }),\n      data: serializedData,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'subscription.createdDate' },\n              { path: 'subscription.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __upsertEmailSubscription;\n}\n\n/** Updates or creates multiple email subscriptions. */\nexport function bulkUpsertEmailSubscription(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __bulkUpsertEmailSubscription({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [\n          { path: 'subscriptions.createdDate' },\n          { path: 'subscriptions.updatedDate' },\n        ],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',\n      method: 'POST' as any,\n      methodFqn:\n        'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({\n        protoPath: '/v1/email-subscriptions/bulk',\n        data: serializedData,\n        host,\n      }),\n      data: serializedData,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'results.emailSubscription.createdDate' },\n              { path: 'results.emailSubscription.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __bulkUpsertEmailSubscription;\n}\n\n/**\n * Creates an unsubscribe link to be shared with the relevant recipient.\n *\n * If someone clicks the **Unsubscribe** button on the confirmation page,\n * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.\n */\nexport function generateUnsubscribeLink(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __generateUnsubscribeLink({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',\n      method: 'POST' as any,\n      methodFqn:\n        'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({\n        protoPath: '/v1/email-subscriptions/unsubscribe-link',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __generateUnsubscribeLink;\n}\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,mEACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;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;AAGd,SAAS,qBACd,SAC4B;AAC5B,WAAS,uBAAuB,EAAE,KAAK,GAAQ;AAC7C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,mEAAmE;AAAA,QACtE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,gCAAgC;AAAA,YACxC,EAAE,MAAM,gCAAgC;AAAA,UAC1C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAuBO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,mEAAmE;AAAA,QACtE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,4BAA4B;AAAA,YACpC,EAAE,MAAM,4BAA4B;AAAA,UACtC;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAQO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,iBAAiB,eAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,2BAA2B;AAAA,UACnC,EAAE,MAAM,2BAA2B;AAAA,QACrC;AAAA,MACF;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,mEAAmE;AAAA,QACtE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,2BAA2B;AAAA,YACnC,EAAE,MAAM,2BAA2B;AAAA,UACrC;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,4BACd,SAC4B;AAC5B,WAAS,8BAA8B,EAAE,KAAK,GAAQ;AACpD,UAAM,iBAAiB,eAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,4BAA4B;AAAA,UACpC,EAAE,MAAM,4BAA4B;AAAA,QACtC;AAAA,MACF;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,mEAAmE;AAAA,QACtE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,wCAAwC;AAAA,YAChD,EAAE,MAAM,wCAAwC;AAAA,UAClD;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAQO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,mEAAmE;AAAA,QACtE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADnNO,IAAK,yBAAL,kBAAKC,4BAAL;AACL,EAAAA,wBAAA,aAAU;AAEV,EAAAA,wBAAA,aAAU;AAEV,EAAAA,wBAAA,aAAU;AAEV,EAAAA,wBAAA,gBAAa;AAEb,EAAAA,wBAAA,kBAAe;AATL,SAAAA;AAAA,GAAA;AAqBL,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,aAAU;AAEV,EAAAA,QAAA,WAAQ;AAER,EAAAA,QAAA,aAAU;AAEV,EAAAA,QAAA,oBAAiB;AAEjB,EAAAA,QAAA,cAAW;AATD,SAAAA;AAAA,GAAA;AAkUL,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;AA4EZ,eAAsBC,sBACpB,KAOA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,EAAE,IAAI,IAAI,CAAC;AAEjE,QAAM,UAC+C;AAAA,IACjD;AAAA,EACF;AAEF,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,IAAI,OAAO;AAAA,QACvC,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,KAAK;AAAA,IACR;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAgCA,eAAsBC,yBACpB,QACA,SAUA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,QAAQ,SAAS;AAAA,EACnB,CAAC;AAED,QAAM,UAC+C;AAAA,IACjD;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,QAAQ,QAAQ,QAAQ,cAAc;AAAA,QAClE,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,UAAU,SAAS;AAAA,IACtB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAsBA,eAAsBC,yBACpB,SAaA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD,cAAc,SAAS;AAAA,EACzB,CAAC;AAED,QAAM,UAC+C;AAAA,IACjD;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,cAAc,oBAAoB;AAAA,QAC9D,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS;AAAA,IACZ;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAiBA,eAAsBC,6BACpB,eAeA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UAC+C;AAAA,IACjD;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,eAAe,OAAO;AAAA,QAClD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,eAAe;AAAA,IAClB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAeA,eAAsBC,yBACpB,cACA,SACuE;AAEvE,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,UAAU,SAAS;AAAA,IACnB,UAAU,SAAS;AAAA,EACrB,CAAC;AAED,QAAM,UAC+C;AAAA,IACjD;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,cAAc;AAAA,UACd,UAAU;AAAA,UACV,UAAU;AAAA,QACZ;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,gBAAgB,SAAS;AAAA,IAC5B;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["payload","SubscriptionEnumStatus","Status","WebhookIdentityType","getEmailSubscription","queryEmailSubscriptions","upsertEmailSubscription","bulkUpsertEmailSubscription","generateUnsubscribeLink"]}

package/build/es/meta.d.mts

@@ -0,0 +1,209 @@
+import { GetEmailSubscriptionRequest as GetEmailSubscriptionRequest$1, GetEmailSubscriptionResponse as GetEmailSubscriptionResponse$1, QueryEmailSubscriptionsRequest as QueryEmailSubscriptionsRequest$1, QueryEmailSubscriptionsResponse as QueryEmailSubscriptionsResponse$1, UpsertEmailSubscriptionRequest as UpsertEmailSubscriptionRequest$1, UpsertEmailSubscriptionResponse as UpsertEmailSubscriptionResponse$1, BulkUpsertEmailSubscriptionRequest as BulkUpsertEmailSubscriptionRequest$1, BulkUpsertEmailSubscriptionResponse as BulkUpsertEmailSubscriptionResponse$1, GenerateUnsubscribeLinkRequest as GenerateUnsubscribeLinkRequest$1, GenerateUnsubscribeLinkResponse as GenerateUnsubscribeLinkResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
+
+interface EmailSubscription {
+    /**
+     * Email subscription ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Email address.
+     * @format EMAIL
+     */
+    email?: string;
+    /**
+     * Indicates the recipient's opt-in or opt-out status
+     * for marketing emails.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `PENDING`: Subscription confirmation was requested,
+     * but recipient hasn't confirmed yet.
+     * - `SUBSCRIBED`: Recipient has opted in to marketing emails.
+     * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    subscriptionStatus?: SubscriptionEnumStatusWithLiterals;
+    /**
+     * Indicates last reported status of sent emails.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `VALID`: Emails to this email address are being delivered successfully.
+     * - `BOUNCED`: The last email to the recipient bounced or was rejected.
+     * - `SPAM_COMPLAINT`: The recipient registered a spam complaint
+     * with their email provider.
+     * - `INACTIVE`: Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.)
+     * This status might impact subsequent emails sent to this address.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    deliverabilityStatus?: StatusWithLiterals;
+    /**
+     * Date and time the email subscription was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the email subscription was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+declare enum SubscriptionEnumStatus {
+    UNKNOWN = "UNKNOWN",
+    /** No Subscription exists */
+    NOT_SET = "NOT_SET",
+    /** Pending Subscription */
+    PENDING = "PENDING",
+    /** Subscribed */
+    SUBSCRIBED = "SUBSCRIBED",
+    /** UnSubscribed */
+    UNSUBSCRIBED = "UNSUBSCRIBED"
+}
+/** @enumType */
+type SubscriptionEnumStatusWithLiterals = SubscriptionEnumStatus | 'UNKNOWN' | 'NOT_SET' | 'PENDING' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
+declare enum Status {
+    NOT_SET = "NOT_SET",
+    /** valid/deferral */
+    VALID = "VALID",
+    /** bounced/rejected/invalid */
+    BOUNCED = "BOUNCED",
+    /** spam/complaint */
+    SPAM_COMPLAINT = "SPAM_COMPLAINT",
+    /** valid, but no activity reported */
+    INACTIVE = "INACTIVE"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'NOT_SET' | 'VALID' | 'BOUNCED' | 'SPAM_COMPLAINT' | 'INACTIVE';
+interface GetEmailSubscriptionRequest {
+    /** @format GUID */
+    id: string;
+}
+interface GetEmailSubscriptionResponse {
+    /** Returned email subscription */
+    emailSubscription?: EmailSubscription;
+}
+interface QueryEmailSubscriptionsRequest {
+    /**
+     * Filter options.
+     * Currently, querying is supported on the `email` field
+     * with the `$in` array filter.
+     */
+    filter: Record<string, any> | null;
+    /**
+     * Pagination options. For more information, see
+     * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     */
+    paging?: Paging;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface QueryEmailSubscriptionsResponse {
+    /** List of subscribed emails that matched the query options. */
+    subscriptions?: EmailSubscription[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface UpsertEmailSubscriptionRequest {
+    /** Email subscription to update or create. */
+    subscription?: EmailSubscription;
+}
+interface UpsertEmailSubscriptionResponse {
+    /** Updated or created email subscription. */
+    subscription?: EmailSubscription;
+}
+interface BulkUpsertEmailSubscriptionRequest {
+    /**
+     * List of email subscriptions to update or create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    subscriptions: EmailSubscription[];
+}
+interface BulkUpsertEmailSubscriptionResponse {
+    /** List of updated or created email subscriptions. */
+    results?: BulkUpsertEmailSubscriptionResult[];
+    /** Numbers of successful and failed actions. */
+    metadata?: Metadata;
+}
+interface BulkUpsertEmailSubscriptionResult {
+    /** Position of the requested email subscription in the bulk array. */
+    originalIndex?: number;
+    /** New or updated email subscription. */
+    emailSubscription?: EmailSubscription;
+    /**
+     * Error information if the action failed.
+     * Omitted from successful actions.
+     */
+    error?: Error;
+}
+interface Error {
+    /** Error code. */
+    errorCode?: string;
+    /** Message that contains details about the error. */
+    message?: string;
+}
+interface Metadata {
+    /** Number of successful actions. */
+    totalSuccess?: number;
+    /** Number of failed actions. */
+    totalFailure?: number;
+}
+interface GenerateUnsubscribeLinkRequest {
+    /**
+     * Email address the unsubscribe link is for.
+     * @format EMAIL
+     */
+    emailAddress: string;
+    /** Arbitrary parameters for closing-the-loop. */
+    metadata?: Record<string, string>;
+    /**
+     * Language for displaying unsubscribe confirmation page.
+     *
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     *
+     * Default: `EN`
+     * @format LANGUAGE
+     */
+    language?: string | null;
+}
+interface GenerateUnsubscribeLinkResponse {
+    /** The unsubscribe link. */
+    link?: string;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getEmailSubscription(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetEmailSubscriptionRequest$1, GetEmailSubscriptionRequest, GetEmailSubscriptionResponse$1, GetEmailSubscriptionResponse>;
+declare function queryEmailSubscriptions(): __PublicMethodMetaInfo<'POST', {}, QueryEmailSubscriptionsRequest$1, QueryEmailSubscriptionsRequest, QueryEmailSubscriptionsResponse$1, QueryEmailSubscriptionsResponse>;
+declare function upsertEmailSubscription(): __PublicMethodMetaInfo<'POST', {}, UpsertEmailSubscriptionRequest$1, UpsertEmailSubscriptionRequest, UpsertEmailSubscriptionResponse$1, UpsertEmailSubscriptionResponse>;
+declare function bulkUpsertEmailSubscription(): __PublicMethodMetaInfo<'POST', {}, BulkUpsertEmailSubscriptionRequest$1, BulkUpsertEmailSubscriptionRequest, BulkUpsertEmailSubscriptionResponse$1, BulkUpsertEmailSubscriptionResponse>;
+declare function generateUnsubscribeLink(): __PublicMethodMetaInfo<'POST', {}, GenerateUnsubscribeLinkRequest$1, GenerateUnsubscribeLinkRequest, GenerateUnsubscribeLinkResponse$1, GenerateUnsubscribeLinkResponse>;
+
+export { type __PublicMethodMetaInfo, bulkUpsertEmailSubscription, generateUnsubscribeLink, getEmailSubscription, queryEmailSubscriptions, upsertEmailSubscription };