refactor(test): refactor authentication tests (#254)

Modern-Treasury · Oct 12, 2023 · bfaebfd · bfaebfd
1 parent 8478f61
commit bfaebfd
Show file tree

Hide file tree

Showing 41 changed files with 122 additions and 131 deletions.
diff --git a/README.md b/README.md
@@ -22,8 +22,8 @@ The full API of this library can be found in [api.md](https://www.github.com/Mod
 import ModernTreasury from 'modern-treasury';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'my api key', // defaults to process.env["MODERN_TREASURY_API_KEY"]
-  organizationId: 'my-organization-ID',
+  organizationId: 'my-organization-ID', // defaults to process.env["MODERN_TREASURY_ORGANIZATION_ID"]
+  apiKey: 'My API Key', // defaults to process.env["MODERN_TREASURY_API_KEY"]
 });
 
 async function main() {
@@ -46,8 +46,8 @@ This library includes TypeScript definitions for all request params and response
 import ModernTreasury from 'modern-treasury';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'my api key', // defaults to process.env["MODERN_TREASURY_API_KEY"]
-  organizationId: 'my-organization-ID',
+  organizationId: 'my-organization-ID', // defaults to process.env["MODERN_TREASURY_ORGANIZATION_ID"]
+  apiKey: 'My API Key', // defaults to process.env["MODERN_TREASURY_API_KEY"]
 });
 
 async function main() {
@@ -166,7 +166,6 @@ You can use the `maxRetries` option to configure or disable this:
 // Configure the default for all requests:
 const modernTreasury = new ModernTreasury({
   maxRetries: 0, // default is 2
-  organizationId: 'my-organization-ID',
 });
 
 // Or, configure per-request:
@@ -184,7 +183,6 @@ Requests time out after 1 minute by default. You can configure this with a `time
 // Configure the default for all requests:
 const modernTreasury = new ModernTreasury({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
-  organizationId: 'my-organization-ID',
 });
 
 // Override per-request:
@@ -266,7 +264,6 @@ import HttpsProxyAgent from 'https-proxy-agent';
 // Configure the default for all requests:
 const modernTreasury = new ModernTreasury({
   httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
-  organizationId: 'my-organization-ID',
 });
 
 // Override per-request:

diff --git a/src/index.ts b/src/index.ts
@@ -11,10 +11,20 @@ import * as TopLevelAPI from 'modern-treasury/resources/top-level';
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env["MODERN_TREASURY_API_KEY"].
+   * Defaults to process.env['MODERN_TREASURY_API_KEY'].
    */
   apiKey?: string;
 
+  /**
+   * Defaults to process.env['MODERN_TREASURY_ORGANIZATION_ID'].
+   */
+  organizationId?: string;
+
+  /**
+   * Defaults to process.env['MODERN_TREASURY_WEBHOOK_KEY'].
+   */
+  webhookKey?: string | null;
+
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    */
@@ -68,33 +78,29 @@ export interface ClientOptions {
    * param to `undefined` in request options.
    */
   defaultQuery?: Core.DefaultQuery;
-
-  organizationId?: string;
-
-  webhookKey?: string | null;
 }
 
 /** API Client for interfacing with the Modern Treasury API. */
 export class ModernTreasury extends Core.APIClient {
   apiKey: string;
   organizationId: string;
-  webhookKey?: string | null;
+  webhookKey: string | null;
 
   private _options: ClientOptions;
 
   /**
    * API Client for interfacing with the Modern Treasury API.
    *
-   * @param {string} [opts.apiKey=process.env['MODERN_TREASURY_API_KEY']] - The API Key to send to the API.
+   * @param {string} [opts.apiKey==process.env['MODERN_TREASURY_API_KEY'] ?? undefined]
+   * @param {string} [opts.organizationId==process.env['MODERN_TREASURY_ORGANIZATION_ID'] ?? undefined]
+   * @param {string | null} [opts.webhookKey==process.env['MODERN_TREASURY_WEBHOOK_KEY'] ?? null]
    * @param {string} [opts.baseURL] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
    * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
    * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
    * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
    * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
-   * @param {string} [opts.organizationId]
-   * @param {string | null} [opts.webhookKey]
    */
   constructor({
     apiKey = Core.readEnv('MODERN_TREASURY_API_KEY'),
@@ -104,7 +110,7 @@ export class ModernTreasury extends Core.APIClient {
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Errors.ModernTreasuryError(
-        "The MODERN_TREASURY_API_KEY environment variable is missing or empty; either provide it, or instantiate the ModernTreasury client with an apiKey option, like new ModernTreasury({ apiKey: 'my apiKey' }).",
+        "The MODERN_TREASURY_API_KEY environment variable is missing or empty; either provide it, or instantiate the ModernTreasury client with an apiKey option, like new ModernTreasury({ apiKey: 'My API Key' }).",
       );
     }
     if (organizationId === undefined) {

diff --git a/tests/api-resources/account-collection-flows.test.ts b/tests/api-resources/account-collection-flows.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource accountCollectionFlows', () => {

diff --git a/tests/api-resources/account-details.test.ts b/tests/api-resources/account-details.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource accountDetails', () => {

diff --git a/tests/api-resources/connections.test.ts b/tests/api-resources/connections.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource connections', () => {

diff --git a/tests/api-resources/counterparties.test.ts b/tests/api-resources/counterparties.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource counterparties', () => {

diff --git a/tests/api-resources/documents.test.ts b/tests/api-resources/documents.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury, { toFile } from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource documents', () => {

diff --git a/tests/api-resources/events.test.ts b/tests/api-resources/events.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource events', () => {

diff --git a/tests/api-resources/expected-payments.test.ts b/tests/api-resources/expected-payments.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource expectedPayments', () => {

diff --git a/tests/api-resources/external-accounts.test.ts b/tests/api-resources/external-accounts.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource externalAccounts', () => {

diff --git a/tests/api-resources/incoming-payment-details.test.ts b/tests/api-resources/incoming-payment-details.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource incomingPaymentDetails', () => {

diff --git a/tests/api-resources/internal-accounts/balance-reports.test.ts b/tests/api-resources/internal-accounts/balance-reports.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource balanceReports', () => {

diff --git a/tests/api-resources/internal-accounts/internal-accounts.test.ts b/tests/api-resources/internal-accounts/internal-accounts.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource internalAccounts', () => {

diff --git a/tests/api-resources/invoices/invoices.test.ts b/tests/api-resources/invoices/invoices.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource invoices', () => {

diff --git a/tests/api-resources/invoices/line-items.test.ts b/tests/api-resources/invoices/line-items.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource lineItems', () => {

diff --git a/tests/api-resources/ledger-account-balance-monitors.test.ts b/tests/api-resources/ledger-account-balance-monitors.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerAccountBalanceMonitors', () => {

diff --git a/tests/api-resources/ledger-account-categories.test.ts b/tests/api-resources/ledger-account-categories.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerAccountCategories', () => {

diff --git a/tests/api-resources/ledger-account-payouts.test.ts b/tests/api-resources/ledger-account-payouts.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerAccountPayouts', () => {

diff --git a/tests/api-resources/ledger-account-statements.test.ts b/tests/api-resources/ledger-account-statements.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerAccountStatements', () => {

diff --git a/tests/api-resources/ledger-accounts.test.ts b/tests/api-resources/ledger-accounts.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerAccounts', () => {

diff --git a/tests/api-resources/ledger-entries.test.ts b/tests/api-resources/ledger-entries.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerEntries', () => {

diff --git a/tests/api-resources/ledger-event-handlers.test.ts b/tests/api-resources/ledger-event-handlers.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerEventHandlers', () => {

diff --git a/tests/api-resources/ledger-transactions/ledger-transactions.test.ts b/tests/api-resources/ledger-transactions/ledger-transactions.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerTransactions', () => {

diff --git a/tests/api-resources/ledger-transactions/versions.test.ts b/tests/api-resources/ledger-transactions/versions.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource versions', () => {

diff --git a/tests/api-resources/ledgerable-events.test.ts b/tests/api-resources/ledgerable-events.test.ts
@@ -4,9 +4,9 @@ import ModernTreasury from 'modern-treasury';
 import { Response } from 'node-fetch';
 
 const modernTreasury = new ModernTreasury({
-  apiKey: 'something1234',
-  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+  apiKey: 'My API Key',
   organizationId: 'my-organization-ID',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource ledgerableEvents', () => {