mailgun.js 9.2.1 → 9.3.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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)
 
 

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/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

@@ -1335,7 +1335,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['trackclick.com'] }
   }
   ```
 
@@ -1355,7 +1355,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
   }
   ```
 
@@ -1392,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)`
@@ -1412,7 +1426,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in']}
   }
   ```
 

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[];
 };