Merge pull request #21 from sendinblue/feature_AP-1237

AP-1237 Wrapper Update

Author: aayush-sib

README.md

@@ -30,7 +30,7 @@ const SibApiV3Sdk = require('sib-api-v3-typescript');
 
 let apiInstance = new SibApiV3Sdk.AccountApi()
 
-// Configure API key authorization: api-key
+// Configure API key authorization: apiKey
 
 let apiKey = apiInstance.authentications['apiKey'];
 apiKey.apiKey = "YOUR API KEY"

api/accountApi.js

@@ -34,7 +34,7 @@ export enum AccountApiApiKeys {
 
 export class AccountApi {
     protected _basePath = defaultBasePath;
-    protected _defaultHeaders : any = { 'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node' };;
+    protected _defaultHeaders : any = { 'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node' };;
     protected _useQuerystring : boolean = false;
 
     protected authentications = {

api/accountApi.ts

@@ -38,7 +38,7 @@ export enum AttributesApiApiKeys {
 export class AttributesApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 

api/attributesApi.js

@@ -60,7 +60,7 @@ export enum ContactsApiApiKeys {
 export class ContactsApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 
@@ -1127,7 +1127,7 @@ export class ContactsApi {
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
      * @param modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
      */
     public async getContacts (limit?: number, offset?: number, modifiedSince?: Date, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetContacts;  }> {
         const localVarPath = this.basePath + '/contacts';
@@ -1216,7 +1216,7 @@ export class ContactsApi {
      * @param modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
      */
     public async getContactsFromList (listId: number, modifiedSince?: Date, limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetContacts;  }> {
         const localVarPath = this.basePath + '/contacts/lists/{listId}/contacts'
@@ -1385,7 +1385,7 @@ export class ContactsApi {
      * @param folderId Id of the folder
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
      */
     public async getFolderLists (folderId: number, limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetFolderLists;  }> {
         const localVarPath = this.basePath + '/contacts/folders/{folderId}/lists'
@@ -1474,7 +1474,7 @@ export class ContactsApi {
      * @summary Get all folders
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
      */
     public async getFolders (limit: number, offset: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetFolders;  }> {
         const localVarPath = this.basePath + '/contacts/folders';
@@ -1642,7 +1642,7 @@ export class ContactsApi {
      * @summary Get all the lists
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
      */
     public async getLists (limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetLists;  }> {
         const localVarPath = this.basePath + '/contacts/lists';

api/attributesApi.ts

@@ -49,7 +49,7 @@ export enum EmailCampaignsApiApiKeys {
 export class EmailCampaignsApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 
@@ -495,7 +495,7 @@ export class EmailCampaignsApi {
      * @param endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either \'status\' not passed and if passed is set to \'sent\' )
      * @param limit Number of documents per page
      * @param offset Index of the first document in the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
      */
     public async getEmailCampaigns (type?: 'classic' | 'trigger', status?: 'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess', startDate?: Date, endDate?: Date, limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetEmailCampaigns;  }> {
         const localVarPath = this.basePath + '/emailCampaigns';

api/contactsApi.js

@@ -40,7 +40,7 @@ export enum FoldersApiApiKeys {
 export class FoldersApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 
@@ -331,7 +331,7 @@ export class FoldersApi {
      * @param folderId Id of the folder
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
      */
     public async getFolderLists (folderId: number, limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetFolderLists;  }> {
         const localVarPath = this.basePath + '/contacts/folders/{folderId}/lists'
@@ -420,7 +420,7 @@ export class FoldersApi {
      * @summary Get all folders
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
      */
     public async getFolders (limit: number, offset: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetFolders;  }> {
         const localVarPath = this.basePath + '/contacts/folders';

api/contactsApi.ts

@@ -45,7 +45,7 @@ export enum ListsApiApiKeys {
 export class ListsApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 
@@ -344,7 +344,7 @@ export class ListsApi {
      * @param modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
      */
     public async getContactsFromList (listId: number, modifiedSince?: Date, limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetContacts;  }> {
         const localVarPath = this.basePath + '/contacts/lists/{listId}/contacts'
@@ -438,7 +438,7 @@ export class ListsApi {
      * @param folderId Id of the folder
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
      */
     public async getFolderLists (folderId: number, limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetFolderLists;  }> {
         const localVarPath = this.basePath + '/contacts/folders/{folderId}/lists'
@@ -602,7 +602,7 @@ export class ListsApi {
      * @summary Get all the lists
      * @param limit Number of documents per page
      * @param offset Index of the first document of the page
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
      */
     public async getLists (limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetLists;  }> {
         const localVarPath = this.basePath + '/contacts/lists';

api/emailCampaignsApi.js

@@ -37,7 +37,7 @@ export enum ProcessApiApiKeys {
 export class ProcessApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 
@@ -178,7 +178,7 @@ export class ProcessApi {
      * @summary Return all the processes for your account
      * @param limit Number limitation for the result returned
      * @param offset Beginning point in the list to retrieve from.
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
      */
     public async getProcesses (limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetProcesses;  }> {
         const localVarPath = this.basePath + '/processes';

api/emailCampaignsApi.ts

@@ -50,7 +50,7 @@ export enum ResellerApiApiKeys {
 export class ResellerApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 

api/foldersApi.js

@@ -46,7 +46,7 @@ export enum SMSCampaignsApiApiKeys {
 export class SMSCampaignsApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;
 
@@ -339,7 +339,7 @@ export class SMSCampaignsApi {
      * @param endDate Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either \'status\' not passed and if passed is set to \'sent\' )
      * @param limit Number limitation for the result returned
      * @param offset Beginning point in the list to retrieve from.
-     * @param sort Sort the results in the ascending/descending order of record creation
+     * @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
      */
     public async getSmsCampaigns (status?: 'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess', startDate?: Date, endDate?: Date, limit?: number, offset?: number, sort?: 'asc' | 'desc', options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetSmsCampaigns;  }> {
         const localVarPath = this.basePath + '/smsCampaigns';

api/foldersApi.ts

@@ -41,7 +41,7 @@ export enum SendersApiApiKeys {
 export class SendersApi {
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        'user-agent': 'sendinblue_clientAPI/v2.1.0/ts-node'
+        'user-agent': 'sendinblue_clientAPI/v2.2.0/ts-node'
     };
     protected _useQuerystring : boolean = false;