adds report schedules

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');

index.ts

@@ -6,4 +6,5 @@ export { ElementTypes } from './src/resources/Element';
 export { EntityTypes, EntityStatuses } from './src/resources/Entity';
 export { PaymentFundStatuses, PaymentStatuses } from './src/resources/Payment';
 export { ReportTypes, ReportStatuses } from './src/resources/Report';
+export { ReportScheduleStatuses, ReportScheduleDeliveryMethodTypes } from './src/resources/ReportSchedule';
 export { WebhookTypes } from './src/resources/Webhook';

package.json

@@ -1,6 +1,6 @@
 {
  "name": "method-node",
- "version": "3.0.0",
+ "version": "3.0.1",
  "description": "Node.js library for the Method API",
  "main": "dist/index.ts",
  "module": "dist/index.mjs",

src/method.ts

@@ -7,6 +7,7 @@ import Event from './resources/Event';
 import Merchant from './resources/Merchant';
 import Payment from './resources/Payment';
 import Report from './resources/Report';
+import ReportSchedule from './resources/ReportSchedule';
 import Webhook from './resources/Webhook';
 import HealthCheck, { IPingResponse } from './resources/HealthCheck';
 import Simulate from './resources/Simulate';
@@ -25,6 +26,7 @@ export class Method {
  merchants: Merchant;
  payments: Payment;
  reports: Report;
+ reportSchedules: ReportSchedule;
  webhooks: Webhook;
  healthcheck: HealthCheck;
  simulate: Simulate;
@@ -46,6 +48,7 @@ export class Method {
  this.merchants = new Merchant(config);
  this.payments = new Payment(config);
  this.reports = new Report(config);
+ this.reportSchedules = new ReportSchedule(config);
  this.webhooks = new Webhook(config);
  this.healthcheck = new HealthCheck(config);
  this.simulate = new Simulate(config);

src/resource.ts

@@ -16,11 +16,13 @@ import { SimulateAttributesInstance } from './resources/Simulate/Entities/Attrib
 import { SimulateVerificationSessionInstance } from './resources/Simulate/Accounts/VerificationSessions';
 import { SimulatePaymentInstrumentInstance } from './resources/Simulate/PaymentInstruments';
 import { ManagedAccountSubResources } from './resources/ManagedAccount';
+import { ReportScheduleSubResources } from './resources/ReportSchedule';
 
 type TSubResources =
  | AccountSubResources
  | PaymentSubResources
  | EntitySubResources
+ | ReportScheduleSubResources
  | SimulateAccountsSubResources
  | SimulateEntitiesSubResources
  | SimulateCreditScoresInstance
@@ -307,6 +309,12 @@ export default class Resource extends ExtensibleFunction {
  return (await this.client.delete(`/${id}`)).data.data;
  }
 
+ protected async _deleteWithParams<Response, Params = {}>(
+ params: Params,
+ ): Promise<Response> {
+ return (await this.client.delete('', { params })).data.data;
+ }
+
  protected async _deleteWithSubPath<Response>(
  path: string,
  requestConfig: IRequestConfig = {},

src/resources/ReportSchedule/DeliveryMethods.ts

@@ -0,0 +1,53 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule, TReportScheduleDeliveryMethodTypes } from './types';
+
+export interface IReportScheduleDeliveryMethodAddOpts {
+ delivery_method: TReportScheduleDeliveryMethodTypes;
+};
+
+export interface IReportScheduleDeliveryMethodsReplaceOpts {
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+};
+
+export default class ReportScheduleDeliveryMethods extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('delivery_methods'));
+ }
+
+ /**
+ * Adds a single delivery method to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/add
+ *
+ * @param opts IReportScheduleDeliveryMethodAddOpts: { delivery_method: TReportScheduleDeliveryMethodTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleDeliveryMethodAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full delivery_methods array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/replace
+ *
+ * @param opts IReportScheduleDeliveryMethodsReplaceOpts: { delivery_methods: TReportScheduleDeliveryMethodTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleDeliveryMethodsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleDeliveryMethodsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single delivery method from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/delivery-methods/delete
+ *
+ * @param delivery_method The delivery method to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(delivery_method: TReportScheduleDeliveryMethodTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { delivery_method: TReportScheduleDeliveryMethodTypes }>({ delivery_method });
+ }
+};

src/resources/ReportSchedule/Recipients.ts

@@ -0,0 +1,56 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleRecipientAddOpts {
+ recipient: string;
+};
+
+export interface IReportScheduleRecipientsReplaceOpts {
+ recipients: string[];
+};
+
+export default class ReportScheduleRecipients extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('recipients'));
+ }
+
+ /**
+ * Adds a single recipient email address to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/add
+ *
+ * @param opts IReportScheduleRecipientAddOpts: { recipient: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleRecipientAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleRecipientAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full recipients array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/replace
+ *
+ * @param opts IReportScheduleRecipientsReplaceOpts: { recipients: string[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleRecipientsReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleRecipientsReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a recipient from an existing Report Schedule. Provide a recipient to
+ * remove a single email address, or omit it to clear all recipients.
+ * https://docs.methodfi.com/reference/report-schedules/recipients/delete
+ *
+ * @param recipient The email address to remove. If omitted, all recipients are cleared.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(recipient?: string) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { recipient?: string }>(
+ recipient ? { recipient } : {},
+ );
+ }
+};

src/resources/ReportSchedule/ReportTypes.ts

@@ -0,0 +1,54 @@
+import Resource from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import type { TReportTypes } from '../Report';
+import type { IReportSchedule } from './types';
+
+export interface IReportScheduleTypeAddOpts {
+ type: TReportTypes;
+};
+
+export interface IReportScheduleTypesReplaceOpts {
+ types: TReportTypes[];
+};
+
+export default class ReportScheduleTypes extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('types'));
+ }
+
+ /**
+ * Adds a single Report type to an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/add
+ *
+ * @param opts IReportScheduleTypeAddOpts: { type: TReportTypes }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async add(opts: IReportScheduleTypeAddOpts) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleTypeAddOpts>(opts);
+ }
+
+ /**
+ * Replaces the full types array on an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/replace
+ *
+ * @param opts IReportScheduleTypesReplaceOpts: { types: TReportTypes[] }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async replace(opts: IReportScheduleTypesReplaceOpts) {
+ return super._update<IResponse<IReportSchedule>, IReportScheduleTypesReplaceOpts>(opts);
+ }
+
+ /**
+ * Removes a single Report type from an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/types/delete
+ *
+ * @param type The Report type to remove.
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async delete(type: TReportTypes) {
+ return super._deleteWithParams<IResponse<IReportSchedule>, { type: TReportTypes }>({ type });
+ }
+};

src/resources/ReportSchedule/index.ts

@@ -0,0 +1,100 @@
+import Resource, { IRequestConfig } from '../../resource';
+import Configuration, { IResponse } from '../../configuration';
+import ReportScheduleTypes from './ReportTypes';
+import ReportScheduleDeliveryMethods from './DeliveryMethods';
+import ReportScheduleRecipients from './Recipients';
+import type {
+ IReportSchedule,
+ IReportScheduleCreateOpts,
+ IReportScheduleUpdateOpts,
+} from './types';
+
+export class ReportScheduleSubResources {
+ types: ReportScheduleTypes;
+ deliveryMethods: ReportScheduleDeliveryMethods;
+ recipients: ReportScheduleRecipients;
+
+ constructor(rpt_sch_id: string, config: Configuration) {
+ this.types = new ReportScheduleTypes(config.addPath(rpt_sch_id));
+ this.deliveryMethods = new ReportScheduleDeliveryMethods(config.addPath(rpt_sch_id));
+ this.recipients = new ReportScheduleRecipients(config.addPath(rpt_sch_id));
+ }
+};
+
+export interface ReportSchedule {
+ (rpt_sch_id: string): ReportScheduleSubResources;
+};
+
+export class ReportSchedule extends Resource {
+ constructor(config: Configuration) {
+ super(config.addPath('report_schedules'));
+ }
+
+ protected _call(rpt_sch_id: string): ReportScheduleSubResources {
+ return new ReportScheduleSubResources(rpt_sch_id, this.config);
+ }
+
+ /**
+ * Retrieves the Report Schedule associated with the ID.
+ * https://docs.methodfi.com/reference/report-schedules/retrieve
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns the Report Schedule associated with the ID.
+ */
+
+ async retrieve(rpt_sch_id: string) {
+ return super._getWithId<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+
+ /**
+ * Returns all the active Report Schedules associated with your team, or an empty array if none have been created.
+ * https://docs.methodfi.com/reference/report-schedules/list
+ *
+ * @returns Returns a list of Report Schedule objects.
+ */
+
+ async list() {
+ return super._list<IResponse<IReportSchedule>>();
+ }
+
+ /**
+ * Creates a new Report Schedule. Once created, the first run is queued immediately for the next scheduled date.
+ * https://docs.methodfi.com/reference/report-schedules/create
+ *
+ * @param opts IReportScheduleCreateOpts
+ * @param requestConfig Idempotency key: { idempotency_key: string }
+ * @returns Returns the newly created Report Schedule object.
+ */
+
+ async create(opts: IReportScheduleCreateOpts, requestConfig?: IRequestConfig) {
+ return super._create<IResponse<IReportSchedule>, IReportScheduleCreateOpts>(opts, requestConfig);
+ }
+
+ /**
+ * Updates the cron expression of an existing Report Schedule.
+ * https://docs.methodfi.com/reference/report-schedules/update
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @param opts IReportScheduleUpdateOpts: { cron: string }
+ * @returns Returns the updated Report Schedule object.
+ */
+
+ async update(rpt_sch_id: string, opts: IReportScheduleUpdateOpts, requestConfig?: IRequestConfig) {
+ return super._patchWithId<IResponse<IReportSchedule>, IReportScheduleUpdateOpts>(rpt_sch_id, opts, requestConfig);
+ }
+
+ /**
+ * Deletes a Report Schedule. The schedule's status is set to inactive and no further reports will be generated.
+ * https://docs.methodfi.com/reference/report-schedules/delete
+ *
+ * @param rpt_sch_id id of the Report Schedule
+ * @returns Returns an empty response.
+ */
+
+ async delete(rpt_sch_id: string) {
+ return super._delete<IResponse<IReportSchedule>>(rpt_sch_id);
+ }
+};
+
+export default ReportSchedule;
+export * from './types';

src/resources/ReportSchedule/types.ts

@@ -0,0 +1,37 @@
+import type { TReportTypes } from '../Report';
+
+export const ReportScheduleStatuses = {
+ active: 'active',
+ inactive: 'inactive',
+} as const;
+
+export type TReportScheduleStatuses = keyof typeof ReportScheduleStatuses;
+
+export const ReportScheduleDeliveryMethodTypes = {
+ webhook: 'webhook',
+ email: 'email',
+} as const;
+
+export type TReportScheduleDeliveryMethodTypes = typeof ReportScheduleDeliveryMethodTypes[keyof typeof ReportScheduleDeliveryMethodTypes];
+
+export interface IReportSchedule {
+ id: string;
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients: string[] | null;
+ cron: string;
+ status: TReportScheduleStatuses;
+ created_at: string;
+ updated_at: string;
+};
+
+export interface IReportScheduleCreateOpts {
+ types: TReportTypes[];
+ delivery_methods: TReportScheduleDeliveryMethodTypes[];
+ recipients?: string[];
+ cron?: string;
+};
+
+export interface IReportScheduleUpdateOpts {
+ cron: string;
+};

test/index.ts

@@ -6,6 +6,7 @@ require('./resources/Entity.tests');
 require('./resources/Merchant.tests');
 require('./resources/Payment.tests');
 require('./resources/Report.tests');
+require('./resources/ReportSchedule.tests');
 require('./resources/Webhook.tests');
 require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');