mailgun.js 9.0.1 → 9.1.1

package/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 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)
+
+
+### Features
+
+* Add tags property for unsubscribe data type ([3a02a50](https://github.com/mailgun/mailgun.js/commits/3a02a50bc824ed2393075a262399f3e660cf771c))
+
+
+### Other changes
+
+* Add issues template ([c7e8515](https://github.com/mailgun/mailgun.js/commits/c7e85152f7cc725a15612385c090a4f794461a78))
+* Add to release commit TS docs files ([7c7376e](https://github.com/mailgun/mailgun.js/commits/7c7376e1fd3802e79c5259b74418aa8063e4e2f7))
+* Freshest docs ([5258cda](https://github.com/mailgun/mailgun.js/commits/5258cda2b1864e4f71681db1549df8b90daa8ca6))
+* Rename issue template file ([4f7857d](https://github.com/mailgun/mailgun.js/commits/4f7857db8b0e331c89d2e6e3a19aa47c87bf3e39))
+* Update readme with a link to docs ([371a46f](https://github.com/mailgun/mailgun.js/commits/371a46f8c20d5418d6389df769eabd4e957f7732))
+* Update typedoc to use markdown ([393c6f1](https://github.com/mailgun/mailgun.js/commits/393c6f186cd2416c0e2802aa50848bf6556a1a15))
+
 ### [9.0.1](https://github.com/mailgun/mailgun.js/compare/v9.0.0...v9.0.1) (2023-06-06)
 
 

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

@@ -73,7 +73,7 @@ Starting from version **9.0.0.** Interfaces and Enums can be imported in the nex
 ```
 
 ### Generated docs
-The list of all available Types, Interfaces and Enums is auto-generated and located in the docs/ folder.
+The list of all available Types, Interfaces and Enums is auto-generated and located in the [docs](./docs/modules.md) folder.
 
 ## Methods
 
@@ -101,9 +101,23 @@ The following service methods are available to instantiated clients. The example
       - [getAccount](#getaccount)
     - [suppressions](#suppressions)
       - [list](#list-1)
+        - [Bounces Example](#bounces-example)
+        - [Unsubscribes Example](#unsubscribes-example)
+        - [Complaints Example](#complaints-example)
       - [get](#get-2)
+        - [Bounces Example](#bounces-example-1)
+        - [Unsubscribes Example](#unsubscribes-example-1)
+        - [Complaints Example](#complaints-example-1)
       - [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)
+        - [Bounces Example](#bounces-example-3)
+        - [Unsubscribes Example](#unsubscribes-example-3)
+        - [Complaints Example](#complaints-example-3)
     - [webhooks](#webhooks)
       - [list](#list-2)
       - [get](#get-3)
@@ -924,7 +938,7 @@ Method naming conventions:
 
   `mg.suppressions.list(domain, suppressionType, query?)`
 
-  - Bounces Example:
+  - #### Bounces Example:
 
     ```js
     mg.suppressions.list('foobar.example.com', 'bounces')
@@ -932,7 +946,7 @@ Method naming conventions:
       .catch(err => console.error(err)); // logs any error
     ```
 
-  - Unsubscribes Example:
+  - #### Unsubscribes Example:
 
     ```js
     mg.suppressions.list('foobar.example.com', 'unsubscribes')
@@ -940,7 +954,7 @@ Method naming conventions:
       .catch(err => console.error(err)); // logs any error
     ```
 
-  - Complaints Example:
+  - #### Complaints Example:
 
     ```js
     mg.suppressions.list('foobar.example.com', 'complaints')
@@ -973,7 +987,7 @@ Method naming conventions:
 
   `mg.suppressions.get(domain, suppressionType, address)`
 
-  - Bounces Example:
+  - #### Bounces Example:
 
     ```js
     mg.suppressions.get('foobar.example.com', 'bounces', 'address@example.com')
@@ -981,7 +995,7 @@ Method naming conventions:
       .catch(err => console.error(err)); // logs any error
     ```
 
-  - Unsubscribes Example:
+  - #### Unsubscribes Example:
 
     ```js
     mg.suppressions.get('foobar.example.com', 'unsubscribes', 'address@example.com')
@@ -989,7 +1003,7 @@ Method naming conventions:
       .catch(err => console.error(err)); // logs any error
     ```
 
-  - Complaints Example:
+  - #### Complaints Example:
 
     ```js
     mg.suppressions.get('foobar.example.com', 'complaints', 'address@example.com')
@@ -1011,7 +1025,7 @@ Method naming conventions:
 -   #### create
     `mg.suppressions.create(domain, suppressionType, data || data[])`
 
-    - Bounces Example:
+    - #### Bounces Example:
       ```JS
       mg.suppressions.create('foobar.example.com', 'bounces', [{address: 'bob@example.com'}])
         .then(msg => console.log(msg)) // logs response data
@@ -1029,16 +1043,16 @@ Method naming conventions:
 
       Promise returns:
 
-      ```JSON
+      ```js
       {
         message: "1 address has been added to the bounces table"
       }
       ```
 
-    - Unsubscribes Example:
+    - #### 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
       ```
@@ -1049,6 +1063,7 @@ Method naming conventions:
       |:-----------|:-----------------------------------------------------------------------------------------------------------------|
       | address    | Valid email address                                                                                              |
       | tag        | Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *) |
+      | tags       | Array with tags to unsubscribe from |
       | created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time)                                  |
 
       Promise returns:
@@ -1058,8 +1073,34 @@ 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']}])
+            .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"
+          }
+          ```
 
-    - Complaints Example:
+    - #### Complaints Example:
 
       ```js
       mg.suppressions.create('foobar.example.com', 'complaints', [{address: 'bob@example.com'}])
@@ -1085,7 +1126,7 @@ Method naming conventions:
 -   #### destroy
     `mg.suppressions.destroy(domain, suppressionType, address)`
 
-    - Bounces Example:
+    - #### Bounces Example:
 
       ```JS
       mg.suppressions.destroy('foobar.example.com', 'bounces', 'bob@example.com')
@@ -1104,7 +1145,7 @@ Method naming conventions:
       }
       ```
 
-    - Unsubscribes Example:
+    - #### Unsubscribes Example:
 
       ```js
       mg.suppressions.destroy('foobar.example.com', 'unsubscribes', 'bob@example.com')
@@ -1123,7 +1164,7 @@ Method naming conventions:
       }
       ```
 
-    - Complaints Example:
+    - #### Complaints Example:
 
       ```js
       mg.suppressions.destroy('foobar.example.com', 'complaints', 'bob@example.com')

package/Types/Suppressions/Suppressions.d.ts

@@ -43,6 +43,7 @@ export type SuppressionCreationData = {
     domain?: string;
     tag?: string;
     created_at?: string;
+    tags?: string[];
 };
 export type SuppressionCreationResponse = {
     body: {