Accepting schedule as an ISO 8601 datetime string

package.json

@@ -1,6 +1,6 @@
 {
   "name": "notificationapi-node-server-sdk",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "NotificationAPI server-side library for Node.js",
   "keywords": [
     "notificationapi",

src/__tests__/index.test.ts

@@ -62,7 +62,7 @@
     notificationapi.init(clientId, clientSecret);
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     const promise = notificationapi[func](params);
     expect(promise).toBeInstanceOf(Promise);
   });
 
@@ -74,7 +74,7 @@
     notificationapi.init(clientId, clientSecret);
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     await notificationapi[func](params);
     expect(axiosMock.history.post).toHaveLength(1);
   });
 
@@ -87,7 +87,7 @@
     notificationapi.init(clientId, clientSecret);
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     await notificationapi[func](params);
     expect(axiosMock.history.post).toHaveLength(1);
     expect(axiosMock.history.post[0].headers['Authorization']).toEqual(
       'Basic ' + cred
@@ -104,7 +104,7 @@
     notificationapi.init(clientId, clientSecret);
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     await notificationapi[func](params);
     expect(console.log).toHaveBeenCalledTimes(1);
   });
 
@@ -118,7 +118,7 @@
     notificationapi.init(clientId, clientSecret);
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     return notificationapi[func](params).catch(() => {
       expect(console.error).toHaveBeenCalledTimes(1);
     });
   });
@@ -133,7 +133,7 @@
     notificationapi.init(clientId, clientSecret);
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(notificationapi[func](params)).rejects.toEqual(
       new Error('Request failed with status code 500')
     );
   });
@@ -247,7 +247,20 @@
       'templateId'
     );
   });
-
+  test('includes schedule in the request body', async () => {
+    axiosMock.onPost(sendEndPointRegex).reply(200);
+    notificationapi.init(clientId, clientSecret);
+    const schedule = new Date().toISOString();
+    await notificationapi.send({
+      notificationId,
+      user,
+      schedule
+    });
+    expect(axiosMock.history.post).toHaveLength(1);
+    expect(JSON.parse(axiosMock.history.post[0].data).schedule).toEqual(
+      schedule
+    );
+  });
   test('includes subNotificationId in the request body', async () => {
     axiosMock.onPost(sendEndPointRegex).reply(200);
     notificationapi.init(clientId, clientSecret);

src/interfaces.ts

@@ -24,6 +24,8 @@ export interface SendRequest {
   forceChannels?: Channels[];
   /** It will be deprecated soon.*/
   secondaryId?: string; //It will be deprecated soon
+  /**An ISO 8601 datetime string to schedule the notification for. For example, '2024-02-20T14:38:03.509Z' */
+  schedule?: string;
   /** By default, notifications are sent using the default template of each channel. You can permanently change the default template from the dashboard. However, you can also use this parameter to force using a specific template. Optional.*/
   templateId?: string;
   /**  The subNotificationId is used to specify further subcategories within a notification. Optional.*/