Send the idempotency key as an Idempotency-Key header instead of a query parameter

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});

src/resources/Account/index.ts

@@ -100,7 +100,7 @@ export class Account extends Resource {
  */
 
  async create(data: IACHCreateOpts | ILiabilityCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, requestConfig);
+ return super._create<IResponse<IAccount>, IACHCreateOpts | ILiabilityCreateOpts>(data, undefined, requestConfig);
  }
 
 

src/resources/Entity/ManualConnect.ts

@@ -44,6 +44,6 @@ export default class EntityManualConnect extends Resource {
  }
 
  async create(opts: IManualConnectCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntityConnect>, IManualConnectCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Entity/Subscriptions.ts

@@ -52,7 +52,7 @@ export default class EntitySubscriptions extends Resource {
  enroll: opts as TEntitySubscriptionNames,
  };
  }
- return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IEntitySubscription>, IEntitySubscriptionCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Entity/index.ts

@@ -100,6 +100,7 @@ export class Entity extends Resource {
  ) {
  return super._create<IResponse<IEntity>, IIndividualCreateOpts | ICorporationCreateOpts>(
  opts,
+ undefined,
  requestConfig,
  );
  }

src/resources/ForwardingRequest/index.ts

@@ -61,6 +61,6 @@ export default class ForwardingRequest extends Resource {
  }
 
  async create(opts: IForwardingRequestCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IForwardingRequest>, IForwardingRequestCreateOpts>(opts, undefined, requestConfig);
  }
 };

src/resources/Payment/index.ts

@@ -62,7 +62,7 @@ export class Payment extends Resource {
  */
 
  async create(opts: IPaymentCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IPayment>, IPaymentCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Report/index.ts

@@ -68,7 +68,7 @@ export default class Report extends Resource {
  */
 
  async create(opts: IReportCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IReport>, IReportCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IReport>, IReportCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

src/resources/Secret/index.ts

@@ -35,7 +35,7 @@ export default class Secret extends Resource {
  }
 
  async create(opts: ISecretCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ISecret>, ISecretCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(sec_id: string) {

src/resources/Team/index.ts

@@ -71,7 +71,7 @@ export class TeamPublicKeys extends Resource {
  }
 
  async create(opts: IMLEPublicKeyCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IMLEPublicKey>, IMLEPublicKeyCreateOpts>(opts, undefined, requestConfig);
  }
 
  async delete(key_id: string) {
@@ -92,7 +92,7 @@ export default class Team extends Resource {
  }
 
  async create(opts: ITeamCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<ITeam>, ITeamCreateOpts>(opts, undefined, requestConfig);
  }
 
  async updateEncryptionKey(opts: ITeamEncryptionKeyOpts, requestConfig?: IRequestConfig) {

src/resources/Webhook/index.ts

@@ -38,7 +38,7 @@ export default class Webhook extends Resource {
  */
 
  async create(opts: IWebhookCreateOpts, requestConfig?: IRequestConfig) {
- return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, requestConfig);
+ return super._create<IResponse<IWebhook>, IWebhookCreateOpts>(opts, undefined, requestConfig);
  }
 
  /**

test/index.ts

@@ -11,3 +11,4 @@ require('./resources/HealthCheck.tests');
 require('./resources/Metadata.tests');
 require('./resources/Event.tests');
 require('./resources/Opal.tests');
+require('./resources/RequestConfig.tests');

test/resources/RequestConfig.tests.ts

@@ -0,0 +1,175 @@
+import { should } from 'chai';
+import {
+ after, before, beforeEach, describe, it,
+} from 'mocha';
+import * as http from 'http';
+import type { AddressInfo } from 'net';
+import { Method } from '../../src/method';
+import type { IRequestConfig } from '../../src/resource';
+
+should();
+
+interface ICapturedRequest {
+ url: string;
+ headers: http.IncomingHttpHeaders;
+};
+
+interface ICreateUnderTest {
+ name: string;
+ create: (requestConfig?: IRequestConfig) => Promise<any>;
+};
+
+const idempotency_key = 'test-idempotency-key';
+
+describe('Request config - core methods tests', () => {
+ let server: http.Server;
+ let client: Method;
+ let requests: ICapturedRequest[] = [];
+
+ before((done) => {
+ server = http.createServer((req, res) => {
+ requests.push({ url: req.url || '', headers: req.headers });
+ res.setHeader('content-type', 'application/json');
+ res.end(JSON.stringify({ data: {} }));
+ });
+
+ server.listen(0, '127.0.0.1', () => {
+ const { port } = server.address() as AddressInfo;
+
+ client = new Method({
+ apiKey: 'sk_test',
+ env: 'dev',
+ baseURL: `http://127.0.0.1:${port}`,
+ });
+
+ done();
+ });
+ });
+
+ after((done) => {
+ server.close(() => done());
+ });
+
+ beforeEach(() => {
+ requests = [];
+ });
+
+ const creates: ICreateUnderTest[] = [
+ {
+ name: 'accounts.create',
+ create: (requestConfig?: IRequestConfig) => client.accounts.create({
+ holder_id: 'ent_au22adjEjWQpF',
+ ach: { routing: '367537407', number: '57838927', type: 'checking' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.create',
+ create: (requestConfig?: IRequestConfig) => client.entities.create({
+ type: 'individual',
+ individual: { first_name: 'Kevin', last_name: 'Doyle' },
+ }, requestConfig),
+ },
+ {
+ name: 'entities.subscriptions.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .subscriptions
+ .create({ enroll: 'credit_score' }, requestConfig),
+ },
+ {
+ name: 'entities.manualConnect.create',
+ create: (requestConfig?: IRequestConfig) => client
+ .entities('ent_au22adjEjWQpF')
+ .manualConnect
+ .create({ bureau: 'equifax', tradelines: [] }, requestConfig),
+ },
+ {
+ name: 'payments.create',
+ create: (requestConfig?: IRequestConfig) => client.payments.create({
+ amount: 5000,
+ source: 'acc_JMJZTrpu3vAmA',
+ destination: 'acc_AXthEBs9NPbfa',
+ description: 'Loan Pmt',
+ }, requestConfig),
+ },
+ {
+ name: 'reports.create',
+ create: (requestConfig?: IRequestConfig) => client.reports.create({
+ type: 'payments.created.current',
+ }, requestConfig),
+ },
+ {
+ name: 'secrets.create',
+ create: (requestConfig?: IRequestConfig) => client.secrets.create({
+ value: 'test-secret-value',
+ }, requestConfig),
+ },
+ {
+ name: 'forwardingRequests.create',
+ create: (requestConfig?: IRequestConfig) => client.forwardingRequests.create({
+ url: 'https://api.example.app/forward',
+ method: 'POST',
+ headers: {},
+ body: '{}',
+ bindings: {},
+ }, requestConfig),
+ },
+ {
+ name: 'webhooks.create',
+ create: (requestConfig?: IRequestConfig) => client.webhooks.create({
+ type: 'payment.create',
+ url: 'https://api.example.app/webhook',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.create({
+ name: 'Test Team',
+ }, requestConfig),
+ },
+ {
+ name: 'teams.publicKeys.create',
+ create: (requestConfig?: IRequestConfig) => client.teams.publicKeys.create({
+ jwk: { kty: 'RSA' },
+ }, requestConfig),
+ },
+ ];
+
+ creates.forEach((resource) => {
+ describe(resource.name, () => {
+ it('should send the idempotency key as an Idempotency-Key header.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ });
+
+ it('should not send the idempotency key as a query parameter.', async () => {
+ await resource.create({ idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].url.should.not.contain('idempotency_key');
+ });
+
+ it('should not send an Idempotency-Key header when no request config is given.', async () => {
+ await resource.create();
+
+ requests.should.have.length(1);
+ requests[0].headers.should.not.have.property('idempotency-key');
+ });
+ });
+ });
+
+ describe('entities.connect.create', () => {
+ it('should send the Idempotency-Key header alongside its query parameters.', async () => {
+ await client
+ .entities('ent_au22adjEjWQpF')
+ .connect
+ .create({}, { expand: ['accounts'] }, { idempotency_key });
+
+ requests.should.have.length(1);
+ requests[0].headers.should.have.property('idempotency-key', idempotency_key);
+ requests[0].url.should.contain('expand');
+ });
+ });
+});