mailgun.js 5.2.2 → 7.0.0

package/CHANGELOG.md

@@ -2,6 +2,63 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [7.0.0](https://github.com/mailgun/mailgun.js/compare/v6.0.1...v7.0.0) (2022-05-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* Replaced ky with axios
+
+### Features
+
+* Fix tests. Improve error handling ([063e3ee](https://github.com/mailgun/mailgun.js/commits/063e3eedcd7d55b59bd32e521aa053be0a8d3101))
+
+
+### Bug Fixes
+
+* Correct handling of options body. Add header for form-data ([e2e210d](https://github.com/mailgun/mailgun.js/commits/e2e210d919ca1a68d76ed4c4aa93cc1178f6ebba))
+* Corrected test to check body and not improper status code ([d11cd39](https://github.com/mailgun/mailgun.js/commits/d11cd39a1316c34bac0bc437bb43d4f8797cd3bd))
+* Refactored ky usage with axios ([df4da91](https://github.com/mailgun/mailgun.js/commits/df4da916f10a0653d1a7e3ed8243f02bd3b824e1))
+* Removed console.log ([b4e21c7](https://github.com/mailgun/mailgun.js/commits/b4e21c74b218f92a8292237aa8fe8b2af91b4b81))
+
+
+### Other changes
+
+* Update docs and readme ([1ccaeac](https://github.com/mailgun/mailgun.js/commits/1ccaeaca4ed954985b2ee9a0c0e7666c2f8f6b0f))
+
+
+### Breaking changes
+
+* Replaced ky with axios ([142bb7a](https://github.com/mailgun/mailgun.js/commits/142bb7ada1671c31a636d89efd7ffc62afaf3671))
+
+### [6.0.1](https://github.com/mailgun/mailgun.js/compare/v6.0.0...v6.0.1) (2022-05-10)
+
+
+### Bug Fixes
+
+* Remove file property handling as a file ([d1a8a14](https://github.com/mailgun/mailgun.js/commits/d1a8a14eb5b12ca38772f9414e068fd49a011bad))
+
+
+### Other changes
+
+* Update tests ([52e443c](https://github.com/mailgun/mailgun.js/commits/52e443c20bd57c36e1b50aa1b8d930e160370ab6))
+
+## [6.0.0](https://github.com/mailgun/mailgun.js/compare/v5.2.2...v6.0.0) (2022-05-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* Update ip-pools client responses body shapes. Refactor of request.ts file
+
+### Breaking changes
+
+* Update ip-pools client responses body shapes. Refactor of request.ts file ([0595d62](https://github.com/mailgun/mailgun.js/commits/0595d62eeba66caa98b19b048425385db982d2f0))
+
+
+### Other changes
+
+* Add tests ([8590989](https://github.com/mailgun/mailgun.js/commits/859098970b21b84a1085cb8cf967db769f28ed0f))
+
 ### [5.2.2](https://github.com/mailgun/mailgun.js/compare/v5.2.1...v5.2.2) (2022-04-22)
 
 

package/README.md

@@ -175,7 +175,7 @@ v:my-var          | v: prefix followed by an arbitrary name allows to attach a c
       from: "Excited User <mailgun@sandbox-123.mailgun.org>",
       to: ["test@example.com"],
       subject: "Hello",
-      text: "<mime encoded string here>"
+      message: "<mime encoded string here>"
     })
     .then(msg => console.log(msg)) // logs response data
     .catch(err => console.log(err)); // logs any error
@@ -1446,6 +1446,7 @@ Response shape:
   "id": "name_of_the_list",
   "quantity": 40,
   "records_processed": 40,
+  "responseStatusCode": 200,
   "status": "uploaded",
   "summary": {
     "result": {
@@ -1875,5 +1876,5 @@ git pull
 
 Next, run ```npm run release```.
 
-After that, run ```npm login``` and ```npm publish``` to publish changes on npm.
+After that, `cd ./dist` and then run ```npm login``` and ```npm publish``` to publish changes on npm.
 

package/formDataBuilder.d.ts

@@ -0,0 +1,14 @@
+import * as NodeFormData from 'form-data';
+import { InputFormData } from './interfaces/IFormData';
+declare class FormDataBuilder {
+    private FormDataConstructor;
+    constructor(FormDataConstructor: InputFormData);
+    createFormData(data: any): NodeFormData | FormData;
+    private isNodeFormData;
+    private getAttachmentOptions;
+    private addMimeDataToFD;
+    private addFilesToFD;
+    private isStream;
+    private addCommonPropertyToFD;
+}
+export default FormDataBuilder;

package/interfaces/DomainCredentials.d.ts

@@ -1,11 +1,11 @@
-export interface DomainCredentialsQuery {
+export declare type DomainCredentialsQuery = {
     limit: number;
     skip: number;
-}
-export interface DomainCredentials {
+};
+export declare type DomainCredentials = {
     login: string;
     password: string;
-}
+};
 export interface DomainCredentialsItem {
     created_at: string;
     login: string;
@@ -41,9 +41,9 @@ export interface DeletedDomainCredentialsResponse {
         spec: string;
     };
 }
-export interface UpdateDomainCredentialsData {
+export declare type UpdateDomainCredentialsData = {
     password: string;
-}
+};
 export interface IDomainCredentials {
     list(domain: string, query: DomainCredentialsQuery): Promise<DomainCredentialsList>;
     create(domain: string, data: DomainCredentials): Promise<DomainCredentialsResult>;

package/interfaces/DomainTags.d.ts

@@ -4,16 +4,16 @@ export declare enum Resolution {
     DAY = "day",
     MONTH = "month"
 }
-export interface DomainTagsQuery {
+export declare type DomainTagsQuery = {
     limit: number;
-}
-export interface DomainTagsStatisticQuery {
+};
+export declare type DomainTagsStatisticQuery = {
     event: string;
     start?: number;
     end?: number;
     resolution?: Resolution;
     duration?: string;
-}
+};
 export interface DomainTagsItemInfo {
     tag: string;
     description: string;

package/interfaces/DomainTemplates.d.ts

@@ -9,37 +9,37 @@ export declare enum Pages {
     NEXT = "next",
     PREV = "prev"
 }
-export interface DomainTemplateData {
+export declare type DomainTemplateData = {
     name: string;
     description: string;
     template: string;
     tag?: string;
     engine?: string;
     comment?: string;
-}
-export interface DomainTemplateVersionData {
+};
+export declare type DomainTemplateVersionData = {
     template: string;
     tag: string;
     engine?: string;
     comment?: string;
     active?: YesNo;
-}
-export interface DomainTemplateUpdateData {
+};
+export declare type DomainTemplateUpdateData = {
     description: string;
-}
-export interface DomainTemplateUpdateVersionData {
+};
+export declare type DomainTemplateUpdateVersionData = {
     template?: string;
     comment?: string;
     active?: YesNo;
-}
-export interface DomainTemplatesQuery {
+};
+export declare type DomainTemplatesQuery = {
     page: Pages;
     limit: number;
     p: string;
-}
-export interface TemplateQuery {
+};
+export declare type TemplateQuery = {
     active: YesNo;
-}
+};
 export interface ShortTemplateVersion {
     tag: string;
     engine: string;

package/interfaces/DomainTracking.d.ts

@@ -35,14 +35,14 @@ export interface UpdateDomainTrackingResponse {
     status: number;
     body: UpdatedOpenTracking;
 }
-export interface OpenTrackingInfo {
+export declare type OpenTrackingInfo = {
     active: 'yes' | 'no' | 'true' | 'false';
-}
-export interface ClickTrackingInfo {
+};
+export declare type ClickTrackingInfo = {
     active: 'yes' | 'no' | 'true' | 'false' | 'htmlonly';
-}
-export interface UnsubscribeTrackingInfo {
+};
+export declare type UnsubscribeTrackingInfo = {
     active: 'yes' | 'no' | 'true' | 'false';
     html_footer: string;
     text_footer: string;
-}
+};

package/interfaces/Domains.d.ts

@@ -1,9 +1,9 @@
-export interface DomainsQuery {
+export declare type DomainsQuery = {
     authority?: string;
     state?: 'active' | 'unverified' | 'disabled';
     limit?: number;
     skip?: number;
-}
+};
 export interface DomainInfo {
     name: string;
     smtp_password: string;
@@ -44,7 +44,7 @@ export interface DNSRecord {
     valid: string;
     value: string;
 }
-export interface DomainResponseData {
+export declare type DomainResponseData = {
     status: number;
     body: {
         domain: DomainData;
@@ -52,7 +52,7 @@ export interface DomainResponseData {
         receiving_dns_records: DNSRecord[];
         sending_dns_records: DNSRecord[];
     };
-}
+};
 export interface DomainListResponseData {
     status: number;
     body: {
@@ -67,10 +67,10 @@ export interface DestroyedDomainResponse {
     status: number;
     body: MessageResponse;
 }
-export interface ConnectionSettings {
+export declare type ConnectionSettings = {
     require_tls: boolean;
     skip_verification: boolean;
-}
+};
 export interface ConnectionSettingsResponse {
     body: {
         connection: ConnectionSettings;

package/interfaces/IpPools.d.ts

@@ -10,10 +10,46 @@ export interface IpPoolListResponse {
         ip_pools: IpPool;
         message: string;
     };
+    status: number;
 }
-export interface IpPoolUpdateData {
+export interface IpPoolListResult {
+    ip_pools: IpPool;
+    message: string;
+    status: number;
+}
+export declare type IpPoolUpdateData = {
     name: string;
     description: string;
-    add_ip: string;
-    remove_ip: string;
-}
+    ips: string[];
+};
+export declare type IpPoolMessageResponse = {
+    body: {
+        message: string;
+    };
+    status: number;
+};
+export declare type IpPoolMessageResult = {
+    message: string;
+    status: number;
+};
+export declare type IpPoolDeleteData = {
+    ip?: string;
+    pool_id?: string;
+};
+export declare type IpPoolCreateData = {
+    name: string;
+    description?: string;
+    ips?: string[];
+};
+export declare type IpPoolCreateResponse = {
+    body: {
+        message: string;
+        pool_id: string;
+    };
+    status: number;
+};
+export declare type IpPoolCreateResult = {
+    status: number;
+    message: string;
+    pool_id: string;
+};

package/interfaces/MultipleValidation.d.ts

@@ -8,6 +8,7 @@ export interface MultipleValidationJob {
     quantity: number;
     records_processed: number;
     status: string;
+    responseStatusCode: number;
     summary: {
         result: {
             catch_all: number;
@@ -28,6 +29,14 @@ export interface CreatedMultipleValidationJob {
     id: string;
     message: string;
 }
+export interface MultipleValidationCreationData {
+    file: Record<string, unknown>;
+    [key: string]: unknown | undefined;
+}
+export interface MultipleValidationCreationDataUpdated {
+    multipleValidationFile: Record<string, unknown>;
+    [key: string]: unknown | undefined;
+}
 export interface PagesList {
     prev: string;
     first: string;
@@ -38,13 +47,14 @@ export interface MultipleValidationJobsListResult {
     jobs: MultipleValidationJob[];
     paging: PagesList;
     total: number;
+    status: number;
 }
 export interface MultipleValidationJobsListResponse {
     status: 200;
     body: MultipleValidationJobsListResult;
 }
 export interface CanceledMultipleValidationJob {
-    body: string;
+    message: string;
     status: number;
 }
 export interface IMultipleValidationClient {

package/interfaces/RequestOptions.d.ts

@@ -1,6 +1,15 @@
+import { AxiosRequestHeaders } from 'axios';
 import Options from './Options';
-interface RequestOptions extends Options {
-    headers: any;
+export interface OnCallEmptyHeaders {
+    [key: string]: undefined;
+}
+export interface RequestOptions extends Options {
+    headers: AxiosRequestHeaders;
     timeout: number;
 }
-export default RequestOptions;
+export interface OnCallRequestOptions {
+    timeout?: number;
+    headers?: AxiosRequestHeaders;
+    query?: any;
+    [key: string]: unknown | undefined;
+}

package/interfaces/Supressions.d.ts

@@ -51,9 +51,9 @@ export declare enum SuppressionModels {
 export interface PagesListAccumulator {
     [index: string]: ParsedPage;
 }
-export interface SuppressionListQuery {
+export declare type SuppressionListQuery = {
     limit?: number;
-}
+};
 export interface SuppressionListResponse {
     body: {
         items: BounceData[] | ComplaintData[] | UnsubscribeData[] | WhiteListData[];
@@ -79,14 +79,14 @@ export interface SuppressionDestroyResult {
     address: string;
     status: number;
 }
-export interface SuppressionCreationData {
+export declare type SuppressionCreationData = {
     address: string;
     code?: number;
     error?: string;
     domain?: string;
     tag?: string;
     created_at?: string;
-}
+};
 export interface SuppressionCreationResponse {
     body: {
         message: string;

package/interfaces/Validate.d.ts

@@ -1,3 +1,6 @@
+export declare type ValidationQuery = {
+    address: string;
+};
 export interface ValidationResult {
     address: string;
     is_disposable_address: boolean;

package/interfaces/Webhooks.d.ts

@@ -15,10 +15,10 @@ export interface WebhookList {
         urls: string[];
     };
 }
-export interface WebhooksQuery {
+export declare type WebhooksQuery = {
     limit?: number;
     skip?: number;
-}
+};
 export interface ValidationResponse {
     code: number;
     message: string;

package/interfaces/lists.d.ts

@@ -1,15 +1,15 @@
-export interface ListsQuery {
+export declare type ListsQuery = {
     address?: string;
     limit?: number;
     skip?: number;
-}
-export interface CreateUpdateList {
+};
+export declare type CreateUpdateList = {
     address: string;
     name?: string;
     description?: string;
     access_level?: 'readonly' | 'members' | 'everyone';
     reply_preference?: 'list' | 'sender';
-}
+};
 export interface DestroyedList {
     address: string;
     message: string;

package/interfaces/mailListMembers.d.ts

@@ -5,18 +5,18 @@ export interface MailListMember {
     subscribed: boolean;
     vars: string | any;
 }
-export interface MailListMembersQuery {
+export declare type MailListMembersQuery = {
     subscribed?: 'yes' | 'no';
     limit?: number;
-}
-export interface MultipleMembersData {
+};
+export declare type MultipleMembersData = {
     members: Array<MailListMember>;
     upsert: 'yes' | 'no';
-}
-export interface MultipleMembersReqData {
+};
+export declare type MultipleMembersReqData = {
     members: string;
     upsert: 'yes' | 'no';
-}
+};
 export interface CreateUpdateMailListMembers {
     address: string;
     name?: string;
@@ -24,13 +24,13 @@ export interface CreateUpdateMailListMembers {
     subscribed?: 'yes' | 'no' | boolean;
     upsert?: 'yes' | 'no';
 }
-export interface CreateUpdateMailListMembersReq {
+export declare type CreateUpdateMailListMembersReq = {
     address: string;
     name?: string;
     vars?: string;
     subscribed?: 'yes' | 'no' | boolean;
     upsert?: 'yes' | 'no';
-}
+};
 export interface DeletedMember {
     member: {
         address: string;

package/interfaces/routes.d.ts

@@ -13,13 +13,13 @@ export interface DestroyRouteResponse {
     id: string;
     message: string;
 }
-export interface CreateUpdateRouteData {
+export declare type CreateUpdateRouteData = {
     priority?: number;
     description?: string;
     expression: string;
     action: string[];
-}
-export interface RoutesListQuery {
+};
+export declare type RoutesListQuery = {
     limit?: number;
     skip?: number;
-}
+};

package/ip-pools.d.ts

@@ -1,21 +1,11 @@
 import Request from './request';
-import { IpPool, IpPoolUpdateData } from './interfaces/IpPools';
+import { IpPoolCreateData, IpPoolCreateResult, IpPoolDeleteData, IpPoolListResult, IpPoolMessageResult, 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>;
+    list(): Promise<IpPoolListResult>;
+    create(data: IpPoolCreateData): Promise<IpPoolCreateResult>;
+    update(poolId: string, data: IpPoolUpdateData): Promise<IpPoolMessageResult>;
+    delete(poolId: string, data: IpPoolDeleteData): Promise<IpPoolMessageResult>;
     private parseIpPoolsResponse;
 }

package/ips.d.ts

@@ -3,7 +3,7 @@ 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>;
+    list(query: any): Promise<IpsListResponseBody>;
+    get(ip: string): Promise<IpData>;
     private parseIpsResponse;
 }