mailgun.js 9.1.0 → 9.1.1

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [9.1.1](https://github.com/mailgun/mailgun.js/compare/v9.1.0...v9.1.1) (2023-06-23)
+
+
+### Bug Fixes
+
+* Creating one unsubscribe with the tag property ([6f27372](https://github.com/mailgun/mailgun.js/commits/6f2737229d14977093e4f8076c053be77002322c))
+* Replace models map by object to remove eslint warning ([1faada1](https://github.com/mailgun/mailgun.js/commits/1faada106b50bb05ddac0b5af1b139264059a12b))
+
+
+### Other changes
+
+* Readme update ([3ccc575](https://github.com/mailgun/mailgun.js/commits/3ccc57535ac6d4eda46b12b5cad398c4eb11ff9d))
+
 ## [9.1.0](https://github.com/mailgun/mailgun.js/compare/v9.0.1...v9.1.0) (2023-06-16)
 
 

package/Classes/Suppressions/SuppressionsClient.d.ts

@@ -5,7 +5,7 @@ import { IBounce, IComplaint, ISuppressionClient, IUnsubscribe, IWhiteList } fro
 import { SuppressionList, SuppressionListResponse, SuppressionDataType, SuppressionCreationData, SuppressionCreationResult, SuppressionListQuery, SuppressionDestroyResult } from '../../Types/Suppressions';
 export default class SuppressionClient extends NavigationThruPages<SuppressionList> implements ISuppressionClient {
     request: Request;
-    models: Map<string, any>;
+    models: object;
     constructor(request: Request);
     protected parseList(response: SuppressionListResponse, Model: {
         new (data: SuppressionDataType): IBounce | IComplaint | IUnsubscribe | IWhiteList;
@@ -14,7 +14,8 @@ export default class SuppressionClient extends NavigationThruPages<SuppressionLi
         new (dataType: SuppressionDataType): T;
     }): T;
     private createWhiteList;
-    private checkType;
+    private createUnsubscribe;
+    private getModel;
     private prepareResponse;
     list(domain: string, type: string, query?: SuppressionListQuery): Promise<SuppressionList>;
     get(domain: string, type: string, address: string): Promise<IBounce | IComplaint | IUnsubscribe | IWhiteList>;

package/README.md

@@ -111,6 +111,7 @@ The following service methods are available to instantiated clients. The example
       - [create](#create-2)
         - [Bounces Example](#bounces-example-2)
         - [Unsubscribes Example](#unsubscribes-example-2)
+          - [Unsubscribe from one tag](#unsubscribe-from-one-tag)
           - [Unsubscribe from particular tags](#unsubscribe-from-particular-tags)
         - [Complaints Example](#complaints-example-2)
       - [destroy](#destroy-1)
@@ -1042,7 +1043,7 @@ Method naming conventions:
 
       Promise returns:
 
-      ```JSON
+      ```js
       {
         message: "1 address has been added to the bounces table"
       }
@@ -1051,7 +1052,7 @@ Method naming conventions:
     - #### Unsubscribes Example:
 
       ```js
-      mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: 'bob@example.com'}])
+      mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: 'bob@example.com'})
         .then(msg => console.log(msg)) // logs response data
         .catch(err => console.error(err)); // logs any error
       ```
@@ -1072,7 +1073,19 @@ Method naming conventions:
         message: "1 address has been added to the unsubscribes table"
       }
       ```
+       - #### Unsubscribe from one tag
+          ```js
+          mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: 'bob@example.com', tag: 'your_tag_to_unsubscribe']})
+            .then(msg => console.log(msg)) // logs response data
+            .catch(err => console.error(err)); // logs any error
+          ```
+          Promise returns:
 
+          ```JS
+          {
+            message: "1 address has been added to the unsubscribes table"
+          }
+          ```
       - #### Unsubscribe from particular tags
           ```js
           mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: 'bob@example.com', tags: ['your_tag_to_unsubscribe', 'another_tag_to_unsubscribe']}])