mailgun.js 9.1.2 → 9.2.1

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.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)
+
+
+### Features
+
+* Add skiped domain update method ([cef4e3b](https://github.com/mailgun/mailgun.js/commits/cef4e3ba97e0003f27a5ef9a5d905b942838cb9d))
+
+
+### Other changes
+
+* Move type from class file ([24c6002](https://github.com/mailgun/mailgun.js/commits/24c6002b64e0377fef8cdaf49591f3fb925a5821))
+
 ### [9.1.2](https://github.com/mailgun/mailgun.js/compare/v9.1.1...v9.1.2) (2023-06-30)
 
 

package/Classes/Domains/domain.d.ts

@@ -1,4 +1,4 @@
-import { DNSRecord, DomainShortData, TDomain } from '../../Types/Domains';
+import { DNSRecord, DomainData, DomainShortData, TDomain } from '../../Types/Domains';
 export default class Domain implements TDomain {
     name: string;
     require_tls: boolean;
@@ -12,5 +12,9 @@ export default class Domain implements TDomain {
     type: string;
     receiving_dns_records: DNSRecord[] | null;
     sending_dns_records: DNSRecord[] | null;
-    constructor(data: DomainShortData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
+    id?: string;
+    is_disabled?: boolean;
+    web_prefix?: string;
+    web_scheme?: string;
+    constructor(data: DomainShortData | DomainData, receiving?: DNSRecord[] | null, sending?: DNSRecord[] | null);
 }

package/Classes/Domains/domainsClient.d.ts

@@ -4,13 +4,14 @@ import Request from '../common/Request';
 import DomainCredentialsClient from './domainsCredentials';
 import DomainTemplatesClient from './domainsTemplates';
 import DomainTagsClient from './domainsTags';
-import { MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse, TDomain } from '../../Types/Domains';
+import { MessageResponse, DomainTrackingData, UpdatedOpenTracking, DomainsQuery, DomainInfo, ConnectionSettings, UpdatedConnectionSettings, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, ReplacementForPool, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse, TDomain, DomainUpdateInfo } from '../../Types/Domains';
 export default class DomainsClient implements IDomainsClient {
     request: Request;
     domainCredentials: IDomainCredentials;
     domainTemplates: IDomainTemplatesClient;
     domainTags: IDomainTagsClient;
     constructor(request: Request, domainCredentialsClient: DomainCredentialsClient, domainTemplatesClient: DomainTemplatesClient, domainTagsClient: DomainTagsClient);
+    private _handleBoolValues;
     private _parseMessage;
     private parseDomainList;
     private _parseDomain;
@@ -19,6 +20,7 @@ export default class DomainsClient implements IDomainsClient {
     list(query?: DomainsQuery): Promise<TDomain[]>;
     get(domain: string): Promise<TDomain>;
     create(data: DomainInfo): Promise<TDomain>;
+    update(domain: string, data: DomainUpdateInfo): Promise<TDomain>;
     verify(domain: string): Promise<TDomain>;
     destroy(domain: string): Promise<MessageResponse>;
     getConnection(domain: string): Promise<ConnectionSettings>;

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/Domains/DomainsClient.d.ts

@@ -1,5 +1,5 @@
 import { APIResponse } from '../../Types/Common';
-import { ClickTrackingInfo, ConnectionSettings, DKIMAuthorityInfo, DKIMSelectorInfo, DomainInfo, DomainsQuery, DomainTrackingData, MessageResponse, OpenTrackingInfo, ReplacementForPool, TDomain, UnsubscribeTrackingInfo, UpdatedConnectionSettings, UpdatedDKIMAuthority, UpdatedDKIMSelectorResponse, UpdatedOpenTracking, UpdatedWebPrefixResponse, WebPrefixInfo } from '../../Types/Domains';
+import { ClickTrackingInfo, ConnectionSettings, DKIMAuthorityInfo, DKIMSelectorInfo, DomainInfo, DomainsQuery, DomainTrackingData, DomainUpdateInfo, MessageResponse, OpenTrackingInfo, ReplacementForPool, TDomain, UnsubscribeTrackingInfo, UpdatedConnectionSettings, UpdatedDKIMAuthority, UpdatedDKIMSelectorResponse, UpdatedOpenTracking, UpdatedWebPrefixResponse, WebPrefixInfo } from '../../Types/Domains';
 import { IDomainCredentials } from './DomainCredentials';
 import { IDomainTagsClient } from './DomainTags';
 import { IDomainTemplatesClient } from './DomainTemplates';
@@ -10,6 +10,7 @@ export interface IDomainsClient {
     list(query?: DomainsQuery): Promise<TDomain[]>;
     get(domain: string): Promise<TDomain>;
     create(data: DomainInfo): Promise<TDomain>;
+    update(domain: string, data: DomainUpdateInfo): Promise<TDomain>;
     verify(domain: string): Promise<TDomain>;
     destroy(domain: string): Promise<MessageResponse>;
     getConnection(domain: string): Promise<ConnectionSettings>;

package/README.md

@@ -89,6 +89,7 @@ The following service methods are available to instantiated clients. The example
       - [list](#list)
       - [get](#get)
       - [create](#create-1)
+      - [update](#update)
       - [destroy](#destroy)
       - [getTracking](#gettracking)
       - [updateTracking](#updatetracking)
@@ -96,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)
@@ -122,13 +124,13 @@ The following service methods are available to instantiated clients. The example
       - [list](#list-2)
       - [get](#get-3)
       - [create](#create-3)
-      - [update](#update)
+      - [update](#update-1)
       - [destroy](#destroy-2)
     - [routes](#routes)
       - [list](#list-3)
       - [get](#get-4)
       - [create](#create-4)
-      - [update](#update-1)
+      - [update](#update-2)
       - [destroy](#destroy-3)
     - [validate](#validate)
       - [get](#get-5)
@@ -141,7 +143,7 @@ The following service methods are available to instantiated clients. The example
       - [list](#list-5)
       - [get](#get-6)
       - [create](#create-6)
-      - [update](#update-2)
+      - [update](#update-3)
       - [destroy](#destroy-5)
     - [mailing list members](#mailing-list-members)
       - [listMembers](#listmember)
@@ -485,13 +487,13 @@ Method naming conventions:
 
 - #### get
 
-  `mg.domains.get()`
+  `mg.domains.get(domain)`
 
   Example:
 
   ```JS
-  mg.domains.get()
-    .then(domains => console.log(domains)) // logs array of domains
+  mg.domains.get('testing.example.com')
+    .then(domains => console.log(domains)) // logs domain object
     .catch(err => console.error(err)); // logs any error
   ```
 
@@ -538,7 +540,11 @@ Method naming conventions:
     spam_action: 'disabled',
     state: 'unverified',
     type: 'custom',
-    wildcard: true
+    wildcard: true,
+    id: '64a4291ebbe4ec7e1d78bc80',
+    is_disabled: false,
+    web_prefix: 'email',
+    web_scheme: 'http'
   }
   ```
 
@@ -556,59 +562,149 @@ Method naming conventions:
 
   Create method accepts data object with next properties:
 
+  | Parameter 	| Description 	|
+  |---	|---	|
+  | name 	| Name of the domain (ex. domain.com) 	|
+  | smtp_password 	| Password for SMTP authentication 	|
+  | spam_action 	| `disabled`, `block`, or `tag`<br>If `disabled`, no spam filtering will occur for inbound messages.<br>If `block`, inbound spam messages will not be delivered.<br>If `tag`, inbound messages will be tagged with a spam header. [Spam Filter](https://documentation.mailgun.com/en/latest/user_manual.html#um-spam-filter)<br>The default is `disabled`. 	|
+  | wildcard 	| Can be string `'true'` or `'false'` or `boolean`<br>Determines whether the domain will accept email for sub-domains when sending messages.<br>The default is `false`. 	|
+  | force_dkim_authority 	| Can be string `'true'` or `'false'` or `boolean`<br>If set to `true`, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account<br>If set to `false`, the domain will have the same DKIM authority as the root domain registered on the same mailgun account<br>The default is `false`. 	|
+  | dkim_key_size 	| **1024** or **2048**<br>Set the length of your domain’s generated DKIM key<br>The default is **1024** 	|
+  | ips 	| An optional, comma-separated list of IP addresses to be assigned to this domain. If not specified, all dedicated IP addresses on the account will be assigned. If the request cannot be fulfilled (e.g. a requested IP is not assigned to the account, etc), a 400 will be returned. 	|
+  | pool_id 	| The id of the IP Pool that you wish to assign to the domain. The pool must contain at least 1 IP. (Note: IP Pools are only available on certain plans; see http://mailgun.com/pricing) 	|
+  | web_scheme 	| String with `http` or `https`<br>Set your **open**, **click** and **unsubscribe** URLs to use `http` or `https`<br>The default is `http` 	|
+
+  Promise returns:
+
+  ```JS
+  name: 'foobar.example.com',
+  require_tls: false,
+  skip_verification: false,
+  state: 'unverified',
+  wildcard: false,
+  spam_action: 'disabled',
+  created_at: 'Tue, 04 Jul 2023 14:09:18 GMT',
+  smtp_password: undefined,
+  smtp_login: 'postmaster@foobar.example.com',
+  type: 'custom',
+  receiving_dns_records: [{
+      "name": "foobar.example.com",
+      "record_type": "TXT",
+      "valid": "unknown",
+      "value": "v=spf1 include:mailgun.org ~all"
+    },
+    {
+      "name": "k1._domainkey.foobar.example.com",
+      "record_type": "TXT",
+      "valid": "unknown",
+      "value": "k=rsa; 123456"
+    },
+    {
+      "name": "email.foobar.example.com",
+      "record_type": "CNAME",
+      "valid": "unknown",
+      "value": "mailgun.org"
+    }
+  ],
+  sending_dns_records: [{
+      "priority": "10",
+      "record_type": "MX",
+      "valid": "unknown",
+      "value": "mxa.mailgun.org"
+    },
+    {
+      "priority": "10",
+      "record_type": "MX",
+      "valid": "unknown",
+      "value": "mxb.mailgun.org"
+  }],
+  id: '64a4291ebbe4ec7e1d78bc80',
+  is_disabled: false,
+  web_prefix: 'email',
+  web_scheme: 'http'
+  ```
+
+- #### update
+
+  `mg.domains.update(domain, options)`
+
+  Example:
+
+  ```js
+  mg.domains.update('foobar.example.com',{
+      wildcard: 'true',
+      web_scheme: 'http',
+      spam_action: 'disabled',
+    })
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
+
+  Update method accepts data object with next properties:
+
   | Property    | Description                                                                                                                                   |
   |:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
-  | name          | Name of the domain (ex. domain.com)                                                                                                           |
-  | smtp_password | Password for SMTP authentication                                                                                                              |
-  | spam_action   | disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged wtih a spam header. See Spam Filter. |
-  | wildcard      | true or false Determines whether the domain will accept email for sub-domains.                                                                |
+  | spam_action   | Can be string with value `disabled`, `block`, or `tag`. If *disabled*, no spam filtering will occur for inbound messages. If `block`, inbound spam messages will not be delivered. If `tag`, inbound messages will be tagged with a spam header. See [Spam Filter](https://documentation.mailgun.com/en/latest/user_manual.html#um-spam-filter).|
+  | web_scheme | Can be string with value `http` or `https`. Set your **open**, **click** and **unsubscribe** URLs to use `http` or `https`. The default is `http`|
+  | wildcard   | Can be string `'true'` or `'false'` or `boolean`. Determines whether the domain will accept email for sub-domains. The default is `false`.|
 
   Promise returns:
 
   ```JS
   {
-    created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
     name: 'foobar.example.com',
-    receiving_dns_records: [{
-        "name": "foobar.example.com",
-        "record_type": "TXT",
-        "valid": "unknown",
-        "value": "v=spf1 include:mailgun.org ~all"
-      },
+    require_tls: false,
+    skip_verification: false,
+    state: 'unverified',
+    wildcard: true,
+    spam_action: 'disabled',
+    created_at: 'Tue, 04 Jul 2023 14:09:18 GMT',
+    smtp_password: undefined,
+    smtp_login: 'postmaster@foobar.example.com',
+    type: 'custom',
+    receiving_dns_records: [
       {
-        "name": "k1._domainkey.foobar.example.com",
-        "record_type": "TXT",
-        "valid": "unknown",
-        "value": "k=rsa; 123456"
+        is_active: true,
+        cached: [],
+        priority: '10',
+        record_type: 'MX',
+        valid: 'unknown',
+        value: 'mxa.mailgun.org'
       },
       {
-        "name": "email.foobar.example.com",
-        "record_type": "CNAME",
-        "valid": "unknown",
-        "value": "mailgun.org"
-      }],
-    require_tls: true,
-    sending_dns_records: [{
-        "priority": "10",
-        "record_type": "MX",
-        "valid": "unknown",
-        "value": "mxa.mailgun.org"
+        is_active: true,
+        cached: [],
+        priority: '10',
+        record_type: 'MX',
+        valid: 'unknown',
+        value: 'mxb.mailgun.org'
+      }
+    ],
+    sending_dns_records: [
+      {
+        is_active: true,
+        cached: [],
+        name: 'foobar.example.com',
+        record_type: 'TXT',
+        valid: 'unknown',
+        value: 'v=spf1 include:mailgun.org ~all'
       },
       {
-        "priority": "10",
-        "record_type": "MX",
-        "valid": "unknown",
-        "value": "mxb.mailgun.org"
-      }],
-    skip_verification: true,
-    smtp_login: 'postmaster@foobar.example.com',
-    smtp_password: 'password',
-    spam_action: 'disabled',
-    state: 'unverified',
-    type: 'custom',
-    wildcard: false
+        is_active: true,
+        cached: [],
+        name: 'email.foobar.example.com',
+        record_type: 'CNAME',
+        valid: 'unknown',
+        value: 'mailgun.org'
+      }
+    ],
+    id: '64a5880eere4eg7e1d85bc69',
+    is_disabled: false,
+    web_prefix: 'email',
+    web_scheme: 'http'
   }
   ```
+
 - #### destroy
 
   `mg.domains.destroy(domainAddress)`
@@ -803,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
   ```
 
@@ -823,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
@@ -1382,7 +1489,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/Domains/Domains.d.ts

@@ -4,16 +4,28 @@ export type DomainsQuery = {
     limit?: number;
     skip?: number;
 };
-export type DomainInfo = {
+export type DomainUpdateInfo = {
+    spam_action?: 'disabled' | 'block' | 'tag';
+    web_scheme?: 'http' | 'https';
+    wildcard?: boolean | 'true' | 'false';
+};
+export type DomainUpdateInfoReq = DomainUpdateInfo & {
+    wildcard?: 'true' | 'false';
+};
+export type DomainInfo = DomainUpdateInfo & {
     name: string;
     smtp_password: string;
-    spam_action?: 'disabled' | 'block' | 'tag';
-    wildcard?: boolean;
     force_dkim_authority?: boolean | 'true' | 'false';
     dkim_key_size?: 1024 | 2048;
     ips?: '';
     pool_id?: '';
-    web_scheme: 'http' | 'https';
+};
+export type DomainInfoReq = DomainInfo & {
+    force_dkim_authority?: 'true' | 'false';
+};
+export type BoolToString = {
+    force_dkim_authority?: DomainInfo['force_dkim_authority'];
+    wildcard?: DomainUpdateInfo['wildcard'];
 };
 export type DomainShortData = {
     name: string;
@@ -133,4 +145,8 @@ export type TDomain = {
     type: string;
     receiving_dns_records: DNSRecord[] | null;
     sending_dns_records: DNSRecord[] | null;
+    id?: string;
+    is_disabled?: boolean;
+    web_prefix?: string;
+    web_scheme?: string;
 };