vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 06:47:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add overload to suppressionList list

Browse Source 
[parameters](https://github.com/SparkPost/node-sparkpost/blob/master/docs/resources/suppressionList.md#methods) is an optional argument
This commit is contained in:
Akinmade Bond
2017-03-20 17:58:39 +01:00
parent 4cfda1e42d
commit cda8d04273
2 changed files with 21 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
sparkpost/index.d.ts
Vendored
+10 -4
View File
@@ -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<SparkPost.SupressionListEntry[]>} [callback]
* @param {SparkPost.ResultsCallback<SparkPost.SupressionListEntry[]>} callback The request callback with supression lists.
*/
list(callback: SparkPost.ResultsCallback<SparkPost.SupressionListEntry[]>): 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<SparkPost.SupressionListEntry[]>} callback The request callback with supression lists.
*/
list(parameters: SparkPost.SupressionSearchParameters, callback: SparkPost.ResultsCallback<SparkPost.SupressionListEntry[]>): 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<SparkPost.SupressionListEntry[]>}
* @returns {Promise<SparkPost.SupressionListEntry[]>} Promise The supression lists
*/
list(parameters?: SparkPost.SupressionSearchParameters): SparkPost.ResultsPromise<SparkPost.SupressionListEntry[]>;
/**
@@ -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;
sparkpost/sparkpost-tests.ts
+11
View File
@@ -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',