@wix/notifications 1.0.13 → 1.0.14

package/build/es/src/ping-notifications-v3-notification.universal.d.ts

@@ -1,146 +0,0 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
-export interface Notification {
-    /** The id of the notification */
-    _id?: string;
-}
-export interface NotifyRequest {
-    /**
-     * Notification template ID. A notification template specifies the text and recipients for notifications.
-     * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
-     */
-    notificationTemplateId: string;
-    /**
-     * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
-     * The value is an object containing the text to replace the placeholder in the notifications.
-     */
-    dynamicValues?: Record<string, DynamicValue>;
-}
-export interface DynamicValue extends DynamicValueOfTypeOneOf {
-    /** Text to be integrated into the notification. */
-    text?: string;
-}
-/** @oneof */
-export interface DynamicValueOfTypeOneOf {
-    /** Text to be integrated into the notification. */
-    text?: string;
-}
-/**
- * Money.
- * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
- */
-export interface Money {
-    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
-    value?: string;
-    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
-    currency?: string;
-    /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
-    formattedValue?: string | null;
-}
-export interface MapDynamicValue {
-    /** items */
-    items?: Record<string, DynamicValue>;
-}
-export interface ArrayDynamicValue {
-    /** items */
-    items?: DynamicValue[];
-}
-export interface AttachmentDynamicValue {
-    /** file name */
-    fileName?: string;
-    /** download url */
-    downloadUrl?: string;
-}
-export interface NotifyResponse {
-    /** ID of the batch of notifications triggered by one request. */
-    notificationBatchId?: string;
-}
-export interface NotifyByAppRequest {
-    /** notification_template_id */
-    notificationTemplateId?: string;
-    /** app_def_id */
-    appDefId?: string;
-    /** dynamic_values */
-    dynamicValues?: Record<string, DynamicValue>;
-    /** template tenant */
-    templateTenant?: string | null;
-    /** overrides */
-    overrides?: Overrides;
-    /** channels content */
-    channelsData?: ChannelsData;
-}
-export interface Overrides {
-    /** excluded_channels */
-    excludedChannels?: TemplateChannel[];
-    /** excluded_audiences */
-    excludedAudiences?: ExcludedAudiences;
-    /** content overrides */
-    content?: ChannelsContent;
-}
-export declare enum TemplateChannel {
-    WEB_FEED = "WEB_FEED",
-    MOBILE_FEED = "MOBILE_FEED",
-    MOBILE_PUSH = "MOBILE_PUSH",
-    BROWSER = "BROWSER",
-    SMS = "SMS",
-    EMAIL = "EMAIL",
-    KAFKA = "KAFKA",
-    VOICE = "VOICE"
-}
-export interface ExcludedAudiences {
-    /** audience_key */
-    audienceKey?: string[];
-}
-export interface ChannelsContent {
-    /** mobile push override */
-    mobileContent?: MobileContent;
-}
-export interface MobileContent {
-    /** title override of mobile push content */
-    title?: string;
-    /** body override of mobile push content */
-    body?: string;
-}
-export interface ChannelsData {
-    /** email data */
-    emailData?: EmailData;
-}
-export interface EmailData {
-    /** shoutout action config */
-    shoutoutActionConfig?: Record<string, any> | null;
-}
-export interface NotifyByAppResponse {
-    /** notification_batch_id */
-    notificationBatchId?: string;
-}
-/**
- * Sends notifications based on the template and dynamic values provided.
- *
- * > This feature is not yet available to all users.
- *
- * An app can call this endpoint up to 100,000 times per month for each site.
- *
- * When you [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center, you are given a notification template ID.
- * Call the Notify endpoint with this ID as `notificationTemplateID` to trigger notifications based on the notification template.
- * If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the `dynamicValues` array.
- * The values you specify are incorporated seamlessly in the notifications sent out.
- * @param notificationTemplateId - Notification template ID. A notification template specifies the text and recipients for notifications.
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
- * @public
- * @documentationMaturity preview
- * @requiredField notificationTemplateId
- * @permissionScope Manage Notifications
- * @applicableIdentity APP
- */
-export declare function notify(notificationTemplateId: string, options?: NotifyOptions): Promise<NotifyResponse>;
-export interface NotifyOptions {
-    /**
-     * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).
-     * The value is an object containing the text to replace the placeholder in the notifications.
-     */
-    dynamicValues?: Record<string, DynamicValue>;
-}

package/build/es/src/ping-notifications-v3-notification.universal.js

@@ -1,109 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { serializer, transformError } from '@wix/metro-runtime/velo';
-import * as ambassadorWixPingNotificationsV3Notification from './ping-notifications-v3-notification.http';
-let __verbose = false;
-function __log(...args) {
-    __verbose && console.log(...args);
-}
-function __inspect(obj) {
-    return obj;
-}
-export const __debug = {
-    verboseLogging: {
-        on: () => (__verbose = true),
-        off: () => (__verbose = false),
-    },
-};
-const _toVeloEntity = '$';
-const _fromVeloEntity = '$';
-export var TemplateChannel;
-(function (TemplateChannel) {
-    TemplateChannel["WEB_FEED"] = "WEB_FEED";
-    TemplateChannel["MOBILE_FEED"] = "MOBILE_FEED";
-    TemplateChannel["MOBILE_PUSH"] = "MOBILE_PUSH";
-    TemplateChannel["BROWSER"] = "BROWSER";
-    TemplateChannel["SMS"] = "SMS";
-    TemplateChannel["EMAIL"] = "EMAIL";
-    TemplateChannel["KAFKA"] = "KAFKA";
-    TemplateChannel["VOICE"] = "VOICE";
-})(TemplateChannel || (TemplateChannel = {}));
-const _arrayDynamicValue = { items: '_dynamicValue' };
-const _dynamicValue = { map: '_mapDynamicValue', array: '_arrayDynamicValue' };
-const _mapDynamicValue = { items: 'Map#_dynamicValue' };
-const _notifyRequest = { dynamicValues: 'Map#_dynamicValue' };
-const _notifyResponse = {};
-/**
- * Sends notifications based on the template and dynamic values provided.
- *
- * > This feature is not yet available to all users.
- *
- * An app can call this endpoint up to 100,000 times per month for each site.
- *
- * When you [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center, you are given a notification template ID.
- * Call the Notify endpoint with this ID as `notificationTemplateID` to trigger notifications based on the notification template.
- * If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the `dynamicValues` array.
- * The values you specify are incorporated seamlessly in the notifications sent out.
- * @param notificationTemplateId - Notification template ID. A notification template specifies the text and recipients for notifications.
- * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.
- * @public
- * @documentationMaturity preview
- * @requiredField notificationTemplateId
- * @permissionScope Manage Notifications
- * @applicableIdentity APP
- */
-export function notify(notificationTemplateId, options) {
-    var _a, _b, _c;
-    return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = {
-            notificationTemplateId: '$[0]',
-            dynamicValues: '$[1].dynamicValues',
-        };
-        const responseTransformation = '$';
-        // @ts-ignore
-        const { httpClient, sideEffects } = arguments[2];
-        const { toAmbassadorRequest } = serializer({
-            rootSchema: _notifyRequest,
-            depSchemas: { _arrayDynamicValue, _dynamicValue, _mapDynamicValue },
-            fqdnTransformation: {
-                paths: [],
-                transformation: _fromVeloEntity,
-            },
-            customTransformation: requestTransformation,
-        });
-        const { fromJSON } = serializer({
-            rootSchema: _notifyResponse,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _toVeloEntity,
-            },
-            customTransformation: responseTransformation,
-        });
-        const payload = toAmbassadorRequest([notificationTemplateId, options]);
-        const reqOpts = ambassadorWixPingNotificationsV3Notification.notify(payload);
-        __log(`"Notify" sending request with: ${__inspect(reqOpts)}`);
-        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
-        try {
-            const result = yield httpClient.request(reqOpts);
-            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
-            return fromJSON(result.data);
-        }
-        catch (err) {
-            const transformedError = transformError(err, requestTransformation, [
-                'notificationTemplateId',
-                'options',
-            ]);
-            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
-            throw transformedError;
-        }
-    });
-}
-//# sourceMappingURL=ping-notifications-v3-notification.universal.js.map

package/build/es/src/ping-notifications-v3-notification.universal.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ping-notifications-v3-notification.universal.js","sourceRoot":"","sources":["../../../src/ping-notifications-v3-notification.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,4CAA4C,MAAM,2CAA2C,CAAC;AAE1G,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AA0F5B,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,8CAA2B,CAAA;IAC3B,sCAAmB,CAAA;IACnB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B;AAkCD,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;AACtD,MAAM,aAAa,GAAG,EAAE,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;AAC/E,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;AACxD,MAAM,cAAc,GAAG,EAAE,aAAa,EAAE,mBAAmB,EAAE,CAAC;AAC9D,MAAM,eAAe,GAAG,EAAE,CAAC;AAE3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAgB,MAAM,CAC1B,sBAA8B,EAC9B,OAAuB;;;QAEvB,MAAM,qBAAqB,GAAG;YAC5B,sBAAsB,EAAE,MAAM;YAC9B,aAAa,EAAE,oBAAoB;SACpC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,EAAE,kBAAkB,EAAE,aAAa,EAAE,gBAAgB,EAAE;YACnE,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;QAEvE,MAAM,OAAO,GAAG,4CAA4C,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE7E,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,wBAAwB;gBACxB,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF"}