Merge pull request #385 from mailgun/update-webhook-method

Change webhooks `update` method
mailgun · Sep 18, 2023 · 97f6852 · 97f6852
2 parents 970c9b6 + 3a3b8d8
commit 97f6852
Show file tree

Hide file tree

Showing 45 changed files with 24,361 additions and 399 deletions.
diff --git a/README.md b/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']}
   }
   ```
 

diff --git a/dist/Classes/Webhooks.d.ts b/dist/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>;
 }
diff --git a/dist/Interfaces/Webhooks/IWebHooksClient.d.ts b/dist/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>;
 }
diff --git a/dist/README.md b/dist/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']}
   }
   ```
 

diff --git a/dist/Types/Webhooks/Webhooks.d.ts b/dist/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[];
 };
diff --git a/dist/mailgun.node.js b/dist/mailgun.node.js
diff --git a/dist/mailgun.web.js b/dist/mailgun.web.js
diff --git a/docs/README.md b/docs/README.md
@@ -1333,7 +1333,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['trackclick.com'] }
   }
   ```
 
@@ -1353,7 +1353,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
   }
   ```
 
@@ -1390,7 +1390,20 @@ 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'] }
   }
   ```
 
@@ -1410,7 +1423,7 @@ Method naming conventions:
 
   ```JS
   {
-    'open': { 'url': 'http://requestb.in' }
+    'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in']}
   }
   ```
 

diff --git a/docs/classes/default.md b/docs/classes/default.md
@@ -34,7 +34,7 @@
 
 #### Defined in
 
-[index.ts:14](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/index.ts#L14)
+[index.ts:14](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/index.ts#L14)
 
 ## Properties
 
@@ -44,7 +44,7 @@
 
 #### Defined in
 
-[index.ts:12](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/index.ts#L12)
+[index.ts:12](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/index.ts#L12)
 
 ## Accessors
 
@@ -58,7 +58,7 @@ typeof [`default`](default.md)
 
 #### Defined in
 
-[index.ts:11](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/index.ts#L11)
+[index.ts:11](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/index.ts#L11)
 
 ## Methods
 
@@ -78,4 +78,4 @@ typeof [`default`](default.md)
 
 #### Defined in
 
-[index.ts:18](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/index.ts#L18)
+[index.ts:18](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/index.ts#L18)
diff --git a/docs/enums/Enums.Resolution.md b/docs/enums/Enums.Resolution.md
@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[Enums/index.ts:3](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L3)
+[Enums/index.ts:3](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L3)
 
 ___
 
@@ -30,7 +30,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:2](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L2)
+[Enums/index.ts:2](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L2)
 
 ___
 
@@ -40,4 +40,4 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:4](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L4)
+[Enums/index.ts:4](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L4)
diff --git a/docs/enums/Enums.SuppressionModels.md b/docs/enums/Enums.SuppressionModels.md
@@ -21,7 +21,7 @@
 
 #### Defined in
 
-[Enums/index.ts:8](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L8)
+[Enums/index.ts:8](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L8)
 
 ___
 
@@ -31,7 +31,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:9](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L9)
+[Enums/index.ts:9](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L9)
 
 ___
 
@@ -41,7 +41,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:10](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L10)
+[Enums/index.ts:10](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L10)
 
 ___
 
@@ -51,4 +51,4 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:11](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L11)
+[Enums/index.ts:11](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L11)
diff --git a/docs/enums/Enums.WebhooksIds.md b/docs/enums/Enums.WebhooksIds.md
@@ -24,7 +24,7 @@
 
 #### Defined in
 
-[Enums/index.ts:15](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L15)
+[Enums/index.ts:15](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L15)
 
 ___
 
@@ -34,7 +34,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:16](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L16)
+[Enums/index.ts:16](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L16)
 
 ___
 
@@ -44,7 +44,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:17](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L17)
+[Enums/index.ts:17](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L17)
 
 ___
 
@@ -54,7 +54,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:18](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L18)
+[Enums/index.ts:18](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L18)
 
 ___
 
@@ -64,7 +64,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:19](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L19)
+[Enums/index.ts:19](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L19)
 
 ___
 
@@ -74,7 +74,7 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:20](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L20)
+[Enums/index.ts:20](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L20)
 
 ___
 
@@ -84,4 +84,4 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:21](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L21)
+[Enums/index.ts:21](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L21)
diff --git a/docs/enums/Enums.YesNo.md b/docs/enums/Enums.YesNo.md
@@ -19,7 +19,7 @@
 
 #### Defined in
 
-[Enums/index.ts:26](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L26)
+[Enums/index.ts:26](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L26)
 
 ___
 
@@ -29,4 +29,4 @@ ___
 
 #### Defined in
 
-[Enums/index.ts:25](https://github.com/mailgun/mailgun.js/blob/a212f26/lib/Enums/index.ts#L25)
+[Enums/index.ts:25](https://github.com/mailgun/mailgun.js/blob/633bce9/lib/Enums/index.ts#L25)