increase 0.2.0 → 0.4.0

package/index.ts

@@ -4,6 +4,7 @@ import qs from 'qs';
 import * as Core from './core';
 import * as Pagination from './pagination';
 import * as API from './resources';
+import * as Errors from '~/error';
 import type { Agent } from 'http';
 import * as FileFromPath from 'formdata-node/file-from-path';
 
@@ -21,12 +22,16 @@ type Config = {
   baseURL?: string;
   timeout?: number;
   httpAgent?: Agent;
+  maxRetries?: number;
+  defaultHeaders?: Core.Headers;
 };
 
 /** Instantiate the API Client. */
 export class Increase extends Core.APIClient {
   apiKey: string;
 
+  private _options: Config;
+
   constructor(config?: Config) {
     const options: Config = {
       apiKey: process.env['INCREASE_API_KEY'] || '',
@@ -44,21 +49,30 @@ export class Increase extends Core.APIClient {
       baseURL: options.baseURL || environments[options.environment || 'production'],
       timeout: options.timeout,
       httpAgent: options.httpAgent,
+      maxRetries: options.maxRetries,
     });
     this.apiKey = options.apiKey;
+    this._options = options;
     this.idempotencyHeader = 'Idempotency-Key';
   }
 
   accounts: API.Accounts = new API.Accounts(this);
   accountNumbers: API.AccountNumbers = new API.AccountNumbers(this);
+  bookkeepingAccounts: API.BookkeepingAccounts = new API.BookkeepingAccounts(this);
+  bookkeepingEntrySets: API.BookkeepingEntrySets = new API.BookkeepingEntrySets(this);
+  bookkeepingEntries: API.BookkeepingEntries = new API.BookkeepingEntries(this);
   realTimeDecisions: API.RealTimeDecisions = new API.RealTimeDecisions(this);
+  realTimePaymentsTransfers: API.RealTimePaymentsTransfers = new API.RealTimePaymentsTransfers(this);
+  balanceLookups: API.BalanceLookups = new API.BalanceLookups(this);
   cards: API.Cards = new API.Cards(this);
   cardDisputes: API.CardDisputes = new API.CardDisputes(this);
   cardProfiles: API.CardProfiles = new API.CardProfiles(this);
   externalAccounts: API.ExternalAccounts = new API.ExternalAccounts(this);
+  exports: API.Exports = new API.Exports(this);
   digitalWalletTokens: API.DigitalWalletTokens = new API.DigitalWalletTokens(this);
   transactions: API.Transactions = new API.Transactions(this);
   pendingTransactions: API.PendingTransactions = new API.PendingTransactions(this);
+  programs: API.Programs = new API.Programs(this);
   declinedTransactions: API.DeclinedTransactions = new API.DeclinedTransactions(this);
   limits: API.Limits = new API.Limits(this);
   accountTransfers: API.AccountTransfers = new API.AccountTransfers(this);
@@ -81,6 +95,13 @@ export class Increase extends Core.APIClient {
   accountStatements: API.AccountStatements = new API.AccountStatements(this);
   simulations: API.Simulations = new API.Simulations(this);
 
+  protected override defaultHeaders(): Core.Headers {
+    return {
+      ...super.defaultHeaders(),
+      ...this._options.defaultHeaders,
+    };
+  }
+
   protected override authHeaders(): Core.Headers {
     return { Authorization: `Bearer ${this.apiKey}` };
   }
@@ -89,36 +110,56 @@ export class Increase extends Core.APIClient {
     return { allowDots: true, arrayFormat: 'comma' };
   }
 
-  static APIError = Core.APIError;
-
-  static APIConnectionError = Core.APIConnectionError;
-  static APIConnectionTimeoutError = Core.APIConnectionTimeoutError;
-
-  static BadRequestError = Core.BadRequestError;
-  static AuthenticationError = Core.AuthenticationError;
-  static PermissionDeniedError = Core.PermissionDeniedError;
-  static NotFoundError = Core.NotFoundError;
-  static ConflictError = Core.ConflictError;
-  static UnprocessableEntityError = Core.UnprocessableEntityError;
-  static RateLimitError = Core.RateLimitError;
-  static InternalServerError = Core.InternalServerError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static RateLimitedError = Errors.RateLimitedError;
+  static InvalidAPIKeyError = Errors.InvalidAPIKeyError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static ObjectNotFoundError = Errors.ObjectNotFoundError;
+  static PrivateFeatureError = Errors.PrivateFeatureError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static InvalidOperationError = Errors.InvalidOperationError;
+  static MalformedRequestError = Errors.MalformedRequestError;
+  static APIMethodNotFoundError = Errors.APIMethodNotFoundError;
+  static InvalidParametersError = Errors.InvalidParametersError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+  static EnvironmentMismatchError = Errors.EnvironmentMismatchError;
+  static IdempotencyConflictError = Errors.IdempotencyConflictError;
+  static InsufficientPermissionsError = Errors.InsufficientPermissionsError;
+  static IdempotencyUnprocessableError = Errors.IdempotencyUnprocessableError;
 }
 
 export const {
   APIError,
-
   APIConnectionError,
   APIConnectionTimeoutError,
-
-  BadRequestError,
-  AuthenticationError,
-  PermissionDeniedError,
   NotFoundError,
   ConflictError,
-  UnprocessableEntityError,
   RateLimitError,
+  BadRequestError,
+  RateLimitedError,
+  InvalidAPIKeyError,
+  AuthenticationError,
   InternalServerError,
-} = Increase;
+  ObjectNotFoundError,
+  PrivateFeatureError,
+  PermissionDeniedError,
+  InvalidOperationError,
+  MalformedRequestError,
+  APIMethodNotFoundError,
+  InvalidParametersError,
+  UnprocessableEntityError,
+  EnvironmentMismatchError,
+  IdempotencyConflictError,
+  InsufficientPermissionsError,
+  IdempotencyUnprocessableError,
+} = Errors;
 
 export import fileFromPath = FileFromPath.fileFromPath;
 
@@ -142,9 +183,29 @@ export namespace Increase {
   export import AccountNumberUpdateParams = API.AccountNumberUpdateParams;
   export import AccountNumberListParams = API.AccountNumberListParams;
 
+  export import BookkeepingAccount = API.BookkeepingAccount;
+  export import BookkeepingAccountsPage = API.BookkeepingAccountsPage;
+  export import BookkeepingAccountCreateParams = API.BookkeepingAccountCreateParams;
+  export import BookkeepingAccountListParams = API.BookkeepingAccountListParams;
+
+  export import BookkeepingEntrySet = API.BookkeepingEntrySet;
+  export import BookkeepingEntrySetCreateParams = API.BookkeepingEntrySetCreateParams;
+
+  export import BookkeepingEntry = API.BookkeepingEntry;
+  export import BookkeepingEntriesPage = API.BookkeepingEntriesPage;
+  export import BookkeepingEntryListParams = API.BookkeepingEntryListParams;
+
   export import RealTimeDecision = API.RealTimeDecision;
   export import RealTimeDecisionActionParams = API.RealTimeDecisionActionParams;
 
+  export import RealTimePaymentsTransfer = API.RealTimePaymentsTransfer;
+  export import RealTimePaymentsTransfersPage = API.RealTimePaymentsTransfersPage;
+  export import RealTimePaymentsTransferCreateParams = API.RealTimePaymentsTransferCreateParams;
+  export import RealTimePaymentsTransferListParams = API.RealTimePaymentsTransferListParams;
+
+  export import BalanceLookupLookupResponse = API.BalanceLookupLookupResponse;
+  export import BalanceLookupLookupParams = API.BalanceLookupLookupParams;
+
   export import Card = API.Card;
   export import CardDetails = API.CardDetails;
   export import CardsPage = API.CardsPage;
@@ -168,6 +229,11 @@ export namespace Increase {
   export import ExternalAccountUpdateParams = API.ExternalAccountUpdateParams;
   export import ExternalAccountListParams = API.ExternalAccountListParams;
 
+  export import Export = API.Export;
+  export import ExportsPage = API.ExportsPage;
+  export import ExportCreateParams = API.ExportCreateParams;
+  export import ExportListParams = API.ExportListParams;
+
   export import DigitalWalletToken = API.DigitalWalletToken;
   export import DigitalWalletTokensPage = API.DigitalWalletTokensPage;
   export import DigitalWalletTokenListParams = API.DigitalWalletTokenListParams;
@@ -180,6 +246,10 @@ export namespace Increase {
   export import PendingTransactionsPage = API.PendingTransactionsPage;
   export import PendingTransactionListParams = API.PendingTransactionListParams;
 
+  export import Program = API.Program;
+  export import ProgramsPage = API.ProgramsPage;
+  export import ProgramListParams = API.ProgramListParams;
+
   export import DeclinedTransaction = API.DeclinedTransaction;
   export import DeclinedTransactionsPage = API.DeclinedTransactionsPage;
   export import DeclinedTransactionListParams = API.DeclinedTransactionListParams;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "increase",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Client library for the Increase API",
   "author": "Increase <dev-feedback@increase.com>",
   "types": "dist/cjs/index.d.ts",
@@ -30,12 +30,12 @@
     "qs": "^6.10.3"
   },
   "devDependencies": {
+    "increase": "link:.",
     "@types/jest": "^27.5.0",
     "@typescript-eslint/eslint-plugin": "^5.33.0",
     "@typescript-eslint/parser": "^5.33.0",
     "eslint": "^8.22.0",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "increase": "link:.",
     "jest": "^28.1.0",
     "prettier": "rattrayalex/prettier#postfix-ternaries",
     "ts-jest": "^28.0.2",

package/pagination.ts

@@ -2,6 +2,9 @@
 
 import { AbstractPage, APIResponse, APIClient, FinalRequestOptions, PageInfo } from './core';
 
+/**
+ * A list of Account objects
+ */
 export interface PageResponse<Item> {
   data: Array<Item>;
 

package/release-please-config.json

@@ -0,0 +1,61 @@
+{
+  "packages": {
+    ".": {}
+  },
+  "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json",
+  "include-v-in-tag": true,
+  "include-component-in-tag": false,
+  "bump-minor-pre-major": true,
+  "bump-patch-for-minor-pre-major": true,
+  "pull-request-header": "Automated Release PR",
+  "changelog-sections": [
+    {
+      "type": "feat",
+      "section": "Features"
+    },
+    {
+      "type": "fix",
+      "section": "Bug Fixes"
+    },
+    {
+      "type": "perf",
+      "section": "Performance Improvements"
+    },
+    {
+      "type": "revert",
+      "section": "Reverts"
+    },
+    {
+      "type": "chore",
+      "section": "Chores"
+    },
+    {
+      "type": "docs",
+      "section": "Documentation"
+    },
+    {
+      "type": "style",
+      "section": "Styles"
+    },
+    {
+      "type": "refactor",
+      "section": "Refactors"
+    },
+    {
+      "type": "test",
+      "section": "Tests",
+      "hidden": true
+    },
+    {
+      "type": "build",
+      "section": "Build System"
+    },
+    {
+      "type": "ci",
+      "section": "Continuous Integration",
+      "hidden": true
+    }
+  ],
+  "release-type": "node",
+  "extra-files": ["version.ts"]
+}

package/resources/account-numbers.ts

@@ -46,7 +46,6 @@ export class AccountNumbers extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/account_numbers', AccountNumbersPage, { query, ...options });
   }
 }
@@ -134,8 +133,38 @@ export interface AccountNumberListParams extends PageParams {
    */
   account_id?: string;
 
+  created_at?: AccountNumberListParams.CreatedAt;
+
   /**
    * The status to retrieve Account Numbers for.
    */
   status?: 'active' | 'disabled' | 'canceled';
 }
+
+export namespace AccountNumberListParams {
+  export interface CreatedAt {
+    /**
+     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    after?: string;
+
+    /**
+     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    before?: string;
+
+    /**
+     * Return results on or after this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_after?: string;
+
+    /**
+     * Return results on or before this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_before?: string;
+  }
+}

package/resources/account-statements.ts

@@ -31,7 +31,6 @@ export class AccountStatements extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/account_statements', AccountStatementsPage, { query, ...options });
   }
 }

package/resources/account-transfers.ts

@@ -41,7 +41,6 @@ export class AccountTransfers extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/account_transfers', AccountTransfersPage, { query, ...options });
   }
 
@@ -135,18 +134,7 @@ export interface AccountTransfer {
   /**
    * The lifecycle status of the transfer.
    */
-  status:
-    | 'pending_submission'
-    | 'pending_approval'
-    | 'canceled'
-    | 'requires_attention'
-    | 'flagged_by_operator'
-    | 'complete';
-
-  /**
-   * If the transfer was created from a template, this will be the template's ID.
-   */
-  template_id: string | null;
+  status: 'pending_approval' | 'canceled' | 'complete';
 
   /**
    * The ID for the transaction funding the transfer.
@@ -161,20 +149,40 @@ export interface AccountTransfer {
 }
 
 export namespace AccountTransfer {
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
   export interface Approval {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
      * the transfer was approved.
      */
     approved_at: string;
+
+    /**
+     * If the Transfer was approved by a user in the dashboard, the email address of
+     * that user.
+     */
+    approved_by: string | null;
   }
 
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
   export interface Cancellation {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
      * the Transfer was canceled.
      */
     canceled_at: string;
+
+    /**
+     * If the Transfer was canceled by a user in the dashboard, the email address of
+     * that user.
+     */
+    canceled_by: string | null;
   }
 }
 

package/resources/accounts.ts

@@ -43,7 +43,6 @@ export class Accounts extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/accounts', AccountsPage, { query, ...options });
   }
 
@@ -62,12 +61,6 @@ export class AccountsPage extends Page<Account> {}
  * transfers, and send payments. They earn interest and have depository insurance.
  */
 export interface Account {
-  /**
-   * The Account's balances in the minor unit of its currency. For dollars, for
-   * example, these values will represent cents.
-   */
-  balances: Account.Balances;
-
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
    * was created.
@@ -108,6 +101,13 @@ export interface Account {
    */
   interest_accrued_at: string | null;
 
+  /**
+   * The Interest Rate currently being earned on the account, as a string containing
+   * a decimal number. For example, a 1% interest rate would be represented as
+   * "0.01".
+   */
+  interest_rate: string;
+
   /**
    * The name you choose for the Account.
    */
@@ -125,22 +125,6 @@ export interface Account {
   type: 'account';
 }
 
-export namespace Account {
-  export interface Balances {
-    /**
-     * The Account's available balance, representing the current balance less any open
-     * Pending Transactions on the Account.
-     */
-    available_balance: number;
-
-    /**
-     * The Account's current balance, representing the sum of all posted Transactions
-     * on the Account.
-     */
-    current_balance: number;
-  }
-}
-
 export interface AccountCreateParams {
   /**
    * The name you choose for the Account.
@@ -157,6 +141,12 @@ export interface AccountCreateParams {
    * with its activity. Its relationship to your group must be `informational`.
    */
   informational_entity_id?: string;
+
+  /**
+   * The identifier for the Program that this Account falls under. Required if you
+   * operate more than one Program.
+   */
+  program_id?: string;
 }
 
 export interface AccountUpdateParams {
@@ -167,13 +157,48 @@ export interface AccountUpdateParams {
 }
 
 export interface AccountListParams extends PageParams {
+  created_at?: AccountListParams.CreatedAt;
+
   /**
    * Filter Accounts for those belonging to the specified Entity.
    */
   entity_id?: string;
 
+  /**
+   * Filter Accounts for those belonging to the specified Entity as informational.
+   */
+  informational_entity_id?: string;
+
   /**
    * Filter Accounts for those with the specified status.
    */
   status?: 'open' | 'closed';
 }
+
+export namespace AccountListParams {
+  export interface CreatedAt {
+    /**
+     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    after?: string;
+
+    /**
+     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    before?: string;
+
+    /**
+     * Return results on or after this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_after?: string;
+
+    /**
+     * Return results on or before this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_before?: string;
+  }
+}

package/resources/ach-prenotifications.ts

@@ -41,7 +41,6 @@ export class ACHPrenotifications extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/ach_prenotifications', ACHPrenotificationsPage, { query, ...options });
   }
 }
@@ -127,6 +126,9 @@ export interface ACHPrenotification {
 }
 
 export namespace ACHPrenotification {
+  /**
+   * If your prenotification is returned, this will contain details of the return.
+   */
   export interface PrenotificationReturn {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which