increase 0.3.0 → 0.5.0

package/resources/account-statements.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class AccountStatements extends APIResource {
@@ -43,6 +44,11 @@ export class AccountStatementsPage extends Page<AccountStatement> {}
  * its associated File.
  */
 export interface AccountStatement {
+  /**
+   * The Account Statement identifier.
+   */
+  id: string;
+
   /**
    * The identifier for the Account this Account Statement belongs to.
    */
@@ -64,11 +70,6 @@ export interface AccountStatement {
    */
   file_id: string;
 
-  /**
-   * The Account Statement identifier.
-   */
-  id: string;
-
   /**
    * The Account's balance at the start of its statement period.
    */
@@ -99,29 +100,7 @@ export interface AccountStatementListParams extends PageParams {
    */
   account_id?: string;
 
-  /**
-   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'statement_period_start.after'?: string;
-
-  /**
-   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'statement_period_start.before'?: string;
-
-  /**
-   * Return results on or after this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'statement_period_start.on_or_after'?: string;
-
-  /**
-   * Return results on or before this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'statement_period_start.on_or_before'?: string;
+  statement_period_start?: AccountStatementListParams.StatementPeriodStart;
 }
 
 export namespace AccountStatementListParams {
@@ -151,3 +130,9 @@ export namespace AccountStatementListParams {
     on_or_before?: string;
   }
 }
+
+export namespace AccountStatements {
+  export import AccountStatement = API.AccountStatement;
+  export import AccountStatementsPage = API.AccountStatementsPage;
+  export import AccountStatementListParams = API.AccountStatementListParams;
+}

package/resources/account-transfers.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class AccountTransfers extends APIResource {
@@ -71,6 +72,11 @@ export class AccountTransfersPage extends Page<AccountTransfer> {}
  * Account transfers move funds between your own accounts at Increase.
  */
 export interface AccountTransfer {
+  /**
+   * The account transfer's identifier.
+   */
+  id: string;
+
   /**
    * The Account to which the transfer belongs.
    */
@@ -121,11 +127,6 @@ export interface AccountTransfer {
    */
   destination_transaction_id: string | null;
 
-  /**
-   * The account transfer's identifier.
-   */
-  id: string;
-
   /**
    * The transfer's network.
    */
@@ -220,29 +221,7 @@ export interface AccountTransferListParams extends PageParams {
    */
   account_id?: string;
 
-  /**
-   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.after'?: string;
-
-  /**
-   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.before'?: string;
-
-  /**
-   * Return results on or after this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_after'?: string;
-
-  /**
-   * Return results on or before this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_before'?: string;
+  created_at?: AccountTransferListParams.CreatedAt;
 }
 
 export namespace AccountTransferListParams {
@@ -272,3 +251,10 @@ export namespace AccountTransferListParams {
     on_or_before?: string;
   }
 }
+
+export namespace AccountTransfers {
+  export import AccountTransfer = API.AccountTransfer;
+  export import AccountTransfersPage = API.AccountTransfersPage;
+  export import AccountTransferCreateParams = API.AccountTransferCreateParams;
+  export import AccountTransferListParams = API.AccountTransferListParams;
+}

package/resources/accounts.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class Accounts extends APIResource {
@@ -61,6 +62,11 @@ export class AccountsPage extends Page<Account> {}
  * transfers, and send payments. They earn interest and have depository insurance.
  */
 export interface Account {
+  /**
+   * The Account identifier.
+   */
+  id: string;
+
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
    * was created.
@@ -78,11 +84,6 @@ export interface Account {
    */
   entity_id: string | null;
 
-  /**
-   * The Account identifier.
-   */
-  id: string;
-
   /**
    * The identifier of an Entity that, while not owning the Account, is associated
    * with its activity.
@@ -101,6 +102,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.
    */
@@ -119,6 +127,11 @@ export interface Account {
 }
 
 export interface AccountCreateParams {
+  /**
+   * The name you choose for the Account.
+   */
+  name: string;
+
   /**
    * The identifier for the Entity that will own the Account.
    */
@@ -131,12 +144,8 @@ export interface AccountCreateParams {
   informational_entity_id?: string;
 
   /**
-   * The name you choose for the Account.
-   */
-  name: string;
-
-  /**
-   * The identifier for the Program that this Account falls under.
+   * The identifier for the Program that this Account falls under. Required if you
+   * operate more than one Program.
    */
   program_id?: string;
 }
@@ -149,34 +158,17 @@ export interface AccountUpdateParams {
 }
 
 export interface AccountListParams extends PageParams {
-  /**
-   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.after'?: string;
+  created_at?: AccountListParams.CreatedAt;
 
   /**
-   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.before'?: string;
-
-  /**
-   * Return results on or after this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_after'?: string;
-
-  /**
-   * Return results on or before this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   * Filter Accounts for those belonging to the specified Entity.
    */
-  'created_at.on_or_before'?: string;
+  entity_id?: string;
 
   /**
-   * Filter Accounts for those belonging to the specified Entity.
+   * Filter Accounts for those belonging to the specified Entity as informational.
    */
-  entity_id?: string;
+  informational_entity_id?: string;
 
   /**
    * Filter Accounts for those with the specified status.
@@ -211,3 +203,11 @@ export namespace AccountListParams {
     on_or_before?: string;
   }
 }
+
+export namespace Accounts {
+  export import Account = API.Account;
+  export import AccountsPage = API.AccountsPage;
+  export import AccountCreateParams = API.AccountCreateParams;
+  export import AccountUpdateParams = API.AccountUpdateParams;
+  export import AccountListParams = API.AccountListParams;
+}

package/resources/ach-prenotifications.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class ACHPrenotifications extends APIResource {
@@ -52,6 +53,11 @@ export class ACHPrenotificationsPage extends Page<ACHPrenotification> {}
  * Automated Clearing House (ACH).
  */
 export interface ACHPrenotification {
+  /**
+   * The ACH Prenotification's identifier.
+   */
+  id: string;
+
   /**
    * The destination account number.
    */
@@ -98,11 +104,6 @@ export interface ACHPrenotification {
    */
   effective_date: string | null;
 
-  /**
-   * The ACH Prenotification's identifier.
-   */
-  id: string;
-
   /**
    * If your prenotification is returned, this will contain details of the return.
    */
@@ -149,6 +150,12 @@ export interface ACHPrenotificationCreateParams {
    */
   account_number: string;
 
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+   * destination account.
+   */
+  routing_number: string;
+
   /**
    * Additional information that will be sent to the recipient.
    */
@@ -196,12 +203,6 @@ export interface ACHPrenotificationCreateParams {
    */
   individual_name?: string;
 
-  /**
-   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
-   * destination account.
-   */
-  routing_number: string;
-
   /**
    * The Standard Entry Class (SEC) code to use for the ACH Prenotification.
    */
@@ -212,29 +213,7 @@ export interface ACHPrenotificationCreateParams {
 }
 
 export interface ACHPrenotificationListParams extends PageParams {
-  /**
-   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.after'?: string;
-
-  /**
-   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.before'?: string;
-
-  /**
-   * Return results on or after this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_after'?: string;
-
-  /**
-   * Return results on or before this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_before'?: string;
+  created_at?: ACHPrenotificationListParams.CreatedAt;
 }
 
 export namespace ACHPrenotificationListParams {
@@ -264,3 +243,10 @@ export namespace ACHPrenotificationListParams {
     on_or_before?: string;
   }
 }
+
+export namespace ACHPrenotifications {
+  export import ACHPrenotification = API.ACHPrenotification;
+  export import ACHPrenotificationsPage = API.ACHPrenotificationsPage;
+  export import ACHPrenotificationCreateParams = API.ACHPrenotificationCreateParams;
+  export import ACHPrenotificationListParams = API.ACHPrenotificationListParams;
+}

package/resources/ach-transfers.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class ACHTransfers extends APIResource {
@@ -60,6 +61,11 @@ export class ACHTransfersPage extends Page<ACHTransfer> {}
  * accessible by the Automated Clearing House (ACH).
  */
 export interface ACHTransfer {
+  /**
+   * The ACH transfer's identifier.
+   */
+  id: string;
+
   /**
    * The Account to which the transfer belongs.
    */
@@ -142,11 +148,6 @@ export interface ACHTransfer {
    */
   funding: 'checking' | 'savings';
 
-  /**
-   * The ACH transfer's identifier.
-   */
-  id: string;
-
   /**
    * Your identifer for the transfer recipient.
    */
@@ -288,6 +289,11 @@ export namespace ACHTransfer {
      */
     created_at: string;
 
+    /**
+     * The three character ACH return code, in the range R01 to R85.
+     */
+    raw_return_reason_code: string;
+
     /**
      * Why the ACH Transfer was returned.
      */
@@ -311,10 +317,57 @@ export namespace ACHTransfer {
       | 'file_record_edit_criteria'
       | 'enr_invalid_individual_name'
       | 'returned_per_odfi_request'
-      | 'addenda_error'
       | 'limited_participation_dfi'
       | 'incorrectly_coded_outbound_international_payment'
-      | 'other';
+      | 'account_sold_to_another_dfi'
+      | 'addenda_error'
+      | 'beneficiary_or_account_holder_deceased'
+      | 'customer_advised_not_within_authorization_terms'
+      | 'corrected_return'
+      | 'duplicate_entry'
+      | 'duplicate_return'
+      | 'enr_duplicate_enrollment'
+      | 'enr_invalid_dfi_account_number'
+      | 'enr_invalid_individual_id_number'
+      | 'enr_invalid_representative_payee_indicator'
+      | 'enr_invalid_transaction_code'
+      | 'enr_return_of_enr_entry'
+      | 'enr_routing_number_check_digit_error'
+      | 'entry_not_processed_by_gateway'
+      | 'field_error'
+      | 'foreign_receiving_dfi_unable_to_settle'
+      | 'iat_entry_coding_error'
+      | 'improper_effective_entry_date'
+      | 'improper_source_document_source_document_presented'
+      | 'invalid_company_id'
+      | 'invalid_foreign_receiving_dfi_identification'
+      | 'invalid_individual_id_number'
+      | 'item_and_rck_entry_presented_for_payment'
+      | 'item_related_to_rck_entry_is_ineligible'
+      | 'mandatory_field_error'
+      | 'misrouted_dishonored_return'
+      | 'misrouted_return'
+      | 'no_errors_found'
+      | 'non_acceptance_of_r62_dishonored_return'
+      | 'non_participant_in_iat_program'
+      | 'permissible_return_entry'
+      | 'permissible_return_entry_not_accepted'
+      | 'rdfi_non_settlement'
+      | 'rdfi_participant_in_check_truncation_program'
+      | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+      | 'return_not_a_duplicate'
+      | 'return_of_erroneous_or_reversing_debit'
+      | 'return_of_improper_credit_entry'
+      | 'return_of_improper_debit_entry'
+      | 'return_of_xck_entry'
+      | 'source_document_presented_for_payment'
+      | 'state_law_affecting_rck_acceptance'
+      | 'stop_payment_on_item_related_to_rck_entry'
+      | 'stop_payment_on_source_document'
+      | 'timely_original_return'
+      | 'trace_number_error'
+      | 'untimely_dishonored_return'
+      | 'untimely_return';
 
     /**
      * The identifier of the Tranasaction associated with this return.
@@ -350,6 +403,23 @@ export interface ACHTransferCreateParams {
    */
   account_id: string;
 
+  /**
+   * The transfer amount in cents. A positive amount originates a credit transfer
+   * pushing funds to the receiving account. A negative amount originates a debit
+   * transfer pulling funds from the receiving account.
+   */
+  amount: number;
+
+  /**
+   * A description you choose to give the transfer. This will be saved with the
+   * transfer details, displayed in the dashboard, and returned by the API. If
+   * `individual_name` and `company_name` are not explicitly set by this API, the
+   * `statement_descriptor` will be sent in those fields to the receiving bank to
+   * help the customer recognize the transfer. You are highly encouraged to pass
+   * `individual_name` and `company_name` instead of relying on this fallback.
+   */
+  statement_descriptor: string;
+
   /**
    * The account number for the destination account.
    */
@@ -361,13 +431,6 @@ export interface ACHTransferCreateParams {
    */
   addendum?: string;
 
-  /**
-   * The transfer amount in cents. A positive amount originates a credit transfer
-   * pushing funds to the receiving account. A negative amount originates a debit
-   * transfer pulling funds from the receiving account.
-   */
-  amount: number;
-
   /**
    * The description of the date of the transfer, usually in the format `YYMMDD`.
    * This is included in the transfer data sent to the receiving bank.
@@ -438,16 +501,6 @@ export interface ACHTransferCreateParams {
     | 'corporate_credit_or_debit'
     | 'prearranged_payments_and_deposit'
     | 'internet_initiated';
-
-  /**
-   * A description you choose to give the transfer. This will be saved with the
-   * transfer details, displayed in the dashboard, and returned by the API. If
-   * `individual_name` and `company_name` are not explicitly set by this API, the
-   * `statement_descriptor` will be sent in those fields to the receiving bank to
-   * help the customer recognize the transfer. You are highly encouraged to pass
-   * `individual_name` and `company_name` instead of relying on this fallback.
-   */
-  statement_descriptor: string;
 }
 
 export interface ACHTransferListParams extends PageParams {
@@ -456,29 +509,7 @@ export interface ACHTransferListParams extends PageParams {
    */
   account_id?: string;
 
-  /**
-   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.after'?: string;
-
-  /**
-   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-   * timestamp.
-   */
-  'created_at.before'?: string;
-
-  /**
-   * Return results on or after this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_after'?: string;
-
-  /**
-   * Return results on or before this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_before'?: string;
+  created_at?: ACHTransferListParams.CreatedAt;
 
   /**
    * Filter ACH Transfers to those made to the specified External Account.
@@ -513,3 +544,10 @@ export namespace ACHTransferListParams {
     on_or_before?: string;
   }
 }
+
+export namespace ACHTransfers {
+  export import ACHTransfer = API.ACHTransfer;
+  export import ACHTransfersPage = API.ACHTransfersPage;
+  export import ACHTransferCreateParams = API.ACHTransferCreateParams;
+  export import ACHTransferListParams = API.ACHTransferListParams;
+}

package/resources/balance-lookups.ts

@@ -2,6 +2,7 @@
 
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
+import * as API from './';
 
 export class BalanceLookups extends APIResource {
   /**
@@ -55,3 +56,8 @@ export interface BalanceLookupLookupParams {
    */
   at_time?: string;
 }
+
+export namespace BalanceLookups {
+  export import BalanceLookupLookupResponse = API.BalanceLookupLookupResponse;
+  export import BalanceLookupLookupParams = API.BalanceLookupLookupParams;
+}

package/resources/bookkeeping-accounts.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class BookkeepingAccounts extends APIResource {
@@ -41,6 +42,11 @@ export class BookkeepingAccountsPage extends Page<BookkeepingAccount> {}
  * Accounts are T-accounts. They can store accounting entries.
  */
 export interface BookkeepingAccount {
+  /**
+   * The account identifier.
+   */
+  id: string;
+
   /**
    * The API Account associated with this bookkeeping account.
    */
@@ -56,11 +62,6 @@ export interface BookkeepingAccount {
    */
   entity_id: string | null;
 
-  /**
-   * The account identifier.
-   */
-  id: string;
-
   /**
    * The name you choose for the account.
    */
@@ -74,6 +75,11 @@ export interface BookkeepingAccount {
 }
 
 export interface BookkeepingAccountCreateParams {
+  /**
+   * The name you choose for the account.
+   */
+  name: string;
+
   /**
    * The entity, if `compliance_category` is `commingled_cash`.
    */
@@ -88,11 +94,13 @@ export interface BookkeepingAccountCreateParams {
    * The entity, if `compliance_category` is `customer_balance`.
    */
   entity_id?: string;
-
-  /**
-   * The name you choose for the account.
-   */
-  name: string;
 }
 
 export interface BookkeepingAccountListParams extends PageParams {}
+
+export namespace BookkeepingAccounts {
+  export import BookkeepingAccount = API.BookkeepingAccount;
+  export import BookkeepingAccountsPage = API.BookkeepingAccountsPage;
+  export import BookkeepingAccountCreateParams = API.BookkeepingAccountCreateParams;
+  export import BookkeepingAccountListParams = API.BookkeepingAccountListParams;
+}

package/resources/bookkeeping-entries.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class BookkeepingEntries extends APIResource {
@@ -31,6 +32,11 @@ export class BookkeepingEntriesPage extends Page<BookkeepingEntry> {}
  * Entries are T-account entries recording debits and credits.
  */
 export interface BookkeepingEntry {
+  /**
+   * The entry identifier.
+   */
+  id: string;
+
   /**
    * The identifier for the Account the Entry belongs to.
    */
@@ -47,11 +53,6 @@ export interface BookkeepingEntry {
    */
   entry_set_id: string;
 
-  /**
-   * The entry identifier.
-   */
-  id: string;
-
   /**
    * A constant representing the object's type. For this resource it will always be
    * `bookkeeping_entry`.
@@ -60,3 +61,9 @@ export interface BookkeepingEntry {
 }
 
 export interface BookkeepingEntryListParams extends PageParams {}
+
+export namespace BookkeepingEntries {
+  export import BookkeepingEntry = API.BookkeepingEntry;
+  export import BookkeepingEntriesPage = API.BookkeepingEntriesPage;
+  export import BookkeepingEntryListParams = API.BookkeepingEntryListParams;
+}