mailgun.js 5.0.3 → 5.0.4

package/lib/interfaces/Supressions.ts

@@ -1,123 +0,0 @@
-import {
-  Bounce, Complaint, Unsubscribe, WhiteList
-} from '../suppressions';
-
-/* eslint-disable camelcase */
-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 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/ip-pools.ts

@@ -1,36 +0,0 @@
-/* eslint-disable camelcase */
-import Request from './request';
-
-import { IpPool, IpPoolListResponse, IpPoolUpdateData } from './interfaces/IpPools';
-
-export default class IpPoolsClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  list(query: any): Promise<IpPool[]> {
-    return this.request.get('/v1/ip_pools', query)
-      .then((response: IpPoolListResponse) => this.parseIpPoolsResponse(response));
-  }
-
-  create(data: { name: string, description?: string, ips?: string[] }) {
-    return this.request.postWithFD('/v1/ip_pools', data)
-      .then((response: { body: { message: string, pool_id: string } }) => response?.body);
-  }
-
-  update(poolId: string, data: IpPoolUpdateData) : Promise<any> {
-    return this.request.patchWithFD(`/v1/ip_pools/${poolId}`, data)
-      .then((response: { body: any }) => response?.body);
-  }
-
-  delete(poolId: string, data: { id: string, pool_id: string }) {
-    return this.request.delete(`/v1/ip_pools/${poolId}`, data)
-      .then((response: { body: any }) => response?.body);
-  }
-
-  private parseIpPoolsResponse(response: { body: any | any }) {
-    return response.body.ip_pools;
-  }
-}

package/lib/ips.ts

@@ -1,24 +0,0 @@
-import MgRequest from './request';
-import { IpData, IpsListResponseBody } from './interfaces/Ips';
-
-export default class IpsClient {
-  request: MgRequest;
-
-  constructor(request: MgRequest) {
-    this.request = request;
-  }
-
-  list(query: any) {
-    return this.request.get('/v3/ips', query)
-      .then((response: { body: IpsListResponseBody }) => this.parseIpsResponse(response));
-  }
-
-  get(ip: string) {
-    return this.request.get(`/v3/ips/${ip}`)
-      .then((response: { body: IpData }) => this.parseIpsResponse(response));
-  }
-
-  private parseIpsResponse(response: { body: IpsListResponseBody | IpData }) {
-    return response.body;
-  }
-}

package/lib/lists.ts

@@ -1,45 +0,0 @@
-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) {
-    this.request = request;
-    this.baseRoute = '/v3/lists';
-    this.members = members;
-  }
-
-  list(query?: ListsQuery): Promise<MailingList[]> {
-    return this.request.get(`${this.baseRoute}/pages`, query)
-      .then((response) => response.body.items as MailingList[]);
-  }
-
-  get(mailListAddress: string): Promise<MailingList> {
-    return this.request.get(`${this.baseRoute}/${mailListAddress}`)
-      .then((response) => response.body.list as MailingList);
-  }
-
-  create(data: CreateUpdateList): Promise<MailingList> {
-    return this.request.postWithFD(this.baseRoute, data)
-      .then((response) => response.body.list as MailingList);
-  }
-
-  update(mailListAddress: string, data: CreateUpdateList): Promise<MailingList> {
-    return this.request.putWithFD(`${this.baseRoute}/${mailListAddress}`, data)
-      .then((response) => response.body.list as MailingList);
-  }
-
-  destroy(mailListAddress: string): Promise<DestroyedList> {
-    return this.request.delete(`${this.baseRoute}/${mailListAddress}`)
-      .then((response) => response.body as DestroyedList);
-  }
-}

package/lib/mailListMembers.ts

@@ -1,83 +0,0 @@
-import Request from './request';
-import {
-  MailListMembersQuery,
-  IMailListsMembers,
-  CreateUpdateMailListMembers,
-  MailListMember,
-  MultipleMembersData,
-  MultipleMembersReqData,
-  DeletedMember,
-  CreateUpdateMailListMembersReq,
-  NewMultipleMembersResponse
-} from './interfaces/mailListMembers';
-
-export default class MailListsMembers implements IMailListsMembers {
-  baseRoute: string;
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-    this.baseRoute = '/v3/lists';
-  }
-
-  private checkAndUpdateData(data: CreateUpdateMailListMembers) {
-    const newData = { ...data };
-
-    if (typeof data.vars === 'object') {
-      newData.vars = JSON.stringify(newData.vars);
-    }
-
-    if (typeof data.subscribed === 'boolean') {
-      newData.subscribed = data.subscribed ? 'yes' : 'no';
-    }
-
-    return newData as CreateUpdateMailListMembersReq;
-  }
-
-  listMembers(mailListAddress: string, query?: MailListMembersQuery): Promise<MailListMember[]> {
-    return this.request.get(`${this.baseRoute}/${mailListAddress}/members/pages`, query)
-      .then((response) => response.body.items as MailListMember[]);
-  }
-
-  getMember(mailListAddress: string, mailListMemberAddress: string): Promise<MailListMember> {
-    return this.request.get(`${this.baseRoute}/${mailListAddress}/members/${mailListMemberAddress}`)
-      .then((response) => response.body.member as MailListMember);
-  }
-
-  createMember(
-    mailListAddress: string,
-    data: CreateUpdateMailListMembers
-  ): Promise<MailListMember> {
-    const reqData = this.checkAndUpdateData(data);
-    return this.request.postWithFD(`${this.baseRoute}/${mailListAddress}/members`, reqData)
-      .then((response) => response.body.member as MailListMember);
-  }
-
-  createMembers(
-    mailListAddress: string,
-    data: MultipleMembersData
-  ): Promise<NewMultipleMembersResponse> {
-    const newData: MultipleMembersReqData = {
-      members: Array.isArray(data.members) ? JSON.stringify(data.members) : data.members,
-      upsert: data.upsert
-    };
-
-    return this.request.postWithFD(`${this.baseRoute}/${mailListAddress}/members.json`, newData)
-      .then((response) => response.body as NewMultipleMembersResponse);
-  }
-
-  updateMember(
-    mailListAddress: string,
-    mailListMemberAddress: string,
-    data: CreateUpdateMailListMembers
-  ): Promise<MailListMember> {
-    const reqData = this.checkAndUpdateData(data);
-    return this.request.putWithFD(`${this.baseRoute}/${mailListAddress}/members/${mailListMemberAddress}`, reqData)
-      .then((response) => response.body.member as MailListMember);
-  }
-
-  destroyMember(mailListAddress: string, mailListMemberAddress: string) : Promise<DeletedMember> {
-    return this.request.delete(`${this.baseRoute}/${mailListAddress}/members/${mailListMemberAddress}`)
-      .then((response) => response.body as DeletedMember);
-  }
-}

package/lib/messages.ts

@@ -1,27 +0,0 @@
-import Request from './request';
-
-export default class MessagesClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  _parseResponse(response: { body: any }) {
-    if (response.body) {
-      return response.body;
-    }
-
-    return response;
-  }
-
-  create(domain: string, data: any) {
-    if (data.message) {
-      return this.request.postWithFD(`/v3/${domain}/messages.mime`, data)
-        .then(this._parseResponse);
-    }
-
-    return this.request.postWithFD(`/v3/${domain}/messages`, data)
-      .then(this._parseResponse);
-  }
-}

package/lib/multipleValidation.ts

@@ -1,37 +0,0 @@
-import {
-  CanceledMultipleValidationJob,
-  CreatedMultipleValidationJob,
-  IMultipleValidationClient,
-  MultipleValidationJob,
-  MultipleValidationJobsListResult
-}
-  from './interfaces/MultipleValidation';
-import Request from './request';
-
-export default class MultipleValidationClient implements IMultipleValidationClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  list(): Promise<MultipleValidationJobsListResult> {
-    return this.request.get('/v4/address/validate/bulk')
-      .then((response) => response.body as MultipleValidationJobsListResult);
-  }
-
-  get(listId: string): Promise<MultipleValidationJob> {
-    return this.request.get(`/v4/address/validate/bulk/${listId}`)
-      .then((response) => response.body);
-  }
-
-  create(listId: string, file: any): Promise<CreatedMultipleValidationJob> {
-    return this.request.postWithFD(`/v4/address/validate/bulk/${listId}`, file)
-      .then((response) => response.body);
-  }
-
-  destroy(listId: string): Promise<CanceledMultipleValidationJob> {
-    return this.request.delete(`/v4/address/validate/bulk/${listId}`)
-      .then((response) => response);
-  }
-}

package/lib/request.ts

@@ -1,271 +0,0 @@
-import * as NodeFormData from 'form-data';
-import * as base64 from 'base-64';
-import urljoin from 'url-join';
-import ky from 'ky-universal';
-import APIError from './error';
-import RequestOptions from './interfaces/RequestOptions';
-import APIErrorOptions from './interfaces/APIErrorOptions';
-import { InputFormData } from './interfaces/IFormData';
-import APIResponse from './interfaces/ApiResponse';
-
-const isStream = (attachment: any) => typeof attachment === 'object' && typeof attachment.pipe === 'function';
-
-function isNodeFormData(formDataInstance: NodeFormData | FormData)
-  : formDataInstance is NodeFormData {
-  return (<NodeFormData>formDataInstance).getHeaders !== undefined;
-}
-
-const getAttachmentOptions = (item: any): {
-  filename?: string,
-  contentType?: string,
-  knownLength?: number
-} => {
-  if (typeof item !== 'object' || isStream(item)) return {};
-
-  const {
-    filename,
-    contentType,
-    knownLength
-  } = item;
-
-  return {
-    ...(filename ? { filename } : { filename: 'file' }),
-    ...(contentType && { contentType }),
-    ...(knownLength && { knownLength })
-  };
-};
-
-const streamToString = (stream: any) => {
-  const chunks: any = [];
-  return new Promise((resolve, reject) => {
-    stream.on('data', (chunk: any) => chunks.push(chunk));
-    stream.on('error', reject);
-    stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
-  });
-};
-
-class Request {
-  private username: string;
-  private key: string;
-  private url: string;
-  private timeout: number;
-  private headers: any;
-  private FormDataConstructor: InputFormData;
-
-  constructor(options: RequestOptions, formData: InputFormData) {
-    this.username = options.username;
-    this.key = options.key;
-    this.url = options.url as string;
-    this.timeout = options.timeout;
-    this.headers = options.headers || {};
-    this.FormDataConstructor = formData;
-  }
-
-  async request(method: string, url: string, inputOptions?: any): Promise<APIResponse> {
-    const options = { ...inputOptions };
-    const basic = base64.encode(`${this.username}:${this.key}`);
-    const headers = {
-      Authorization: `Basic ${basic}`,
-      ...this.headers,
-      ...options?.headers
-    };
-
-    delete options?.headers;
-
-    if (!headers['Content-Type']) {
-      // for form-data it will be Null so we need to remove it
-      delete headers['Content-Type'];
-    }
-
-    const params = { ...options };
-
-    if (options?.query && Object.getOwnPropertyNames(options?.query).length > 0) {
-      params.searchParams = options.query;
-      delete params.query;
-    }
-
-    const response = await ky(
-      urljoin(this.url, url),
-      {
-        method: method.toLocaleUpperCase(),
-        headers,
-        throwHttpErrors: false,
-        timeout: this.timeout,
-        ...params
-      }
-    );
-
-    if (!response?.ok) {
-      const message = response?.body && isStream(response.body)
-        ? await streamToString(response.body)
-        : await response?.json();
-
-      throw new APIError({
-        status: response?.status,
-        statusText: response?.statusText,
-        body: { message }
-      } as APIErrorOptions);
-    }
-
-    const res = {
-      body: await response?.json(),
-      status: response?.status
-    };
-
-    return res;
-  }
-
-  query(method: string, url: string, query: any, options?: any) : Promise<APIResponse> {
-    return this.request(method, url, { query, ...options });
-  }
-
-  command(method: string, url: string, data: any, options?: any) : Promise<APIResponse> {
-    return this.request(method, url, {
-      headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-      body: data,
-      ...options
-    });
-  }
-
-  get(url: string, query?: any, options?: any) : Promise<APIResponse> {
-    return this.query('get', url, query, options);
-  }
-
-  head(url: string, query: any, options: any) : Promise<APIResponse> {
-    return this.query('head', url, query, options);
-  }
-
-  options(url: string, query: any, options: any) : Promise<APIResponse> {
-    return this.query('options', url, query, options);
-  }
-
-  post(url: string, data: any, options?: any) : Promise<APIResponse> {
-    return this.command('post', url, data, options);
-  }
-
-  postWithFD(url: string, data: any): Promise<APIResponse> {
-    if (!data) {
-      throw new Error('Please provide data object');
-    }
-    const params: any = {
-      headers: { 'Content-Type': null }
-    };
-    const formData = this.createFormData(data);
-    return this.command('post', url, formData, params);
-  }
-
-  putWithFD(url: string, data: any): Promise<APIResponse> {
-    if (!data) {
-      throw new Error('Please provide data object');
-    }
-    const params: any = {
-      headers: { 'Content-Type': null }
-    };
-    const formData = this.createFormData(data);
-    return this.command('put', url, formData, params);
-  }
-
-  patchWithFD(url: string, data: any): Promise<APIResponse> {
-    if (!data) {
-      throw new Error('Please provide data object');
-    }
-    const params: any = {
-      headers: { 'Content-Type': null }
-    };
-    const formData = this.createFormData(data);
-    return this.command('patch', url, formData, params);
-  }
-
-  createFormData(data: any): NodeFormData | FormData {
-    const formData: NodeFormData | FormData = Object.keys(data)
-      .filter(function (key) { return data[key]; })
-      .reduce((formDataAcc: NodeFormData | FormData, key) => {
-        const fileKeys = ['attachment', 'inline', 'file'];
-        if (fileKeys.includes(key)) {
-          this.addFilesToFD(key, data[key], formDataAcc);
-          return formDataAcc;
-        }
-
-        if (key === 'message') { // mime message
-          this.addMimeDataToFD(key, data[key], formDataAcc);
-          return formDataAcc;
-        }
-
-        this.addCommonPropertyToFD(key, data[key], formDataAcc);
-        return formDataAcc;
-      }, new this.FormDataConstructor());
-    return formData;
-  }
-
-  private addMimeDataToFD(
-    key: string,
-    data: Buffer | Blob,
-    formDataInstance: NodeFormData | FormData
-  ): void {
-    if (isNodeFormData(formDataInstance)) {
-      if (Buffer.isBuffer(data)) {
-        formDataInstance.append(key, data, { filename: 'MimeMessage' });
-      }
-    } else {
-      formDataInstance.append(key, data as Blob, 'MimeMessage');
-    }
-  }
-
-  private addFilesToFD(
-    propertyName: string,
-    value: any,
-    formDataInstance: NodeFormData | FormData
-  ): void {
-    const appendFileToFD = (
-      key: string,
-      obj: any,
-      formData: NodeFormData | FormData
-    ): void => {
-      const isStreamData = isStream(obj);
-      const objData = isStreamData ? obj : obj.data;
-      // getAttachmentOptions should be called with obj parameter to prevent loosing filename
-      const options = getAttachmentOptions(obj);
-      if (isNodeFormData(formData)) {
-        formData.append(key, objData, options);
-        return;
-      }
-      formData.append(key, objData, options.filename);
-    };
-
-    if (Array.isArray(value)) {
-      value.forEach(function (item) {
-        appendFileToFD(propertyName, item, formDataInstance);
-      });
-    } else {
-      appendFileToFD(propertyName, value, formDataInstance);
-    }
-  }
-
-  private addCommonPropertyToFD(
-    key: string,
-    value: any,
-    formDataAcc: NodeFormData | FormData
-  ): void {
-    if (Array.isArray(value)) {
-      value.forEach(function (item: any) {
-        formDataAcc.append(key, item);
-      });
-    } else if (value != null) {
-      formDataAcc.append(key, value);
-    }
-  }
-
-  put(url: string, data: any, options?: any): Promise<APIResponse> {
-    return this.command('put', url, data, options);
-  }
-
-  patch(url: string, data: any, options?: any): Promise<APIResponse> {
-    return this.command('patch', url, data, options);
-  }
-
-  delete(url: string, data?: any, options?: any): Promise<APIResponse> {
-    return this.command('delete', url, data, options);
-  }
-}
-
-export default Request;

package/lib/routes.ts

@@ -1,37 +0,0 @@
-import {
-  CreateUpdateRouteData, DestroyRouteResponse, Route, RoutesListQuery, UpdateRouteResponse
-} from './interfaces/routes';
-import Request from './request';
-
-export default class RoutesClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  list(query: RoutesListQuery): Promise<Route[]> {
-    return this.request.get('/v3/routes', query)
-      .then((response) => response.body.items);
-  }
-
-  get(id: string): Promise<Route> {
-    return this.request.get(`/v3/routes/${id}`)
-      .then((response) => response.body.route);
-  }
-
-  create(data: CreateUpdateRouteData): Promise<Route> {
-    return this.request.postWithFD('/v3/routes', data)
-      .then((response) => response.body.route);
-  }
-
-  update(id: string, data: CreateUpdateRouteData): Promise<UpdateRouteResponse> {
-    return this.request.putWithFD(`/v3/routes/${id}`, data)
-      .then((response) => response.body);
-  }
-
-  destroy(id: string): Promise<DestroyRouteResponse> {
-    return this.request.delete(`/v3/routes/${id}`)
-      .then((response) => response.body);
-  }
-}