mailgun.js 5.2.1 → 5.2.2

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 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.
 
+### [5.2.2](https://github.com/mailgun/mailgun.js/compare/v5.2.1...v5.2.2) (2022-04-22)
+
+
+### Bug Fixes
+
+* Fix parsing of a response body with json data ([d57671f](https://github.com/mailgun/mailgun.js/commits/d57671f0b0af0c24e64684697e3f5d9001fa43cd))
+* Update message type. Update readme file ([dd22ec0](https://github.com/mailgun/mailgun.js/commits/dd22ec0588b7ddcf04f2f96f6b109502446f766c))
+* Update query parameter type for events get method ([1705a1f](https://github.com/mailgun/mailgun.js/commits/1705a1f34f855d53471548646dda44dbdd0d6338))
+* Update response handler to support string response ([6e0f305](https://github.com/mailgun/mailgun.js/commits/6e0f3053e2ffe9dec25dd6fa8cfe19140be626ad))
+
 ### [5.2.1](https://github.com/mailgun/mailgun.js/compare/v5.2.0...v5.2.1) (2022-04-14)
 
 

package/README.md

@@ -135,7 +135,9 @@ Options:
 
 Parameter         | Description
 :---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-to                | Email address of the recipient(s). Example: "Bob <bob@host.com>". You can use commas to separate multiple recipients (e.g.: "test@example.com,test@example.com" or ["test@example.com", "test@example.com"]). Make sure to include all To, Cc and Bcc recipients of the message.
+to                | Email address of the recipient(s). Example: "Bob <bob@host.com>". You can use commas to separate multiple recipients (e.g.: "test@example.com,test@example.com" or ["test@example.com", "test@example.com"]).
+cc                | Same as `To` but for `carbon copy`
+bcc               | Same as `To` but for `blind carbon copy`
 html              | HTML version of the message.
 text              | Text version of the message.
 message           | MIME string of the message. Make sure to use multipart/form-data to send this as a file upload.

package/events.d.ts

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

package/interfaces/Events.d.ts

@@ -3,6 +3,27 @@ export interface EventsPage {
     number: string;
     url: string;
 }
+export interface FilterField {
+    event?: string;
+    list?: string;
+    attachment?: string;
+    from?: string;
+    'message-id'?: string;
+    subject?: string;
+    to?: string;
+    size?: string;
+    recipient?: string;
+    recipients?: string;
+    tags?: string;
+    severity?: string;
+}
+export interface EventsQuery extends FilterField {
+    page?: string;
+    begin?: string;
+    end?: string;
+    ascending?: 'yes' | 'no';
+    limit?: number;
+}
 export interface PagesList {
     previous: string;
     first: string;

package/interfaces/Messages.d.ts

@@ -8,7 +8,7 @@ export declare type MailgunMessageData = {
      *
      * @example `Bob <bob@host.com>`. You can use commas to separate multiple recipients.
      */
-    to?: string;
+    to?: string | string[];
     /**
      * Same as `To` but for `carbon copy`
      */