@trycourier/courier 2.8.0 → 3.0.0

package/CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v3.0.0] - 2021-11-02
+
+- fixes type definition for `getRecipientSubscriptions`
+
 ## [v2.8.0] - 2021-10-29
 
 - adds GET /messages/{messageId}/output API
@@ -173,7 +177,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## v1.0.1 - 2019-07-12
 
-[unreleased]: https://github.com/trycourier/courier-node/compare/v2.8.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-node/compare/v3.0.0...HEAD
+[v3.0.0]: https://github.com/trycourier/courier-node/compare/v2.8.0...v3.0.0
 [v2.8.0]: https://github.com/trycourier/courier-node/compare/v2.7.0...v2.8.0
 [v2.7.0]: https://github.com/trycourier/courier-node/compare/v2.6.0...v2.7.0
 [v2.6.0]: https://github.com/trycourier/courier-node/compare/v2.4.0...v2.6.0

package/lib/lists/types.d.ts

@@ -6,6 +6,10 @@ export interface ICourierList {
     name: string;
     updated?: number;
 }
+export interface ICourierRecipientSubscriptionsResponse {
+    paging: ICourierPaging;
+    results: ICourierList[];
+}
 export interface ICourierListPutParams {
     name: string;
     preferences?: {

package/lib/profile.d.ts

@@ -1,9 +1,9 @@
-import { ICourierList } from "./lists/types";
+import { ICourierRecipientSubscriptionsResponse } from "./lists/types";
 import { ICourierClientConfiguration, ICourierProfileDeleteParameters, ICourierProfileGetParameters, ICourierProfileGetResponse, ICourierProfileListsPostParameters, ICourierProfilePostConfig, ICourierProfilePostParameters, ICourierProfilePostResponse, ICourierProfilePutParameters, ICourierProfilePutResponse } from "./types";
 export declare const replaceProfile: (options: ICourierClientConfiguration) => (params: ICourierProfilePutParameters) => Promise<ICourierProfilePutResponse>;
 export declare const mergeProfile: (options: ICourierClientConfiguration) => (params: ICourierProfilePostParameters, config?: ICourierProfilePostConfig | undefined) => Promise<ICourierProfilePostResponse>;
 export declare const getProfile: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierProfileGetResponse>;
 export declare const deleteProfile: (options: ICourierClientConfiguration) => (params: ICourierProfileDeleteParameters) => Promise<void>;
-export declare const getRecipientSubscriptions: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
+export declare const getRecipientSubscriptions: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierRecipientSubscriptionsResponse>;
 export declare const addRecipientToLists: (options: ICourierClientConfiguration) => (params: ICourierProfileListsPostParameters) => Promise<ICourierProfilePostResponse>;
 export declare const removeRecipientFromAllLists: (options: ICourierClientConfiguration) => (params: ICourierProfileGetParameters) => Promise<ICourierProfilePostResponse>;

package/lib/types.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from "axios";
 import { ICourierClientAutomations } from "./automations/types";
-import { ICourierClientLists, ICourierList } from "./lists/types";
+import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } from "./lists/types";
 import { ICourierClientNotifications } from "./notifications/types";
 import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
 export declare type HttpMethodClient = <T>(url: string, body?: object, config?: AxiosRequestConfig) => Promise<{
@@ -269,7 +269,7 @@ export interface ICourierClient {
     getMessages: (params?: ICourierMessagesGetParameters) => Promise<ICourierMessagesGetResponse>;
     getProfile: (params: ICourierProfileGetParameters) => Promise<ICourierProfileGetResponse>;
     deleteProfile: (params: ICourierProfileDeleteParameters) => Promise<void>;
-    getRecipientSubscriptions: (params: ICourierProfileGetParameters) => Promise<ICourierList[]>;
+    getRecipientSubscriptions: (params: ICourierProfileGetParameters) => Promise<ICourierRecipientSubscriptionsResponse>;
     lists: ICourierClientLists;
     mergeProfile: (params: ICourierProfilePostParameters, config?: ICourierProfilePostConfig) => Promise<ICourierProfilePostResponse>;
     notifications: ICourierClientNotifications;

package/package.json

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