mailgun.js 5.0.3 → 5.1.0

package/lib/stats.ts

@@ -1,62 +0,0 @@
-import urljoin from 'url-join';
-import Request from './request';
-import { StatsQuery, StatsOptions, Stat } from './interfaces/StatsOptions';
-
-class Stats {
-  start: Date;
-  end: Date;
-  resolution: string;
-  stats: Stat[];
-
-  constructor(data: StatsOptions) {
-    this.start = new Date(data.start);
-    this.end = new Date(data.end);
-    this.resolution = data.resolution;
-    this.stats = data.stats.map(function (stat: Stat) {
-      const res = { ...stat };
-      res.time = new Date(stat.time);
-      return res;
-    });
-  }
-}
-
-export default class StatsClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  private prepareSearchParams(query: StatsQuery | undefined): Array<Array<string>> {
-    let searchParams = [] as Array<Array<string>>;
-    if (typeof query === 'object' && Object.keys(query).length) {
-      searchParams = Object.entries(query).reduce((arrayWithPairs, currentPair) => {
-        const [key, value] = currentPair;
-        if (Array.isArray(value) && value.length) {
-          const repeatedProperty = value.map((item) => [key, item]);
-          return [...arrayWithPairs, ...repeatedProperty];
-        }
-        arrayWithPairs.push([key, value]);
-        return arrayWithPairs;
-      }, [] as Array<Array<string>>);
-    }
-
-    return searchParams;
-  }
-
-  _parseStats(response: { body: StatsOptions }): Stats {
-    return new Stats(response.body);
-  }
-
-  getDomain(domain: string, query?: StatsQuery): Promise<Stats> {
-    const searchParams = this.prepareSearchParams(query);
-    return this.request.get(urljoin('/v3', domain, 'stats/total'), searchParams)
-      .then(this._parseStats);
-  }
-
-  getAccount(query?: StatsQuery): Promise<Stats> {
-    const searchParams = this.prepareSearchParams(query);
-    return this.request.get('/v3/stats/total', searchParams)
-      .then(this._parseStats);
-  }
-}

package/lib/suppressions.ts

@@ -1,253 +0,0 @@
-/* eslint-disable camelcase */
-import urljoin from 'url-join';
-
-import Request from './request';
-import {
-  BounceData,
-  ComplaintData,
-  PagesList,
-  PagesListAccumulator,
-  ParsedPage,
-  ParsedPagesList,
-  SuppressionCreationData,
-  SuppressionCreationResponse,
-  SuppressionCreationResult,
-  SuppressionDestroyResponse,
-  SuppressionDestroyResult,
-  SuppressionList,
-  SuppressionListQuery,
-  SuppressionListResponse,
-  SuppressionModels,
-  SuppressionResponse,
-  UnsubscribeData,
-  WhiteListData,
-} from './interfaces/Supressions';
-import APIError from './error';
-import APIErrorOptions from './interfaces/APIErrorOptions';
-
-const createOptions = {
-  headers: { 'Content-Type': 'application/json' }
-};
-export class Suppression {
-  type: string;
-  constructor(type: SuppressionModels) {
-    this.type = type;
-  }
-}
-export class Bounce extends Suppression {
-  address: string;
-  code: number;
-  error: string;
-  created_at: Date;
-
-  constructor(data: BounceData) {
-    super(SuppressionModels.BOUNCES);
-    this.address = data.address;
-    this.code = +data.code;
-    this.error = data.error;
-    this.created_at = new Date(data.created_at);
-  }
-}
-
-export class Complaint extends Suppression {
-  address: string | undefined;
-  created_at: Date;
-
-  constructor(data: ComplaintData) {
-    super(SuppressionModels.COMPLAINTS);
-    this.address = data.address;
-    this.created_at = new Date(data.created_at);
-  }
-}
-
-export class Unsubscribe extends Suppression {
-  address: string;
-  tags: string[];
-  created_at: Date;
-
-  constructor(data: UnsubscribeData) {
-    super(SuppressionModels.UNSUBSCRIBES);
-    this.address = data.address;
-    this.tags = data.tags;
-    this.created_at = new Date(data.created_at);
-  }
-}
-
-export class WhiteList extends Suppression {
-  value: string;
-  reason: string;
-  createdAt: Date;
-
-  constructor(data: WhiteListData) {
-    super(SuppressionModels.WHITELISTS);
-    this.value = data.value;
-    this.reason = data.reason;
-    this.createdAt = new Date(data.createdAt);
-  }
-}
-
-export default class SuppressionClient {
-  request: Request;
-  models: Map<string, any>;
-
-  constructor(request: Request) {
-    this.request = request;
-    this.models = new Map();
-    this.models.set('bounces', Bounce);
-    this.models.set('complaints', Complaint);
-    this.models.set('unsubscribes', Unsubscribe);
-    this.models.set('whitelists', WhiteList);
-  }
-
-  _parsePage(id: string, pageUrl: string) : ParsedPage {
-    const parsedUrl = new URL(pageUrl);
-    const { searchParams } = parsedUrl;
-    return {
-      id,
-      page: searchParams.has('page') ? searchParams.get('page') : undefined,
-      address: searchParams.has('address') ? searchParams.get('address') : undefined,
-      url: pageUrl
-    };
-  }
-
-  _parsePageLinks(response: SuppressionListResponse): ParsedPagesList {
-    const pages = Object.entries(response.body.paging as PagesList);
-    return pages.reduce(
-      (acc: PagesListAccumulator, pair: [pageUrl: string, id: string]) => {
-        const id = pair[0];
-        const pageUrl = pair[1];
-        acc[id] = this._parsePage(id, pageUrl);
-        return acc;
-      }, {}
-    ) as unknown as ParsedPagesList;
-  }
-
-  _parseList(
-    response: SuppressionListResponse,
-    Model: {
-      new(data: BounceData | ComplaintData | UnsubscribeData | WhiteListData):
-      Bounce | Complaint | Unsubscribe | WhiteList
-    }
-  ): SuppressionList {
-    const data = {} as SuppressionList;
-    data.items = response.body.items.map((item) => new Model(item));
-
-    data.pages = this._parsePageLinks(response);
-
-    return data;
-  }
-
-  _parseItem<T extends Suppression>(
-    data : BounceData | ComplaintData | UnsubscribeData | WhiteListData,
-    Model: {
-      new(data: BounceData | ComplaintData | UnsubscribeData | WhiteListData):
-      T
-    }
-  ): T {
-    return new Model(data);
-  }
-
-  private createWhiteList(
-    domain: string,
-    data: SuppressionCreationData | SuppressionCreationData[]
-  ): Promise<SuppressionCreationResult> {
-    if (Array.isArray(data)) {
-      throw new APIError({
-        status: 400,
-        statusText: 'Data property should be an object',
-        body: {
-          message: 'Whitelist\'s creation process does not support multiple creations. Data property should be an object'
-        }
-      } as APIErrorOptions);
-    }
-    return this.request
-      .postWithFD(urljoin('v3', domain, 'whitelists'), data)
-      .then(this.prepareResponse);
-  }
-
-  private checkType(type: string) {
-    if (!this.models.has(type)) {
-      throw new APIError({
-        status: 400,
-        statusText: 'Unknown type value',
-        body: { message: 'Type may be only one of [bounces, complaints, unsubscribes, whitelists]' }
-      } as APIErrorOptions);
-    }
-  }
-
-  private prepareResponse(response: SuppressionCreationResponse): SuppressionCreationResult {
-    return {
-      message: response.body.message,
-      type: response.body.type || '',
-      value: response.body.value || '',
-      status: response.status
-    };
-  }
-
-  list(
-    domain: string,
-    type: string,
-    query?: SuppressionListQuery
-  ): Promise<SuppressionList> {
-    this.checkType(type);
-
-    const model = this.models.get(type);
-    return this.request
-      .get(urljoin('v3', domain, type), query)
-      .then((response: SuppressionListResponse) => this._parseList(response, model));
-  }
-
-  get(
-    domain: string,
-    type: string,
-    address: string
-  ): Promise<Bounce | Complaint | Unsubscribe | WhiteList> {
-    this.checkType(type);
-
-    const model = this.models.get(type);
-    return this.request
-      .get(urljoin('v3', domain, type, encodeURIComponent(address)))
-      .then((response: SuppressionResponse) => this._parseItem<typeof model>(response.body, model));
-  }
-
-  create(
-    domain: string,
-    type: string,
-    data: SuppressionCreationData | SuppressionCreationData[]
-  ): Promise<SuppressionCreationResult> {
-    this.checkType(type);
-    // supports adding multiple suppressions by default
-    let postData;
-    if (type === 'whitelists') {
-      return this.createWhiteList(domain, data);
-    }
-
-    if (!Array.isArray(data)) {
-      postData = [data];
-    } else {
-      postData = [...data];
-    }
-
-    return this.request
-      .post(urljoin('v3', domain, type), JSON.stringify(postData), createOptions)
-      .then(this.prepareResponse);
-  }
-
-  destroy(
-    domain: string,
-    type: string,
-    address: string
-  ): Promise<SuppressionDestroyResult> {
-    this.checkType(type);
-    return this.request
-      .delete(urljoin('v3', domain, type, encodeURIComponent(address)))
-      .then((response: SuppressionDestroyResponse) => ({
-        message: response.body.message,
-        value: response.body.value || '',
-        address: response.body.address || '',
-        status: response.status
-      }));
-  }
-}
-
-module.exports = SuppressionClient;

package/lib/validate.ts

@@ -1,20 +0,0 @@
-import APIResponse from './interfaces/ApiResponse';
-import { IMultipleValidationClient } from './interfaces/MultipleValidation';
-import { ValidationResult, ValidationResponse } from './interfaces/Validate';
-import Request from './request';
-
-export default class ValidateClient {
-  public multipleValidation;
-  request: Request;
-
-  constructor(request: Request, multipleValidationClient: IMultipleValidationClient) {
-    this.request = request;
-    this.multipleValidation = multipleValidationClient;
-  }
-
-  get(address: string): Promise<ValidationResult> {
-    return this.request.get('/v4/address/validate', { address })
-      .then((response : APIResponse) => response)
-      .then((res : ValidationResponse) => res.body as ValidationResult);
-  }
-}

package/lib/webhooks.ts

@@ -1,83 +0,0 @@
-import urljoin from 'url-join';
-
-import {
-  ValidationResponse,
-  WebhookList,
-  WebhookResponse,
-  WebhooksIds,
-  WebhooksQuery
-} from './interfaces/Webhooks';
-import Request from './request';
-
-class Webhook {
-  id: string;
-  url: string | undefined;
-
-  constructor(id: string, url: string | undefined) {
-    this.id = id;
-    this.url = url;
-  }
-}
-
-export default class WebhookClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  _parseWebhookList(response: { body: { webhooks: WebhookList } }): WebhookList {
-    return response.body.webhooks;
-  }
-
-  _parseWebhookWithID(id: string) {
-    return function (response: WebhookResponse): Webhook {
-      const webhookResponse = response?.body?.webhook;
-      let url = webhookResponse?.url;
-      if (!url) {
-        url = webhookResponse?.urls && webhookResponse.urls.length
-          ? webhookResponse.urls[0]
-          : undefined;
-      }
-      return new Webhook(id, url);
-    };
-  }
-
-  _parseWebhookTest(response: { body: { code: number, message: string } })
-  : {code: number, message:string} {
-    return { code: response.body.code, message: response.body.message } as ValidationResponse;
-  }
-
-  list(domain: string, query: WebhooksQuery): Promise<WebhookList> {
-    return this.request.get(urljoin('/v3/domains', domain, 'webhooks'), query)
-      .then(this._parseWebhookList);
-  }
-
-  get(domain: string, id: WebhooksIds): Promise<Webhook> {
-    return this.request.get(urljoin('/v3/domains', domain, 'webhooks', id))
-      .then(this._parseWebhookWithID(id));
-  }
-
-  create(domain: string,
-    id: string,
-    url: string,
-    test = false): Promise<Webhook | ValidationResponse> {
-    if (test) {
-      return this.request.putWithFD(urljoin('/v3/domains', domain, 'webhooks', id, 'test'), { url })
-        .then(this._parseWebhookTest);
-    }
-
-    return this.request.postWithFD(urljoin('/v3/domains', domain, 'webhooks'), { id, url })
-      .then(this._parseWebhookWithID(id));
-  }
-
-  update(domain: string, id: string, url: string): Promise<Webhook> {
-    return this.request.putWithFD(urljoin('/v3/domains', domain, 'webhooks', id), { url })
-      .then(this._parseWebhookWithID(id));
-  }
-
-  destroy(domain: string, id: string) : Promise<Webhook> {
-    return this.request.delete(urljoin('/v3/domains', domain, 'webhooks', id))
-      .then(this._parseWebhookWithID(id));
-  }
-}

package/test/client.test.ts

@@ -1,96 +0,0 @@
-import formData from 'form-data';
-
-import { expect } from 'chai';
-
-import Client from '../lib/client';
-import Request from '../lib/request';
-import DomainsClient from '../lib/domains';
-import EventsClient from '../lib/events';
-import WebhooksClient from '../lib/webhooks';
-import SuppressionsClient from '../lib/suppressions';
-import MessagesClient from '../lib/messages';
-import RoutesClient from '../lib/routes';
-import ValidateClient from '../lib/validate';
-
-import { InputFormData } from '../lib/interfaces/IFormData';
-import StatsClient from '../lib/stats';
-import ListsClient from '../lib/lists';
-import IpPoolsClient from '../lib/ip-pools';
-import IpsClient from '../lib/ips';
-
-describe('Client', function () {
-  let client: any;
-
-  beforeEach(function () {
-    client = new Client({
-      username: 'username',
-      key: 'key',
-      public_key: 'key',
-      timeout: 10000
-    }, formData as InputFormData);
-  });
-
-  it('raises error when username is not provided', function () {
-    expect(
-      function () {
-        return new Client({ key: 'key' } as any, formData as InputFormData);
-      }
-    ).to.throw('Parameter "username" is required');
-  });
-
-  it('raises error when key is not provided', function () {
-    expect(
-      function () {
-        return new Client({ username: 'username' } as any, formData as InputFormData);
-      }
-    ).to.throw('Parameter "key" is required');
-  });
-
-  it('exposes raw request client', function () {
-    client.request.should.be.instanceOf(Request);
-  });
-
-  it('creates domain client', function () {
-    client.domains.should.be.instanceOf(DomainsClient);
-  });
-
-  it('creates event client', function () {
-    client.events.should.be.instanceOf(EventsClient);
-  });
-
-  it('creates webhook client', function () {
-    client.webhooks.should.be.instanceOf(WebhooksClient);
-  });
-
-  it('creates suppressions client', function () {
-    client.suppressions.should.be.instanceOf(SuppressionsClient);
-  });
-
-  it('creates stats client', function () {
-    client.stats.should.be.instanceOf(StatsClient);
-  });
-
-  it('creates messages client', function () {
-    client.messages.should.be.instanceOf(MessagesClient);
-  });
-
-  it('creates routes client', function () {
-    client.routes.should.be.instanceOf(RoutesClient);
-  });
-
-  it('creates ips client', function () {
-    client.ips.should.be.instanceOf(IpsClient);
-  });
-
-  it('creates ip_pools client', function () {
-    client.ip_pools.should.be.instanceOf(IpPoolsClient);
-  });
-
-  it('creates lists client', function () {
-    client.lists.should.be.instanceOf(ListsClient);
-  });
-
-  it('creates address validate client', function () {
-    client.validate.should.be.instanceOf(ValidateClient);
-  });
-});

package/test/data/emailsValidation1.csv

@@ -1,3 +0,0 @@
-email
-1testEmailAdressForCheck@test.com
-2testEmailAdressForCheck@test.com