From cda8d042738faf159ca32b06a47fcbf72f405881 Mon Sep 17 00:00:00 2001 From: Akinmade Bond Date: Mon, 20 Mar 2017 17:58:39 +0100 Subject: [PATCH] Add overload to suppressionList `list` [parameters](https://github.com/SparkPost/node-sparkpost/blob/master/docs/resources/suppressionList.md#methods) is an optional argument --- sparkpost/index.d.ts | 14 ++++++++++---- sparkpost/sparkpost-tests.ts | 11 +++++++++++ 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/sparkpost/index.d.ts b/sparkpost/index.d.ts index edef477f3d..e21cd1cf24 100644 --- a/sparkpost/index.d.ts +++ b/sparkpost/index.d.ts @@ -373,15 +373,21 @@ declare class SparkPost { /** * List all entries in your suppression list, filtered by an optional set of search parameters. * - * @param {SparkPost.SupressionSearchParameters} [parameters] an object of [search parameters]{@link https://developers.sparkpost.com/api/suppression-list#suppression-list-search-get} - * @param {Promise} [callback] + * @param {SparkPost.ResultsCallback} callback The request callback with supression lists. + */ + list(callback: SparkPost.ResultsCallback): void; + /** + * List all entries in your suppression list, filtered by an optional set of search parameters. + * + * @param {SparkPost.SupressionSearchParameters} parameters an object of [search parameters]{@link https://developers.sparkpost.com/api/suppression-list#suppression-list-search-get} + * @param {SparkPost.ResultsCallback} callback The request callback with supression lists. */ list(parameters: SparkPost.SupressionSearchParameters, callback: SparkPost.ResultsCallback): void; /** * List all entries in your suppression list, filtered by an optional set of search parameters. * * @param {SparkPost.SupressionSearchParameters} [parameters] an object of [search parameters]{@link https://developers.sparkpost.com/api/suppression-list#suppression-list-search-get} - * @returns {Promise} + * @returns {Promise} Promise The supression lists */ list(parameters?: SparkPost.SupressionSearchParameters): SparkPost.ResultsPromise; /** @@ -415,7 +421,7 @@ declare class SparkPost { /** * Insert or update one or many entries. * - * @param parameters The suppression entry list + * @param listEntries The suppression entry list * @param callback The request callback */ upsert(listEntries: SparkPost.CreateSupressionListEntry | SparkPost.CreateSupressionListEntry[], callback: SparkPost.ResultsCallback<{ message: string }>): void; diff --git a/sparkpost/sparkpost-tests.ts b/sparkpost/sparkpost-tests.ts index ac994ab31b..fdfe3e71cc 100644 --- a/sparkpost/sparkpost-tests.ts +++ b/sparkpost/sparkpost-tests.ts @@ -867,6 +867,17 @@ client.suppressionList.list({ } }); +// Callback +client.suppressionList.list(function(err, data) { + if (err) { + console.log('Whoops! Something went wrong'); + console.log(err); + } else { + console.log('Congrats you can use our client library!'); + console.log(data); + } +}); + // Promise client.suppressionList.upsert({ recipient: 'test1@test.com',