mailgun.js 3.7.3 → 4.1.1

package/CHANGELOG.md

@@ -2,6 +2,47 @@
 
 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.1.1](https://github.com/mailgun/mailgun.js/compare/v4.1.0...v4.1.1) (2021-12-13)
+
+
+### Bug Fixes
+
+* Ip_pools create and update methods fix ([#215](https://github.com/mailgun/mailgun.js/issues/215)) ([eb1830d](https://github.com/mailgun/mailgun.js/commits/eb1830de472737c0b3dc6a4cb8856f73b52d20c2))
+
+## [4.1.0](https://github.com/mailgun/mailgun.js/compare/v4.0.1...v4.1.0) (2021-11-30)
+
+
+### Features
+
+* Add support of whitelists into suppressions client ([#214](https://github.com/mailgun/mailgun.js/issues/214)) ([1e4fb84](https://github.com/mailgun/mailgun.js/commits/1e4fb84d2528751a9c2dddd1599d2bc0e12b1fdd))
+
+### [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)

package/README.md

@@ -1581,7 +1581,7 @@ Example:
 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 
+    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
   })
@@ -1758,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;
 }

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

@@ -15,9 +15,73 @@ export interface EventsResponse {
         paging: PagesList;
     };
 }
+export interface DomainEvent {
+    severity: string;
+    tags: string[];
+    storage: {
+        url: string;
+        key: string;
+    };
+    'delivery-status': {
+        tls: boolean;
+        'mx-host': string;
+        code: number;
+        description: string;
+        'session-seconds': number;
+        utf8: boolean;
+        'attempt-no': number;
+        message: string;
+        'certificate-verified': boolean;
+    };
+    'recipient-domain': string;
+    id: string;
+    campaigns: [];
+    reason: string;
+    'user-variables': {
+        [key: string]: any;
+    };
+    flags: {
+        'is-routed': boolean;
+        'is-authenticated': boolean;
+        'is-system-test': boolean;
+        'is-test-mode': boolean;
+    };
+    'log-level': string;
+    template?: any;
+    timestamp: number;
+    envelope: {
+        transport: string;
+        sender: string;
+        'sending-ip': string;
+        targets: string;
+    };
+    message: {
+        headers: {
+            to: string;
+            'message-id': string;
+            from: string;
+            subject: string;
+        };
+        attachments: [];
+        size: 308;
+    };
+    recipient: string;
+    event: string;
+}
+export interface ParsedPage {
+    id: string;
+    number: string;
+    url: string;
+}
+export interface ParsedPagesList {
+    previous: ParsedPage;
+    first: ParsedPage;
+    last: ParsedPage;
+    next: ParsedPage;
+}
 export interface EventsList {
-    items: [];
-    pages: PagesList;
+    items: DomainEvent[];
+    pages: ParsedPagesList;
 }
 export interface PagesListAccumulator {
     [index: string]: EventsPage;

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

@@ -0,0 +1,55 @@
+export interface MultipleValidationJob {
+    created_at: number;
+    download_url: {
+        csv: string;
+        json: string;
+    };
+    id: string;
+    quantity: number;
+    records_processed: number;
+    status: string;
+    summary: {
+        result: {
+            catch_all: number;
+            deliverable: number;
+            do_not_send: number;
+            undeliverable: number;
+            unknown: number;
+        };
+        risk: {
+            high: number;
+            low: number;
+            medium: number;
+            unknown: number;
+        };
+    };
+}
+export interface CreatedMultipleValidationJob {
+    id: string;
+    message: string;
+}
+export interface PagesList {
+    prev: string;
+    first: string;
+    last: string;
+    next: string;
+}
+export interface MultipleValidationJobsListResult {
+    jobs: MultipleValidationJob[];
+    paging: PagesList;
+    total: number;
+}
+export interface MultipleValidationJobsListResponse {
+    status: 200;
+    body: MultipleValidationJobsListResult;
+}
+export interface CanceledMultipleValidationJob {
+    body: string;
+    status: number;
+}
+export interface IMultipleValidationClient {
+    list(): Promise<MultipleValidationJobsListResult>;
+    get(listId: string): Promise<MultipleValidationJob>;
+    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
+    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
+}

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

@@ -13,3 +13,9 @@ export interface UnsubscribeData {
     tags: any;
     created_at: string | Date;
 }
+export interface WhiteListData {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: string | Date;
+}

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

@@ -0,0 +1,12 @@
+export interface ValidationResult {
+    address: string;
+    is_disposable_address: boolean;
+    is_role_address: boolean;
+    reason: string[];
+    result: string;
+    risk: string;
+}
+export interface ValidationResponse {
+    status: number;
+    body: ValidationResult;
+}

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

@@ -7,7 +7,7 @@ export interface WebhookResponseBody {
     webhook: APIWebhook;
 }
 export interface WebhookResponse {
-    status: string;
+    status: number;
     body: WebhookResponseBody;
 }
 export interface WebhookList {
@@ -19,3 +19,7 @@ export interface WebhooksQuery {
     limit?: number;
     skip?: number;
 }
+export interface ValidationResponse {
+    code: number;
+    message: string;
+}

package/dist/lib/multipleValidation.d.ts

@@ -0,0 +1,10 @@
+import { CanceledMultipleValidationJob, CreatedMultipleValidationJob, IMultipleValidationClient, MultipleValidationJob, MultipleValidationJobsListResult } from './interfaces/MultipleValidation';
+import Request from './request';
+export default class MultipleValidationClient implements IMultipleValidationClient {
+    request: Request;
+    constructor(request: Request);
+    list(): Promise<MultipleValidationJobsListResult>;
+    get(listId: string): Promise<MultipleValidationJob>;
+    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
+    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
+}

package/dist/lib/parse.d.ts

@@ -1,6 +0,0 @@
-import Request from './request';
-export default class ParseClient {
-    request: Request;
-    constructor(request: Request);
-    get(addresses: string[] | string, enableDnsEspChecks: boolean): Promise<any>;
-}

package/dist/lib/request.d.ts

@@ -8,7 +8,7 @@ declare class Request {
     private url;
     private timeout;
     private headers;
-    private formData;
+    private FormDataConstructor;
     constructor(options: RequestOptions, formData: InputFormData);
     request(method: string, url: string, inputOptions?: any): Promise<APIResponse>;
     query(method: string, url: string, query: any, options?: any): Promise<APIResponse>;
@@ -19,7 +19,11 @@ declare class Request {
     post(url: string, data: any, options?: any): Promise<APIResponse>;
     postWithFD(url: string, data: any): Promise<APIResponse>;
     putWithFD(url: string, data: any): Promise<APIResponse>;
+    patchWithFD(url: string, data: any): Promise<APIResponse>;
     createFormData(data: any): NodeFormData | FormData;
+    private addMimeDataToFD;
+    private addFilesToFD;
+    private addCommonPropertyToFD;
     put(url: string, data: any, options?: any): Promise<APIResponse>;
     patch(url: string, data: any, options?: any): Promise<APIResponse>;
     delete(url: string, data?: any, options?: any): Promise<APIResponse>;

package/dist/lib/suppressions.d.ts

@@ -1,5 +1,5 @@
 import Request from './request';
-import { BounceData, ComplaintData, UnsubscribeData } from './interfaces/Supressions';
+import { BounceData, ComplaintData, UnsubscribeData, WhiteListData } from './interfaces/Supressions';
 declare class Bounce {
     type: string;
     address: string;
@@ -21,13 +21,21 @@ declare class Unsubscribe {
     created_at: Date;
     constructor(data: UnsubscribeData);
 }
-declare type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe;
+declare class WhiteList {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: Date;
+    constructor(data: WhiteListData);
+}
+declare type TModel = typeof Bounce | typeof Complaint | typeof Unsubscribe | typeof WhiteList;
 export default class SuppressionClient {
     request: any;
     models: {
         bounces: typeof Bounce;
         complaints: typeof Complaint;
         unsubscribes: typeof Unsubscribe;
+        whitelists: typeof WhiteList;
     };
     constructor(request: Request);
     _parsePage(id: string, pageUrl: string): {
@@ -49,7 +57,8 @@ export default class SuppressionClient {
     }, Model: TModel): any;
     _parseItem(response: {
         body: any;
-    }, Model: TModel): Bounce | Complaint | Unsubscribe;
+    }, Model: TModel): Bounce | Complaint | Unsubscribe | WhiteList;
+    private createWhiteList;
     list(domain: string, type: string, query: any): any;
     get(domain: string, type: string, address: string): any;
     create(domain: string, type: string, data: any): any;

package/dist/lib/validate.d.ts

@@ -1,6 +1,9 @@
+import { IMultipleValidationClient } from './interfaces/MultipleValidation';
+import { ValidationResult } from './interfaces/Validate';
 import Request from './request';
 export default class ValidateClient {
+    multipleValidation: IMultipleValidationClient;
     request: Request;
-    constructor(request: Request);
-    get(address: string): Promise<any>;
+    constructor(request: Request, multipleValidationClient: IMultipleValidationClient);
+    get(address: string): Promise<ValidationResult>;
 }

package/dist/lib/webhooks.d.ts

@@ -1,4 +1,4 @@
-import { WebhookList, WebhookResponse, WebhooksQuery } from './interfaces/Webhooks';
+import { ValidationResponse, WebhookList, WebhookResponse, WebhooksQuery } from './interfaces/Webhooks';
 import Request from './request';
 declare class Webhook {
     id: string;
@@ -6,7 +6,7 @@ declare class Webhook {
     constructor(id: string, url: string);
 }
 export default class WebhookClient {
-    request: any;
+    request: Request;
     constructor(request: Request);
     _parseWebhookList(response: {
         body: {
@@ -25,7 +25,7 @@ export default class WebhookClient {
     };
     list(domain: string, query: WebhooksQuery): Promise<WebhookList>;
     get(domain: string, id: string): Promise<Webhook>;
-    create(domain: string, id: string, url: string, test?: boolean): Promise<Webhook>;
+    create(domain: string, id: string, url: string, test?: boolean): Promise<Webhook | ValidationResponse>;
     update(domain: string, id: string, url: string): Promise<Webhook>;
     destroy(domain: string, id: string): Promise<Webhook>;
 }