@trycourier/courier 5.4.0 → 5.6.0

package/README.md

@@ -748,6 +748,7 @@ const { audienceId } = await courier.audiences.put({
 // To retrieve list of members in a given audience, you can use the following:
 const { items: audienceMembers } = await courier.audiences.listMembers(
   audienceId
+  cursor: "<CURSOR>", // optional
 );
 
 // To send a notification to all users that match the given filter criteria, you can use the following:

package/lib/audiences/index.d.ts

@@ -3,7 +3,11 @@ import * as AudienceTypes from "./types";
 export declare const audiences: (options: ICourierClientConfiguration) => {
     delete: (audienceId: string) => Promise<void>;
     get: (audienceId: string) => Promise<AudienceTypes.IAudience>;
-    listAudiences: () => Promise<AudienceTypes.IAudienceListResponse>;
-    listMembers: (audienceId: string) => Promise<AudienceTypes.IAudienceMemberListResponse>;
+    listAudiences: (params?: {
+        cursor: string;
+    } | undefined) => Promise<AudienceTypes.IAudienceListResponse>;
+    listMembers: (audienceId: string, params?: {
+        cursor: string;
+    } | undefined) => Promise<AudienceTypes.IAudienceMemberListResponse>;
     put: (audience: Omit<AudienceTypes.IAudience, "created_at" | "updated_at">) => Promise<AudienceTypes.IAudience>;
 };

package/lib/audiences/index.js

@@ -61,11 +61,11 @@ var getAudience = function (options) {
     }); };
 };
 var listAudiences = function (options) {
-    return function () { return __awaiter(void 0, void 0, void 0, function () {
+    return function (params) { return __awaiter(void 0, void 0, void 0, function () {
         var response;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/audiences")];
+                case 0: return [4 /*yield*/, options.httpClient.get("/audiences", params)];
                 case 1:
                     response = _a.sent();
                     return [2 /*return*/, response.data];
@@ -74,11 +74,11 @@ var listAudiences = function (options) {
     }); };
 };
 var listMembers = function (options) {
-    return function (audienceId) { return __awaiter(void 0, void 0, void 0, function () {
+    return function (audienceId, params) { return __awaiter(void 0, void 0, void 0, function () {
         var response;
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/audiences/" + audienceId + "/members")];
+                case 0: return [4 /*yield*/, options.httpClient.get("/audiences/" + audienceId + "/members", params)];
                 case 1:
                     response = _a.sent();
                     return [2 /*return*/, response.data];

package/lib/audiences/types.d.ts

@@ -54,8 +54,12 @@ export interface IAudiencePutResponse {
 export interface ICourierClientAudiences {
     delete: (id: string) => Promise<void>;
     get: (id: string) => Promise<IAudience>;
-    listAudiences: () => Promise<IAudienceListResponse>;
-    listMembers: (id: string) => Promise<IAudienceMemberListResponse>;
+    listAudiences: (params?: {
+        cursor: string;
+    }) => Promise<IAudienceListResponse>;
+    listMembers: (id: string, params?: {
+        cursor: string;
+    }) => Promise<IAudienceMemberListResponse>;
     put: (audience: Omit<IAudience, "created_at" | "updated_at">) => Promise<IAudience>;
 }
 export {};

package/lib/send/types.d.ts

@@ -169,6 +169,9 @@ export interface MessageContext {
 }
 export interface MessageData extends Record<string, any> {
 }
+export interface MessageDelay {
+    duration?: number;
+}
 export declare type RuleType = "snooze" | "channel_preferences" | "status";
 export interface IRule<T extends RuleType> {
     type: T;
@@ -275,6 +278,7 @@ export interface BaseMessage {
     channels?: MessageChannels;
     context?: MessageContext;
     data?: MessageData;
+    delay?: MessageDelay;
     metadata?: MessageMetadata;
     providers?: MessageProviders;
     routing?: Routing;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "description": "A node.js module for communicating with the Courier REST API.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",