mailgun.js 5.0.3 → 5.0.4

package/lib/domainsCredentials.ts

@@ -1,88 +0,0 @@
-import urljoin from 'url-join';
-import APIResponse from './interfaces/ApiResponse';
-import Request from './request';
-
-import {
-  CreatedUpdatedDomainCredentialsResponse,
-  DeletedDomainCredentialsResponse,
-  DomainCredentials,
-  DomainCredentialsList,
-  DomainCredentialsQuery,
-  DomainCredentialsResponseData,
-  DomainCredentialsResult,
-  IDomainCredentials,
-  UpdateDomainCredentialsData
-} from './interfaces/DomainCredentials';
-
-export default class DomainCredentialsClient implements IDomainCredentials {
-  baseRoute: string;
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-    this.baseRoute = '/v3/domains/';
-  }
-
-  private _parseDomainCredentialsList(
-    response: DomainCredentialsResponseData
-  ): DomainCredentialsList {
-    return {
-      items: response.body.items,
-      totalCount: response.body.total_count
-    };
-  }
-
-  private _parseMessageResponse(
-    response: CreatedUpdatedDomainCredentialsResponse
-  ): DomainCredentialsResult {
-    const result = {
-      status: response.status,
-      message: response.body.message
-    } as DomainCredentialsResult;
-    return result;
-  }
-
-  private _parseDeletedResponse(
-    response:DeletedDomainCredentialsResponse
-  ): DomainCredentialsResult {
-    const result = {
-      status: response.status,
-      message: response.body.message,
-      spec: response.body.spec
-    } as DomainCredentialsResult;
-
-    return result;
-  }
-
-  list(domain: string, query?: DomainCredentialsQuery): Promise<DomainCredentialsList> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/credentials'), query)
-      .then(
-        (res: APIResponse) => this._parseDomainCredentialsList(res as DomainCredentialsResponseData)
-      );
-  }
-
-  create(
-    domain: string,
-    data: DomainCredentials
-  ): Promise<DomainCredentialsResult> {
-    return this.request.postWithFD(`${this.baseRoute}${domain}/credentials`, data)
-      .then((res: APIResponse) => this._parseMessageResponse(res));
-  }
-
-  update(
-    domain: string,
-    credentialsLogin: string,
-    data: UpdateDomainCredentialsData
-  ): Promise<DomainCredentialsResult> {
-    return this.request.putWithFD(`${this.baseRoute}${domain}/credentials/${credentialsLogin}`, data)
-      .then((res: APIResponse) => this._parseMessageResponse(res));
-  }
-
-  destroy(
-    domain: string,
-    credentialsLogin: string
-  ): Promise<DomainCredentialsResult> {
-    return this.request.delete(`${this.baseRoute}${domain}/credentials/${credentialsLogin}`)
-      .then((res: APIResponse) => this._parseDeletedResponse(res));
-  }
-}

package/lib/domainsTags.ts

@@ -1,165 +0,0 @@
-import urljoin from 'url-join';
-import APIResponse from './interfaces/ApiResponse';
-import Request from './request';
-
-import {
-  DomainTagAPIResponseStatsItem,
-  DomainTagCountriesAggregation,
-  DomainTagCountriesAPIResponse,
-  DomainTagDevicesAggregation,
-  DomainTagDevicesAPIResponse,
-  DomainTagProvidersAggregation,
-  DomainTagProvidersAPIResponse,
-  DomainTagsItem,
-  DomainTagsItemInfo,
-  DomainTagsList,
-  DomainTagsMessageRes,
-  DomainTagsQuery,
-  DomainTagsResponseData,
-  DomainTagsStatisticQuery,
-  DomainTagStatAPIResponse,
-  DomainTagStatisticItem,
-  DomainTagStatisticResult,
-  IDomainTagsClient,
-  PagesList,
-  PagesListAccumulator,
-  ParsedPagesList,
-  Resolution
-} from './interfaces/DomainTags';
-
-export class DomainTag implements DomainTagsItem {
-  tag: string;
-  description: string;
-  'first-seen': Date;
-  'last-seen': Date;
-
-  constructor(tagInfo: DomainTagsItemInfo) {
-    this.tag = tagInfo.tag;
-    this.description = tagInfo.description;
-    this['first-seen'] = new Date(tagInfo['first-seen']);
-    this['last-seen'] = new Date(tagInfo['last-seen']);
-  }
-}
-
-export class DomainTagStatistic implements DomainTagStatisticResult {
-  tag: string;
-  description: string;
-  start: Date;
-  end: Date;
-  resolution: Resolution;
-  stats: DomainTagStatisticItem[];
-
-  constructor(tagStatisticInfo: DomainTagStatAPIResponse) {
-    this.tag = tagStatisticInfo.body.tag;
-    this.description = tagStatisticInfo.body.description;
-    this.start = new Date(tagStatisticInfo.body.start);
-    this.end = new Date(tagStatisticInfo.body.end);
-    this.resolution = tagStatisticInfo.body.resolution;
-    this.stats = tagStatisticInfo.body.stats.map(function (stat: DomainTagAPIResponseStatsItem) {
-      const res = { ...stat, time: new Date(stat.time) };
-      return res;
-    });
-  }
-}
-
-export default class DomainTagsClient implements IDomainTagsClient {
-  baseRoute: string;
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-    this.baseRoute = '/v3/';
-  }
-
-  private _parsePageLinks(response: DomainTagsResponseData): ParsedPagesList {
-    const pages = Object.entries(response.body.paging as PagesList);
-    return pages.reduce(
-      (acc: PagesListAccumulator, entrie: [url: string, id: string]) => {
-        const id = entrie[0];
-        const url = entrie[1];
-        acc[id] = {
-          id,
-          url
-        };
-        return acc;
-      }, {}
-    ) as unknown as ParsedPagesList;
-  }
-
-  private _parseDomainTagsList(
-    response: DomainTagsResponseData
-  ): DomainTagsList {
-    return {
-      items: response.body.items.map((tagInfo) => new DomainTag(tagInfo)),
-      pages: this._parsePageLinks(response)
-    };
-  }
-
-  private _parseTagStatistic(
-    response: DomainTagStatAPIResponse
-  ): DomainTagStatistic {
-    return new DomainTagStatistic(response);
-  }
-
-  list(domain: string, query?: DomainTagsQuery): Promise<DomainTagsList> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/tags'), query)
-      .then(
-        (res: APIResponse) => this._parseDomainTagsList(res as DomainTagsResponseData)
-      );
-  }
-
-  get(domain: string, tag: string): Promise<DomainTagsItem> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/tags', tag))
-      .then(
-        (res: APIResponse) => new DomainTag(res.body)
-      );
-  }
-
-  update(domain: string, tag: string, description: string): Promise<DomainTagsMessageRes> {
-    return this.request.put(urljoin(this.baseRoute, domain, '/tags', tag), description)
-      .then(
-        (res: APIResponse) => res.body as DomainTagsMessageRes
-      );
-  }
-
-  destroy(
-    domain: string,
-    tag: string
-  ): Promise<DomainTagsMessageRes> {
-    return this.request.delete(`${this.baseRoute}${domain}/tags/${tag}`)
-      .then((res: APIResponse) => (
-        {
-          message: res.body.message,
-          status: res.status
-        } as DomainTagsMessageRes));
-  }
-
-  statistic(domain: string, tag: string, query: DomainTagsStatisticQuery)
-    : Promise<DomainTagStatistic> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/tags', tag, 'stats'), query)
-      .then(
-        (res: APIResponse) => this._parseTagStatistic(res)
-      );
-  }
-
-  countries(domain: string, tag: string): Promise<DomainTagCountriesAggregation> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/tags', tag, 'stats/aggregates/countries'))
-      .then(
-        (res: DomainTagCountriesAPIResponse) => res.body as DomainTagCountriesAggregation
-      );
-  }
-
-  providers(domain: string, tag: string): Promise<DomainTagProvidersAggregation> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/tags', tag, 'stats/aggregates/providers'))
-      .then(
-        (res: DomainTagProvidersAPIResponse) => res.body as DomainTagProvidersAggregation
-      );
-  }
-
-  devices(domain: string, tag: string): Promise<DomainTagDevicesAggregation> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/tags', tag, 'stats/aggregates/devices'))
-      .then(
-        (res: DomainTagDevicesAPIResponse) => res.body as DomainTagDevicesAggregation
-      );
-  }
-}

package/lib/domainsTemplates.ts

@@ -1,235 +0,0 @@
-import urljoin from 'url-join';
-import APIResponse from './interfaces/ApiResponse';
-import Request from './request';
-
-import {
-  CreateDomainTemplateAPIResponse,
-  CreateDomainTemplateVersionAPIResponse,
-  CreateDomainTemplateVersionResult,
-  DomainTemplate, DomainTemplateData,
-  DomainTemplatesQuery,
-  DomainTemplateUpdateData,
-  DomainTemplateUpdateVersionData,
-  DomainTemplateVersionData,
-  GetDomainTemplateAPIResponse,
-  IDomainTemplatesClient,
-  ListDomainTemplatesAPIResponse,
-  ListDomainTemplatesResult,
-  ListDomainTemplateVersionsAPIResponse,
-  ListDomainTemplateVersionsResult,
-  MutateDomainTemplateVersionAPIResponse,
-  MutateDomainTemplateVersionResult,
-  NotificationAPIResponse,
-  NotificationResult,
-  ShortTemplateVersion,
-  TemplateQuery,
-  TemplateVersion,
-  UpdateOrDeleteDomainTemplateAPIResponse,
-  UpdateOrDeleteDomainTemplateResult
-} from './interfaces/DomainTemplates';
-
-export class DomainTemplateItem implements DomainTemplate {
-  name : string;
-  description : string;
-  createdAt : Date | '';
-  createdBy : string;
-  id : string;
-  version?: TemplateVersion;
-  versions?: ShortTemplateVersion[];
-
-  constructor(domainTemplateFromAPI: DomainTemplate) {
-    this.name = domainTemplateFromAPI.name;
-    this.description = domainTemplateFromAPI.description;
-    this.createdAt = domainTemplateFromAPI.createdAt ? new Date(domainTemplateFromAPI.createdAt) : '';
-    this.createdBy = domainTemplateFromAPI.createdBy;
-    this.id = domainTemplateFromAPI.id;
-
-    if (domainTemplateFromAPI.version) {
-      this.version = domainTemplateFromAPI.version;
-      if (domainTemplateFromAPI.version.createdAt) {
-        this.version.createdAt = new Date(domainTemplateFromAPI.version.createdAt);
-      }
-    }
-
-    if (domainTemplateFromAPI.versions && domainTemplateFromAPI.versions.length) {
-      this.versions = domainTemplateFromAPI.versions.map((version) => {
-        const result = { ...version };
-        result.createdAt = new Date(version.createdAt);
-        return result;
-      });
-    }
-  }
-}
-
-export default class DomainTemplatesClient implements IDomainTemplatesClient {
-  baseRoute: string;
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-    this.baseRoute = '/v3/';
-  }
-
-  private parseCreationResponse(data: CreateDomainTemplateAPIResponse): DomainTemplateItem {
-    return new DomainTemplateItem(data.body.template);
-  }
-
-  private parseCreationVersionResponse(
-    data: CreateDomainTemplateVersionAPIResponse
-  ): CreateDomainTemplateVersionResult {
-    const result: CreateDomainTemplateVersionResult = {} as CreateDomainTemplateVersionResult;
-    result.status = data.status;
-    result.message = data.body.message;
-    if (data.body && data.body.template) {
-      result.template = new DomainTemplateItem(data.body.template);
-    }
-    return result;
-  }
-
-  private parseMutationResponse(
-    data: UpdateOrDeleteDomainTemplateAPIResponse
-  ): UpdateOrDeleteDomainTemplateResult {
-    const result: UpdateOrDeleteDomainTemplateResult = {} as UpdateOrDeleteDomainTemplateResult;
-    result.status = data.status;
-    result.message = data.body.message;
-    if (data.body && data.body.template) {
-      result.templateName = data.body.template.name;
-    }
-    return result;
-  }
-
-  private parseNotificationResponse(data: NotificationAPIResponse): NotificationResult {
-    const result: NotificationResult = {} as NotificationResult;
-    result.status = data.status;
-    result.message = data.body.message;
-    return result;
-  }
-
-  private parseMutateTemplateVersionResponse(
-    data: MutateDomainTemplateVersionAPIResponse
-  ): MutateDomainTemplateVersionResult {
-    const result: MutateDomainTemplateVersionResult = {} as MutateDomainTemplateVersionResult;
-    result.status = data.status;
-    result.message = data.body.message;
-    if (data.body.template) {
-      result.templateName = data.body.template.name;
-      result.templateVersion = { tag: data.body.template.version.tag };
-    }
-    return result;
-  }
-
-  private parseList(response: ListDomainTemplatesAPIResponse): ListDomainTemplatesResult {
-    const data = {} as ListDomainTemplatesResult;
-
-    data.items = response.body.items.map((d: DomainTemplate) => new DomainTemplateItem(d));
-
-    data.pages = response.body.paging;
-
-    return data;
-  }
-
-  private parseListTemplateVersions(
-    response: ListDomainTemplateVersionsAPIResponse
-  ): ListDomainTemplateVersionsResult {
-    const data = {} as ListDomainTemplateVersionsResult;
-
-    data.template = new DomainTemplateItem(response.body.template);
-
-    data.pages = response.body.paging;
-
-    return data;
-  }
-
-  list(domain: string, query?: DomainTemplatesQuery): Promise<ListDomainTemplatesResult> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/templates'), query)
-      .then(
-        (res: APIResponse) => this.parseList(res)
-      );
-  }
-
-  get(domain: string, templateName: string, query?: TemplateQuery): Promise<DomainTemplateItem> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/templates/', templateName), query)
-      .then(
-        (res: GetDomainTemplateAPIResponse) => new DomainTemplateItem(res.body.template)
-      );
-  }
-
-  create(
-    domain: string,
-    data: DomainTemplateData
-  ): Promise<DomainTemplateItem> {
-    return this.request.postWithFD(urljoin(this.baseRoute, domain, '/templates'), data)
-      .then((res: CreateDomainTemplateAPIResponse) => this.parseCreationResponse(res));
-  }
-
-  update(
-    domain: string,
-    templateName: string,
-    data: DomainTemplateUpdateData
-  ): Promise<UpdateOrDeleteDomainTemplateResult> {
-    return this.request.putWithFD(urljoin(this.baseRoute, domain, '/templates/', templateName), data)
-      .then((res: UpdateOrDeleteDomainTemplateAPIResponse) => this.parseMutationResponse(res));
-  }
-
-  destroy(domain: string, templateName: string): Promise<UpdateOrDeleteDomainTemplateResult> {
-    return this.request.delete(urljoin(this.baseRoute, domain, '/templates/', templateName))
-      .then((res: UpdateOrDeleteDomainTemplateAPIResponse) => this.parseMutationResponse(res));
-  }
-
-  destroyAll(domain: string): Promise<NotificationResult> {
-    return this.request.delete(urljoin(this.baseRoute, domain, '/templates'))
-      .then((res: NotificationAPIResponse) => this.parseNotificationResponse(res));
-  }
-
-  createVersion(
-    domain: string,
-    templateName: string,
-    data: DomainTemplateVersionData
-  ): Promise<CreateDomainTemplateVersionResult> {
-    return this.request.postWithFD(urljoin(this.baseRoute, domain, '/templates/', templateName, '/versions'), data)
-      .then(
-        (res: CreateDomainTemplateVersionAPIResponse) => this.parseCreationVersionResponse(res)
-      );
-  }
-
-  getVersion(domain: string, templateName: string, tag: string): Promise<DomainTemplateItem> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/templates/', templateName, '/versions/', tag))
-      .then(
-        (res: GetDomainTemplateAPIResponse) => new DomainTemplateItem(res.body.template)
-      );
-  }
-
-  updateVersion(
-    domain: string,
-    templateName: string,
-    tag: string,
-    data: DomainTemplateUpdateVersionData
-  ): Promise<MutateDomainTemplateVersionResult> {
-    return this.request.putWithFD(urljoin(this.baseRoute, domain, '/templates/', templateName, '/versions/', tag), data)
-      .then(
-        // eslint-disable-next-line max-len
-        (res: MutateDomainTemplateVersionAPIResponse) => this.parseMutateTemplateVersionResponse(res)
-      );
-  }
-
-  destroyVersion(
-    domain: string,
-    templateName: string,
-    tag: string
-  ): Promise<MutateDomainTemplateVersionResult> {
-    return this.request.delete(urljoin(this.baseRoute, domain, '/templates/', templateName, '/versions/', tag))
-      // eslint-disable-next-line max-len
-      .then((res: MutateDomainTemplateVersionAPIResponse) => this.parseMutateTemplateVersionResponse(res));
-  }
-
-  listVersions(
-    domain: string,
-    templateName: string,
-    query?: DomainTemplatesQuery
-  ): Promise<ListDomainTemplateVersionsResult> {
-    return this.request.get(urljoin(this.baseRoute, domain, '/templates', templateName, '/versions'), query)
-      .then(
-        (res: ListDomainTemplateVersionsAPIResponse) => this.parseListTemplateVersions(res)
-      );
-  }
-}

package/lib/error.ts

@@ -1,22 +0,0 @@
-import APIErrorOptions from './interfaces/APIErrorOptions';
-
-export default class APIError extends Error {
-  status: number | string;
-  stack: string;
-  details: string;
-
-  constructor({
-    status,
-    statusText,
-    message,
-    body = {}
-  }: APIErrorOptions) {
-    const { message: bodyMessage, error } = body;
-    super();
-
-    this.stack = '';
-    this.status = status;
-    this.message = message || error || statusText;
-    this.details = bodyMessage;
-  }
-}

package/lib/events.ts

@@ -1,54 +0,0 @@
-import urljoin from 'url-join';
-import {
-  EventsList, EventsPage, EventsResponse, PagesList, PagesListAccumulator, ParsedPagesList
-} from './interfaces/Events';
-
-import Request from './request';
-
-export default class EventClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  _parsePageNumber(url: string) : string {
-    return url.split('/').pop() || '';
-  }
-
-  _parsePage(id: string, url: string) : EventsPage {
-    return { id, number: this._parsePageNumber(url), url };
-  }
-
-  _parsePageLinks(response: EventsResponse) : ParsedPagesList {
-    const pages = Object.entries(response.body.paging as PagesList);
-    return pages.reduce(
-      (acc: PagesListAccumulator, pair: [url: string, id: string]) => {
-        const id = pair[0];
-        const url = pair[1];
-        acc[id] = this._parsePage(id, url);
-        return acc;
-      }, {}
-    ) as unknown as ParsedPagesList;
-  }
-
-  _parseEventList(response: EventsResponse) : EventsList {
-    return {
-      items: response.body.items,
-      pages: this._parsePageLinks(response)
-    };
-  }
-
-  get(domain: string, query?: { page: string }) : Promise<EventsList> {
-    let url;
-    const queryCopy = { ...query };
-    if (queryCopy && queryCopy.page) {
-      url = urljoin('/v3', domain, 'events', queryCopy.page);
-      delete queryCopy.page;
-    } else {
-      url = urljoin('/v3', domain, 'events');
-    }
-    return this.request.get(url, queryCopy)
-      .then((response: EventsResponse) => this._parseEventList(response));
-  }
-}

package/lib/index.ts

@@ -1,16 +0,0 @@
-import Client from './client';
-import { InputFormData } from './interfaces/IFormData';
-import Options from './interfaces/Options';
-
-export default class Mailgun {
-  static get default(): typeof Mailgun { return this; }
-  private formData: InputFormData
-
-  constructor(FormData: InputFormData) {
-    this.formData = FormData;
-  }
-
-  client(options: Options) : Client {
-    return new Client(options, this.formData);
-  }
-}

package/lib/interfaces/APIErrorOptions.ts

@@ -1,10 +0,0 @@
-interface APIErrorOptions {
-  headers: { [key: string]: any };
-  status: number | string;
-  message: string;
-  body: any;
-  url: string;
-  statusText: string;
-}
-
-export default APIErrorOptions;

package/lib/interfaces/IpPools.ts

@@ -1,22 +0,0 @@
-/* eslint-disable camelcase */
-export interface IpPool {
-  description: string;
-  ips: string[];
-  is_linked: boolean;
-  name: string;
-  pool_id: string;
-}
-
-export interface IpPoolListResponse {
-  body: {
-    ip_pools: IpPool,
-    message: string
-  }
-}
-
-export interface IpPoolUpdateData {
-  name: string,
-  description: string,
-  add_ip: string,
-  remove_ip: string
-}

package/lib/interfaces/Ips.ts

@@ -1,12 +0,0 @@
-/* eslint-disable camelcase */
-export interface IpsListResponseBody {
-  assignable_to_pools: boolean;
-  items: string[];
-  total_count: number;
-}
-
-export interface IpData {
-  ip: string;
-  dedicated: boolean;
-  rdns: string;
-}

package/lib/interfaces/Options.ts

@@ -1,10 +0,0 @@
-/* eslint-disable camelcase */
- interface Options {
-  username: string;
-  key: string;
-  url?: string;
-  public_key?: string;
-  timeout?: number;
-}
-
-export default Options;

package/lib/interfaces/StatsOptions.ts

@@ -1,25 +0,0 @@
-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 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;
-}