increase 0.2.0 → 0.3.0

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,60 @@ export interface AccountNumberListParams 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;
+
   /**
    * 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 });
   }
 }
@@ -100,7 +99,29 @@ export interface AccountStatementListParams extends PageParams {
    */
   account_id?: string;
 
-  statement_period_start?: AccountStatementListParams.StatementPeriodStart;
+  /**
+   * 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;
 }
 
 export namespace AccountStatementListParams {

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;
   }
 }
 
@@ -212,7 +220,29 @@ export interface AccountTransferListParams extends PageParams {
    */
   account_id?: string;
 
-  created_at?: AccountTransferListParams.CreatedAt;
+  /**
+   * 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;
 }
 
 export namespace AccountTransferListParams {

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.
@@ -125,28 +118,7 @@ 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.
-   */
-  name: string;
-
   /**
    * The identifier for the Entity that will own the Account.
    */
@@ -157,6 +129,16 @@ export interface AccountCreateParams {
    * with its activity. Its relationship to your group must be `informational`.
    */
   informational_entity_id?: string;
+
+  /**
+   * The name you choose for the Account.
+   */
+  name: string;
+
+  /**
+   * The identifier for the Program that this Account falls under.
+   */
+  program_id?: string;
 }
 
 export interface AccountUpdateParams {
@@ -167,6 +149,30 @@ 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;
+
+  /**
+   * 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;
+
   /**
    * Filter Accounts for those belonging to the specified Entity.
    */
@@ -177,3 +183,31 @@ export interface AccountListParams extends PageParams {
    */
   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
@@ -147,12 +149,6 @@ 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.
    */
@@ -200,6 +196,12 @@ 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.
    */
@@ -210,7 +212,29 @@ export interface ACHPrenotificationCreateParams {
 }
 
 export interface ACHPrenotificationListParams extends PageParams {
-  created_at?: ACHPrenotificationListParams.CreatedAt;
+  /**
+   * 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;
 }
 
 export namespace ACHPrenotificationListParams {

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
@@ -303,6 +327,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.
@@ -322,23 +350,6 @@ 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.
    */
@@ -351,7 +362,14 @@ export interface ACHTransferCreateParams {
   addendum?: string;
 
   /**
-   * The description of the date of the transfer, usually in the format `YYYYMMDD`.
+   * 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.
    */
   company_descriptive_date?: string;
@@ -420,6 +438,16 @@ 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 {
@@ -428,7 +456,29 @@ export interface ACHTransferListParams extends PageParams {
    */
   account_id?: string;
 
-  created_at?: ACHTransferListParams.CreatedAt;
+  /**
+   * 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;
 
   /**
    * Filter ACH Transfers to those made to the specified External Account.

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;
+}