increase 0.8.0 → 0.9.0

package/src/resources/account-statements.ts

@@ -3,17 +3,14 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class AccountStatements extends APIResource {
   /**
    * Retrieve an Account Statement
    */
-  retrieve(
-    accountStatementId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountStatement>> {
+  retrieve(accountStatementId: string, options?: Core.RequestOptions): Core.APIPromise<AccountStatement> {
     return this.get(`/account_statements/${accountStatementId}`, options);
   }
 
@@ -23,12 +20,12 @@ export class AccountStatements extends APIResource {
   list(
     query?: AccountStatementListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountStatementsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<AccountStatementsPage>;
+  ): Core.PagePromise<AccountStatementsPage, AccountStatement>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountStatementsPage, AccountStatement>;
   list(
     query: AccountStatementListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountStatementsPage> {
+  ): Core.PagePromise<AccountStatementsPage, AccountStatement> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/account-transfers.ts

@@ -3,27 +3,21 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class AccountTransfers extends APIResource {
   /**
    * Create an Account Transfer
    */
-  create(
-    body: AccountTransferCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountTransfer>> {
+  create(body: AccountTransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<AccountTransfer> {
     return this.post('/account_transfers', { body, ...options });
   }
 
   /**
    * Retrieve an Account Transfer
    */
-  retrieve(
-    accountTransferId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountTransfer>> {
+  retrieve(accountTransferId: string, options?: Core.RequestOptions): Core.APIPromise<AccountTransfer> {
     return this.get(`/account_transfers/${accountTransferId}`, options);
   }
 
@@ -33,12 +27,12 @@ export class AccountTransfers extends APIResource {
   list(
     query?: AccountTransferListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountTransfersPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<AccountTransfersPage>;
+  ): Core.PagePromise<AccountTransfersPage, AccountTransfer>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountTransfersPage, AccountTransfer>;
   list(
     query: AccountTransferListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountTransfersPage> {
+  ): Core.PagePromise<AccountTransfersPage, AccountTransfer> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -48,20 +42,14 @@ export class AccountTransfers extends APIResource {
   /**
    * Approve an Account Transfer
    */
-  approve(
-    accountTransferId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountTransfer>> {
+  approve(accountTransferId: string, options?: Core.RequestOptions): Core.APIPromise<AccountTransfer> {
     return this.post(`/account_transfers/${accountTransferId}/approve`, options);
   }
 
   /**
    * Cancel an Account Transfer
    */
-  cancel(
-    accountTransferId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<AccountTransfer>> {
+  cancel(accountTransferId: string, options?: Core.RequestOptions): Core.APIPromise<AccountTransfer> {
     return this.post(`/account_transfers/${accountTransferId}/cancel`, options);
   }
 }

package/src/resources/accounts.ts

@@ -3,21 +3,21 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class Accounts extends APIResource {
   /**
    * Create an Account
    */
-  create(body: AccountCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Account>> {
+  create(body: AccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<Account> {
     return this.post('/accounts', { body, ...options });
   }
 
   /**
    * Retrieve an Account
    */
-  retrieve(accountId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Account>> {
+  retrieve(accountId: string, options?: Core.RequestOptions): Core.APIPromise<Account> {
     return this.get(`/accounts/${accountId}`, options);
   }
 
@@ -28,19 +28,19 @@ export class Accounts extends APIResource {
     accountId: string,
     body: AccountUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Account>> {
+  ): Core.APIPromise<Account> {
     return this.patch(`/accounts/${accountId}`, { body, ...options });
   }
 
   /**
    * List Accounts
    */
-  list(query?: AccountListParams, options?: Core.RequestOptions): Core.PagePromise<AccountsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<AccountsPage>;
+  list(query?: AccountListParams, options?: Core.RequestOptions): Core.PagePromise<AccountsPage, Account>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountsPage, Account>;
   list(
     query: AccountListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<AccountsPage> {
+  ): Core.PagePromise<AccountsPage, Account> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -50,7 +50,7 @@ export class Accounts extends APIResource {
   /**
    * Close an Account
    */
-  close(accountId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Account>> {
+  close(accountId: string, options?: Core.RequestOptions): Core.APIPromise<Account> {
     return this.post(`/accounts/${accountId}/close`, options);
   }
 }

package/src/resources/ach-prenotifications.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class ACHPrenotifications extends APIResource {
@@ -13,17 +13,14 @@ export class ACHPrenotifications extends APIResource {
   create(
     body: ACHPrenotificationCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ACHPrenotification>> {
+  ): Core.APIPromise<ACHPrenotification> {
     return this.post('/ach_prenotifications', { body, ...options });
   }
 
   /**
    * Retrieve an ACH Prenotification
    */
-  retrieve(
-    achPrenotificationId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ACHPrenotification>> {
+  retrieve(achPrenotificationId: string, options?: Core.RequestOptions): Core.APIPromise<ACHPrenotification> {
     return this.get(`/ach_prenotifications/${achPrenotificationId}`, options);
   }
 
@@ -33,12 +30,12 @@ export class ACHPrenotifications extends APIResource {
   list(
     query?: ACHPrenotificationListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ACHPrenotificationsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ACHPrenotificationsPage>;
+  ): Core.PagePromise<ACHPrenotificationsPage, ACHPrenotification>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ACHPrenotificationsPage, ACHPrenotification>;
   list(
     query: ACHPrenotificationListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ACHPrenotificationsPage> {
+  ): Core.PagePromise<ACHPrenotificationsPage, ACHPrenotification> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -109,6 +106,12 @@ export interface ACHPrenotification {
    */
   effective_date: string | null;
 
+  /**
+   * If the receiving bank notifies that future transfers should use different
+   * details, this will contain those details.
+   */
+  notifications_of_change: Array<ACHPrenotification.NotificationsOfChange>;
+
   /**
    * If your prenotification is returned, this will contain details of the return.
    */
@@ -137,6 +140,51 @@ export interface ACHPrenotification {
 }
 
 export namespace ACHPrenotification {
+  export interface NotificationsOfChange {
+    /**
+     * The type of change that occurred.
+     *
+     * - `incorrect_account_number` - The account number was incorrect.
+     * - `incorrect_routing_number` - The routing number was incorrect.
+     * - `incorrect_routing_number_and_account_number` - Both the routing number and
+     *   the account number were incorrect.
+     * - `incorrect_transaction_code` - The transaction code was incorrect.
+     * - `incorrect_account_number_and_transaction_code` - The account number and the
+     *   transaction code were incorrect.
+     * - `incorrect_routing_number_account_number_and_transaction_code` - The routing
+     *   number, account number, and transaction code were incorrect.
+     * - `incorrect_receiving_depository_financial_institution_identification` - The
+     *   receiving depository financial institution identification was incorrect.
+     * - `incorrect_individual_identification_number` - The individual identification
+     *   number was incorrect.
+     * - `addenda_format_error` - The addenda had an incorrect format.
+     * - `incorrect_standard_entry_class_code_for_outbound_international_payment` - The
+     *   standard entry class code was incorrect for an outbound international payment.
+     */
+    change_code:
+      | 'incorrect_account_number'
+      | 'incorrect_routing_number'
+      | 'incorrect_routing_number_and_account_number'
+      | 'incorrect_transaction_code'
+      | 'incorrect_account_number_and_transaction_code'
+      | 'incorrect_routing_number_account_number_and_transaction_code'
+      | 'incorrect_receiving_depository_financial_institution_identification'
+      | 'incorrect_individual_identification_number'
+      | 'addenda_format_error'
+      | 'incorrect_standard_entry_class_code_for_outbound_international_payment';
+
+    /**
+     * The corrected data.
+     */
+    corrected_data: string;
+
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the notification occurred.
+     */
+    created_at: string;
+  }
+
   /**
    * If your prenotification is returned, this will contain details of the return.
    */

package/src/resources/ach-transfers.ts

@@ -3,36 +3,36 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class ACHTransfers extends APIResource {
   /**
    * Create an ACH Transfer
    */
-  create(
-    body: ACHTransferCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ACHTransfer>> {
+  create(body: ACHTransferCreateParams, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer> {
     return this.post('/ach_transfers', { body, ...options });
   }
 
   /**
    * Retrieve an ACH Transfer
    */
-  retrieve(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>> {
+  retrieve(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer> {
     return this.get(`/ach_transfers/${achTransferId}`, options);
   }
 
   /**
    * List ACH Transfers
    */
-  list(query?: ACHTransferListParams, options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage>;
+  list(
+    query?: ACHTransferListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ACHTransfersPage, ACHTransfer>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ACHTransfersPage, ACHTransfer>;
   list(
     query: ACHTransferListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ACHTransfersPage> {
+  ): Core.PagePromise<ACHTransfersPage, ACHTransfer> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -42,14 +42,14 @@ export class ACHTransfers extends APIResource {
   /**
    * Approves an ACH Transfer in a pending_approval state.
    */
-  approve(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>> {
+  approve(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer> {
     return this.post(`/ach_transfers/${achTransferId}/approve`, options);
   }
 
   /**
    * Cancels an ACH Transfer in a pending_approval state.
    */
-  cancel(achTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<ACHTransfer>> {
+  cancel(achTransferId: string, options?: Core.RequestOptions): Core.APIPromise<ACHTransfer> {
     return this.post(`/ach_transfers/${achTransferId}/cancel`, options);
   }
 }
@@ -589,6 +589,14 @@ export namespace ACHTransfer {
    * details.
    */
   export interface Submission {
+    /**
+     * When the funds transfer is expected to settle in the recipient's account.
+     * Credits may be available sooner, at the receiving banks discretion. The FedACH
+     * schedule is published
+     * [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
+     */
+    expected_funds_settlement_at: string;
+
     /**
      * When the ACH transfer was sent to FedACH.
      */

package/src/resources/balance-lookups.ts

@@ -2,7 +2,7 @@
 
 import * as Core from '../core';
 import { APIResource } from '../resource';
-import * as API from '.';
+import * as API from './index';
 
 export class BalanceLookups extends APIResource {
   /**
@@ -11,7 +11,7 @@ export class BalanceLookups extends APIResource {
   lookup(
     body: BalanceLookupLookupParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<BalanceLookupLookupResponse>> {
+  ): Core.APIPromise<BalanceLookupLookupResponse> {
     return this.post('/balance_lookups', { body, ...options });
   }
 }

package/src/resources/bookkeeping-accounts.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class BookkeepingAccounts extends APIResource {
@@ -13,7 +13,7 @@ export class BookkeepingAccounts extends APIResource {
   create(
     body: BookkeepingAccountCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<BookkeepingAccount>> {
+  ): Core.APIPromise<BookkeepingAccount> {
     return this.post('/bookkeeping_accounts', { body, ...options });
   }
 
@@ -23,12 +23,12 @@ export class BookkeepingAccounts extends APIResource {
   list(
     query?: BookkeepingAccountListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<BookkeepingAccountsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingAccountsPage>;
+  ): Core.PagePromise<BookkeepingAccountsPage, BookkeepingAccount>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingAccountsPage, BookkeepingAccount>;
   list(
     query: BookkeepingAccountListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<BookkeepingAccountsPage> {
+  ): Core.PagePromise<BookkeepingAccountsPage, BookkeepingAccount> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/bookkeeping-entries.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class BookkeepingEntries extends APIResource {
@@ -13,12 +13,12 @@ export class BookkeepingEntries extends APIResource {
   list(
     query?: BookkeepingEntryListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<BookkeepingEntriesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingEntriesPage>;
+  ): Core.PagePromise<BookkeepingEntriesPage, BookkeepingEntry>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingEntriesPage, BookkeepingEntry>;
   list(
     query: BookkeepingEntryListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<BookkeepingEntriesPage> {
+  ): Core.PagePromise<BookkeepingEntriesPage, BookkeepingEntry> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/bookkeeping-entry-sets.ts

@@ -2,7 +2,7 @@
 
 import * as Core from '../core';
 import { APIResource } from '../resource';
-import * as API from '.';
+import * as API from './index';
 
 export class BookkeepingEntrySets extends APIResource {
   /**
@@ -11,7 +11,7 @@ export class BookkeepingEntrySets extends APIResource {
   create(
     body: BookkeepingEntrySetCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<BookkeepingEntrySet>> {
+  ): Core.APIPromise<BookkeepingEntrySet> {
     return this.post('/bookkeeping_entry_sets', { body, ...options });
   }
 }

package/src/resources/card-disputes.ts

@@ -3,36 +3,36 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class CardDisputes extends APIResource {
   /**
    * Create a Card Dispute
    */
-  create(
-    body: CardDisputeCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<CardDispute>> {
+  create(body: CardDisputeCreateParams, options?: Core.RequestOptions): Core.APIPromise<CardDispute> {
     return this.post('/card_disputes', { body, ...options });
   }
 
   /**
    * Retrieve a Card Dispute
    */
-  retrieve(cardDisputeId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<CardDispute>> {
+  retrieve(cardDisputeId: string, options?: Core.RequestOptions): Core.APIPromise<CardDispute> {
     return this.get(`/card_disputes/${cardDisputeId}`, options);
   }
 
   /**
    * List Card Disputes
    */
-  list(query?: CardDisputeListParams, options?: Core.RequestOptions): Core.PagePromise<CardDisputesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<CardDisputesPage>;
+  list(
+    query?: CardDisputeListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CardDisputesPage, CardDispute>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CardDisputesPage, CardDispute>;
   list(
     query: CardDisputeListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<CardDisputesPage> {
+  ): Core.PagePromise<CardDisputesPage, CardDispute> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/card-profiles.ts

@@ -3,41 +3,48 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class CardProfiles extends APIResource {
   /**
    * Create a Card Profile
    */
-  create(
-    body: CardProfileCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<CardProfile>> {
+  create(body: CardProfileCreateParams, options?: Core.RequestOptions): Core.APIPromise<CardProfile> {
     return this.post('/card_profiles', { body, ...options });
   }
 
   /**
    * Retrieve a Card Profile
    */
-  retrieve(cardProfileId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<CardProfile>> {
+  retrieve(cardProfileId: string, options?: Core.RequestOptions): Core.APIPromise<CardProfile> {
     return this.get(`/card_profiles/${cardProfileId}`, options);
   }
 
   /**
    * List Card Profiles
    */
-  list(query?: CardProfileListParams, options?: Core.RequestOptions): Core.PagePromise<CardProfilesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<CardProfilesPage>;
+  list(
+    query?: CardProfileListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CardProfilesPage, CardProfile>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CardProfilesPage, CardProfile>;
   list(
     query: CardProfileListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<CardProfilesPage> {
+  ): Core.PagePromise<CardProfilesPage, CardProfile> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
     return this.getAPIList('/card_profiles', CardProfilesPage, { query, ...options });
   }
+
+  /**
+   * Archive an Card Profile
+   */
+  archive(cardProfileId: string, options?: Core.RequestOptions): Core.APIPromise<CardProfile> {
+    return this.post(`/card_profiles/${cardProfileId}/archive`, options);
+  }
 }
 
 export class CardProfilesPage extends Page<CardProfile> {}
@@ -72,6 +79,11 @@ export interface CardProfile {
    */
   digital_wallets: CardProfile.DigitalWallets;
 
+  /**
+   * Whether this Card Profile is the default for all cards in its Increase group.
+   */
+  is_default: boolean;
+
   /**
    * How physical cards should be designed and shipped.
    */
@@ -171,22 +183,36 @@ export namespace CardProfile {
     /**
      * The identifier of the File containing the physical card's back image.
      */
-    back_image_file_id: string;
+    back_image_file_id: string | null;
 
     /**
      * The identifier of the File containing the physical card's carrier image.
      */
-    carrier_image_file_id: string;
+    carrier_image_file_id: string | null;
 
     /**
      * A phone number the user can contact to receive support for their card.
      */
-    contact_phone: string;
+    contact_phone: string | null;
 
     /**
      * The identifier of the File containing the physical card's front image.
      */
-    front_image_file_id: string;
+    front_image_file_id: string | null;
+
+    /**
+     * The status of the Physical Card Profile.
+     *
+     * - `not_eligible` - The Card Profile is not eligible for physical cards.
+     * - `rejected` - There is an issue with the Physical Card Profile preventing it
+     *   from use.
+     * - `pending_reviewing` - The card profile is awaiting review by Increase.
+     * - `pending_submitting` - The card profile is awaiting submission to the
+     *   fulfillment provider.
+     * - `submitted` - The Physical Card Profile has been submitted to the fulfillment
+     *   provider.
+     */
+    status: 'not_eligible' | 'rejected' | 'pending_reviewing' | 'pending_submitting' | 'submitted';
   }
 }