mailgun.js 8.2.1 → 9.0.0

package/{interfaces/Ips.d.ts → Types/IPs/IPs.d.ts}

@@ -1,10 +1,13 @@
-export interface IpsListResponseBody {
+export type IpsListResponseBody = {
     assignable_to_pools: boolean;
     items: string[];
     total_count: number;
-}
-export interface IpData {
+};
+export type IpData = {
     ip: string;
     dedicated: boolean;
     rdns: string;
-}
+};
+export type IPsListQuery = {
+    dedicated: boolean | string;
+};

package/Types/IPs/index.d.ts

@@ -0,0 +1 @@
+export * from './IPs';

package/{interfaces/Options.d.ts → Types/MailgunClient/MailgunClientOptions.d.ts}

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

package/Types/MailgunClient/index.d.ts

@@ -0,0 +1 @@
+export * from './MailgunClientOptions';

package/Types/MailingLists/MailingListMembers.d.ts

@@ -0,0 +1,60 @@
+import { PagesList, ParsedPagesList } from '../Common';
+import { MailingList } from './MailingLists';
+export type MailListMember = {
+    address: string;
+    name: string;
+    subscribed: boolean;
+    vars: {
+        [key: string]: unknown;
+    };
+};
+export type MailListMembersQuery = {
+    subscribed?: 'yes' | 'no';
+    limit?: number;
+    page?: string;
+};
+export type MultipleMembersData = {
+    members: Array<MailListMember>;
+    upsert: 'yes' | 'no';
+};
+export type MultipleMembersReqData = {
+    members: string;
+    upsert: 'yes' | 'no';
+};
+export type CreateUpdateMailListMembers = {
+    address: string;
+    name?: string;
+    vars?: string;
+    subscribed?: 'yes' | 'no' | boolean;
+    upsert?: 'yes' | 'no';
+};
+export type CreateUpdateMailListMembersReq = {
+    address: string;
+    name?: string;
+    vars?: string;
+    subscribed?: 'yes' | 'no' | boolean;
+    upsert?: 'yes' | 'no';
+};
+export type DeletedMember = {
+    member: {
+        address: string;
+    };
+    message: string;
+};
+export type NewMultipleMembersResponse = {
+    list: MailingList;
+    message: string;
+    'task-id': string;
+};
+export type MailListMembersResponse = {
+    body: {
+        items: MailListMember[];
+        paging: PagesList;
+    };
+    status: number;
+};
+export type MailListMembersResult = {
+    items: MailListMember[];
+    pages: ParsedPagesList;
+    status: number;
+};

package/{interfaces/lists.d.ts → Types/MailingLists/MailingLists.d.ts}

@@ -1,26 +1,26 @@
-import { PagesList, ParsedPagesList } from './NavigationThruPages';
-export declare type ListsQuery = {
+import { PagesList, ParsedPagesList } from '../Common';
+export type ListsQuery = {
     address?: string;
     limit?: number;
     page?: string;
 };
-export declare type CreateUpdateList = {
+export type CreateUpdateList = {
     address: string;
     name?: string;
     description?: string;
     access_level?: 'readonly' | 'members' | 'everyone';
     reply_preference?: 'list' | 'sender';
 };
-export interface DestroyedList {
+export type DestroyedList = {
     address: string;
     message: string;
-}
-export interface StartValidationResult {
+};
+export type StartValidationResult = {
     status: number;
     id: string;
     message: string;
-}
-export interface ValidationResponse {
+};
+export type MailingListValidationResponse = {
     status: string;
     download_url: {
         csv: string;
@@ -44,22 +44,22 @@ export interface ValidationResponse {
             unknown: number;
         };
     };
-}
-export interface ValidationApiResponse extends ValidationResponse {
+};
+export type MailingListValidationApiResponse = MailingListValidationResponse & {
     created_at: number;
-}
-export interface ValidationResultData extends ValidationResponse {
+};
+export type MailingListValidationResultData = MailingListValidationResponse & {
     created_at: Date;
-}
-export interface ValidationResult {
+};
+export type MailingListValidationResult = {
     status: number;
-    validationResult: ValidationResultData;
-}
-export interface CancelValidationResult {
+    validationResult: MailingListValidationResultData;
+};
+export type MailingListCancelValidationResult = {
     status: number;
     message: string;
-}
-export interface MailingList {
+};
+export type MailingList = {
     access_level: string;
     address: string;
     created_at: string;
@@ -67,16 +67,16 @@ export interface MailingList {
     members_count: number;
     name: string;
     reply_preference: null | string;
-}
-export interface MailingListResult {
+};
+export type MailingListResult = {
     items: MailingList[];
     status: number;
     pages: ParsedPagesList;
-}
-export interface MailingListApiResponse {
+};
+export type MailingListApiResponse = {
     body: {
         items: MailingList[];
         paging: PagesList;
     };
     status: number;
-}
+};

package/Types/MailingLists/index.d.ts

@@ -0,0 +1,2 @@
+export * from './MailingListMembers';
+export * from './MailingLists';

package/{interfaces → Types/Messages}/Messages.d.ts

@@ -4,10 +4,10 @@
  *
  * @see {@link https://stackoverflow.com/a/49725198}
  */
-export declare type AtLeastOneKeyPresent<Object_, Keys extends keyof Object_ = keyof Object_> = Pick<Object_, Exclude<keyof Object_, Keys>> & {
+export type AtLeastOneKeyPresent<Object_, Keys extends keyof Object_ = keyof Object_> = Pick<Object_, Exclude<keyof Object_, Keys>> & {
     [K in Keys]-?: Required<Pick<Object_, K>> & Partial<Pick<Object_, Exclude<Keys, K>>>;
 }[Keys];
-export declare type MailgunMessageContent = AtLeastOneKeyPresent<{
+export type MailgunMessageContent = AtLeastOneKeyPresent<{
     /**
      * Body of the message. (text version)
      */
@@ -25,7 +25,7 @@ export declare type MailgunMessageContent = AtLeastOneKeyPresent<{
     */
     template?: string;
 }>;
-export declare type MailgunMessageData = MailgunMessageContent & {
+export type MailgunMessageData = MailgunMessageContent & {
     /**
      * Email address for `From` header
      */
@@ -163,18 +163,18 @@ export declare type MailgunMessageData = MailgunMessageContent & {
      * `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;
+    [key: string]: unknown;
 };
-export interface MessagesSendAPIResponse {
+export type MessagesSendAPIResponse = {
     status: number;
     body: {
         id: string;
         message: string;
     };
-}
-export interface MessagesSendResult {
+};
+export type MessagesSendResult = {
     id?: string;
     message?: string;
     status: number;
     details?: string;
-}
+};

package/Types/Messages/index.d.ts

@@ -0,0 +1 @@
+export * from './Messages';

package/{interfaces/routes.d.ts → Types/Routes/Routes.d.ts}

@@ -1,25 +1,25 @@
-export interface Route {
+export type Route = {
     actions: string[];
     created_at: string;
     description: string;
     expression: string;
     id: string;
     priority: number;
-}
-export interface UpdateRouteResponse extends Route {
+};
+export type UpdateRouteResponse = Route & {
     message: string;
-}
-export interface DestroyRouteResponse {
+};
+export type DestroyRouteResponse = {
     id: string;
     message: string;
-}
-export declare type CreateUpdateRouteData = {
+};
+export type CreateUpdateRouteData = {
     priority?: number;
     description?: string;
     expression: string;
     action: string[];
 };
-export declare type RoutesListQuery = {
+export type RoutesListQuery = {
     limit?: number;
     skip?: number;
 };

package/Types/Routes/index.d.ts

@@ -0,0 +1 @@
+export * from './Routes';

package/{interfaces/StatsOptions.d.ts → Types/Stats/Stats.d.ts}

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

package/Types/Stats/index.d.ts

@@ -0,0 +1 @@
+export * from './Stats';

package/Types/Suppressions/Bounce.d.ts

@@ -0,0 +1,6 @@
+export type BounceData = {
+    address: string;
+    code: number;
+    error: string;
+    created_at: string | Date;
+};

package/Types/Suppressions/Complaint.d.ts

@@ -0,0 +1,4 @@
+export type ComplaintData = {
+    address: string;
+    created_at: string | Date;
+};

package/Types/Suppressions/Suppressions.d.ts

@@ -0,0 +1,60 @@
+import { BounceData, ComplaintData, UnsubscribeData, WhiteListData } from '.';
+import { IBounce, IComplaint, IUnsubscribe, IWhiteList } from '../../Interfaces';
+import { PagesList, ParsedPagesList } from '../Common';
+export type SuppressionList = {
+    items: (IBounce | IComplaint | IUnsubscribe | IWhiteList)[];
+    pages: ParsedPagesList;
+    status: number;
+};
+export type SuppressionListQuery = {
+    limit?: number;
+    page?: string;
+};
+export type SuppressionDataType = BounceData | ComplaintData | UnsubscribeData | WhiteListData;
+export type SuppressionListResponse = {
+    body: {
+        items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[];
+        paging: PagesList;
+    };
+    status: number;
+};
+export type SuppressionResponse = {
+    body: SuppressionDataType;
+    status: number;
+};
+export type SuppressionDestroyResponse = {
+    body: {
+        message: string;
+        value?: string;
+        address?: string;
+    };
+    status: number;
+};
+export type SuppressionDestroyResult = {
+    message: string;
+    value: string;
+    address: string;
+    status: number;
+};
+export type SuppressionCreationData = {
+    address: string;
+    code?: number;
+    error?: string;
+    domain?: string;
+    tag?: string;
+    created_at?: string;
+};
+export type SuppressionCreationResponse = {
+    body: {
+        message: string;
+        type?: string;
+        value?: string;
+    };
+    status: number;
+};
+export type SuppressionCreationResult = {
+    message: string;
+    type: string;
+    value: string;
+    status: number;
+};

package/Types/Suppressions/Unsubscribe.d.ts

@@ -0,0 +1,5 @@
+export type UnsubscribeData = {
+    address: string;
+    tags: any;
+    created_at: string | Date;
+};

package/Types/Suppressions/WhiteList.d.ts

@@ -0,0 +1,6 @@
+export type WhiteListData = {
+    type: string;
+    value: string;
+    reason: string;
+    createdAt: string | Date;
+};

package/Types/Suppressions/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Bounce';
+export * from './Complaint';
+export * from './Suppressions';
+export * from './Unsubscribe';
+export * from './WhiteList';

package/{interfaces → Types/Validations}/MultipleValidation.d.ts

@@ -1,5 +1,5 @@
-import { PagesList, ParsedPagesList } from './NavigationThruPages';
-export interface MultipleValidationJobData {
+import { PagesList, ParsedPagesList } from '../Common';
+export type MultipleValidationJobData = {
     created_at: number;
     id: string;
     quantity: number;
@@ -24,8 +24,8 @@ export interface MultipleValidationJobData {
             unknown: number;
         };
     };
-}
-export interface MultipleValidationJobResult {
+};
+export type MultipleValidationJobResult = {
     createdAt: Date;
     id: string;
     quantity: number;
@@ -51,44 +51,38 @@ export interface MultipleValidationJobResult {
             unknown: number;
         };
     };
-}
-export interface CreatedMultipleValidationJob {
+};
+export type CreatedMultipleValidationJob = {
     id: string;
     message: string;
-}
-export interface MultipleValidationCreationData {
+};
+export type MultipleValidationCreationData = {
     file: Record<string, unknown>;
     [key: string]: unknown | undefined;
-}
-export interface MultipleValidationCreationDataUpdated {
+};
+export type MultipleValidationCreationDataUpdated = {
     multipleValidationFile: Record<string, unknown>;
     [key: string]: unknown | undefined;
-}
-export interface MultipleValidationJobsListResult {
+};
+export type MultipleValidationJobsListResult = {
     jobs: MultipleValidationJobResult[];
     pages: ParsedPagesList;
     total: number;
     status: number;
-}
-export interface MultipleValidationJobsListQuery {
+};
+export type MultipleValidationJobsListQuery = {
     limit: number;
     page: string;
-}
-export interface MultipleValidationJobsListResponse {
+};
+export type MultipleValidationJobsListResponse = {
     status: number;
     body: {
         paging: PagesList;
         jobs: MultipleValidationJobData[];
         total: number;
     };
-}
-export interface CanceledMultipleValidationJob {
+};
+export type CanceledMultipleValidationJob = {
     message: string;
     status: number;
-}
-export interface IMultipleValidationClient {
-    list(): Promise<MultipleValidationJobsListResult>;
-    get(listId: string): Promise<MultipleValidationJobResult>;
-    create(listId: string, file: any): Promise<CreatedMultipleValidationJob>;
-    destroy(listId: string): Promise<CanceledMultipleValidationJob>;
-}
+};

package/{interfaces/Validate.d.ts → Types/Validations/Validation.d.ts}

@@ -1,15 +1,15 @@
-export declare type ValidationQuery = {
+export type ValidationQuery = {
     address: string;
 };
-export interface ValidationResult {
+export type ValidationResult = {
     address: string;
     is_disposable_address: boolean;
     is_role_address: boolean;
     reason: string[];
     result: string;
     risk: string;
-}
-export interface ValidationResponse {
+};
+export type ValidationResponse = {
     status: number;
     body: ValidationResult;
-}
+};

package/Types/Validations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './MultipleValidation';
+export * from './Validation';

package/Types/Webhooks/Webhooks.d.ts

@@ -0,0 +1,29 @@
+export type APIWebhook = {
+    url?: string;
+    urls?: string[];
+};
+export type WebhookResponseBody = {
+    message: string;
+    webhook: APIWebhook;
+};
+export type WebhookResponse = {
+    status: number;
+    body: WebhookResponseBody;
+};
+export type WebhookList = {
+    [id: string]: {
+        urls: string[];
+    };
+};
+export type WebhooksQuery = {
+    limit?: number;
+    skip?: number;
+};
+export type WebhookValidationResponse = {
+    code: number;
+    message: string;
+};
+export type WebhookResult = {
+    id: string;
+    url: string | undefined;
+};

package/Types/Webhooks/index.d.ts

@@ -0,0 +1 @@
+export * from './Webhooks';

package/Types/index.d.ts

@@ -0,0 +1,13 @@
+export * from './Common';
+export * from './Domains';
+export * from './Events';
+export * from './IPPools';
+export * from './IPs';
+export * from './MailgunClient';
+export * from './MailingLists';
+export * from './Messages';
+export * from './Routes';
+export * from './Stats';
+export * from './Suppressions';
+export * from './Validations';
+export * from './Webhooks';

package/index.d.ts

@@ -1,9 +1,12 @@
-import Client from './client';
-import { InputFormData } from './interfaces/IFormData';
-import Options from './interfaces/Options';
+import { IMailgunClient } from './Interfaces';
+import { InputFormData } from './Types/Common';
+import { MailgunClientOptions } from './Types/MailgunClient';
+export * as Enums from './Enums';
+export * from './Types';
+export * as Interfaces from './Interfaces';
 export default class Mailgun {
     static get default(): typeof Mailgun;
     private formData;
     constructor(FormData: InputFormData);
-    client(options: Options): Client;
+    client(options: MailgunClientOptions): IMailgunClient;
 }