mailgun.js 9.2.0 → 9.3.0

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 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.3.0](https://github.com/mailgun/mailgun.js/compare/v9.2.1...v9.3.0) (2023-09-18)
+
+
+### Features
+
+* Update webhook.update method to allow multiple URLs ([633bce9](https://github.com/mailgun/mailgun.js/commits/633bce9f2a7a704972251af16aeafdc73d5cbbde))
+
+
+### Other changes
+
+* Update docs ([3a3b8d8](https://github.com/mailgun/mailgun.js/commits/3a3b8d8a9ced9f6a2d63ce42010980d20cfaf815))
+
+### [9.2.1](https://github.com/mailgun/mailgun.js/compare/v9.2.0...v9.2.1) (2023-08-16)
+
+
+### Bug Fixes
+
+* Node.js native FormData issue ([f00dd57](https://github.com/mailgun/mailgun.js/commits/f00dd57137334e663b01dc833deefad2f36b23f6))
+
+
+### Other changes
+
+* Update readme for events ([83996c9](https://github.com/mailgun/mailgun.js/commits/83996c95fce7d8ecc3f2c5b8fcd0241500a7b1a5))
+
 ## [9.2.0](https://github.com/mailgun/mailgun.js/compare/v9.1.2...v9.2.0) (2023-07-07)
 
 

package/Classes/Webhooks.d.ts

@@ -5,7 +5,8 @@ import Request from './common/Request';
 export declare class Webhook implements WebhookResult {
     id: string;
     url: string | undefined;
-    constructor(id: string, url: string | undefined);
+    urls: string[];
+    constructor(id: string, url: string | undefined, urls: string[]);
 }
 export default class WebhooksClient implements IWebHooksClient {
     request: Request;
@@ -16,6 +17,6 @@ export default class WebhooksClient implements IWebHooksClient {
     list(domain: string, query: WebhooksQuery): Promise<WebhookList>;
     get(domain: string, id: WebhooksIds): Promise<WebhookResult>;
     create(domain: string, id: string, url: string, test?: boolean): Promise<WebhookResult | WebhookValidationResponse>;
-    update(domain: string, id: string, url: string): Promise<WebhookResult>;
+    update(domain: string, id: string, urlValues: string | string[]): Promise<WebhookResult>;
     destroy(domain: string, id: string): Promise<WebhookResult>;
 }

package/Classes/common/FormDataBuilder.d.ts

@@ -4,7 +4,7 @@ declare class FormDataBuilder {
     private FormDataConstructor;
     constructor(FormDataConstructor: InputFormData);
     createFormData(data: any): NodeFormData | FormData;
-    private isNodeFormData;
+    private isFormDataPackage;
     private getAttachmentOptions;
     private addMimeDataToFD;
     private addFilesToFD;

package/Interfaces/Webhooks/IWebHooksClient.d.ts

@@ -4,6 +4,6 @@ export interface IWebHooksClient {
     list(domain: string, query: WebhooksQuery): Promise<WebhookList>;
     get(domain: string, id: WebhooksIds): Promise<WebhookResult>;
     create(domain: string, id: string, url: string, test: boolean): Promise<WebhookResult | WebhookValidationResponse>;
-    update(domain: string, id: string, url: string): Promise<WebhookResult>;
+    update(domain: string, id: string, url: string | string[]): Promise<WebhookResult>;
     destroy(domain: string, id: string): Promise<WebhookResult>;
 }

package/README.md

@@ -97,6 +97,7 @@ The following service methods are available to instantiated clients. The example
       - [assignIp](#assignip)
     - [events](#events)
       - [get](#get-1)
+        - [Example with Date and *Filter field*](#example-with-date-and-filter-field)
     - [stats](#stats)
       - [getDomain](#getdomain)
       - [getAccount](#getaccount)
@@ -898,13 +899,15 @@ Method naming conventions:
 
 - #### get
 
-  `mg.events.get(domain, query)`
+  `mg.events.get(domain, data)`
 
   Example:
 
   ```js
-  mg.events.get('foobar.example.com', { page: 'mypageid' })
-    .then(data => console.log(data.items)) // logs array of event objects
+  mg.events.get('foobar.example.com', {
+      page: 'mypageid',
+      event: 'opened'
+  }).then(data => console.log(data.items)) // logs array of event objects
     .catch(err => console.error(err)); // logs any error
   ```
 
@@ -918,8 +921,17 @@ Method naming conventions:
   | end       | The end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.                                                                                                                                    |
   | ascending | Defines the direction of the search time range if the range end time is not specified. Can be either yes or no. Refer to Time Range for details.                                                                                                                                |
   | limit     | Number of entries to return. (300 max)                                                                                                                                                                                                                                          |
-  | <field>   | <field> is the name of the Filter Field. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator. |
-
+  | **field** | **field** is the name of the *[Filter Field](https://documentation.mailgun.com/en/latest/api-events.html#filter-field)*. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator. |
+  - #### Example with Date and *Filter field*
+    ```js
+      const date = new Date(2023, 7, 2, 0, 0, 0, 0); // Wed Aug 02 2023 00:00:00 GMT+0300
+        const events = await mg.events.get('foobar.example.com', {
+          begin: date.toUTCString(), // 'Tue, 01 Aug 2023 21:00:00 GMT'
+          ascending: 'yes',
+          limit: 5,
+          event: 'delivered'
+        });
+    ```
   Promise returns: items (array of event objects), pages (paging keys grouped by id)
 
   ```JS
@@ -1323,7 +1335,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['trackclick.com'] }
   }
   ```
 
@@ -1343,7 +1355,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
   }
   ```
 
@@ -1380,10 +1392,24 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
   }
   ```
 
+  ```js
+  mg.webhooks.update('foobar.example.com', 'open', ['http://requestb.in', 'http://requestb1.in' ]) // bounce, deliver, drop, spam, unsubscribe, click, open
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
+
+  Promise returns:
+  ```JS
+  {
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in', 'http://requestb1.in'] }
+  }
+  ```
+
+
 - #### destroy
 
   `mg.webhooks.destroy(domain, id)`
@@ -1400,7 +1426,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in']}
   }
   ```
 
@@ -1477,7 +1503,7 @@ Method naming conventions:
 
   Promise returns: response body
 
-  ```JS
+  ```js
   {
     actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
     created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',

package/Types/Webhooks/Webhooks.d.ts

@@ -25,5 +25,9 @@ export type WebhookValidationResponse = {
 };
 export type WebhookResult = {
     id: string;
+    /**
+     * @deprecated url property is deprecated. Use "urls" instead.
+     */
     url: string | undefined;
+    urls: string[];
 };