increase 0.2.0 → 0.4.0

package/resources/ach-transfers.ts

@@ -35,7 +35,6 @@ export class ACHTransfers extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/ach_transfers', ACHTransfersPage, { query, ...options });
   }
 
@@ -127,6 +126,12 @@ export interface ACHTransfer {
    */
   currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
+  /**
+   * The transfer effective date in
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  effective_date: string | null;
+
   /**
    * The identifier of the External Account the transfer was made to, if any.
    */
@@ -162,7 +167,7 @@ export interface ACHTransfer {
    * If the receiving bank accepts the transfer but notifies that future transfers
    * should use different details, this will contain those details.
    */
-  notification_of_change: ACHTransfer.NotificationOfChange | null;
+  notifications_of_change: Array<ACHTransfer.NotificationsOfChange>;
 
   /**
    * If your transfer is returned, this will contain details of the return.
@@ -193,6 +198,7 @@ export interface ACHTransfer {
   status:
     | 'pending_approval'
     | 'canceled'
+    | 'pending_reviewing'
     | 'pending_submission'
     | 'submitted'
     | 'returned'
@@ -205,11 +211,6 @@ export interface ACHTransfer {
    */
   submission: ACHTransfer.Submission | null;
 
-  /**
-   * If the transfer was created from a template, this will be the template's ID.
-   */
-  template_id: string | null;
-
   /**
    * The ID for the transaction funding the transfer.
    */
@@ -223,23 +224,43 @@ export interface ACHTransfer {
 }
 
 export namespace ACHTransfer {
+  /**
+   * 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;
   }
 
-  export interface NotificationOfChange {
+  export interface NotificationsOfChange {
     /**
      * The type of change that occurred.
      */
@@ -257,6 +278,9 @@ export namespace ACHTransfer {
     created_at: string;
   }
 
+  /**
+   * If your transfer is returned, this will contain details of the return.
+   */
   export interface Return {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -264,6 +288,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.
      */
@@ -287,10 +316,58 @@ 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';
+      | '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.
@@ -303,6 +380,10 @@ export namespace ACHTransfer {
     transfer_id: string;
   }
 
+  /**
+   * After the transfer is submitted to FedACH, this will contain supplemental
+   * details.
+   */
   export interface Submission {
     /**
      * When the ACH transfer was sent to FedACH.
@@ -351,7 +432,7 @@ export interface ACHTransferCreateParams {
   addendum?: string;
 
   /**
-   * The description of the date of the transfer, usually in the format `YYYYMMDD`.
+   * 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.
    */
   company_descriptive_date?: string;

package/resources/balance-lookups.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+
+export class BalanceLookups extends APIResource {
+  /**
+   * Look up the balance for an Account
+   */
+  lookup(
+    body: BalanceLookupLookupParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<BalanceLookupLookupResponse>> {
+    return this.post('/balance_lookups', { body, ...options });
+  }
+}
+
+/**
+ * Represents a request to lookup the balance of an Account at a given point in
+ * time.
+ */
+export interface BalanceLookupLookupResponse {
+  /**
+   * The identifier for the account for which the balance was queried.
+   */
+  account_id: string;
+
+  /**
+   * 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;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `balance_lookup`.
+   */
+  type: 'balance_lookup';
+}
+
+export interface BalanceLookupLookupParams {
+  /**
+   * The Account to query the balance for.
+   */
+  account_id: string;
+
+  /**
+   * The moment to query the balance at. If not set, returns the current balances.
+   */
+  at_time?: string;
+}

package/resources/bookkeeping-accounts.ts

@@ -0,0 +1,98 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class BookkeepingAccounts extends APIResource {
+  /**
+   * Create a Bookkeeping Account
+   */
+  create(
+    body: BookkeepingAccountCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<BookkeepingAccount>> {
+    return this.post('/bookkeeping_accounts', { body, ...options });
+  }
+
+  /**
+   * List Bookkeeping Accounts
+   */
+  list(
+    query?: BookkeepingAccountListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingAccountsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingAccountsPage>;
+  list(
+    query: BookkeepingAccountListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingAccountsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/bookkeeping_accounts', BookkeepingAccountsPage, { query, ...options });
+  }
+}
+
+export class BookkeepingAccountsPage extends Page<BookkeepingAccount> {}
+
+/**
+ * Accounts are T-accounts. They can store accounting entries.
+ */
+export interface BookkeepingAccount {
+  /**
+   * The API Account associated with this bookkeeping account.
+   */
+  account_id: string | null;
+
+  /**
+   * The compliance category of the account.
+   */
+  compliance_category: 'commingled_cash' | 'customer_balance' | null;
+
+  /**
+   * The Entity associated with this bookkeeping account.
+   */
+  entity_id: string | null;
+
+  /**
+   * The account identifier.
+   */
+  id: string;
+
+  /**
+   * The name you choose for the account.
+   */
+  name: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `bookkeeping_account`.
+   */
+  type: 'bookkeeping_account';
+}
+
+export interface BookkeepingAccountCreateParams {
+  /**
+   * The name you choose for the account.
+   */
+  name: string;
+
+  /**
+   * The entity, if `compliance_category` is `commingled_cash`.
+   */
+  account_id?: string;
+
+  /**
+   * The account compliance category.
+   */
+  compliance_category?: 'commingled_cash' | 'customer_balance';
+
+  /**
+   * The entity, if `compliance_category` is `customer_balance`.
+   */
+  entity_id?: string;
+}
+
+export interface BookkeepingAccountListParams extends PageParams {}

package/resources/bookkeeping-entries.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class BookkeepingEntries extends APIResource {
+  /**
+   * List Bookkeeping Entries
+   */
+  list(
+    query?: BookkeepingEntryListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingEntriesPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingEntriesPage>;
+  list(
+    query: BookkeepingEntryListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingEntriesPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/bookkeeping_entries', BookkeepingEntriesPage, { query, ...options });
+  }
+}
+
+export class BookkeepingEntriesPage extends Page<BookkeepingEntry> {}
+
+/**
+ * Entries are T-account entries recording debits and credits.
+ */
+export interface BookkeepingEntry {
+  /**
+   * The identifier for the Account the Entry belongs to.
+   */
+  account_id: string;
+
+  /**
+   * The Entry amount in the minor unit of its currency. For dollars, for example,
+   * this is cents.
+   */
+  amount: number;
+
+  /**
+   * The identifier for the Account the Entry belongs to.
+   */
+  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`.
+   */
+  type: 'bookkeeping_entry';
+}
+
+export interface BookkeepingEntryListParams extends PageParams {}

package/resources/bookkeeping-entry-sets.ts

@@ -0,0 +1,100 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+
+export class BookkeepingEntrySets extends APIResource {
+  /**
+   * Create a Bookkeeping Entry Set
+   */
+  create(
+    body: BookkeepingEntrySetCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<BookkeepingEntrySet>> {
+    return this.post('/bookkeeping_entry_sets', { body, ...options });
+  }
+}
+
+/**
+ * Entry Sets are accounting entries that are transactionally applied.
+ */
+export interface BookkeepingEntrySet {
+  /**
+   * The timestamp of the entry set.
+   */
+  date: string;
+
+  /**
+   * The entries
+   */
+  entries: Array<BookkeepingEntrySet.Entries>;
+
+  /**
+   * The entry set identifier.
+   */
+  id: string;
+
+  /**
+   * The transaction identifier, if any.
+   */
+  transaction_id: string | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `bookkeeping_entry_set`.
+   */
+  type: 'bookkeeping_entry_set';
+}
+
+export namespace BookkeepingEntrySet {
+  export interface Entries {
+    /**
+     * The bookkeeping account impacted by the entry.
+     */
+    account_id: string;
+
+    /**
+     * The amount of the entry in minor units.
+     */
+    amount: number;
+
+    /**
+     * The entry identifier.
+     */
+    id: string;
+  }
+}
+
+export interface BookkeepingEntrySetCreateParams {
+  /**
+   * The bookkeeping entries.
+   */
+  entries: Array<BookkeepingEntrySetCreateParams.Entries>;
+
+  /**
+   * The date of the transaction. If `transaction_id` is provided, this must match
+   * the `created_at` field on that resource.
+   */
+  date?: string;
+
+  /**
+   * The identifier of the Transaction related to this entry set, if any.
+   */
+  transaction_id?: string;
+}
+
+export namespace BookkeepingEntrySetCreateParams {
+  export interface Entries {
+    /**
+     * The identifier for the Bookkeeping Account impacted by this entry.
+     */
+    account_id: string;
+
+    /**
+     * The entry amount in the minor unit of the account currency. For dollars, for
+     * example, this is cents. Debit entries have positive amounts; credit entries have
+     * negative amounts.
+     */
+    amount: number;
+  }
+}

package/resources/card-disputes.ts

@@ -35,7 +35,6 @@ export class CardDisputes extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/card_disputes', CardDisputesPage, { query, ...options });
   }
 }
@@ -93,6 +92,10 @@ export interface CardDispute {
 }
 
 export namespace CardDispute {
+  /**
+   * If the Card Dispute's status is `accepted`, this will contain details of the
+   * successful dispute.
+   */
   export interface Acceptance {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -109,9 +112,13 @@ export namespace CardDispute {
      * The identifier of the Transaction that was created to return the disputed funds
      * to your account.
      */
-    transaction_id: string | null;
+    transaction_id: string;
   }
 
+  /**
+   * If the Card Dispute's status is `rejected`, this will contain details of the
+   * unsuccessful dispute.
+   */
   export interface Rejection {
     /**
      * The identifier of the Card Dispute that was rejected.
@@ -179,8 +186,9 @@ export namespace CardDisputeListParams {
 
   export interface Status {
     /**
-     * Return results whose value is in the provided list. For GET requests, this
-     * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+     * Filter Card Disputes for those with the specified status or statuses. For GET
+     * requests, this should be encoded as a comma-delimited string, such as
+     * `?in=one,two,three`.
      */
     in?: Array<'pending_reviewing' | 'accepted' | 'rejected'>;
   }

package/resources/card-profiles.ts

@@ -35,7 +35,6 @@ export class CardProfiles extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/card_profiles', CardProfilesPage, { query, ...options });
   }
 }
@@ -83,6 +82,10 @@ export interface CardProfile {
 }
 
 export namespace CardProfile {
+  /**
+   * How Cards should appear in digital wallets such as Apple Pay. Different wallets
+   * will use these values to render card artwork appropriately for their app.
+   */
   export interface DigitalWallets {
     /**
      * The identifier of the File containing the card's icon image.
@@ -126,6 +129,9 @@ export namespace CardProfile {
   }
 
   export namespace DigitalWallets {
+    /**
+     * The Card's text color, specified as an RGB triple.
+     */
     export interface TextColor {
       /**
        * The value of the blue channel in the RGB color.
@@ -159,6 +165,10 @@ export interface CardProfileCreateParams {
 }
 
 export namespace CardProfileCreateParams {
+  /**
+   * How Cards should appear in digital wallets such as Apple Pay. Different wallets
+   * will use these values to render card artwork appropriately for their app.
+   */
   export interface DigitalWallets {
     /**
      * The identifier of the File containing the card's icon image.
@@ -202,6 +212,9 @@ export namespace CardProfileCreateParams {
   }
 
   export namespace DigitalWallets {
+    /**
+     * The Card's text color, specified as an RGB triple. The default is white.
+     */
     export interface TextColor {
       /**
        * The value of the blue channel in the RGB color.
@@ -228,8 +241,9 @@ export interface CardProfileListParams extends PageParams {
 export namespace CardProfileListParams {
   export interface Status {
     /**
-     * Return results whose value is in the provided list. For GET requests, this
-     * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+     * Filter Card Profiles for those with the specified status or statuses. For GET
+     * requests, this should be encoded as a comma-delimited string, such as
+     * `?in=one,two,three`.
      */
     in?: Array<'pending' | 'rejected' | 'active' | 'archived'>;
   }

package/resources/cards.ts

@@ -43,7 +43,6 @@ export class Cards extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/cards', CardsPage, { query, ...options });
   }
 
@@ -128,6 +127,9 @@ export interface Card {
 }
 
 export namespace Card {
+  /**
+   * The Card's billing address.
+   */
   export interface BillingAddress {
     /**
      * The city of the billing address.
@@ -155,6 +157,11 @@ export namespace Card {
     state: string | null;
   }
 
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
   export interface DigitalWallet {
     /**
      * The card profile assigned to this digital card. Card profiles may also be
@@ -232,13 +239,18 @@ export interface CardCreateParams {
 
   /**
    * The contact information used in the two-factor steps for digital wallet card
-   * creation. At least one field must be present to complete the digital wallet
-   * steps.
+   * creation. To add the card to a digital wallet, you may supply an email or phone
+   * number with this request. Otherwise, subscribe and then action a Real Time
+   * Decision with the category `digital_wallet_token_requested` or
+   * `digital_wallet_authentication_requested`.
    */
   digital_wallet?: CardCreateParams.DigitalWallet;
 }
 
 export namespace CardCreateParams {
+  /**
+   * The card's billing address.
+   */
   export interface BillingAddress {
     /**
      * The city of the billing address.
@@ -266,6 +278,13 @@ export namespace CardCreateParams {
     line2?: string;
   }
 
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. To add the card to a digital wallet, you may supply an email or phone
+   * number with this request. Otherwise, subscribe and then action a Real Time
+   * Decision with the category `digital_wallet_token_requested` or
+   * `digital_wallet_authentication_requested`.
+   */
   export interface DigitalWallet {
     /**
      * The card profile assigned to this digital card. Card profiles may also be
@@ -312,6 +331,9 @@ export interface CardUpdateParams {
 }
 
 export namespace CardUpdateParams {
+  /**
+   * The card's updated billing address.
+   */
   export interface BillingAddress {
     /**
      * The city of the billing address.
@@ -339,6 +361,11 @@ export namespace CardUpdateParams {
     line2?: string;
   }
 
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
   export interface DigitalWallet {
     /**
      * The card profile assigned to this digital card. Card profiles may also be