shred-api-client 1.12.1 → 1.13.0

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

@@ -1,11 +1,13 @@
 import Environment from "../model/Env";
-import { NotificationSchema, NotificationDetail, Trigger } from "../model/Notification.schema";
+import { NotificationSchema, NotificationDetail, Trigger, NotificationItem } from "../model/Notification.schema";
 import Context from "../model/Context";
 import { APIResponse } from "../model/Api";
 declare class NotificationAPI implements NotificationSchema {
     private env;
     private clientHTTP;
     constructor(env: Environment);
+    markAsRead(ctx: Context, id: string): Promise<boolean>;
+    getNotifications(ctx: Context): Promise<APIResponse<NotificationItem>>;
     deleteTrigger(ctx: Context, triggerId: string): Promise<boolean>;
     updateTrigger(ctx: Context, triggerId: string, t: Partial<Trigger>): Promise<Trigger>;
     createTrigger(ctx: Context, t: Trigger): Promise<Trigger>;

package/dist/api/Notification.api.js

@@ -10,6 +10,17 @@ class NotificationAPI {
         this.env = env;
         this.clientHTTP = new HTTPClient_1.default();
     }
+    async markAsRead(ctx, id) {
+        const endpointData = Notification_schema_1.NotificationEndpoints.MarkAsRead;
+        const endpoint = endpointData.uri.replace(":id", id);
+        const data = await this.clientHTTP.makeRequest(this.env, endpoint, endpointData.method, null, ctx);
+        return data;
+    }
+    async getNotifications(ctx) {
+        const endpointData = Notification_schema_1.NotificationEndpoints.ListNotifications;
+        const data = await this.clientHTTP.makeRequest(this.env, endpointData.uri, endpointData.method, null, ctx);
+        return data;
+    }
     async deleteTrigger(ctx, triggerId) {
         const endpointData = Notification_schema_1.NotificationEndpoints.Delete;
         const endpoint = endpointData.uri.replace(":id", triggerId);

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

@@ -7,6 +7,8 @@ interface NotificationSchema {
     deleteTrigger: (ctx: Context, triggerId: string) => Promise<boolean>;
     updateTrigger: (ctx: Context, triggerId: string, trigger: Partial<Trigger>) => Promise<Trigger>;
     push: (context: Context, notification: NotificationDetail) => Promise<boolean>;
+    getNotifications: (ctx: Context) => Promise<APIResponse<NotificationItem>>;
+    markAsRead: (ctx: Context, id: string) => Promise<boolean>;
 }
 declare const NotificationEndpoints: {
     Create: {
@@ -29,6 +31,14 @@ declare const NotificationEndpoints: {
         uri: string;
         method: string;
     };
+    ListNotifications: {
+        uri: string;
+        method: string;
+    };
+    MarkAsRead: {
+        uri: string;
+        method: string;
+    };
 };
 type Criteria = {
     type: Notification.CriteriaType;
@@ -44,7 +54,10 @@ type History = {
         success: number;
         error: number;
     };
-    errorList?: string[];
+    errorList?: {
+        token: string;
+        error: string;
+    }[];
     executionTimeDuration?: number;
 };
 type RecurrenceRule = {
@@ -73,10 +86,17 @@ type Trigger = {
     createdAt?: number;
     modified?: number;
 };
-type NotificationDetail = {
+type NotificationItem = {
+    id: string;
+    userId: string;
+    triggerId?: string;
     title: string;
     body: string;
-    userToken?: string;
-    metadata?: Record<string, any>;
+    status: "failed" | "delivered";
+    deliveredAt: number;
+    openedAt?: number;
+    metadata: Record<string, string | number>;
+    error?: string;
 };
-export { NotificationSchema, NotificationEndpoints, NotificationDetail, RecurrenceRule, Trigger, Criteria, History, };
+type NotificationDetail = Pick<NotificationItem, "title" | "body" | "userId" | "metadata">;
+export { NotificationItem, NotificationSchema, NotificationEndpoints, NotificationDetail, RecurrenceRule, Trigger, Criteria, History, };

package/dist/model/Notification.schema.js

@@ -22,5 +22,13 @@ const NotificationEndpoints = {
         uri: "/notifications/push/",
         method: "POST",
     },
+    ListNotifications: {
+        uri: "/notifications/list/",
+        method: "GET",
+    },
+    MarkAsRead: {
+        uri: "/notifications/:id/read/",
+        method: "PUT",
+    },
 };
 exports.NotificationEndpoints = NotificationEndpoints;

package/dist/namespace.d.ts

@@ -1,5 +1,5 @@
 import { Product as TProduct, Subscription as TSubscription, Charge as TCharge } from "./model/Subscription.schema";
-import { Trigger as TTrigger, Criteria as TCriteria, NotificationDetail as TNContent, RecurrenceRule as TRRule, History as THistory } from "./model/Notification.schema";
+import { Trigger as TTrigger, Criteria as TCriteria, NotificationDetail as TNContent, RecurrenceRule as TRRule, NotificationItem as TNotificaitonItem, History as THistory } from "./model/Notification.schema";
 import { APIResponse } from "./model/Api";
 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";
@@ -69,6 +69,7 @@ export declare namespace Notification {
     type Trigger = TTrigger;
     type Criteria = TCriteria;
     type History = THistory;
+    type Item = TNotificaitonItem;
     type Detail = TNContent;
 }
 export declare namespace User {

package/package.json

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