sib-api-v3-sdk - npm Package Compare versions

Comparing version 6.0.0 to 6.0.1

docs/ContactsApi.md

@@ -13,2 +13,3 @@ # SibApiV3Sdk.ContactsApi
 [**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
+[**deleteContact**](ContactsApi.md#deleteContact) | **DELETE** /contacts/{email} | Deletes a contact
 [**deleteFolder**](ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
@@ -335,2 +336,50 @@ [**deleteList**](ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
 
+<a name="deleteContact"></a>
+# **deleteContact**
+> deleteContact(email)
+
+Deletes a contact
+
+### Example
+```javascript
+var SibApiV3Sdk = require('sib-api-v3-sdk');
+var defaultClient = SibApiV3Sdk.ApiClient.instance;
+
+// Configure API key authorization: api-key
+var apiKey = defaultClient.authentications['api-key'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+var apiInstance = new SibApiV3Sdk.ContactsApi();
+
+var email = "email_example"; // String | Email (urlencoded) of the contact
+
+apiInstance.deleteContact(email).then(function() {
+  console.log('API called successfully.');
+}, function(error) {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **String**| Email (urlencoded) of the contact | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
 <a name="deleteFolder"></a>
@@ -337,0 +386,0 @@ # **deleteFolder**

docs/GetAccountPlan.md

@@ -7,6 +7,7 @@ # SibApiV3Sdk.GetAccountPlan
 **type** | **String** | Displays the plan type of the user | 
-**creditsType** | **String** | This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. | 
-**credits** | **Number** | Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan. | 
+**creditsType** | **String** | This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. | 
+**credits** | **Number** | Remaining credits of the user | 
 **startDate** | **Date** | Date of the period from which the plan will start (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional] 
 **endDate** | **Date** | Date of the period from which the plan will end (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional] 
+**userLimit** | **Number** | Only in case of reseller account. It implies the total number of child accounts you can add to your account. | [optional] 
 
@@ -37,4 +38,2 @@
 
-* `userLimit` (value: `"userLimit"`)
-
 * `sendLimit` (value: `"sendLimit"`)
@@ -41,0 +40,0 @@

package.json

 {
   "name": "sib-api-v3-sdk",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "Official SendinBlue provided RESTFul API V3 nodejs library",
@@ -5,0 +5,0 @@ "license": "ISC",

README.md

@@ -12,3 +12,3 @@ # SendinBlue's API v3 Node.js Library
 - API version: 3.0.0
-- Package version: 5.0.x
+- Package version: 6.0.x
 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen
@@ -124,2 +124,3 @@
 *SibApiV3Sdk.ContactsApi* | [**deleteAttribute**](docs/ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
+*SibApiV3Sdk.ContactsApi* | [**deleteContact**](docs/ContactsApi.md#deleteContact) | **DELETE** /contacts/{email} | Deletes a contact
 *SibApiV3Sdk.ContactsApi* | [**deleteFolder**](docs/ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
@@ -126,0 +127,0 @@ *SibApiV3Sdk.ContactsApi* | [**deleteList**](docs/ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list

src/api/ContactsApi.js

@@ -374,2 +374,51 @@ /**
     /**
+     * Deletes a contact
+     * @param {String} email Email (urlencoded) of the contact
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+    this.deleteContactWithHttpInfo = function(email) {
+      var postBody = null;
+
+      // verify the required parameter 'email' is set
+      if (email === undefined || email === null) {
+        throw new Error("Missing the required parameter 'email' when calling deleteContact");
+      }
+
+
+      var pathParams = {
+        'email': email
+      };
+      var queryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['api-key'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = null;
+
+      return this.apiClient.callApi(
+        '/contacts/{email}', 'DELETE',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType
+      );
+    }
+
+    /**
+     * Deletes a contact
+     * @param {String} email Email (urlencoded) of the contact
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+    this.deleteContact = function(email) {
+      return this.deleteContactWithHttpInfo(email)
+        .then(function(response_and_data) {
+          return response_and_data.data;
+        });
+    }
+
+
+    /**
      * Delete a folder (and all its lists)
@@ -376,0 +425,0 @@ * @param {Number} folderId Id of the folder

src/model/GetAccountPlan.js

@@ -48,4 +48,4 @@ /**
    * @param type {module:model/GetAccountPlan.TypeEnum} Displays the plan type of the user
-   * @param creditsType {module:model/GetAccountPlan.CreditsTypeEnum} This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.
-   * @param credits {Number} Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan.
+   * @param creditsType {module:model/GetAccountPlan.CreditsTypeEnum} This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.
+   * @param credits {Number} Remaining credits of the user
    */
@@ -60,2 +60,3 @@ var exports = function(type, creditsType, credits) {
 
+
   };
@@ -89,2 +90,5 @@
       }
+      if (data.hasOwnProperty('userLimit')) {
+        obj['userLimit'] = ApiClient.convertToType(data['userLimit'], 'Number');
+      }
     }
@@ -100,3 +104,3 @@ return obj;
   /**
-   * This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.
+   * This is the type of the credit, \"Send Limit\" is one of the possible types of credit of a user. \"Send Limit\" implies the total number of emails you can send to the subscribers in your account.
    * @member {module:model/GetAccountPlan.CreditsTypeEnum} creditsType
@@ -106,3 +110,3 @@ */
   /**
-   * Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan.
+   * Remaining credits of the user
    * @member {Number} credits
@@ -121,2 +125,7 @@ */
   exports.prototype['endDate'] = undefined;
+  /**
+   * Only in case of reseller account. It implies the total number of child accounts you can add to your account.
+   * @member {Number} userLimit
+   */
+  exports.prototype['userLimit'] = undefined;
 
@@ -168,7 +177,2 @@
     /**
-     * value: "userLimit"
-     * @const
-     */
-    "userLimit": "userLimit",
-    /**
      * value: "sendLimit"
@@ -175,0 +179,0 @@ * @const

test/api/ContactsApi.spec.js

@@ -114,2 +114,12 @@ /**
     });
+    describe('deleteContact', function() {
+      it('should call deleteContact successfully', function(done) {
+        //uncomment below and update the code to test deleteContact
+        //instance.deleteContact(function(error) {
+        //  if (error) throw error;
+        //expect().to.be();
+        //});
+        done();
+      });
+    });
     describe('deleteFolder', function() {
@@ -116,0 +126,0 @@ it('should call deleteFolder successfully', function(done) {

test/model/GetAccountPlan.spec.js

@@ -90,4 +90,10 @@ /**
 
+    it('should have the property userLimit (base name: "userLimit")', function() {
+      // uncomment below and update the code to test the property userLimit
+      //var instane = new SibApiV3Sdk.GetAccountPlan();
+      //expect(instance).to.be();
+    });
+
   });
 
 }));

No alert changes

Improved metrics

Total package byte prevSize

1791173

increased by0.18%

Lines of code

34767

increased by0.17%

Number of lines in readme file

386

increased by0.26%

No dependency changes