mailgun.js 3.7.1 → 4.0.1

package/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 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.
 
+### [4.0.1](https://github.com/mailgun/mailgun.js/compare/v4.0.0...v4.0.1) (2021-11-25)
+
+
+### Bug Fixes
+
+* Fixes handling of mime messages ([#213](https://github.com/mailgun/mailgun.js/issues/213)) ([ad43490](https://github.com/mailgun/mailgun.js/commits/ad43490a562b95cb77e38cb66f71ef13a4da8331))
+
+## [4.0.0](https://github.com/mailgun/mailgun.js/compare/v3.7.3...v4.0.0) (2021-11-18)
+
+
+### ⚠ BREAKING CHANGES
+
+* updated signature of unlinkIpPoll method
+
+* feature: Update events client to use v3 of API
+
+* feature: Update webhooks to use v3 of API
+
+* breaking: Update validation to use v4 of API
+* removed parse client functionality.
+Changed mg.validate.get response
+Added multiple email addresses validation
+
+* other: Update domain credentials responses to add status code
+
+* Update endpoints for service methods (#209) ([59f812d](https://github.com/mailgun/mailgun.js/commits/59f812dcf771a5d7ed812424bb5dfaef0f52ff62)), closes [#209](https://github.com/mailgun/mailgun.js/issues/209)
+
+### [3.7.3](https://github.com/mailgun/mailgun.js/compare/v3.7.2...v3.7.3) (2021-11-10)
+
+### [3.7.2](https://github.com/mailgun/mailgun-js/compare/v3.7.1...v3.7.2) (2021-10-28)
+
 ### [3.7.1](https://github.com/mailgun/mailgun-js/compare/v3.7.0...v3.7.1) (2021-10-28)
 
 

package/README.md

@@ -104,6 +104,19 @@ The following service methods are available to instantiated clients. The example
       - [get](#get-5)
     - [parse](#parse)
       - [get](#get-6)
+    - [lists](#lists)
+      - [list](#list-4)
+      - [get](#get-7)
+      - [create](#create-5)
+      - [update](#update-2)
+      - [destroy](#destroy-3)
+    - [mailListMembers](#maillistmembers)
+      - [listMembers](#listmember)
+      - [getMember](#getmember)
+      - [createMember](#createmember)
+      - [createMembers](#createmembers)
+      - [updateMember](#updatemember)
+      - [destroyMember](#destroymember)
   - [Browser Demo](#browser-demo)
 - [Development](#development)
   - [Requirements](#requirements)
@@ -1363,6 +1376,327 @@ Promise Returns: response body
 }
 ```
 
+### lists
+
+A client to manage mailing lists.
+
+#### list
+
+`mg.lists.list()`
+
+Example:
+
+```js
+mg.lists.list()
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+[
+  {
+    access_level: 'readonly',
+    address: 'noreply@sample.com',
+    created_at: 'Wed, 27 Oct 2021 21:59:21 -0000',
+    description: '',
+    members_count: 0,
+    name: '',
+    reply_preference: 'list'
+  }
+]
+```
+
+#### get
+
+`mg.lists.get(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.get('noreply@sample.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'readonly',
+  address: 'noreply@sample.com',
+  created_at: 'Thu, 28 Oct 2021 00:16:56 -0000',
+  description: '',
+  members_count: 0,
+  name: '',
+  reply_preference: 'list'
+}
+```
+
+#### create
+
+`mg.lists.create(data)`
+
+Example:
+
+```js
+mg.lists.create({
+    address: 'reply@sample.com',
+    name: 'Reply Address', // optional, modifiable on website
+    description: 'Mailing lists for repliable address', // optional, modifiable on website
+    access_level: 'readonly', // optional, modifiable on website
+    reply_preference: 'list', // optional, modifiable on website
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'readonly',
+  address: 'reply@sample.com',
+  created_at: 'Thu, 28 Oct 2021 03:12:17 -0000',
+  description: 'Mailing lists for repliable address',
+  members_count: 0,
+  name: 'Reply Address',
+  reply_preference: 'list'
+}
+```
+
+#### update
+
+`mg.lists.update(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.update('reply@sample.com', {
+    address: 'foo@sample.com',
+    name: 'Foo', // optional, modifiable on website
+    description: 'Foo bar bat', // optional, modifiable on website
+    access_level: 'members', // optional, modifiable on website
+    reply_preference: 'sender', // optional, modifiable on website
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'members',
+  address: 'foo@sample.com',
+  created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
+  description: 'Foo bar bat',
+  members_count: 0,
+  name: 'Foo',
+  reply_preference: 'sender'
+}
+```
+
+#### destroy
+
+`mg.lists.destroy(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.destroy('foo@sample.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'foo@sample.com',
+  message: 'Mailing list has been removed'
+}
+```
+
+### mailListMembers
+
+A client to manage members within a specific mailing list.
+
+#### listMembers
+
+`mg.lists.members.listMembers(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.members.listMembers('reply@sample.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+[
+  {
+    address: 'foo@bar.com',
+    name: 'Jane Doe',
+    subscribed: true,
+    vars: { age: 50 }
+  }
+]
+```
+
+#### getMember
+
+`mg.lists.members.getMember(mailListAddress, mailListMemberAddress)`
+
+Example:
+
+```js
+mg.lists.members.getMember('reply@sample.com', 'foo@bar.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'foo@bar.com',
+  name: 'Jane Doe',
+  subscribed: true,
+  vars: { age: 50 }
+}
+```
+
+#### createMember
+
+`mg.lists.members.createMember(mailListAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.createMember('reply@sample.com', {
+    address: 'bat@bar.com',
+    name: 'John Smith', // optional, modifiable on website
+    vars: {hobby: "chess"}, // optional, modifiable on website
+    subscribed: 'no', // optional, modifiable on website
+    upsert: 'yes', // optional, choose yes to insert if not exist, or update it exist
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'bat@bar.com',
+  name: 'John Smith',
+  subscribed: false,
+  vars: { hobby: 'chess' }
+}
+```
+
+#### createMembers
+
+`mg.lists.members.createMembers(mailListAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.createMembers('reply@sample.com', {
+    members: [
+      {
+        address: "bot1@foobar.com",
+        name: "Bot1 Superbot",
+        vars: {location: "loc1"},
+        subscribed: true,
+      },
+      {
+        address: "bot2@foobar.com",
+        name: "Bot2 Superbot",
+        vars: {location: "loc2"},
+        subscribed: false,
+      },
+    ],
+    upsert: "yes",
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  list: {
+    access_level: 'readonly',
+    address: 'reply@sample.com',
+    created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
+    description: 'For reply purpose',
+    members_count: 2,
+    name: 'Reply',
+    reply_preference: 'list'
+  },
+  message: 'Mailing list has been updated',
+  'task-id': '575b943c37a211ec8a520242ac11000a'
+}
+```
+
+#### updateMember
+
+`mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.updateMember('reply@sample.com', 'bot1@foobar.com', {
+    address: 'bot0@barfoo.com',
+    name: 'Bot0 Normalbot', // optional, modifiable on website
+    vars: {location: "space"},
+    subscribed: false,
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'bot0@barfoo.com',
+  name: 'Bot0 Normalbot',
+  subscribed: false,
+  vars: { location: 'space' }
+}
+```
+
+#### destroyMember
+
+`mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)`
+
+Example:
+
+```js
+mg.lists.members.destroyMember('reply@sample.com', 'bot2@foobar.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  member: { address: 'bot2@foobar.com' },
+  message: 'Mailing list member has been deleted'
+}
+```
+
+
+
 ## Browser Demo
 
 ![image](https://cloud.githubusercontent.com/assets/399776/10718632/e8fe56e4-7b34-11e5-84c8-cfcfde978711.png)
@@ -1424,7 +1758,7 @@ git pull
 
 Next, run ```npm run release```.
 
-After that, ```run npm login``` and ```npm publish``` to publish changes on npm.
+After that, run ```npm login``` and ```npm publish``` to publish changes on npm.
 
 ## TODO
 - add browser demo to heroku

package/dist/lib/client.d.ts

@@ -1,4 +1,3 @@
-import Request from './request';
 import Options from './interfaces/Options';
 import DomainClient from './domains';
 import EventClient from './events';
@@ -8,7 +7,6 @@ import WebhookClient from './webhooks';
 import MessagesClient from './messages';
 import RoutesClient from './routes';
 import ValidateClient from './validate';
-import ParseClient from './parse';
 import IpsClient from './ips';
 import IpPoolsClient from './ip-pools';
 import ListsClient from './lists';
@@ -22,9 +20,7 @@ export default class Client {
     suppressions: SuppressionClient;
     messages: MessagesClient;
     routes: RoutesClient;
-    public_request: Request;
     validate: ValidateClient;
-    parse: ParseClient;
     ips: IpsClient;
     ip_pools: IpPoolsClient;
     lists: ListsClient;

package/dist/lib/domains.d.ts

@@ -1,8 +1,9 @@
-import { DomainResponseData, DestroyedDomain, DestroyedDomainResponse, DomainsQuery, DomainInfo, DomainListResponseData, DomainShortData, DNSRecord } from './interfaces/Domains';
+import { DomainsQuery, DomainInfo, DomainShortData, DNSRecord, ConnectionSettings, UpdatedConnectionSettings, DKIMAuthorityInfo, UpdatedDKIMAuthority, DKIMSelectorInfo, UpdatedDKIMSelectorResponse, WebPrefixInfo, UpdatedWebPrefixResponse, ReplacementForPool, MessageResponse } from './interfaces/Domains';
 import APIResponse from './interfaces/ApiResponse';
 import Request from './request';
-import { DomainTrackingResponse, DomainTrackingData, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, UpdateDomainTrackingResponse, UpdatedOpenTracking } from './interfaces/DomainTracking';
-declare class Domain {
+import { DomainTrackingData, OpenTrackingInfo, ClickTrackingInfo, UnsubscribeTrackingInfo, UpdatedOpenTracking } from './interfaces/DomainTracking';
+import DomainCredentialsClient from './domainsCredentials';
+export declare class Domain {
     name: string;
     require_tls: boolean;
     skip_verification: boolean;
@@ -19,22 +20,27 @@ declare class Domain {
 }
 export default class DomainClient {
     request: Request;
-    constructor(request: Request);
-    _parseMessage(response: DestroyedDomainResponse): DestroyedDomain;
-    _parseDomainList(response: DomainListResponseData): Domain[];
-    _parseDomain(response: DomainResponseData): Domain;
-    _parseTrackingSettings(response: DomainTrackingResponse): DomainTrackingData;
-    _parseTrackingUpdate(response: UpdateDomainTrackingResponse): UpdatedOpenTracking;
-    list(query: DomainsQuery): Promise<Domain[]>;
+    domainCredentials: DomainCredentialsClient;
+    constructor(request: Request, domainCredentialsClient: DomainCredentialsClient);
+    private _parseMessage;
+    private _parseDomainList;
+    private _parseDomain;
+    private _parseTrackingSettings;
+    private _parseTrackingUpdate;
+    list(query?: DomainsQuery): Promise<Domain[]>;
     get(domain: string): Promise<Domain>;
     create(data: DomainInfo): Promise<Domain>;
-    destroy(domain: string): Promise<DestroyedDomain>;
+    destroy(domain: string): Promise<MessageResponse>;
+    getConnection(domain: string): Promise<ConnectionSettings>;
+    updateConnection(domain: string, data: ConnectionSettings): Promise<UpdatedConnectionSettings>;
     getTracking(domain: string): Promise<DomainTrackingData>;
     updateTracking(domain: string, type: string, data: OpenTrackingInfo | ClickTrackingInfo | UnsubscribeTrackingInfo): Promise<UpdatedOpenTracking>;
     getIps(domain: string): Promise<string[]>;
     assignIp(domain: string, ip: string): Promise<APIResponse>;
     deleteIp(domain: string, ip: string): Promise<APIResponse>;
     linkIpPool(domain: string, pool_id: string): Promise<APIResponse>;
-    unlinkIpPoll(domain: string, pool_id: string, ip: string): Promise<APIResponse>;
+    unlinkIpPoll(domain: string, replacement: ReplacementForPool): Promise<APIResponse>;
+    updateDKIMAuthority(domain: string, data: DKIMAuthorityInfo): Promise<UpdatedDKIMAuthority>;
+    updateDKIMSelector(domain: string, data: DKIMSelectorInfo): Promise<UpdatedDKIMSelectorResponse>;
+    updateWebPrefix(domain: string, data: WebPrefixInfo): Promise<UpdatedWebPrefixResponse>;
 }
-export {};

package/dist/lib/domainsCredentials.d.ts

@@ -0,0 +1,14 @@
+import Request from './request';
+import { DomainCredentials, DomainCredentialsList, DomainCredentialsQuery, DomainCredentialsResult, IDomainCredentials, UpdateDomainCredentialsData } from './interfaces/DomainCredentials';
+export default class DomainCredentialsClient implements IDomainCredentials {
+    baseRoute: string;
+    request: Request;
+    constructor(request: Request);
+    private _parseDomainCredentialsList;
+    private _parseMessageResponse;
+    private _parseDeletedResponse;
+    list(domain: string, query?: DomainCredentialsQuery): Promise<DomainCredentialsList>;
+    create(domain: string, data: DomainCredentials): Promise<DomainCredentialsResult>;
+    update(domain: string, credentialsLogin: string, data: UpdateDomainCredentialsData): Promise<DomainCredentialsResult>;
+    destroy(domain: string, credentialsLogin: string): Promise<DomainCredentialsResult>;
+}

package/dist/lib/events.d.ts

@@ -1,13 +1,13 @@
-import { EventsList, EventsPage, EventsResponse, PagesList } from './interfaces/Events';
+import { EventsList, EventsPage, EventsResponse, ParsedPagesList } from './interfaces/Events';
 import Request from './request';
 export default class EventClient {
     request: Request;
     constructor(request: Request);
     _parsePageNumber(url: string): string;
     _parsePage(id: string, url: string): EventsPage;
-    _parsePageLinks(response: EventsResponse): PagesList;
+    _parsePageLinks(response: EventsResponse): ParsedPagesList;
     _parseEventList(response: EventsResponse): EventsList;
-    get(domain: string, query: {
+    get(domain: string, query?: {
         page: string;
     }): Promise<EventsList>;
 }

package/dist/lib/interfaces/DomainCredentials.d.ts

@@ -0,0 +1,52 @@
+export interface DomainCredentialsQuery {
+    limit: number;
+    skip: number;
+}
+export interface DomainCredentials {
+    login: string;
+    password: string;
+}
+export interface DomainCredentialsItem {
+    created_at: string;
+    login: string;
+    mailbox: string;
+    size_bytes: number | null;
+}
+export interface DomainCredentialsResponseData {
+    status: number;
+    body: {
+        items: DomainCredentialsItem[];
+        total_count: number;
+    };
+}
+export interface DomainCredentialsList {
+    items: DomainCredentialsItem[];
+    totalCount: number;
+}
+export interface DomainCredentialsResult {
+    status: number;
+    message: string;
+    spec?: string;
+}
+export interface CreatedUpdatedDomainCredentialsResponse {
+    status: number;
+    body: {
+        message: string;
+    };
+}
+export interface DeletedDomainCredentialsResponse {
+    status: number;
+    body: {
+        message: string;
+        spec: string;
+    };
+}
+export interface UpdateDomainCredentialsData {
+    password: string;
+}
+export interface IDomainCredentials {
+    list(domain: string, query: DomainCredentialsQuery): Promise<DomainCredentialsList>;
+    create(domain: string, data: DomainCredentials): Promise<DomainCredentialsResult>;
+    update(domain: string, credentialsLogin: string, data: UpdateDomainCredentialsData): Promise<DomainCredentialsResult>;
+    destroy(domain: string, credentialsLogin: string): Promise<DomainCredentialsResult>;
+}

package/dist/lib/interfaces/DomainTracking.d.ts

@@ -18,7 +18,7 @@ export interface DomainTrackingResponse {
     };
 }
 export interface UpdatedOpenTracking {
-    message: 'Domain tracking settings have been updated';
+    message: string;
     open?: {
         active: boolean;
     };
@@ -36,13 +36,13 @@ export interface UpdateDomainTrackingResponse {
     body: UpdatedOpenTracking;
 }
 export interface OpenTrackingInfo {
-    active: 'yes' | 'no';
+    active: 'yes' | 'no' | 'true' | 'false';
 }
 export interface ClickTrackingInfo {
-    active: 'yes' | 'no' | 'htmlonly';
+    active: 'yes' | 'no' | 'true' | 'false' | 'htmlonly';
 }
 export interface UnsubscribeTrackingInfo {
-    active: boolean;
+    active: 'yes' | 'no' | 'true' | 'false';
     html_footer: string;
     text_footer: string;
 }

package/dist/lib/interfaces/Domains.d.ts

@@ -9,7 +9,7 @@ export interface DomainInfo {
     smtp_password: string;
     spam_action?: 'disabled' | 'block' | 'tag';
     wildcard?: boolean;
-    force_dkim_authority?: true;
+    force_dkim_authority?: boolean | 'true' | 'false';
     dkim_key_size?: 1024 | 2048;
     ips?: '';
     pool_id?: '';
@@ -60,12 +60,62 @@ export interface DomainListResponseData {
         total_count: number;
     };
 }
-export interface DestroyedDomain {
+export interface MessageResponse {
     message: string;
 }
 export interface DestroyedDomainResponse {
     status: number;
+    body: MessageResponse;
+}
+export interface ConnectionSettings {
+    require_tls: boolean;
+    skip_verification: boolean;
+}
+export interface ConnectionSettingsResponse {
     body: {
-        message: string;
+        connection: ConnectionSettings;
     };
+    status: number;
+}
+export interface UpdatedConnectionSettings {
+    message: string;
+    require_tls: boolean;
+    skip_verification: boolean;
+}
+export interface UpdatedConnectionSettingsRes {
+    body: UpdatedConnectionSettings;
+    status: number;
+}
+export interface DKIMAuthorityInfo {
+    self: boolean | 'yes' | 'no' | 'true' | 'false';
+}
+export interface UpdatedDKIMAuthority {
+    changed: boolean;
+    message: string;
+    sending_dns_records: DNSRecord[];
+}
+export interface UpdatedDKIMAuthorityResponse {
+    body: UpdatedDKIMAuthority;
+    status: 200;
+}
+export interface DKIMSelectorInfo {
+    dkimSelector: string;
+}
+export interface UpdatedDKIMSelectorResponse {
+    body: MessageResponse;
+    status: number;
+}
+export interface WebPrefixInfo {
+    webPrefix: string;
+}
+export interface UpdatedWebPrefix {
+    message: string;
+}
+export interface UpdatedWebPrefixResponse {
+    body: MessageResponse;
+    status: number;
+}
+export interface ReplacementForPool {
+    pool_id?: string;
+    ip?: string;
 }