mailgun.js 5.0.2 → 5.0.5

package/interfaces/Messages.d.ts

@@ -0,0 +1,165 @@
+export declare type MailgunMessageData = {
+    /**
+     * Email address for `From` header
+     */
+    from?: string;
+    /**
+     * Email address of the recipient(s).
+     *
+     * @example `Bob <bob@host.com>`. You can use commas to separate multiple recipients.
+     */
+    to?: string;
+    /**
+     * Same as `To` but for `carbon copy`
+     */
+    cc?: string;
+    /**
+     * Same as `To` but for `blind carbon copy`
+     */
+    bcc?: string;
+    /**
+     * Message subject
+     */
+    subject?: string;
+    /**
+     * Body of the message. (text version)
+     */
+    text?: string;
+    /**
+     * Body of the message. (HTML version)
+     */
+    html?: string;
+    /**
+     * [AMP](https://developers.google.com/gmail/ampemail/) part of the message. Please follow google guidelines to compose and send AMP emails.
+     */
+    'amp-html'?: string;
+    /**
+     * File attachment. You can post multiple `attachment` values.
+     *
+     * **Important:** You must use `multipart/form-data` encoding when sending attachments.
+     */
+    attachment?: any;
+    /**
+     * Attachment with `inline` disposition. Can be used to send inline images (see example).
+     *
+     * You can post multiple `inline` values.
+     */
+    inline?: any;
+    /**
+     * Name of a template stored via [template API](https://documentation.mailgun.com/en/latest/api-templates.html#api-templates). See [Templates](https://documentation.mailgun.com/en/latest/user_manual.html#templating) for more information
+     */
+    template?: string;
+    /**
+     * Use this parameter to send a message to specific version of a template
+     */
+    't:version'?: string;
+    /**
+     * Pass `yes` if you want to have rendered template
+     * in the text part of the message in case of template sending
+     */
+    't:text'?: boolean | 'yes' | 'no';
+    /**
+     * Tag string. See [Tagging](https://documentation.mailgun.com/en/latest/user_manual.html#tagging) for more information.
+     */
+    'o:tag'?: string | string[];
+    /**
+     * Enables/disables DKIM signatures on per-message basis. Pass `yes`, `no`, `true` or `false`
+     */
+    'o:dkim'?: boolean | 'yes' | 'no';
+    /**
+     * Desired time of delivery. See [Date Format](https://documentation.mailgun.com/en/latest/api-intro.html#date-format).
+     *
+     * Note: Messages can be scheduled for a maximum of 3 days in the future.
+     */
+    'o:deliverytime'?: string;
+    /**
+     * Toggles Send Time Optimization (STO) on a per-message basis.
+     *
+     * String should be set to the number of hours in `[0-9]+h` format,
+     * with the minimum being `24h` and the maximum being `72h`.
+     *
+     * This value defines the time window in which Mailgun will run the optimization algorithm based on prior engagement data of a given recipient. See [Sending a message with STO](https://documentation.mailgun.com/en/latest/user_manual.html#sto-sending) for details.
+     *
+     * _Please note that STO is only available on certain plans.
+     * See www.mailgun.com/pricing for more info._
+     */
+    'o:deliverytime-optimize-period'?: string;
+    /**
+     * Toggles Timezone Optimization (TZO) on a per message basis.
+     *
+     * String should be set to preferred delivery time in `HH:mm` or `hh:mmaa` format, where `HH:mm` is used for 24 hour format without AM/PM and `hh:mmaa` is used for 12 hour format with AM/PM. See [Sending a message with TZO](https://documentation.mailgun.com/en/latest/user_manual.html#tzo-sending) for details.
+     *
+     * Please note that TZO is only available on certain plans.
+     * See www.mailgun.com/pricing for more info.
+     */
+    'o:time-zone-localize'?: string;
+    /**
+     * Enables sending in test mode. Pass `yes` if needed. See [Sending in Test Mode](https://documentation.mailgun.com/en/latest/user_manual.html#manual-testmode)
+     */
+    'o:testmode'?: boolean | 'yes' | 'no';
+    /**
+     * Toggles tracking on a per-message basis, see [Tracking Messages](https://documentation.mailgun.com/en/latest/user_manual.html#tracking-messages for details. Pass 'yes', 'no', 'true' or 'false'
+     */
+    'o:tracking'?: boolean | 'yes' | 'no';
+    /**
+     * Toggles clicks tracking on a per-message basis.
+     * Has higher priority than domain-level setting.
+     * Pass `yes`, `no`, `true`, `false` or `htmlonly`.
+     */
+    'o:tracking-clicks'?: boolean | 'yes' | 'no' | 'htmlonly';
+    /**
+     * Toggles opens tracking on a per-message basis.
+     * Has higher priority than domain-level setting.
+     *  Pass 'yes' or 'no', 'true' or 'false'
+     */
+    'o:tracking-opens'?: boolean | 'yes' | 'no';
+    /**
+     * If set to 'True' or 'yes' this requires the message only be sent over a TLS connection.
+     * If a TLS connection can not be established, Mailgun will not deliver the message.
+     *
+     * If set to 'False' or 'no', Mailgun will still try and upgrade the connection,
+     * but if Mailgun can not, the message will be delivered over a plaintext SMTP connection.
+     *
+     * The default is 'False'.
+     */
+    'o:require-tls'?: boolean | 'yes' | 'no';
+    /**
+     * If set to `True` or `yes`, the certificate and hostname will not be verified
+     * when trying to establish a TLS connection
+     * and Mailgun will accept any certificate during delivery.
+     *
+     * If set to `False` or `no`, Mailgun will verify the certificate and hostname.
+     * If either one can not be verified, a TLS connection will not be established.
+     *
+     * The default is `False`.
+     */
+    'o:skip-verification'?: boolean | 'yes' | 'no';
+    /**
+     * A valid JSON-encoded dictionary, where key is a plain recipient address and value is a dictionary with variables that can be referenced in the message body. See [Batch Sending](https://documentation.mailgun.com/en/latest/user_manual.html#batch-sending) for more information.
+     */
+    'recipient-variables'?: string;
+    /**
+     * h:' prefix followed by an arbitrary value allows to append a custom MIME header
+     * to the message ('X-My-Header' in this case).
+     * For example, `h:Reply-To` to specify Reply-To address.
+     */
+    'h:X-My-Header'?: string;
+    /**
+     * `v:` prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See [Attaching Data to Messages](https://documentation.mailgun.com/en/latest/user_manual.html#manual-customdata) for more information.
+     */
+    'v:my-var'?: string;
+    [key: string]: any;
+};
+export interface MessagesSendAPIResponse {
+    status: number;
+    body: {
+        id: string;
+        message: string;
+    };
+}
+export interface MessagesSendResult {
+    id?: string;
+    message?: string;
+    status: number;
+    details?: string;
+}

package/{lib/interfaces/MultipleValidation.ts → interfaces/MultipleValidation.d.ts}

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 export interface MultipleValidationJob {
     created_at: number;
     download_url: {
@@ -22,41 +21,35 @@ export interface MultipleValidationJob {
             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
+    body: MultipleValidationJobsListResult;
 }
-
 export interface CanceledMultipleValidationJob {
-     body: string;
-     status: number;
+    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>
+    list(): Promise<MultipleValidationJobsListResult>;
+    get(listId: string): Promise<MultipleValidationJob>;
+    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
+    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
 }

package/interfaces/Options.d.ts

@@ -0,0 +1,8 @@
+interface Options {
+    username: string;
+    key: string;
+    url?: string;
+    public_key?: string;
+    timeout?: number;
+}
+export default Options;

package/{lib/interfaces/RequestOptions.ts → interfaces/RequestOptions.d.ts}

@@ -1,8 +1,6 @@
 import Options from './Options';
-
 interface RequestOptions extends Options {
-  headers: any;
-  timeout: number;
+    headers: any;
+    timeout: number;
 }
-
 export default RequestOptions;

package/interfaces/StatsOptions.d.ts

@@ -0,0 +1,22 @@
+export interface Stat {
+    time: string | Date;
+    delivered: {
+        smtp: number;
+        http: number;
+        total: number;
+    };
+}
+export interface StatsOptions {
+    start: string | Date;
+    end: string | Date;
+    resolution: string;
+    stats: Stat[];
+}
+export declare type StatsEvent = 'accepted' | 'delivered' | 'opened' | 'clicked' | 'unsubscribed' | 'stored' | 'rejected' | 'complained' | 'failed-temporary' | 'failed-permanent';
+export interface StatsQuery {
+    event: StatsEvent | StatsEvent[];
+    start?: string | Date;
+    end?: string | Date;
+    resolution?: 'hour' | 'day' | 'month';
+    duration?: string;
+}

package/interfaces/Supressions.d.ts

@@ -0,0 +1,103 @@
+import { Bounce, Complaint, Unsubscribe, WhiteList } from '../suppressions';
+export interface BounceData {
+    address: string;
+    code: number;
+    error: string;
+    created_at: string | Date;
+}
+export interface ComplaintData {
+    address: string;
+    created_at: string | Date;
+}
+export interface UnsubscribeData {
+    address: string;
+    tags: any;
+    created_at: string | Date;
+}
+export interface WhiteListData {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: string | Date;
+}
+export interface ParsedPage {
+    id: string;
+    page: string | null | undefined;
+    address: string | null | undefined;
+    url: string;
+}
+export interface ParsedPagesList {
+    previous: ParsedPage;
+    first: ParsedPage;
+    last: ParsedPage;
+    next: ParsedPage;
+}
+export interface SuppressionList {
+    items: (Bounce | Complaint | Unsubscribe | WhiteList)[];
+    pages: ParsedPagesList;
+}
+export interface PagesList {
+    previous: string;
+    first: string;
+    last: string;
+    next: string;
+}
+export declare enum SuppressionModels {
+    BOUNCES = "bounces",
+    COMPLAINTS = "complaints",
+    UNSUBSCRIBES = "unsubscribes",
+    WHITELISTS = "whitelists"
+}
+export interface PagesListAccumulator {
+    [index: string]: ParsedPage;
+}
+export interface SuppressionListQuery {
+    limit?: number;
+}
+export interface SuppressionListResponse {
+    body: {
+        items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[];
+        paging: PagesList;
+    };
+    status: number;
+}
+export interface SuppressionResponse {
+    body: BounceData | ComplaintData | UnsubscribeData | WhiteListData;
+    status: number;
+}
+export interface SuppressionDestroyResponse {
+    body: {
+        message: string;
+        value?: string;
+        address?: string;
+    };
+    status: number;
+}
+export interface SuppressionDestroyResult {
+    message: string;
+    value: string;
+    address: string;
+    status: number;
+}
+export interface SuppressionCreationData {
+    address: string;
+    code?: number;
+    error?: string;
+    domain?: string;
+    tag?: string;
+    created_at?: string;
+}
+export interface SuppressionCreationResponse {
+    body: {
+        message: string;
+        type?: string;
+        value?: string;
+    };
+    status: number;
+}
+export interface SuppressionCreationResult {
+    message: string;
+    type: string;
+    value: string;
+    status: number;
+}

package/{lib/interfaces/Validate.ts → interfaces/Validate.d.ts}

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 export interface ValidationResult {
     address: string;
     is_disposable_address: boolean;
@@ -8,7 +6,6 @@ export interface ValidationResult {
     result: string;
     risk: string;
 }
-
 export interface ValidationResponse {
     status: number;
     body: ValidationResult;

package/{lib/interfaces/Webhooks.ts → interfaces/Webhooks.d.ts}

@@ -1,40 +1,34 @@
 export interface APIWebhook {
-    url?: string
+    url?: string;
     urls?: string[];
 }
-
 export interface WebhookResponseBody {
     message: string;
     webhook: APIWebhook;
 }
-
 export interface WebhookResponse {
     status: number;
     body: WebhookResponseBody;
 }
-
 export interface WebhookList {
     [id: string]: {
-        urls: string[]
-    }
+        urls: string[];
+    };
 }
-
 export interface WebhooksQuery {
     limit?: number;
     skip?: number;
 }
-
 export interface ValidationResponse {
     code: number;
     message: string;
 }
-
-export enum WebhooksIds {
-    CLICKED = 'clicked',
-    COMPLAINED = 'complained',
-    DELIVERED = 'delivered',
-    OPENED = 'opened',
-    PERMANENT_FAIL = 'permanent_fail',
-    TEMPORARY_FAIL = 'temporary_fail',
-    UNSUBSCRIBED = 'unsubscribe',
+export declare enum WebhooksIds {
+    CLICKED = "clicked",
+    COMPLAINED = "complained",
+    DELIVERED = "delivered",
+    OPENED = "opened",
+    PERMANENT_FAIL = "permanent_fail",
+    TEMPORARY_FAIL = "temporary_fail",
+    UNSUBSCRIBED = "unsubscribe"
 }

package/{lib/interfaces/lists.ts → interfaces/lists.d.ts}

@@ -1,23 +1,19 @@
-/* eslint-disable camelcase */
 export interface ListsQuery {
     address?: string;
     limit?: number;
     skip?: number;
 }
-
 export interface CreateUpdateList {
     address: string;
     name?: string;
     description?: string;
-    access_level?: 'readonly' | 'members'| 'everyone';
+    access_level?: 'readonly' | 'members' | 'everyone';
     reply_preference?: 'list' | 'sender';
 }
-
 export interface DestroyedList {
     address: string;
     message: string;
 }
-
 export interface MailingList {
     access_level: string;
     address: string;

package/{lib/interfaces/mailListMembers.ts → interfaces/mailListMembers.d.ts}

@@ -1,26 +1,22 @@
 import { MailingList } from './lists';
-
 export interface MailListMember {
     address: string;
     name: string;
-    subscribed: boolean,
+    subscribed: boolean;
     vars: string | any;
 }
 export interface MailListMembersQuery {
     subscribed?: 'yes' | 'no';
     limit?: number;
 }
-
 export interface MultipleMembersData {
     members: Array<MailListMember>;
     upsert: 'yes' | 'no';
 }
-
 export interface MultipleMembersReqData {
     members: string;
     upsert: 'yes' | 'no';
 }
-
 export interface CreateUpdateMailListMembers {
     address: string;
     name?: string;
@@ -28,7 +24,6 @@ export interface CreateUpdateMailListMembers {
     subscribed?: 'yes' | 'no' | boolean;
     upsert?: 'yes' | 'no';
 }
-
 export interface CreateUpdateMailListMembersReq {
     address: string;
     name?: string;
@@ -36,32 +31,22 @@ export interface CreateUpdateMailListMembersReq {
     subscribed?: 'yes' | 'no' | boolean;
     upsert?: 'yes' | 'no';
 }
-
 export interface DeletedMember {
     member: {
         address: string;
-    },
+    };
     message: string;
-  }
-
+}
 export interface NewMultipleMembersResponse {
     list: MailingList;
     message: string;
     'task-id': string;
 }
-
 export interface IMailListsMembers {
     listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]>;
-    getMember(address: string, memberAddress: string): Promise<MailListMember>,
-    createMember(
-        mailListAddress: string,
-        data: CreateUpdateMailListMembers): Promise<MailListMember>,
-    createMembers(
-        mailListAddress: string,
-        data: MultipleMembersData): Promise<NewMultipleMembersResponse>,
-    updateMember(
-        address: string,
-        memberAddress: string,
-        data: CreateUpdateMailListMembers): Promise<MailListMember>,
-    destroyMember(address : string, memberAddress: string): Promise<DeletedMember>
+    getMember(address: string, memberAddress: string): Promise<MailListMember>;
+    createMember(mailListAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
+    createMembers(mailListAddress: string, data: MultipleMembersData): Promise<NewMultipleMembersResponse>;
+    updateMember(address: string, memberAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
+    destroyMember(address: string, memberAddress: string): Promise<DeletedMember>;
 }

package/{lib/interfaces/routes.ts → interfaces/routes.d.ts}

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 export interface Route {
     actions: string[];
     created_at: string;
@@ -7,23 +6,19 @@ export interface Route {
     id: string;
     priority: number;
 }
-
-export interface UpdateRouteResponse extends Route{
+export interface UpdateRouteResponse extends Route {
     message: string;
 }
-
 export interface DestroyRouteResponse {
     id: string;
     message: string;
 }
-
 export interface CreateUpdateRouteData {
     priority?: number;
     description?: string;
     expression: string;
     action: string[];
 }
-
 export interface RoutesListQuery {
     limit?: number;
     skip?: number;

package/ip-pools.d.ts

@@ -0,0 +1,21 @@
+import Request from './request';
+import { IpPool, IpPoolUpdateData } from './interfaces/IpPools';
+export default class IpPoolsClient {
+    request: Request;
+    constructor(request: Request);
+    list(query: any): Promise<IpPool[]>;
+    create(data: {
+        name: string;
+        description?: string;
+        ips?: string[];
+    }): Promise<{
+        message: string;
+        pool_id: string;
+    }>;
+    update(poolId: string, data: IpPoolUpdateData): Promise<any>;
+    delete(poolId: string, data: {
+        id: string;
+        pool_id: string;
+    }): Promise<any>;
+    private parseIpPoolsResponse;
+}

package/ips.d.ts

@@ -0,0 +1,9 @@
+import MgRequest from './request';
+import { IpData, IpsListResponseBody } from './interfaces/Ips';
+export default class IpsClient {
+    request: MgRequest;
+    constructor(request: MgRequest);
+    list(query: any): Promise<IpsListResponseBody | IpData>;
+    get(ip: string): Promise<IpsListResponseBody | IpData>;
+    private parseIpsResponse;
+}

package/lists.d.ts

@@ -0,0 +1,14 @@
+import Request from './request';
+import { ListsQuery, CreateUpdateList, DestroyedList, MailingList } from './interfaces/lists';
+import { IMailListsMembers } from './interfaces/mailListMembers';
+export default class ListsClient {
+    baseRoute: string;
+    request: Request;
+    members: IMailListsMembers;
+    constructor(request: Request, members: IMailListsMembers);
+    list(query?: ListsQuery): Promise<MailingList[]>;
+    get(mailListAddress: string): Promise<MailingList>;
+    create(data: CreateUpdateList): Promise<MailingList>;
+    update(mailListAddress: string, data: CreateUpdateList): Promise<MailingList>;
+    destroy(mailListAddress: string): Promise<DestroyedList>;
+}

package/mailListMembers.d.ts

@@ -0,0 +1,14 @@
+import Request from './request';
+import { MailListMembersQuery, IMailListsMembers, CreateUpdateMailListMembers, MailListMember, MultipleMembersData, DeletedMember, NewMultipleMembersResponse } from './interfaces/mailListMembers';
+export default class MailListsMembers implements IMailListsMembers {
+    baseRoute: string;
+    request: Request;
+    constructor(request: Request);
+    private checkAndUpdateData;
+    listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]>;
+    getMember(mailListAddress: string, mailListMemberAddress: string): Promise<MailListMember>;
+    createMember(mailListAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
+    createMembers(mailListAddress: string, data: MultipleMembersData): Promise<NewMultipleMembersResponse>;
+    updateMember(mailListAddress: string, mailListMemberAddress: string, data: CreateUpdateMailListMembers): Promise<MailListMember>;
+    destroyMember(mailListAddress: string, mailListMemberAddress: string): Promise<DeletedMember>;
+}