@wix/auto_sdk_email-subscriptions_email-subscriptions 1.0.0 → 1.0.2

package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.context.d.ts

@@ -9,4 +9,4 @@ export declare const generateUnsubscribeLink: MaybeContext<BuildRESTFunction<typ
 /** */
 export declare const onEmailsubscriptionEmailSubscriptionChanged: ReturnType<typeof createEventModule<typeof publicOnEmailsubscriptionEmailSubscriptionChanged>>;
 export { SubscriptionEnumStatus, Status, WebhookIdentityType, } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
-export { EmailSubscription, V1RenderUnsubscribePageRequest, RawHttpResponse, HeadersEntry, V1ConfirmUnsubscribeActionRequest, Empty, EmailSubscriptionChanged, GetEmailSubscriptionRequest, GetEmailSubscriptionResponse, UpdateEmailSubscriptionRequest, UpdateEmailSubscriptionResponse, QueryEmailSubscriptionsRequest, Paging, QueryEmailSubscriptionsResponse, PagingMetadata, UpsertEmailSubscriptionRequest, UpsertEmailSubscriptionResponse, BulkUpsertEmailSubscriptionRequest, BulkUpsertEmailSubscriptionResponse, BulkUpsertEmailSubscriptionResult, Error, Metadata, GenerateUnsubscribeLinkRequest, GenerateUnsubscribeLinkResponse, RenderUnsubscribePageRequest, ConfirmUnsubscribeActionRequest, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, EmailSubscriptionNonNullableFields, GetEmailSubscriptionResponseNonNullableFields, QueryEmailSubscriptionsResponseNonNullableFields, UpsertEmailSubscriptionResponseNonNullableFields, BulkUpsertEmailSubscriptionResponseNonNullableFields, GenerateUnsubscribeLinkResponseNonNullableFields, BaseEventMetadata, EmailsubscriptionEmailSubscriptionChangedEnvelope, QueryEmailSubscriptionsOptions, UpsertEmailSubscriptionOptions, GenerateUnsubscribeLinkOptions, } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
+export { EmailSubscription, EmailSubscriptionChanged, GetEmailSubscriptionRequest, GetEmailSubscriptionResponse, UpdateEmailSubscriptionRequest, UpdateEmailSubscriptionResponse, QueryEmailSubscriptionsRequest, Paging, QueryEmailSubscriptionsResponse, PagingMetadata, UpsertEmailSubscriptionRequest, UpsertEmailSubscriptionResponse, BulkUpsertEmailSubscriptionRequest, BulkUpsertEmailSubscriptionResponse, BulkUpsertEmailSubscriptionResult, Error, Metadata, GenerateUnsubscribeLinkRequest, GenerateUnsubscribeLinkResponse, RenderUnsubscribePageRequest, RawHttpResponse, HeadersEntry, ConfirmUnsubscribeActionRequest, Empty, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, V1RenderUnsubscribePageRequest, V1ConfirmUnsubscribeActionRequest, EmailSubscriptionNonNullableFields, GetEmailSubscriptionResponseNonNullableFields, QueryEmailSubscriptionsResponseNonNullableFields, UpsertEmailSubscriptionResponseNonNullableFields, BulkUpsertEmailSubscriptionResponseNonNullableFields, GenerateUnsubscribeLinkResponseNonNullableFields, BaseEventMetadata, EmailsubscriptionEmailSubscriptionChangedEnvelope, QueryEmailSubscriptionsOptions, UpsertEmailSubscriptionOptions, GenerateUnsubscribeLinkOptions, } from './emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';

package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.d.ts

@@ -7,7 +7,7 @@ export declare function getEmailSubscription(payload: object): RequestOptionsFac
  *
  * Currently, querying is supported on the `email` field
  * with the `$in` array filter.
- * For example, to query for emails "me@my.com" and "you@your.org",
+ * For example, to query for emails `"me@my.com"`` and `"you@your.org"``,
  * the filter should be formed like this:
  *
  * ```json
@@ -26,8 +26,8 @@ export declare function queryEmailSubscriptions(payload: object): RequestOptions
 /**
  * Updates or creates an email subscription for the requested email.
  *
- * An email subscription is always returned in the response,
- * regardless of whether it was updated or created.
+ * An email subscription is returned in the response
+ * whether it was updated or created.
  */
 export declare function upsertEmailSubscription(payload: object): RequestOptionsFactory<any>;
 /** Updates or creates multiple email subscriptions. */

package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.http.js

@@ -87,7 +87,7 @@ exports.getEmailSubscription = getEmailSubscription;
  *
  * Currently, querying is supported on the `email` field
  * with the `$in` array filter.
- * For example, to query for emails "me@my.com" and "you@your.org",
+ * For example, to query for emails `"me@my.com"`` and `"you@your.org"``,
  * the filter should be formed like this:
  *
  * ```json
@@ -133,8 +133,8 @@ exports.queryEmailSubscriptions = queryEmailSubscriptions;
 /**
  * Updates or creates an email subscription for the requested email.
  *
- * An email subscription is always returned in the response,
- * regardless of whether it was updated or created.
+ * An email subscription is returned in the response
+ * whether it was updated or created.
  */
 function upsertEmailSubscription(payload) {
     function __upsertEmailSubscription({ host }) {

package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.public.d.ts

@@ -11,7 +11,7 @@ interface QueryEmailSubscriptionsSignature {
      *
      * Currently, querying is supported on the `email` field
      * with the `$in` array filter.
-     * For example, to query for emails "me@my.com" and "you@your.org",
+     * For example, to query for emails `"me@my.com"`` and `"you@your.org"``,
      * the filter should be formed like this:
      *
      * ```json
@@ -36,8 +36,8 @@ interface UpsertEmailSubscriptionSignature {
     /**
      * Updates or creates an email subscription for the requested email.
      *
-     * An email subscription is always returned in the response,
-     * regardless of whether it was updated or created.
+     * An email subscription is returned in the response
+     * whether it was updated or created.
      */
     (options?: UpsertEmailSubscriptionOptions | undefined): Promise<UpsertEmailSubscriptionResponse & UpsertEmailSubscriptionResponseNonNullableFields>;
 }

package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.d.ts

@@ -1,22 +1,40 @@
 export interface EmailSubscription {
     /**
      * Email subscription ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
-    /** Email address. */
+    /**
+     * Email address.
+     * @format EMAIL
+     */
     email?: string;
     /**
      * Indicates the recipient's opt-in or opt-out status
      * for marketing emails.
      *
-     * Default: `NOT_SET`.
+     * - `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?: SubscriptionEnumStatus;
     /**
      * Indicates last reported status of sent emails.
      *
-     * Default: `NOT_SET`.
+     * - `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?: Status;
     /**
@@ -31,55 +49,34 @@ export interface EmailSubscription {
     updatedDate?: Date | null;
 }
 export declare enum SubscriptionEnumStatus {
-    /** Undefined status. */
     UNKNOWN = "UNKNOWN",
-    /** No status specified. This is the default, initial value before any info about the email address is known. */
+    /** No Subscription exists */
     NOT_SET = "NOT_SET",
-    /** Subscription confirmation was requested, but recipient hasn't confirmed yet. */
+    /** Pending Subscription */
     PENDING = "PENDING",
-    /** Recipient has opted in to marketing emails. */
+    /** Subscribed */
     SUBSCRIBED = "SUBSCRIBED",
-    /** Recipient has opted out of marketing emails. */
+    /** UnSubscribed */
     UNSUBSCRIBED = "UNSUBSCRIBED"
 }
 export declare enum Status {
-    /** No status specified. This is the initial default value before any info about the email address is known. */
     NOT_SET = "NOT_SET",
-    /** Emails to this email address are being delivered successfully. */
+    /** valid/deferral */
     VALID = "VALID",
-    /** The last email to the recipient bounced or was rejected. */
+    /** bounced/rejected/invalid */
     BOUNCED = "BOUNCED",
-    /** The recipient registered a spam complaint with their email provider. */
+    /** spam/complaint */
     SPAM_COMPLAINT = "SPAM_COMPLAINT",
-    /** 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. */
+    /** valid, but no activity reported */
     INACTIVE = "INACTIVE"
 }
-export interface V1RenderUnsubscribePageRequest {
-    /** Payload */
-    payload?: string;
-    /** Language */
-    language?: string | null;
-}
-export interface RawHttpResponse {
-    body?: Uint8Array;
-    statusCode?: number | null;
-    headers?: HeadersEntry[];
-}
-export interface HeadersEntry {
-    key?: string;
-    value?: string;
-}
-export interface V1ConfirmUnsubscribeActionRequest {
-    /** Payload */
-    payload?: string;
-}
-export interface Empty {
-}
+/** Triggered when an email subscription's status is changed. */
 export interface EmailSubscriptionChanged {
-    /** subscription */
+    /** Email subscription that changed. */
     subscription?: EmailSubscription;
 }
 export interface GetEmailSubscriptionRequest {
+    /** @format GUID */
     id: string;
 }
 export interface GetEmailSubscriptionResponse {
@@ -138,7 +135,11 @@ export interface UpsertEmailSubscriptionResponse {
     subscription?: EmailSubscription;
 }
 export interface BulkUpsertEmailSubscriptionRequest {
-    /** List of email subscriptions to update or create. */
+    /**
+     * List of email subscriptions to update or create.
+     * @minSize 1
+     * @maxSize 100
+     */
     subscriptions: EmailSubscription[];
 }
 export interface BulkUpsertEmailSubscriptionResponse {
@@ -171,11 +172,21 @@ export interface Metadata {
     totalFailure?: number;
 }
 export interface GenerateUnsubscribeLinkRequest {
-    /** Email address the unsubscribe link is for. */
+    /**
+     * 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 (optional - default EN). */
+    /**
+     * 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;
 }
 export interface GenerateUnsubscribeLinkResponse {
@@ -188,10 +199,21 @@ export interface RenderUnsubscribePageRequest {
     /** Language */
     language?: string | null;
 }
+export interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+export interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
 export interface ConfirmUnsubscribeActionRequest {
     /** Payload */
     payload?: string;
 }
+export interface Empty {
+}
 export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -265,9 +287,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -275,26 +303,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -304,6 +356,16 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+export interface V1RenderUnsubscribePageRequest {
+    /** Payload */
+    payload?: string;
+    /** Language */
+    language?: string | null;
+}
+export interface V1ConfirmUnsubscribeActionRequest {
+    /** Payload */
+    payload?: string;
+}
 interface EmailSubscriptionNonNullableFields {
     email: string;
     subscriptionStatus: SubscriptionEnumStatus;

package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js

@@ -3,28 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookIdentityType = exports.Status = exports.SubscriptionEnumStatus = void 0;
 var SubscriptionEnumStatus;
 (function (SubscriptionEnumStatus) {
-    /** Undefined status. */
     SubscriptionEnumStatus["UNKNOWN"] = "UNKNOWN";
-    /** No status specified. This is the default, initial value before any info about the email address is known. */
+    /** No Subscription exists */
     SubscriptionEnumStatus["NOT_SET"] = "NOT_SET";
-    /** Subscription confirmation was requested, but recipient hasn't confirmed yet. */
+    /** Pending Subscription */
     SubscriptionEnumStatus["PENDING"] = "PENDING";
-    /** Recipient has opted in to marketing emails. */
+    /** Subscribed */
     SubscriptionEnumStatus["SUBSCRIBED"] = "SUBSCRIBED";
-    /** Recipient has opted out of marketing emails. */
+    /** UnSubscribed */
     SubscriptionEnumStatus["UNSUBSCRIBED"] = "UNSUBSCRIBED";
 })(SubscriptionEnumStatus || (exports.SubscriptionEnumStatus = SubscriptionEnumStatus = {}));
 var Status;
 (function (Status) {
-    /** No status specified. This is the initial default value before any info about the email address is known. */
     Status["NOT_SET"] = "NOT_SET";
-    /** Emails to this email address are being delivered successfully. */
+    /** valid/deferral */
     Status["VALID"] = "VALID";
-    /** The last email to the recipient bounced or was rejected. */
+    /** bounced/rejected/invalid */
     Status["BOUNCED"] = "BOUNCED";
-    /** The recipient registered a spam complaint with their email provider. */
+    /** spam/complaint */
     Status["SPAM_COMPLAINT"] = "SPAM_COMPLAINT";
-    /** 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. */
+    /** valid, but no activity reported */
     Status["INACTIVE"] = "INACTIVE";
 })(Status || (exports.Status = Status = {}));
 var WebhookIdentityType;

package/build/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js","sourceRoot":"","sources":["../../../src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.ts"],"names":[],"mappings":";;;AAiCA,IAAY,sBAWX;AAXD,WAAY,sBAAsB;IAChC,wBAAwB;IACxB,6CAAmB,CAAA;IACnB,gHAAgH;IAChH,6CAAmB,CAAA;IACnB,mFAAmF;IACnF,6CAAmB,CAAA;IACnB,kDAAkD;IAClD,mDAAyB,CAAA;IACzB,mDAAmD;IACnD,uDAA6B,CAAA;AAC/B,CAAC,EAXW,sBAAsB,sCAAtB,sBAAsB,QAWjC;AAED,IAAY,MAWX;AAXD,WAAY,MAAM;IAChB,+GAA+G;IAC/G,6BAAmB,CAAA;IACnB,qEAAqE;IACrE,yBAAe,CAAA;IACf,+DAA+D;IAC/D,6BAAmB,CAAA;IACnB,2EAA2E;IAC3E,2CAAiC,CAAA;IACjC,6NAA6N;IAC7N,+BAAqB,CAAA;AACvB,CAAC,EAXW,MAAM,sBAAN,MAAM,QAWjB;AAuRD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"emailsubscriptions-v1-emailsubscription-email-subscriptions.types.js","sourceRoot":"","sources":["../../../src/emailsubscriptions-v1-emailsubscription-email-subscriptions.types.ts"],"names":[],"mappings":";;;AAmDA,IAAY,sBAUX;AAVD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,6BAA6B;IAC7B,6CAAmB,CAAA;IACnB,2BAA2B;IAC3B,6CAAmB,CAAA;IACnB,iBAAiB;IACjB,mDAAyB,CAAA;IACzB,mBAAmB;IACnB,uDAA6B,CAAA;AAC/B,CAAC,EAVW,sBAAsB,sCAAtB,sBAAsB,QAUjC;AAED,IAAY,MAUX;AAVD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,qBAAqB;IACrB,yBAAe,CAAA;IACf,+BAA+B;IAC/B,6BAAmB,CAAA;IACnB,qBAAqB;IACrB,2CAAiC,CAAA;IACjC,sCAAsC;IACtC,+BAAqB,CAAA;AACvB,CAAC,EAVW,MAAM,sBAAN,MAAM,QAUjB;AAyTD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}