@wix/notifications 1.0.12 → 1.0.14

package/build/cjs/index.d.ts

@@ -1 +1 @@
-export * as notifications from './src/ping-notifications-v3-notification.public';
+export * as notifications from './src/ping-notifications-v1-public-notification.public';

package/build/cjs/index.js

@@ -20,5 +20,5 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.notifications = void 0;
-exports.notifications = __importStar(require("./src/ping-notifications-v3-notification.public"));
+exports.notifications = __importStar(require("./src/ping-notifications-v1-public-notification.public"));
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

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

package/build/cjs/index.typings.d.ts

@@ -0,0 +1 @@
+export * as notifications from './src/ping-notifications-v1-public-notification.universal';

package/build/cjs/index.typings.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.notifications = void 0;
+exports.notifications = __importStar(require("./src/ping-notifications-v1-public-notification.universal"));
+//# sourceMappingURL=index.typings.js.map

package/build/cjs/index.typings.js.map

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

package/build/cjs/src/ping-notifications-v1-public-notification.http.d.ts

@@ -0,0 +1,13 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { PublicNotifyRequest, Empty } from './ping-notifications-v1-public-notification.types';
+/**
+ * Sends a notification.
+ *
+ *
+ * The `notify()` function sends a [notification](https://support.wix.com/en/article/about-your-dashboard-notifications) to the specified recipients on the specified channels.
+ *
+ * List the the channels for the notification in the `channels` parameter .
+ *
+ * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
+ */
+export declare function notify(payload: PublicNotifyRequest): RequestOptionsFactory<Empty>;

package/build/cjs/src/{ping-notifications-v3-notification.http.js → ping-notifications-v1-public-notification.http.js}

@@ -3,12 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.notify = void 0;
 const ambassador_1 = require("@wix/metro-runtime/ambassador");
 const metro_runtime_1 = require("@wix/metro-runtime");
-const _arrayDynamicValue = { items: '_dynamicValue' };
-const _dynamicValue = { map: '_mapDynamicValue', array: '_arrayDynamicValue' };
-const _mapDynamicValue = { items: 'Map#_dynamicValue' };
-const _notifyRequest = { dynamicValues: 'Map#_dynamicValue' };
-const _notifyResponse = {};
-function resolveComWixpressPingHubApiV3NotificationsServiceV3Url(opts) {
+const _empty = {};
+const _publicNotifyRequest = {};
+function resolveComWixpressPingHubApiPublicNotificationsServiceUrl(opts) {
     const domainToMappings = {
         'api._api_base_domain_': [
             {
@@ -46,32 +43,26 @@ function resolveComWixpressPingHubApiV3NotificationsServiceV3Url(opts) {
     return (0, metro_runtime_1.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
 /**
- * Sends notifications based on the template and dynamic values provided.
+ * Sends a notification.
  *
- * > 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.
+ * The `notify()` function sends a [notification](https://support.wix.com/en/article/about-your-dashboard-notifications) to the specified recipients on the specified channels.
  *
- * 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.
+ * List the the channels for the notification in the `channels` parameter .
+ *
+ * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
  */
 function notify(payload) {
-    const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_notifyRequest, {
-        _arrayDynamicValue,
-        _dynamicValue,
-        _mapDynamicValue,
-    });
-    const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_notifyResponse, {});
+    const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_publicNotifyRequest, {});
+    const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_empty, {});
     function __notify({ host }) {
         const serializedData = toReq(payload);
         const metadata = {
-            entityFqdn: 'wix.ping.notifications.v3.notification',
+            entityFqdn: 'wix.ping.notifications.v1.public_notification',
             method: 'POST',
-            methodFqn: 'com.wixpress.ping.hub.api.v3.NotificationsServiceV3.Notify',
-            url: resolveComWixpressPingHubApiV3NotificationsServiceV3Url({
-                protoPath: '/v3/notify',
+            methodFqn: 'com.wixpress.ping.hub.api.PublicNotificationsService.Notify',
+            url: resolveComWixpressPingHubApiPublicNotificationsServiceUrl({
+                protoPath: '/api/v1/notify',
                 data: serializedData,
                 host,
             }),
@@ -84,4 +75,4 @@ function notify(payload) {
     return __notify;
 }
 exports.notify = notify;
-//# sourceMappingURL=ping-notifications-v3-notification.http.js.map
+//# sourceMappingURL=ping-notifications-v1-public-notification.http.js.map

package/build/cjs/src/ping-notifications-v1-public-notification.http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ping-notifications-v1-public-notification.http.js","sourceRoot":"","sources":["../../../src/ping-notifications-v1-public-notification.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,MAAM,GAAG,EAAE,CAAC;AAClB,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEhC,SAAS,yDAAyD,CAChE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,0BAA0B;gBACnC,QAAQ,EAAE,YAAY;aACvB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM,CACpB,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAErD,SAAS,QAAQ,CAAC,EAAE,IAAI,EAAO;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,+CAA+C;YAC3D,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,6DAA6D;YACxE,GAAG,EAAE,yDAAyD,CAAC;gBAC7D,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAE3B,OAAO,QAAQ,CAAC;AAClB,CAAC;AA9BD,wBA8BC"}

package/build/cjs/src/ping-notifications-v1-public-notification.public.d.ts

@@ -0,0 +1,8 @@
+import { HttpClient } from '@wix/sdk-types';
+import { Channel, NotifyOptions } from './ping-notifications-v1-public-notification.universal';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function notify(httpClient: HttpClient): (body: string | null, channels: Channel[], options?: NotifyOptions | undefined) => Promise<void>;
+export { Role, Channel, DashboardPages, } from './ping-notifications-v1-public-notification.universal';
+export { Public_notification, PublicNotifyRequest, PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf, ToSiteContributors, ToContacts, ToTopicsSubscribers, Empty, NotifyOptions, } from './ping-notifications-v1-public-notification.universal';

package/build/cjs/src/ping-notifications-v1-public-notification.public.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardPages = exports.Channel = exports.Role = exports.notify = exports.__metadata = void 0;
+const ping_notifications_v1_public_notification_universal_1 = require("./ping-notifications-v1-public-notification.universal");
+exports.__metadata = { PACKAGE_NAME: '@wix/notifications' };
+function notify(httpClient) {
+    return (body, channels, options) => (0, ping_notifications_v1_public_notification_universal_1.notify)(body, channels, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.notify = notify;
+var ping_notifications_v1_public_notification_universal_2 = require("./ping-notifications-v1-public-notification.universal");
+Object.defineProperty(exports, "Role", { enumerable: true, get: function () { return ping_notifications_v1_public_notification_universal_2.Role; } });
+Object.defineProperty(exports, "Channel", { enumerable: true, get: function () { return ping_notifications_v1_public_notification_universal_2.Channel; } });
+Object.defineProperty(exports, "DashboardPages", { enumerable: true, get: function () { return ping_notifications_v1_public_notification_universal_2.DashboardPages; } });
+//# sourceMappingURL=ping-notifications-v1-public-notification.public.js.map

package/build/cjs/src/ping-notifications-v1-public-notification.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ping-notifications-v1-public-notification.public.js","sourceRoot":"","sources":["../../../src/ping-notifications-v1-public-notification.public.ts"],"names":[],"mappings":";;;AACA,+HAI+D;AAElD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAEjE,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,IAAmB,EAAE,QAAmB,EAAE,OAAuB,EAAE,EAAE,CAC3E,IAAA,4DAAe,EACb,IAAI,EACJ,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,wBASC;AAED,6HAI+D;AAH7D,2IAAA,IAAI,OAAA;AACJ,8IAAA,OAAO,OAAA;AACP,qJAAA,cAAc,OAAA"}

package/build/cjs/src/ping-notifications-v1-public-notification.types.d.ts

@@ -0,0 +1,77 @@
+export interface Public_notification {
+    /** id */
+    id?: string | null;
+}
+export interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
+    /** Send to site contributors */
+    toSiteContributors?: ToSiteContributors;
+    /** Send to contacts */
+    toContacts?: ToContacts;
+    /** Send to topic subscribers */
+    toTopicsSubscribers?: ToTopicsSubscribers;
+    /** an open url as an action target */
+    targetUrl?: string | null;
+    /** target_dashboard_page */
+    targetDashboardPage?: DashboardPages;
+    /** The title of the notification */
+    title?: string | null;
+    /** The body of the notification */
+    body?: string | null;
+    /** The Action of the notification */
+    action?: string | null;
+    /** The channel to which send the notification */
+    channels?: Channel[];
+}
+/** @oneof */
+export interface PublicNotifyRequestRecipientsFilterOneOf {
+    /** Send to site contributors */
+    toSiteContributors?: ToSiteContributors;
+    /** Send to contacts */
+    toContacts?: ToContacts;
+    /** Send to topic subscribers */
+    toTopicsSubscribers?: ToTopicsSubscribers;
+}
+/** @oneof */
+export interface PublicNotifyRequestActionTargetOneOf {
+    /** an open url as an action target */
+    targetUrl?: string | null;
+    /** target_dashboard_page */
+    targetDashboardPage?: DashboardPages;
+}
+export interface ToSiteContributors {
+    /** with_role */
+    withRole?: Role;
+}
+export declare enum Role {
+    /** All contributors with any role */
+    All_Contributors = "All_Contributors",
+    /** Only the owner */
+    Owner = "Owner"
+}
+export interface ToContacts {
+    /** contact_ids */
+    contactIds?: string[];
+}
+export interface ToTopicsSubscribers {
+    /** topics */
+    topics?: string[];
+    /** excluded_contact_ids */
+    excludedContactIds?: string[];
+}
+export declare enum Channel {
+    /** No Default Channel - need to expilicitly decide on channel */
+    Undefined = "Undefined",
+    /** The widget inside Wix */
+    Dashboard = "Dashboard",
+    /** Mobile push to WixApp */
+    Mobile = "Mobile",
+    /** Browser push to the active browser (Chrome/Safari only) */
+    Browser = "Browser"
+}
+export declare enum DashboardPages {
+    Undefined_Page = "Undefined_Page",
+    /** goes to business manager home */
+    Home = "Home"
+}
+export interface Empty {
+}

package/build/cjs/src/ping-notifications-v1-public-notification.types.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardPages = exports.Channel = exports.Role = void 0;
+var Role;
+(function (Role) {
+    /** All contributors with any role */
+    Role["All_Contributors"] = "All_Contributors";
+    /** Only the owner */
+    Role["Owner"] = "Owner";
+})(Role = exports.Role || (exports.Role = {}));
+var Channel;
+(function (Channel) {
+    /** No Default Channel - need to expilicitly decide on channel */
+    Channel["Undefined"] = "Undefined";
+    /** The widget inside Wix */
+    Channel["Dashboard"] = "Dashboard";
+    /** Mobile push to WixApp */
+    Channel["Mobile"] = "Mobile";
+    /** Browser push to the active browser (Chrome/Safari only) */
+    Channel["Browser"] = "Browser";
+})(Channel = exports.Channel || (exports.Channel = {}));
+var DashboardPages;
+(function (DashboardPages) {
+    DashboardPages["Undefined_Page"] = "Undefined_Page";
+    /** goes to business manager home */
+    DashboardPages["Home"] = "Home";
+})(DashboardPages = exports.DashboardPages || (exports.DashboardPages = {}));
+//# sourceMappingURL=ping-notifications-v1-public-notification.types.js.map

package/build/cjs/src/ping-notifications-v1-public-notification.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ping-notifications-v1-public-notification.types.js","sourceRoot":"","sources":["../../../src/ping-notifications-v1-public-notification.types.ts"],"names":[],"mappings":";;;AAmDA,IAAY,IAKX;AALD,WAAY,IAAI;IACd,qCAAqC;IACrC,6CAAqC,CAAA;IACrC,qBAAqB;IACrB,uBAAe,CAAA;AACjB,CAAC,EALW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKf;AAcD,IAAY,OASX;AATD,WAAY,OAAO;IACjB,iEAAiE;IACjE,kCAAuB,CAAA;IACvB,4BAA4B;IAC5B,kCAAuB,CAAA;IACvB,4BAA4B;IAC5B,4BAAiB,CAAA;IACjB,8DAA8D;IAC9D,8BAAmB,CAAA;AACrB,CAAC,EATW,OAAO,GAAP,eAAO,KAAP,eAAO,QASlB;AAED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mDAAiC,CAAA;IACjC,oCAAoC;IACpC,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}

package/build/cjs/src/ping-notifications-v1-public-notification.universal.d.ts

@@ -0,0 +1,155 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Public_notification {
+    /** id */
+    _id?: string | null;
+}
+export interface PublicNotifyRequest extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
+    /** List of site contributors to notify. */
+    toSiteContributors?: ToSiteContributors;
+    /** List of contacts to notify. */
+    toContacts?: ToContacts;
+    /** Notify contacts who are subscribed to specific topics. */
+    toTopicsSubscribers?: ToTopicsSubscribers;
+    /** URL to navigate to when the `action` text is clicked. */
+    targetUrl?: string | null;
+    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    targetDashboardPage?: DashboardPages;
+    /**
+     * Notification title. Only displayed on mobile and browser notifications.
+     *
+     * Max: 512 characters
+     */
+    title?: string | null;
+    /**
+     * Contents of the notification.
+     *
+     * Max: 512 characters
+     */
+    body?: string | null;
+    /**
+     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
+     *
+     * Max: 512 characters
+     */
+    action?: string | null;
+    /**
+     * The channels to send the notification on. One or more of:
+     *
+     * - `"Mobile"`: Sends the notification to the Wix App.
+     * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
+     * - `"Browser"`: Sends the notification to the contributor's browser.
+     */
+    channels?: Channel[];
+}
+/** @oneof */
+export interface PublicNotifyRequestRecipientsFilterOneOf {
+    /** List of site contributors to notify. */
+    toSiteContributors?: ToSiteContributors;
+    /** List of contacts to notify. */
+    toContacts?: ToContacts;
+    /** Notify contacts who are subscribed to specific topics. */
+    toTopicsSubscribers?: ToTopicsSubscribers;
+}
+/** @oneof */
+export interface PublicNotifyRequestActionTargetOneOf {
+    /** URL to navigate to when the `action` text is clicked. */
+    targetUrl?: string | null;
+    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    targetDashboardPage?: DashboardPages;
+}
+export interface ToSiteContributors {
+    /**
+     * Roles to receive the notification. One of:
+     *
+     * - `"All_Contributors"`: All site contributors (default).
+     * - `"Owner"`: Only the site owner.
+     */
+    withRole?: Role;
+}
+export declare enum Role {
+    /** All contributors with any role */
+    All_Contributors = "All_Contributors",
+    /** Only the owner */
+    Owner = "Owner"
+}
+export interface ToContacts {
+    /** List of contact IDs. */
+    contactIds?: string[];
+}
+export interface ToTopicsSubscribers {
+    /** List of topics. */
+    topics?: string[];
+    /** List of contact IDs to exclude from notification. */
+    excludedContactIds?: string[];
+}
+export declare enum Channel {
+    /** No Default Channel - need to expilicitly decide on channel */
+    Undefined = "Undefined",
+    /** The widget inside Wix */
+    Dashboard = "Dashboard",
+    /** Mobile push to WixApp */
+    Mobile = "Mobile",
+    /** Browser push to the active browser (Chrome/Safari only) */
+    Browser = "Browser"
+}
+export declare enum DashboardPages {
+    Undefined_Page = "Undefined_Page",
+    /** goes to business manager home */
+    Home = "Home"
+}
+export interface Empty {
+}
+/**
+ * Sends a notification.
+ *
+ *
+ * The `notify()` function sends a [notification](https://support.wix.com/en/article/about-your-dashboard-notifications) to the specified recipients on the specified channels.
+ *
+ * List the the channels for the notification in the `channels` parameter .
+ *
+ * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField body
+ * @requiredField channels
+ * @param options - Notification options.
+ * @param body - The body of the notification.
+ *
+ * Max: 512 characters
+ * @param channels - The channels to send the notification on. One or more of:
+ *
+ * - `"Mobile"`: Sends the notification to the Wix App.
+ * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
+ * - `"Browser"`: Sends the notification to the contributor's browser.
+ * @returns Fulfilled when the send notification request is received.
+ */
+export declare function notify(body: string | null, channels: Channel[], options?: NotifyOptions): Promise<void>;
+export interface NotifyOptions extends PublicNotifyRequestRecipientsFilterOneOf, PublicNotifyRequestActionTargetOneOf {
+    /** List of site contributors to notify. */
+    toSiteContributors?: ToSiteContributors;
+    /** List of contacts to notify. */
+    toContacts?: ToContacts;
+    /** Notify contacts who are subscribed to specific topics. */
+    toTopicsSubscribers?: ToTopicsSubscribers;
+    /**
+     * Notification title. Only displayed on mobile and browser notifications.
+     *
+     * Max: 512 characters
+     */
+    title?: string | null;
+    /**
+     * Clickable text that links to the `targetUrl` or `targetDashboardPage`. For example, "Click this!".
+     *
+     * Max: 512 characters
+     */
+    action?: string | null;
+    /** URL to navigate to when the `action` text is clicked. */
+    targetUrl?: string | null;
+    /** URL of Dashboard page to navigate to when the `action` text is clicked. */
+    targetDashboardPage?: DashboardPages;
+}

package/build/cjs/src/{ping-notifications-v3-notification.universal.js → ping-notifications-v1-public-notification.universal.js}

@@ -28,9 +28,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.notify = exports.TemplateChannel = exports.__debug = void 0;
+exports.notify = exports.DashboardPages = exports.Channel = exports.Role = exports.__debug = void 0;
 const velo_1 = require("@wix/metro-runtime/velo");
-const ambassadorWixPingNotificationsV3Notification = __importStar(require("./ping-notifications-v3-notification.http"));
+const ambassadorWixPingNotificationsV1PublicNotification = __importStar(require("./ping-notifications-v1-public-notification.http"));
 let __verbose = false;
 function __log(...args) {
     __verbose && console.log(...args);
@@ -46,54 +46,76 @@ exports.__debug = {
 };
 const _toVeloEntity = '$';
 const _fromVeloEntity = '$';
-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 = exports.TemplateChannel || (exports.TemplateChannel = {}));
-const _arrayDynamicValue = { items: '_dynamicValue' };
-const _dynamicValue = { map: '_mapDynamicValue', array: '_arrayDynamicValue' };
-const _mapDynamicValue = { items: 'Map#_dynamicValue' };
-const _notifyRequest = { dynamicValues: 'Map#_dynamicValue' };
-const _notifyResponse = {};
+var Role;
+(function (Role) {
+    /** All contributors with any role */
+    Role["All_Contributors"] = "All_Contributors";
+    /** Only the owner */
+    Role["Owner"] = "Owner";
+})(Role = exports.Role || (exports.Role = {}));
+var Channel;
+(function (Channel) {
+    /** No Default Channel - need to expilicitly decide on channel */
+    Channel["Undefined"] = "Undefined";
+    /** The widget inside Wix */
+    Channel["Dashboard"] = "Dashboard";
+    /** Mobile push to WixApp */
+    Channel["Mobile"] = "Mobile";
+    /** Browser push to the active browser (Chrome/Safari only) */
+    Channel["Browser"] = "Browser";
+})(Channel = exports.Channel || (exports.Channel = {}));
+var DashboardPages;
+(function (DashboardPages) {
+    DashboardPages["Undefined_Page"] = "Undefined_Page";
+    /** goes to business manager home */
+    DashboardPages["Home"] = "Home";
+})(DashboardPages = exports.DashboardPages || (exports.DashboardPages = {}));
+const _empty = {};
+const _publicNotifyRequest = {};
 /**
- * Sends notifications based on the template and dynamic values provided.
+ * Sends a notification.
  *
- * > 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.
+ * The `notify()` function sends a [notification](https://support.wix.com/en/article/about-your-dashboard-notifications) to the specified recipients on the specified channels.
  *
- * 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.
+ * List the the channels for the notification in the `channels` parameter .
+ *
+ * List the recipients for the notification in the `toContacts`, `toSiteContributors`, and `toTopicsSubscribers` parameters.
  * @public
  * @documentationMaturity preview
- * @requiredField notificationTemplateId
- * @permissionScope Manage Notifications
- * @applicableIdentity APP
+ * @requiredField body
+ * @requiredField channels
+ * @param options - Notification options.
+ * @param body - The body of the notification.
+ *
+ * Max: 512 characters
+ * @param channels - The channels to send the notification on. One or more of:
+ *
+ * - `"Mobile"`: Sends the notification to the Wix App.
+ * - `"Dashboard"`: Sends the notification to the contributor's Wix Dashboard.
+ * - `"Browser"`: Sends the notification to the contributor's browser.
+ * @returns Fulfilled when the send notification request is received.
  */
-function notify(notificationTemplateId, options) {
+function notify(body, channels, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = {
-            notificationTemplateId: '$[0]',
-            dynamicValues: '$[1].dynamicValues',
+            body: '$[0]',
+            channels: '$[1]',
+            toSiteContributors: '$[2].toSiteContributors',
+            toContacts: '$[2].toContacts',
+            toTopicsSubscribers: '$[2].toTopicsSubscribers',
+            title: '$[2].title',
+            action: '$[2].action',
+            targetUrl: '$[2].targetUrl',
+            targetDashboardPage: '$[2].targetDashboardPage',
         };
         const responseTransformation = '$';
         // @ts-ignore
-        const { httpClient, sideEffects } = arguments[2];
+        const { httpClient, sideEffects } = arguments[3];
         const { toAmbassadorRequest } = (0, velo_1.serializer)({
-            rootSchema: _notifyRequest,
-            depSchemas: { _arrayDynamicValue, _dynamicValue, _mapDynamicValue },
+            rootSchema: _publicNotifyRequest,
+            depSchemas: {},
             fqdnTransformation: {
                 paths: [],
                 transformation: _fromVeloEntity,
@@ -101,7 +123,7 @@ function notify(notificationTemplateId, options) {
             customTransformation: requestTransformation,
         });
         const { fromJSON } = (0, velo_1.serializer)({
-            rootSchema: _notifyResponse,
+            rootSchema: _empty,
             depSchemas: {},
             fqdnTransformation: {
                 paths: [],
@@ -109,8 +131,8 @@ function notify(notificationTemplateId, options) {
             },
             customTransformation: responseTransformation,
         });
-        const payload = toAmbassadorRequest([notificationTemplateId, options]);
-        const reqOpts = ambassadorWixPingNotificationsV3Notification.notify(payload);
+        const payload = toAmbassadorRequest([body, channels, options]);
+        const reqOpts = ambassadorWixPingNotificationsV1PublicNotification.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 {
@@ -120,7 +142,8 @@ function notify(notificationTemplateId, options) {
         }
         catch (err) {
             const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
-                'notificationTemplateId',
+                'body',
+                'channels',
                 'options',
             ]);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
@@ -129,4 +152,4 @@ function notify(notificationTemplateId, options) {
     });
 }
 exports.notify = notify;
-//# sourceMappingURL=ping-notifications-v3-notification.universal.js.map
+//# sourceMappingURL=ping-notifications-v1-public-notification.universal.js.map

package/build/cjs/src/ping-notifications-v1-public-notification.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ping-notifications-v1-public-notification.universal.js","sourceRoot":"","sources":["../../../src/ping-notifications-v1-public-notification.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,qIAAuH;AAEvH,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;AAEY,QAAA,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;AA4E5B,IAAY,IAKX;AALD,WAAY,IAAI;IACd,qCAAqC;IACrC,6CAAqC,CAAA;IACrC,qBAAqB;IACrB,uBAAe,CAAA;AACjB,CAAC,EALW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKf;AAcD,IAAY,OASX;AATD,WAAY,OAAO;IACjB,iEAAiE;IACjE,kCAAuB,CAAA;IACvB,4BAA4B;IAC5B,kCAAuB,CAAA;IACvB,4BAA4B;IAC5B,4BAAiB,CAAA;IACjB,8DAA8D;IAC9D,8BAAmB,CAAA;AACrB,CAAC,EATW,OAAO,GAAP,eAAO,KAAP,eAAO,QASlB;AAED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mDAAiC,CAAA;IACjC,oCAAoC;IACpC,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAID,MAAM,MAAM,GAAG,EAAE,CAAC;AAClB,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAsB,MAAM,CAC1B,IAAmB,EACnB,QAAmB,EACnB,OAAuB;;;QAEvB,MAAM,qBAAqB,GAAG;YAC5B,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,MAAM;YAChB,kBAAkB,EAAE,yBAAyB;YAC7C,UAAU,EAAE,iBAAiB;YAC7B,mBAAmB,EAAE,0BAA0B;YAC/C,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,SAAS,EAAE,gBAAgB;YAC3B,mBAAmB,EAAE,0BAA0B;SAChD,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,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,MAAM;YAClB,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,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QAE/D,MAAM,OAAO,GACX,kDAAkD,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAErE,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,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,MAAM;gBACN,UAAU;gBACV,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;AAnED,wBAmEC"}

package/build/es/index.d.ts

@@ -1 +1 @@
-export * as notifications from './src/ping-notifications-v3-notification.public';
+export * as notifications from './src/ping-notifications-v1-public-notification.public';

package/build/es/index.js

@@ -1,2 +1,2 @@
-export * as notifications from './src/ping-notifications-v3-notification.public';
+export * as notifications from './src/ping-notifications-v1-public-notification.public';
 //# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,iDAAiD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,wDAAwD,CAAC"}

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

@@ -0,0 +1 @@
+export * as notifications from './src/ping-notifications-v1-public-notification.universal';

package/build/es/index.typings.js

@@ -0,0 +1,2 @@
+export * as notifications from './src/ping-notifications-v1-public-notification.universal';
+//# sourceMappingURL=index.typings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,2DAA2D,CAAC"}