Merge pull request #2 from sendinblue/feature_formatting-files

file format

Author: ekta-slit

README.md

@@ -1,22 +1,24 @@
-# SendinBlue Api V3 Node.js Library
+# SendinBlue's API v3 Node.js Library
 
-SendinBlueApi - Node.js client for sendinblue-apiv3
-SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  | 
-This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+SendinBlue's API exposes the entire SendinBlue features via a standardized programmatic interface. Please refer to the full [documentation](https://developers.sendinblue.com) to learn more.
+
+This is the wrapper for the API. It implements all the features of the API v3. It supports callbacks.
+
+SendinBlue's API matches the [OpenAPI v2 definition](https://www.openapis.org/). The specification can be downloaded herede.
+
+This library is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by SendinBlue:
 
 - API version: 3.0.0
-- Package version: 3.0.0
+- Package version: 1.0.0
 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen
-For more information, please visit [https://account.sendinblue.com/support](https://account.sendinblue.com/support)
 
 ## Installation
 
 ### For [Node.js](https://nodejs.org/)
 
 #### npm
 
-To publish the library as a [npm](https://www.npmjs.com/),
-please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/).
 
 Then install it via:
 
@@ -26,7 +28,7 @@ npm install sendinblue-apiv3 --save
 
 ##### Local development
 
-To use the library locally without publishing to a remote npm registry, first install the dependencies by changing 
+To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
 into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
 
 ```shell
@@ -45,7 +47,7 @@ Finally, switch to the directory you want to use your sendinblue-apiv3 from, and
 npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
 ```
 
-You should now be able to `require('sendinblue-apiv3')` in javascript files from the directory you ran the last 
+You should now be able to `require('sendinblue-apiv3')` in javascript files from the directory you ran the last
 command above from.
 
 #### git
@@ -58,19 +60,6 @@ then install it via:
     npm install sendinblue/APIv3-nodejs-library --save
 ```
 
-### For browser
-
-The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
-the above steps with Node.js and installing browserify with `npm install -g browserify`,
-perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually 
-use this library):
-
-```shell
-browserify main.js > bundle.js
-```
-
-Then include *bundle.js* in the HTML pages.
-
 ### Webpack Configuration
 
 Using Webpack you may encounter the following error: "Module not found: Error:
@@ -462,10 +451,16 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Authorization
 
-
 ### api-key
 
 - **Type**: API key
 - **API key parameter name**: api-key
 - **Location**: HTTP header
 
+## Support and Feedback
+
+Be sure to visit the SendinBlue official [documentation website](https://sendinblue.readme.io/docs ) for additional information about our API.
+
+If you find a bug, please post the issue on [Github](https://github.com/sendinblue/APIv3-nodejs-library/issues).
+
+As always, if you need additional assistance, drop us a note [here](https://account.sendinblue.com/support).

docs/SMTPApi.md

@@ -260,7 +260,7 @@ apiKey.apiKey = 'YOUR API KEY';
 var apiInstance = new SendinBlueApi.SMTPApi();
 
 var opts = { 
-  'limit': 100, // Number | Number of documents returned per page
+  'limit': 50, // Number | Number of documents returned per page
   'offset': 0, // Number | Index of the first document on the page
   'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
   'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
@@ -370,7 +370,7 @@ var apiInstance = new SendinBlueApi.SMTPApi();
 
 var opts = { 
   'templateStatus': false, // Boolean | Filter on the status of the template. Active = true, inactive = false
-  'limit': 500, // Number | Number of documents returned per page
+  'limit': 50, // Number | Number of documents returned per page
   'offset': 0 // Number | Index of the first document in the page
 };
 

docs/TransactionalSMSApi.md

@@ -28,7 +28,7 @@ apiKey.apiKey = 'YOUR API KEY';
 var apiInstance = new SendinBlueApi.TransactionalSMSApi();
 
 var opts = { 
-  'limit': 100, // Number | Number of documents per page
+  'limit': 50, // Number | Number of documents per page
   'startDate': new Date("2013-10-20"), // Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
   'endDate': new Date("2013-10-20"), // Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
   'offset': 0, // Number | Index of the first document of the page

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sendinblue-apiv3",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Official SendinBlue provided RESTFul API V3 nodejs library",
   "license": "ISC",
   "main": "src/index.js",

src/api/SMTPApi.js

@@ -252,7 +252,7 @@
     /**
      * Get your SMTP activity aggregated per day
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.limit Number of documents returned per page (default to 100)
+     * @param {Number} opts.limit Number of documents returned per page (default to 50)
      * @param {Number} opts.offset Index of the first document on the page (default to 0)
      * @param {Date} opts.startDate Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
      * @param {Date} opts.endDate Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
@@ -350,7 +350,7 @@
      * Get the list of SMTP templates
      * @param {Object} opts Optional parameters
      * @param {Boolean} opts.templateStatus Filter on the status of the template. Active = true, inactive = false (default to false)
-     * @param {Number} opts.limit Number of documents returned per page (default to 500)
+     * @param {Number} opts.limit Number of documents returned per page (default to 50)
      * @param {Number} opts.offset Index of the first document in the page (default to 0)
      * @param {module:api/SMTPApi~getSmtpTemplatesCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/InlineResponse20012}

src/api/TransactionalSMSApi.js

@@ -59,7 +59,7 @@
     /**
      * Get all the SMS activity (unaggregated events)
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.limit Number of documents per page (default to 100)
+     * @param {Number} opts.limit Number of documents per page (default to 50)
      * @param {Date} opts.startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
      * @param {Date} opts.endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
      * @param {Number} opts.offset Index of the first document of the page (default to 0)