mailgun.js 10.2.3 → 10.3.0

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 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.
 
+## [10.3.0](https://github.com/mailgun/mailgun.js/compare/v10.2.4...v10.3.0) (2024-12-23)
+
+
+### Features
+
+* Add support for Inbox Placements ([5450a4b](https://github.com/mailgun/mailgun.js/commits/5450a4b37c5876d2668e2b7a5a1e1c0941afde68))
+
+### [10.2.4](https://github.com/mailgun/mailgun.js/compare/v10.2.3...v10.2.4) (2024-11-21)
+
+
+### Bug Fixes
+
+* **deps-dev:** bump webpack from 5.76.0 to 5.94.0 ([166f27c](https://github.com/mailgun/mailgun.js/commits/166f27ca06d7728143aad98051c6d9009900a51c))
+* **deps:** bump axios from 1.7.2 to 1.7.4 ([22ae183](https://github.com/mailgun/mailgun.js/commits/22ae18375e64a1ea9b4f1657dd91363110360c1a))
+* Fix vulnarable dependency ([039866b](https://github.com/mailgun/mailgun.js/commits/039866bc050f52145ca2da14bebe536aed067b20))
+
+
+### Other changes
+
+* Add tests coverage thresholds ([bfca371](https://github.com/mailgun/mailgun.js/commits/bfca3710da7492cfb0430d1da8370af55fbaa226))
+
 ### [10.2.3](https://github.com/mailgun/mailgun.js/compare/v10.2.2...v10.2.3) (2024-07-18)
 
 ### [10.2.2](https://github.com/mailgun/mailgun.js/compare/v10.2.1...v10.2.2) (2024-07-17)

package/Classes/InboxPlacements/AttributesClient.d.ts

@@ -0,0 +1,10 @@
+import { IInboxPlacementsAttributesClient } from '../../Interfaces';
+import { InboxPlacementsAttributesResult, InboxPlacementsValuesResult } from '../../Types/InboxPlacements';
+import Request from '../common/Request';
+export default class InboxPlacementsAttributesClient implements IInboxPlacementsAttributesClient {
+    request: Request;
+    path: string;
+    constructor(request: Request, path: string);
+    list(): Promise<InboxPlacementsAttributesResult>;
+    get(attributeName: string): Promise<InboxPlacementsValuesResult>;
+}

package/Classes/InboxPlacements/FiltersClient.d.ts

@@ -0,0 +1,9 @@
+import { InboxPlacementsFiltersResult } from '../../Types/InboxPlacements';
+import Request from '../common/Request';
+import { IInboxPlacementsFiltersClient } from '../../Interfaces';
+export default class InboxPlacementsFiltersClient implements IInboxPlacementsFiltersClient {
+    request: Request;
+    path: string;
+    constructor(request: Request, path: string);
+    list(): Promise<InboxPlacementsFiltersResult>;
+}

package/Classes/InboxPlacements/Results/InboxPlacementsResultsClient.d.ts

@@ -0,0 +1,20 @@
+import { IIPRSharingClient, IInboxPlacementsAttributesClient, IInboxPlacementsFiltersClient, IInboxPlacementsResultsClient, ILogger } from '../../../Interfaces';
+import { InboxPlacementsDestroyResult, InboxPlacementsResultWithStatus, InboxPlacementsResultsList, InboxPlacementsResultsListAPIResponse, InboxPlacementsResultsQuery } from '../../../Types/InboxPlacements';
+import NavigationThruPages from '../../common/NavigationThruPages';
+import Request from '../../common/Request';
+export default class InboxPlacementsResultsClient extends NavigationThruPages<InboxPlacementsResultsList> implements IInboxPlacementsResultsClient {
+    request: Request;
+    attributes: IInboxPlacementsAttributesClient;
+    filters: IInboxPlacementsFiltersClient;
+    sharing: IIPRSharingClient;
+    private logger;
+    constructor(request: Request, attributes: IInboxPlacementsAttributesClient, filters: IInboxPlacementsFiltersClient, sharing: IIPRSharingClient, logger?: ILogger);
+    private convertDateToUTC;
+    private prepareQueryData;
+    private prepareInboxPlacementsResult;
+    protected parseList(response: InboxPlacementsResultsListAPIResponse): InboxPlacementsResultsList;
+    list(query: InboxPlacementsResultsQuery): Promise<InboxPlacementsResultsList>;
+    get(id: string): Promise<InboxPlacementsResultWithStatus>;
+    destroy(id: string): Promise<InboxPlacementsDestroyResult>;
+    getResultByShareId(shareId: string): Promise<InboxPlacementsResultWithStatus>;
+}

package/Classes/InboxPlacements/Results/InboxPlacementsResultsClient.ts

@@ -0,0 +1,18 @@
+import { IInboxPlacementsAttributesClient, IInboxPlacementsFiltersClient, IInboxPlacementsResultsClient, ILogger } from '../../../Interfaces';
+import { InboxPlacementsDestroyResult, InboxPlacementsResultWithStatus, InboxPlacementsResultsList, InboxPlacementsResultsListAPIResponse, InboxPlacementsResultsQuery } from '../../../Types/InboxPlacements';
+import NavigationThruPages from '../../common/NavigationThruPages';
+import Request from '../../common/Request';
+export default class InboxPlacementsResultsClient extends NavigationThruPages<InboxPlacementsResultsList> implements IInboxPlacementsResultsClient {
+    request: Request;
+    attributes: IInboxPlacementsAttributesClient;
+    filters: IInboxPlacementsFiltersClient;
+    private logger;
+    constructor(request: Request, attributes: IInboxPlacementsAttributesClient, filters: IInboxPlacementsFiltersClient, logger?: ILogger);
+    private convertDateToUTC;
+    private prepareQueryData;
+    private prepareInboxPlacementsResult;
+    protected parseList(response: InboxPlacementsResultsListAPIResponse): InboxPlacementsResultsList;
+    list(query: InboxPlacementsResultsQuery): Promise<InboxPlacementsResultsList>;
+    get(id: string): Promise<InboxPlacementsResultWithStatus>;
+    destroy(id: string): Promise<InboxPlacementsDestroyResult>;
+}

package/Classes/InboxPlacements/Results/InboxPlacementsResultsSharing.ts

@@ -0,0 +1,10 @@
+import {
+  IPRSharingResult,
+  IPRSharingUpdateData,
+  IPRSharingUpdateResult
+} from '../../../Types/InboxPlacements';
+
+export interface IIPRSharingClient {
+  get(id: string): Promise<IPRSharingResult>;
+  update(id: string, data: IPRSharingUpdateData): Promise<IPRSharingUpdateResult>;
+}

package/Classes/InboxPlacements/Results/InboxPlacementsResultsSharingClient.d.ts

@@ -0,0 +1,14 @@
+import { IIPRSharingClient } from '../../../Interfaces';
+import { IPRSharingResult, IPRSharingUpdateData, IPRSharingUpdateResult } from '../../../Types/InboxPlacements';
+import Request from '../../common/Request';
+export default class IPRSharingClient implements IIPRSharingClient {
+    request: Request;
+    constructor(request: Request);
+    private prepareInboxPlacementsResultSharing;
+    get(id: string): Promise<IPRSharingResult & {
+        status: number;
+    }>;
+    update(id: string, data: IPRSharingUpdateData): Promise<IPRSharingUpdateResult & {
+        status: number;
+    }>;
+}

package/Classes/InboxPlacements/SeedsLists/AttributesClient.d.ts

@@ -0,0 +1,10 @@
+import { IInboxPlacementsAttributesClient } from '../../../Interfaces';
+import { InboxPlacementsAttributesResult, InboxPlacementsValuesResult } from '../../../Types/InboxPlacements';
+import Request from '../../common/Request';
+export default class InboxPlacementsAttributesClient implements IInboxPlacementsAttributesClient {
+    request: Request;
+    path: string;
+    constructor(request: Request, path: string);
+    list(): Promise<InboxPlacementsAttributesResult>;
+    get(attributeName: string): Promise<InboxPlacementsValuesResult>;
+}

package/Classes/InboxPlacements/SeedsLists/FiltersClient.d.ts

@@ -0,0 +1,8 @@
+import { SeedsListsFiltersResult } from '../../../Types/InboxPlacements';
+import Request from '../../common/Request';
+import { ISeedsListsFiltersClient } from '../../../Interfaces';
+export default class SeedsListsFiltersClient implements ISeedsListsFiltersClient {
+    request: Request;
+    constructor(request: Request);
+    list(): Promise<SeedsListsFiltersResult>;
+}

package/Classes/InboxPlacements/SeedsLists/SeedsListsClient.d.ts

@@ -0,0 +1,21 @@
+import { ILogger, IInboxPlacementsAttributesClient, ISeedsListsClient, IInboxPlacementsFiltersClient } from '../../../Interfaces';
+import { SeedsListsAPIResponse, SeedsListsCreatingData, SeedsListsQuery, SeedsListsResult, SeedsListsDestroyApiResponse, SeedsListsUpdatingData, SeedListResult } from '../../../Types/InboxPlacements';
+import NavigationThruPages from '../../common/NavigationThruPages';
+import Request from '../../common/Request';
+export default class SeedsListsClient extends NavigationThruPages<SeedsListsResult> implements ISeedsListsClient {
+    request: Request;
+    attributes: IInboxPlacementsAttributesClient;
+    filters: IInboxPlacementsFiltersClient;
+    private logger;
+    constructor(request: Request, attributes: IInboxPlacementsAttributesClient, filters: IInboxPlacementsFiltersClient, logger?: ILogger);
+    private convertDateToUTC;
+    private prepareQueryData;
+    private prepareResult;
+    private prepareSeedList;
+    protected parseList(response: SeedsListsAPIResponse): SeedsListsResult;
+    list(query: SeedsListsQuery): Promise<SeedsListsResult>;
+    get(id: string): Promise<SeedListResult>;
+    create(data: SeedsListsCreatingData): Promise<SeedListResult>;
+    update(id: string, data: SeedsListsUpdatingData): Promise<SeedListResult>;
+    destroy(id: string): Promise<SeedsListsDestroyApiResponse>;
+}

package/Classes/InboxPlacements/inboxPlacements.d.ts

@@ -0,0 +1,13 @@
+import { IInboxPlacementsClient, IInboxPlacementsResultsClient } from '../../Interfaces';
+import { ISeedsListsClient } from '../../Interfaces/InboxPlacements/SeedsLists/SeedsListsClient';
+import { IInboxPlacementsProvidersClient } from '../../Interfaces/InboxPlacements/providers/InboxPlacementsProviders';
+import { InboxPlacementsData, InboxPlacementsTestResult } from '../../Types/InboxPlacements';
+import Request from '../common/Request';
+export default class InboxPlacementsClient implements IInboxPlacementsClient {
+    request: Request;
+    seedsLists: ISeedsListsClient;
+    results: IInboxPlacementsResultsClient;
+    providers: IInboxPlacementsProvidersClient;
+    constructor(request: Request, seedsListsClient: ISeedsListsClient, results: IInboxPlacementsResultsClient, providers: IInboxPlacementsProvidersClient);
+    runTest(data: InboxPlacementsData): Promise<InboxPlacementsTestResult>;
+}

package/Classes/InboxPlacements/providers/InboxPlacementsProviders.d.ts

@@ -0,0 +1,10 @@
+import { IInboxPlacementsProvidersClient } from '../../../Interfaces/InboxPlacements/providers/InboxPlacementsProviders';
+import { InboxPlacementsProvidersList } from '../../../Types/InboxPlacements';
+import Request from '../../common/Request';
+export default class InboxPlacementsProvidersClient implements IInboxPlacementsProvidersClient {
+    request: Request;
+    path: string;
+    constructor(request: Request);
+    private parseList;
+    list(): Promise<InboxPlacementsProvidersList>;
+}

package/Classes/MailgunClient.d.ts

@@ -1,5 +1,5 @@
 import { MailgunClientOptions, InputFormData } from '../Types';
-import { IDomainsClient, IWebHooksClient, IMailgunClient, IMailingListsClient, IEventClient, IStatsClient, ISuppressionClient, IMessagesClient, IRoutesClient, IValidationClient, IIPsClient, IIPPoolsClient, ISubaccountsClient } from '../Interfaces';
+import { IDomainsClient, IWebHooksClient, IMailgunClient, IMailingListsClient, IEventClient, IStatsClient, ISuppressionClient, IMessagesClient, IRoutesClient, IValidationClient, IIPsClient, IIPPoolsClient, ISubaccountsClient, IInboxPlacementsClient } from '../Interfaces';
 export default class MailgunClient implements IMailgunClient {
     private request;
     domains: IDomainsClient;
@@ -14,6 +14,7 @@ export default class MailgunClient implements IMailgunClient {
     ip_pools: IIPPoolsClient;
     lists: IMailingListsClient;
     subaccounts: ISubaccountsClient;
+    inboxPlacements: IInboxPlacementsClient;
     constructor(options: MailgunClientOptions, formData: InputFormData);
     setSubaccount(subaccountId: string): void;
     resetSubaccount(): void;

package/Interfaces/InboxPlacements/AttributesClient.d.ts

@@ -0,0 +1,5 @@
+import { InboxPlacementsAttributesResult, InboxPlacementsValuesResult } from '../../Types/InboxPlacements';
+export interface IInboxPlacementsAttributesClient {
+    list(): Promise<InboxPlacementsAttributesResult>;
+    get(attributeName: string): Promise<InboxPlacementsValuesResult>;
+}

package/Interfaces/InboxPlacements/FiltersClient.d.ts

@@ -0,0 +1,4 @@
+import { InboxPlacementsFiltersResult } from '../../Types/InboxPlacements';
+export interface IInboxPlacementsFiltersClient {
+    list(): Promise<InboxPlacementsFiltersResult>;
+}

package/Interfaces/InboxPlacements/InboxPlacementsClient.d.ts

@@ -0,0 +1,10 @@
+import { InboxPlacementsData, InboxPlacementsTestResult } from '../../Types/InboxPlacements';
+import { IInboxPlacementsResultsClient } from './Results/InboxPlacementsResults';
+import { ISeedsListsClient } from './SeedsLists/SeedsListsClient';
+import { IInboxPlacementsProvidersClient } from './providers/InboxPlacementsProviders';
+export interface IInboxPlacementsClient {
+    seedsLists: ISeedsListsClient;
+    results: IInboxPlacementsResultsClient;
+    providers: IInboxPlacementsProvidersClient;
+    runTest(data: InboxPlacementsData): Promise<InboxPlacementsTestResult>;
+}

package/Interfaces/InboxPlacements/Results/InboxPlacementsResults.d.ts

@@ -0,0 +1,13 @@
+import { InboxPlacementsDestroyResult, InboxPlacementsResultWithStatus, InboxPlacementsResultsList, InboxPlacementsResultsQuery } from '../../../Types/InboxPlacements';
+import { IInboxPlacementsAttributesClient } from '../AttributesClient';
+import { IInboxPlacementsFiltersClient } from '../FiltersClient';
+import { IIPRSharingClient } from './InboxPlacementsResultsSharing';
+export interface IInboxPlacementsResultsClient {
+    sharing: IIPRSharingClient;
+    attributes: IInboxPlacementsAttributesClient;
+    filters: IInboxPlacementsFiltersClient;
+    list(query: InboxPlacementsResultsQuery): Promise<InboxPlacementsResultsList>;
+    get(address: string): Promise<InboxPlacementsResultWithStatus>;
+    destroy(id: string): Promise<InboxPlacementsDestroyResult>;
+    getResultByShareId(shareId: string): Promise<InboxPlacementsResultWithStatus>;
+}

package/Interfaces/InboxPlacements/Results/InboxPlacementsResultsClient.d.ts

@@ -0,0 +1,8 @@
+import { InboxPlacementsResultsListResult, InboxPlacementsResultsQuery } from '../../../Types/InboxPlacements';
+import { ISeedsListsAttributesClient } from '../SeedsLists/AttributesClient';
+import { ISeedsListsFiltersClient } from '../SeedsLists/FiltersClient';
+export interface IInboxPlacementsResultsClient {
+    attributes: ISeedsListsAttributesClient;
+    filters: ISeedsListsFiltersClient;
+    list(query: InboxPlacementsResultsQuery): Promise<InboxPlacementsResultsListResult>;
+}

package/Interfaces/InboxPlacements/Results/InboxPlacementsResultsSharing.d.ts

@@ -0,0 +1,5 @@
+import { IPRSharingResult, IPRSharingUpdateData, IPRSharingUpdateResult } from '../../../Types/InboxPlacements';
+export interface IIPRSharingClient {
+    get(id: string): Promise<IPRSharingResult>;
+    update(id: string, data: IPRSharingUpdateData): Promise<IPRSharingUpdateResult>;
+}

package/Interfaces/InboxPlacements/SeedsLists/AttributesClient.d.ts

@@ -0,0 +1,5 @@
+import { InboxPlacementsAttributesResult, InboxPlacementsValuesResult } from '../../../Types/InboxPlacements';
+export interface IInboxPlacementsAttributesClient {
+    list(): Promise<InboxPlacementsAttributesResult>;
+    get(attributeName: string): Promise<InboxPlacementsValuesResult>;
+}

package/Interfaces/InboxPlacements/SeedsLists/FiltersClient.d.ts

@@ -0,0 +1,4 @@
+import { SeedsListsFiltersResult } from '../../../Types/InboxPlacements';
+export interface ISeedsListsFiltersClient {
+    list(): Promise<SeedsListsFiltersResult>;
+}

package/Interfaces/InboxPlacements/SeedsLists/SeedsListsClient.d.ts

@@ -0,0 +1,12 @@
+import { SeedListResult, SeedsListsCreatingData, SeedsListsDestroyApiResponse, SeedsListsQuery, SeedsListsResult, SeedsListsUpdatingData } from '../../../Types/InboxPlacements';
+import { IInboxPlacementsAttributesClient } from '../AttributesClient';
+import { IInboxPlacementsFiltersClient } from '../FiltersClient';
+export interface ISeedsListsClient {
+    attributes: IInboxPlacementsAttributesClient;
+    filters: IInboxPlacementsFiltersClient;
+    list(query: SeedsListsQuery): Promise<SeedsListsResult>;
+    get(address: string): Promise<SeedListResult>;
+    create(data: SeedsListsCreatingData): Promise<SeedListResult>;
+    update(address: string, data: SeedsListsUpdatingData): Promise<SeedListResult>;
+    destroy(address: string): Promise<SeedsListsDestroyApiResponse>;
+}

package/Interfaces/InboxPlacements/index.d.ts

@@ -0,0 +1,6 @@
+export * from './InboxPlacementsClient';
+export * from './AttributesClient';
+export * from './FiltersClient';
+export * from './SeedsLists/SeedsListsClient';
+export * from './Results/InboxPlacementsResults';
+export * from './Results/InboxPlacementsResultsSharing';

package/Interfaces/InboxPlacements/providers/InboxPlacementsProviders.d.ts

@@ -0,0 +1,4 @@
+import { InboxPlacementsProvidersList } from '../../../Types/InboxPlacements';
+export interface IInboxPlacementsProvidersClient {
+    list(): Promise<InboxPlacementsProvidersList>;
+}

package/Interfaces/MailgunClient/IMailgunClient.d.ts

@@ -10,6 +10,7 @@ import { IIPsClient } from '../IPs';
 import { IIPPoolsClient } from '../IPPools';
 import { IMailingListsClient } from '../MailingLists';
 import { ISubaccountsClient } from '../Subaccounts';
+import { IInboxPlacementsClient } from '../InboxPlacements';
 export interface IMailgunClient {
     domains: IDomainsClient;
     webhooks: IWebHooksClient;
@@ -23,6 +24,7 @@ export interface IMailgunClient {
     ip_pools: IIPPoolsClient;
     lists: IMailingListsClient;
     subaccounts: ISubaccountsClient;
+    inboxPlacements: IInboxPlacementsClient;
     setSubaccount(subaccountId: string): void;
     resetSubaccount(): void;
 }

package/Interfaces/index.d.ts

@@ -12,3 +12,4 @@ export * from './Routes';
 export * from './IPs';
 export * from './IPPools';
 export * from './Subaccounts';
+export * from './InboxPlacements';