shred-api-client 1.10.7 → 1.10.9

package/dist/api/Notification.api.d.ts

@@ -0,0 +1,10 @@
+import Environment from "../model/Env";
+import { NotificationSchema, Notification } from "../model/Notification.schema";
+import Context from "../model/Context";
+declare class NotificationAPI implements NotificationSchema {
+    private env;
+    private clientHTTP;
+    constructor(env: Environment);
+    push(ctx: Context, notification: Notification): Promise<boolean>;
+}
+export default NotificationAPI;

package/dist/api/{PushNotification.api.js → Notification.api.js}

@@ -4,16 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const HTTPClient_1 = __importDefault(require("../util/HTTPClient"));
-const PushNotification_schema_1 = require("../model/PushNotification.schema");
-class PushNotificationAPI {
+const Notification_schema_1 = require("../model/Notification.schema");
+class NotificationAPI {
     constructor(env) {
         this.env = env;
         this.clientHTTP = new HTTPClient_1.default();
     }
     async push(ctx, notification) {
-        const endpointInfo = PushNotification_schema_1.PushNotificationEndpoints.Push;
+        const endpointInfo = Notification_schema_1.NotificationEndpoints.Push;
         const data = await this.clientHTTP.makeRequest(this.env, endpointInfo.uri, endpointInfo.method, notification, ctx);
         return data.success;
     }
 }
-exports.default = PushNotificationAPI;
+exports.default = NotificationAPI;

package/dist/model/Api.d.ts

@@ -1,6 +1,6 @@
 import Environment from "./Env";
 import { PromptAPISchema } from "./Prompt.schema";
-import { PushNotificationSchema } from "./PushNotification.schema";
+import { NotificationSchema } from "./Notification.schema";
 import { SubscriptionAPISchema } from "./Subscription.schema";
 import { UserAPISchema } from "./User.schema";
 import { EmailAPISchema } from "./Email.schema";
@@ -11,7 +11,7 @@ export declare class ShredAPI {
     user: UserAPISchema;
     subscription: SubscriptionAPISchema;
     prompt: PromptAPISchema;
-    pushNotification: PushNotificationSchema;
+    pushNotification: NotificationSchema;
     email: EmailAPISchema;
     tenant: TenantAPISchema;
     app: APPConfigSchema;

package/dist/model/Api.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShredAPI = void 0;
-const PushNotification_api_1 = __importDefault(require("../api/PushNotification.api"));
+const Notification_api_1 = __importDefault(require("../api/Notification.api"));
 const Prompt_api_1 = __importDefault(require("../api/Prompt.api"));
 const Subscription_api_1 = __importDefault(require("../api/Subscription.api"));
 const Tenant_api_1 = __importDefault(require("../api/Tenant.api"));
@@ -17,7 +17,7 @@ class ShredAPI {
         this.user = new User_api_1.default(env);
         this.prompt = new Prompt_api_1.default(env);
         this.subscription = new Subscription_api_1.default(env);
-        this.pushNotification = new PushNotification_api_1.default(env);
+        this.pushNotification = new Notification_api_1.default(env);
         this.email = new Email_api_1.default(env);
         this.tenant = new Tenant_api_1.default(env);
         this.project = new Project_api_1.default(env);

package/dist/model/{PushNotification.schema.d.ts → Notification.schema.d.ts}

@@ -1,48 +1,45 @@
 import Context from "./Context";
 import { Notification } from "./../namespace";
-interface PushNotificationSchema {
-    push: (context: Context, notification: PushNotification) => Promise<boolean>;
+interface NotificationSchema {
+    push: (context: Context, notification: Notification) => Promise<boolean>;
 }
-declare const PushNotificationEndpoints: {
+declare const NotificationEndpoints: {
     Push: {
         uri: string;
         method: string;
     };
 };
-type NotificationCriteria = {
+type Criteria = {
     type: Notification.CriteriaType;
     params: Record<string, any>;
 };
-type NotificationHistory = {
+type History = {
     executedAt: number;
     status: "success" | "failed" | "info" | "warn";
     notifiedUsers?: number;
     executionTimeDuration?: number;
 };
-type NotificationTrigger = {
+type Trigger = {
     id: string;
     title: string;
     description: string;
     transportType: Notification.TransportType[];
-    notification: {
-        title: string;
-        body: string;
-    };
+    notification: Notification;
     executionTime: string;
     repeatDays: Notification.WeekDay[];
-    history?: NotificationHistory[];
+    history?: History[];
     status: Notification.Status;
     isRecurring: boolean;
     executionDate?: number;
-    criteria: NotificationCriteria;
+    criteria: Criteria;
     nextExecution?: number;
     createdAt?: number;
     modified?: number;
 };
-type PushNotification = {
+type Notification = {
     title: string;
     body: string;
-    userToken: string;
-    metadata: any;
+    userToken?: string;
+    metadata?: any;
 };
-export { PushNotificationSchema, PushNotificationEndpoints, PushNotification, NotificationTrigger, NotificationCriteria, NotificationHistory, };
+export { NotificationSchema, NotificationEndpoints, Notification, Trigger, Criteria, History, };

package/dist/model/Notification.schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notification = exports.NotificationEndpoints = void 0;
+const namespace_1 = require("./../namespace");
+Object.defineProperty(exports, "Notification", { enumerable: true, get: function () { return namespace_1.Notification; } });
+const NotificationEndpoints = {
+    Push: {
+        uri: "/notifications/push/",
+        method: "POST",
+    },
+};
+exports.NotificationEndpoints = NotificationEndpoints;

package/dist/model/User.schema.d.ts

@@ -98,6 +98,7 @@ type User = {
     preferences?: Preferences;
     tenantId?: string;
     editorId?: string;
+    timezone?: string;
     customerId: string;
     role: Role;
 };

package/dist/namespace.d.ts

@@ -1,5 +1,5 @@
 import { Product as TProduct, Subscription as TSubscription, Charge as TCharge } from "./model/Subscription.schema";
-import { NotificationTrigger as TTrigger, NotificationCriteria as TCriteria, NotificationHistory as THistory } from "./model/PushNotification.schema";
+import { Trigger as TTrigger, Criteria as TCriteria, Notification as TNContent, History as THistory } from "./model/Notification.schema";
 import { System as TSystem, User as TUser, Preferences as UserPreferences, Role as TRole } from "./model/User.schema";
 import { Email as TEmail } from "./model/Email.schema";
 import { Asset as TAsset } from "./model/Asset.schema";
@@ -59,6 +59,7 @@ export declare namespace Notification {
     type Trigger = TTrigger;
     type Criteria = TCriteria;
     type History = THistory;
+    type Item = TNContent;
 }
 export declare namespace User {
     type Preferences = UserPreferences;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shred-api-client",
-  "version": "1.10.7",
+  "version": "1.10.9",
   "description": "API Client for Shred",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/api/PushNotification.api.d.ts

@@ -1,10 +0,0 @@
-import Environment from "../model/Env";
-import { PushNotificationSchema, PushNotification } from "../model/PushNotification.schema";
-import Context from "../model/Context";
-declare class PushNotificationAPI implements PushNotificationSchema {
-    private env;
-    private clientHTTP;
-    constructor(env: Environment);
-    push(ctx: Context, notification: PushNotification): Promise<boolean>;
-}
-export default PushNotificationAPI;

package/dist/model/PushNotification.schema.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PushNotificationEndpoints = void 0;
-const PushNotificationEndpoints = {
-    Push: {
-        uri: "/notifications/push/",
-        method: "POST",
-    },
-};
-exports.PushNotificationEndpoints = PushNotificationEndpoints;