@wix/email-subscriptions 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1 @@
+export * as emailSubscriptions from './src/emailsubscriptions-v1-emailsubscription.public';

package/build/cjs/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emailSubscriptions = void 0;
+exports.emailSubscriptions = __importStar(require("./src/emailsubscriptions-v1-emailsubscription.public"));
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,2GAA2F"}

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

@@ -0,0 +1,40 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { BulkUpsertEmailSubscriptionRequest, BulkUpsertEmailSubscriptionResponse, GenerateUnsubscribeLinkRequest, GenerateUnsubscribeLinkResponse, QueryEmailSubscriptionsRequest, QueryEmailSubscriptionsResponse, UpsertEmailSubscriptionRequest, UpsertEmailSubscriptionResponse } from './emailsubscriptions-v1-emailsubscription.types';
+/**
+ * Retrieves email subscriptions,
+ * given the provided paging, filtering, and sorting.
+ *
+ * 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",
+ * the filter should be formed like this:
+ *
+ * ```json
+ * { "filter": {
+ * "email": {
+ * "$in": ["me@my.com", "you@your.org"]
+ * }
+ * }
+ * }
+ * ```
+ *
+ * To learn how to query email subscriptions, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ */
+export declare function queryEmailSubscriptions(payload: QueryEmailSubscriptionsRequest): RequestOptionsFactory<QueryEmailSubscriptionsResponse>;
+/**
+ * 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.
+ */
+export declare function upsertEmailSubscription(payload: UpsertEmailSubscriptionRequest): RequestOptionsFactory<UpsertEmailSubscriptionResponse>;
+/** Updates or creates multiple email subscriptions. */
+export declare function bulkUpsertEmailSubscription(payload: BulkUpsertEmailSubscriptionRequest): RequestOptionsFactory<BulkUpsertEmailSubscriptionResponse>;
+/**
+ * Creates an unsubscribe link to be shared with the relevant recipient.
+ *
+ * If someone clicks the **Unsubscribe** button on the confirmation page,
+ * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
+ */
+export declare function generateUnsubscribeLink(payload: GenerateUnsubscribeLinkRequest): RequestOptionsFactory<GenerateUnsubscribeLinkResponse>;

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

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateUnsubscribeLink = exports.bulkUpsertEmailSubscription = exports.upsertEmailSubscription = exports.queryEmailSubscriptions = void 0;
+const ambassador_1 = require("@wix/metro-runtime/ambassador");
+const metro_runtime_1 = require("@wix/metro-runtime");
+const _bulkUpsertEmailSubscriptionRequest = {
+    subscriptions: '_emailSubscription',
+};
+const _bulkUpsertEmailSubscriptionResponse = {
+    results: '_bulkUpsertEmailSubscriptionResult',
+};
+const _bulkUpsertEmailSubscriptionResult = {
+    emailSubscription: '_emailSubscription',
+};
+const _emailSubscription = {
+    createdDate: 'google.protobuf.Timestamp',
+    updatedDate: 'google.protobuf.Timestamp',
+};
+const _generateUnsubscribeLinkRequest = {};
+const _generateUnsubscribeLinkResponse = {};
+const _queryEmailSubscriptionsRequest = {};
+const _queryEmailSubscriptionsResponse = {
+    subscriptions: '_emailSubscription',
+};
+const _upsertEmailSubscriptionRequest = { subscription: '_emailSubscription' };
+const _upsertEmailSubscriptionResponse = { subscription: '_emailSubscription' };
+function resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl(opts) {
+    const domainToMappings = {
+        'api._api_base_domain_': [
+            {
+                srcPath: '/email-subscriptions-app',
+                destPath: '',
+            },
+        ],
+        'www.wixapis.com': [
+            {
+                srcPath: '/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',
+            },
+        ],
+        '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',
+            },
+        ],
+    };
+    return (0, metro_runtime_1.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+/**
+ * Retrieves email subscriptions,
+ * given the provided paging, filtering, and sorting.
+ *
+ * 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",
+ * the filter should be formed like this:
+ *
+ * ```json
+ * { "filter": {
+ * "email": {
+ * "$in": ["me@my.com", "you@your.org"]
+ * }
+ * }
+ * }
+ * ```
+ *
+ * To learn how to query email subscriptions, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ */
+function queryEmailSubscriptions(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryEmailSubscriptionsRequest, {});
+    const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_queryEmailSubscriptionsResponse, {
+        _emailSubscription,
+    });
+    function __queryEmailSubscriptions({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
+            method: 'POST',
+            methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions',
+            url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+                protoPath: '/v1/email-subscriptions/query',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __queryEmailSubscriptions.fromReq = fromReq;
+    return __queryEmailSubscriptions;
+}
+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.
+ */
+function upsertEmailSubscription(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_upsertEmailSubscriptionRequest, { _emailSubscription });
+    const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_upsertEmailSubscriptionResponse, {
+        _emailSubscription,
+    });
+    function __upsertEmailSubscription({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
+            method: 'POST',
+            methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription',
+            url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+                protoPath: '/v1/email-subscriptions',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __upsertEmailSubscription.fromReq = fromReq;
+    return __upsertEmailSubscription;
+}
+exports.upsertEmailSubscription = upsertEmailSubscription;
+/** Updates or creates multiple email subscriptions. */
+function bulkUpsertEmailSubscription(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_bulkUpsertEmailSubscriptionRequest, { _emailSubscription });
+    const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_bulkUpsertEmailSubscriptionResponse, { _bulkUpsertEmailSubscriptionResult, _emailSubscription });
+    function __bulkUpsertEmailSubscription({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
+            method: 'POST',
+            methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription',
+            url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+                protoPath: '/v1/email-subscriptions/bulk',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __bulkUpsertEmailSubscription.fromReq = fromReq;
+    return __bulkUpsertEmailSubscription;
+}
+exports.bulkUpsertEmailSubscription = bulkUpsertEmailSubscription;
+/**
+ * Creates an unsubscribe link to be shared with the relevant recipient.
+ *
+ * If someone clicks the **Unsubscribe** button on the confirmation page,
+ * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
+ */
+function generateUnsubscribeLink(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_generateUnsubscribeLinkRequest, {});
+    const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_generateUnsubscribeLinkResponse, {});
+    function __generateUnsubscribeLink({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.emailsubscriptions.v1.emailsubscription',
+            method: 'POST',
+            methodFqn: 'com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink',
+            url: resolveComWixpressEmailsubscriptionsV1EmailSubscriptionsServiceUrl({
+                protoPath: '/v1/email-subscriptions/unsubscribe-link',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __generateUnsubscribeLink.fromReq = fromReq;
+    return __generateUnsubscribeLink;
+}
+exports.generateUnsubscribeLink = generateUnsubscribeLink;
+//# sourceMappingURL=emailsubscriptions-v1-emailsubscription.http.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"emailsubscriptions-v1-emailsubscription.http.js","sourceRoot":"","sources":["../../../src/emailsubscriptions-v1-emailsubscription.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAchD,MAAM,mCAAmC,GAAG;IAC1C,aAAa,EAAE,oBAAoB;CACpC,CAAC;AACF,MAAM,oCAAoC,GAAG;IAC3C,OAAO,EAAE,oCAAoC;CAC9C,CAAC;AACF,MAAM,kCAAkC,GAAG;IACzC,iBAAiB,EAAE,oBAAoB;CACxC,CAAC;AACF,MAAM,kBAAkB,GAAG;IACzB,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG;IACvC,aAAa,EAAE,oBAAoB;CACpC,CAAC;AACF,MAAM,+BAA+B,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAC/E,MAAM,gCAAgC,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAEhF,SAAS,kEAAkE,CACzE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,yCAAyC;gBAClD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,8CAA8C;gBACvD,QAAQ,EAAE,yBAAyB;aACpC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,uBAAuB,CACrC,OAAuC;IAEvC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,+BAA+B,EAC/B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,gCAAgC,EAAE;QACzE,kBAAkB;KACnB,CAAC,CAAC;IAEH,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sFAAsF;YACxF,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,+BAA+B;gBAC1C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,yBAAyB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE5C,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAjCD,0DAiCC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,OAAuC;IAEvC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,+BAA+B,EAC/B,EAAE,kBAAkB,EAAE,CACvB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,gCAAgC,EAAE;QACzE,kBAAkB;KACnB,CAAC,CAAC;IAEH,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sFAAsF;YACxF,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,yBAAyB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE5C,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAjCD,0DAiCC;AAED,uDAAuD;AACvD,SAAgB,2BAA2B,CACzC,OAA2C;IAE3C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,mCAAmC,EACnC,EAAE,kBAAkB,EAAE,CACvB,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,oCAAoC,EACpC,EAAE,kCAAkC,EAAE,kBAAkB,EAAE,CAC3D,CAAC;IAEF,SAAS,6BAA6B,CAAC,EAAE,IAAI,EAAO;QAClD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0FAA0F;YAC5F,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,8BAA8B;gBACzC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,6BAA6B,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhD,OAAO,6BAA6B,CAAC;AACvC,CAAC;AAlCD,kEAkCC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,OAAuC;IAEvC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,+BAA+B,EAC/B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACtC,gCAAgC,EAChC,EAAE,CACH,CAAC;IAEF,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,6CAA6C;YACzD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sFAAsF;YACxF,GAAG,EAAE,kEAAkE,CAAC;gBACtE,SAAS,EAAE,0CAA0C;gBACrD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,yBAAyB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE5C,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAlCD,0DAkCC"}

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

@@ -0,0 +1,11 @@
+import { HttpClient } from '@wix/sdk-types';
+import { EmailSubscription, GenerateUnsubscribeLinkOptions, QueryEmailSubscriptionsOptions, UpsertEmailSubscriptionOptions } from './emailsubscriptions-v1-emailsubscription.universal';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function queryEmailSubscriptions(httpClient: HttpClient): (filter: Record<string, any> | null, options?: QueryEmailSubscriptionsOptions | undefined) => Promise<import("./emailsubscriptions-v1-emailsubscription.universal").QueryEmailSubscriptionsResponse>;
+export declare function upsertEmailSubscription(httpClient: HttpClient): (options?: UpsertEmailSubscriptionOptions | undefined) => Promise<import("./emailsubscriptions-v1-emailsubscription.universal").UpsertEmailSubscriptionResponse>;
+export declare function bulkUpsertEmailSubscription(httpClient: HttpClient): (subscriptions: EmailSubscription[]) => Promise<import("./emailsubscriptions-v1-emailsubscription.universal").BulkUpsertEmailSubscriptionResponse>;
+export declare function generateUnsubscribeLink(httpClient: HttpClient): (emailAddress: string, options?: GenerateUnsubscribeLinkOptions | undefined) => Promise<import("./emailsubscriptions-v1-emailsubscription.universal").GenerateUnsubscribeLinkResponse>;
+export { SubscriptionEnumStatus, Status, } from './emailsubscriptions-v1-emailsubscription.universal';
+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, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, ExtendedFieldsUpdatedEvent, QueryEmailSubscriptionsOptions, UpsertEmailSubscriptionOptions, GenerateUnsubscribeLinkOptions, } from './emailsubscriptions-v1-emailsubscription.universal';

package/build/cjs/src/emailsubscriptions-v1-emailsubscription.public.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Status = exports.SubscriptionEnumStatus = exports.generateUnsubscribeLink = exports.bulkUpsertEmailSubscription = exports.upsertEmailSubscription = exports.queryEmailSubscriptions = exports.__metadata = void 0;
+const emailsubscriptions_v1_emailsubscription_universal_1 = require("./emailsubscriptions-v1-emailsubscription.universal");
+exports.__metadata = { PACKAGE_NAME: '@wix/email-subscriptions' };
+function queryEmailSubscriptions(httpClient) {
+    return (filter, options) => (0, emailsubscriptions_v1_emailsubscription_universal_1.queryEmailSubscriptions)(filter, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.queryEmailSubscriptions = queryEmailSubscriptions;
+function upsertEmailSubscription(httpClient) {
+    return (options) => (0, emailsubscriptions_v1_emailsubscription_universal_1.upsertEmailSubscription)(options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.upsertEmailSubscription = upsertEmailSubscription;
+function bulkUpsertEmailSubscription(httpClient) {
+    return (subscriptions) => (0, emailsubscriptions_v1_emailsubscription_universal_1.bulkUpsertEmailSubscription)(subscriptions, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.bulkUpsertEmailSubscription = bulkUpsertEmailSubscription;
+function generateUnsubscribeLink(httpClient) {
+    return (emailAddress, options) => (0, emailsubscriptions_v1_emailsubscription_universal_1.generateUnsubscribeLink)(emailAddress, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.generateUnsubscribeLink = generateUnsubscribeLink;
+var emailsubscriptions_v1_emailsubscription_universal_2 = require("./emailsubscriptions-v1-emailsubscription.universal");
+Object.defineProperty(exports, "SubscriptionEnumStatus", { enumerable: true, get: function () { return emailsubscriptions_v1_emailsubscription_universal_2.SubscriptionEnumStatus; } });
+Object.defineProperty(exports, "Status", { enumerable: true, get: function () { return emailsubscriptions_v1_emailsubscription_universal_2.Status; } });
+//# sourceMappingURL=emailsubscriptions-v1-emailsubscription.public.js.map

package/build/cjs/src/emailsubscriptions-v1-emailsubscription.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emailsubscriptions-v1-emailsubscription.public.js","sourceRoot":"","sources":["../../../src/emailsubscriptions-v1-emailsubscription.public.ts"],"names":[],"mappings":";;;AACA,2HAS6D;AAEhD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,0BAA0B,EAAE,CAAC;AAEvE,SAAgB,uBAAuB,CAAC,UAAsB;IAC5D,OAAO,CACL,MAAkC,EAClC,OAAwC,EACxC,EAAE,CACF,IAAA,2EAAgC,EAC9B,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAXD,0DAWC;AAED,SAAgB,uBAAuB,CAAC,UAAsB;IAC5D,OAAO,CAAC,OAAwC,EAAE,EAAE,CAClD,IAAA,2EAAgC,EAC9B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,0DAOC;AAED,SAAgB,2BAA2B,CAAC,UAAsB;IAChE,OAAO,CAAC,aAAkC,EAAE,EAAE,CAC5C,IAAA,+EAAoC,EAClC,aAAa;IACb,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kEAOC;AAED,SAAgB,uBAAuB,CAAC,UAAsB;IAC5D,OAAO,CAAC,YAAoB,EAAE,OAAwC,EAAE,EAAE,CACxE,IAAA,2EAAgC,EAC9B,YAAY,EACZ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0DAQC;AAED,yHAG6D;AAF3D,2JAAA,sBAAsB,OAAA;AACtB,2IAAA,MAAM,OAAA"}

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

@@ -0,0 +1,258 @@
+export interface EmailSubscription {
+    /** @readonly */
+    id?: string | null;
+    /** Email address. */
+    email?: string;
+    /**
+     * Indicates the recipient's opt-in or opt-out status
+     * for marketing emails.
+     *
+     * - `NOT_SET`: No status specified.
+     * - `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.
+     *
+     * - `NOT_SET`: No status specified.
+     * - `VALID`: Emails haven't bounced,
+     * but the recipient hasn't actively subscribed or unsubscribed.
+     * - `BOUNCED`: The last email to the recipient bounced or was rejected.
+     * - `SPAM_COMPLAINT`: Recipient registered a spam complaint
+     * with their email provider.
+     * - `INACTIVE`: No activity has been reported.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    deliverabilityStatus?: Status;
+    /** @readonly */
+    createdDate?: Date;
+    /** @readonly */
+    updatedDate?: Date;
+}
+export declare enum SubscriptionEnumStatus {
+    UNKNOWN = "UNKNOWN",
+    /** No Subscription exists */
+    NOT_SET = "NOT_SET",
+    /** Pending Subscription */
+    PENDING = "PENDING",
+    /** Subscribed */
+    SUBSCRIBED = "SUBSCRIBED",
+    /** UnSubscribed */
+    UNSUBSCRIBED = "UNSUBSCRIBED"
+}
+export 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"
+}
+export interface EmailSubscriptionChanged {
+    /** subscription */
+    subscription?: EmailSubscription;
+}
+export interface GetEmailSubscriptionRequest {
+    id?: string;
+}
+export interface GetEmailSubscriptionResponse {
+    /** Returned email subscription */
+    emailSubscription?: EmailSubscription;
+}
+export interface UpdateEmailSubscriptionRequest {
+    /** Email subscription to update */
+    subscription?: EmailSubscription;
+}
+export interface UpdateEmailSubscriptionResponse {
+    /** Updated email subscription */
+    subscription?: EmailSubscription;
+}
+export 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;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryEmailSubscriptionsResponse {
+    /** List of subscribed emails that matched the query options. */
+    subscriptions?: EmailSubscription[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+export 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;
+}
+export interface UpsertEmailSubscriptionRequest {
+    /** Email subscription to update or create. */
+    subscription?: EmailSubscription;
+}
+export interface UpsertEmailSubscriptionResponse {
+    /** Updated or created email subscription. */
+    subscription?: EmailSubscription;
+}
+export interface BulkUpsertEmailSubscriptionRequest {
+    /** List of email subscriptions to update or create. */
+    subscriptions: EmailSubscription[];
+}
+export interface BulkUpsertEmailSubscriptionResponse {
+    /** List of updated or created email subscriptions. */
+    results?: BulkUpsertEmailSubscriptionResult[];
+    /** Numbers of successful and failed actions. */
+    metadata?: Metadata;
+}
+export 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;
+}
+export interface Error {
+    /** Error code. */
+    errorCode?: string;
+    /** Message that contains details about the error. */
+    message?: string;
+}
+export interface Metadata {
+    /** Number of successful actions. */
+    totalSuccess?: number;
+    /** Number of failed actions. */
+    totalFailure?: number;
+}
+export interface GenerateUnsubscribeLinkRequest {
+    /** Email address the unsubscribe link is for. */
+    emailAddress: string;
+    /** Arbitrary parameters for closing-the-loop. */
+    metadata?: Record<string, string>;
+    /** Language for displaying unsubscribe confirmation page (optional - default EN). */
+    language?: string | null;
+}
+export interface GenerateUnsubscribeLinkResponse {
+    /** The unsubscribe link. */
+    link?: string;
+}
+export interface RenderUnsubscribePageRequest {
+    /** 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 ConfirmUnsubscribeActionRequest {
+    /** Payload */
+    payload?: string;
+}
+export interface Empty {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+    /** random GUID so clients can tell if event was already handled */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /**
+     * Assuming that all messages including Actions have id
+     * Example: The id of the specific order, the id of a specific campaign
+     */
+    entityId?: string;
+    /** The time of the event. Useful if there was a delay in dispatching */
+    eventTime?: Date;
+    /**
+     * A field that should be set if this event was triggered by an anonymize request.
+     * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
+     * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+export 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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface ExtendedFieldsUpdatedEvent {
+    currentEntityAsJson?: string;
+}

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

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Status = exports.SubscriptionEnumStatus = void 0;
+var SubscriptionEnumStatus;
+(function (SubscriptionEnumStatus) {
+    SubscriptionEnumStatus["UNKNOWN"] = "UNKNOWN";
+    /** No Subscription exists */
+    SubscriptionEnumStatus["NOT_SET"] = "NOT_SET";
+    /** Pending Subscription */
+    SubscriptionEnumStatus["PENDING"] = "PENDING";
+    /** Subscribed */
+    SubscriptionEnumStatus["SUBSCRIBED"] = "SUBSCRIBED";
+    /** UnSubscribed */
+    SubscriptionEnumStatus["UNSUBSCRIBED"] = "UNSUBSCRIBED";
+})(SubscriptionEnumStatus = exports.SubscriptionEnumStatus || (exports.SubscriptionEnumStatus = {}));
+var Status;
+(function (Status) {
+    Status["NOT_SET"] = "NOT_SET";
+    /** valid/deferral */
+    Status["VALID"] = "VALID";
+    /** bounced/rejected/invalid */
+    Status["BOUNCED"] = "BOUNCED";
+    /** spam/complaint */
+    Status["SPAM_COMPLAINT"] = "SPAM_COMPLAINT";
+    /** valid, but no activity reported */
+    Status["INACTIVE"] = "INACTIVE";
+})(Status = exports.Status || (exports.Status = {}));
+//# sourceMappingURL=emailsubscriptions-v1-emailsubscription.types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"emailsubscriptions-v1-emailsubscription.types.js","sourceRoot":"","sources":["../../../src/emailsubscriptions-v1-emailsubscription.types.ts"],"names":[],"mappings":";;;AAsCA,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,GAAtB,8BAAsB,KAAtB,8BAAsB,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,GAAN,cAAM,KAAN,cAAM,QAUjB"}