increase 0.2.0 → 0.3.0

package/resources/index.ts

@@ -44,6 +44,25 @@ export {
   AccountTransfersPage,
   AccountTransfers,
 } from './account-transfers';
+export { BalanceLookupLookupResponse, BalanceLookupLookupParams, BalanceLookups } from './balance-lookups';
+export {
+  BookkeepingAccount,
+  BookkeepingAccountCreateParams,
+  BookkeepingAccountListParams,
+  BookkeepingAccountsPage,
+  BookkeepingAccounts,
+} from './bookkeeping-accounts';
+export {
+  BookkeepingEntry,
+  BookkeepingEntryListParams,
+  BookkeepingEntriesPage,
+  BookkeepingEntries,
+} from './bookkeeping-entries';
+export {
+  BookkeepingEntrySet,
+  BookkeepingEntrySetCreateParams,
+  BookkeepingEntrySets,
+} from './bookkeeping-entry-sets';
 export {
   Card,
   CardDetails,
@@ -104,6 +123,7 @@ export {
   EventSubscriptionsPage,
   EventSubscriptions,
 } from './event-subscriptions';
+export { Export, ExportCreateParams, ExportListParams, ExportsPage, Exports } from './exports';
 export {
   ExternalAccount,
   ExternalAccountCreateParams,
@@ -140,7 +160,15 @@ export {
   PendingTransactionsPage,
   PendingTransactions,
 } from './pending-transactions';
+export { Program, ProgramListParams, ProgramsPage, Programs } from './programs';
 export { RealTimeDecision, RealTimeDecisionActionParams, RealTimeDecisions } from './real-time-decisions';
+export {
+  RealTimePaymentsTransfer,
+  RealTimePaymentsTransferCreateParams,
+  RealTimePaymentsTransferListParams,
+  RealTimePaymentsTransfersPage,
+  RealTimePaymentsTransfers,
+} from './real-time-payments-transfers';
 export {
   RoutingNumber,
   RoutingNumberListParams,

package/resources/limits.ts

@@ -43,7 +43,6 @@ export class Limits extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/limits', LimitsPage, { query, ...options });
   }
 }
@@ -102,6 +101,11 @@ export interface Limit {
 }
 
 export interface LimitCreateParams {
+  /**
+   * The interval for the metric. Required if `metric` is `count` or `volume`.
+   */
+  interval?: 'transaction' | 'day' | 'week' | 'month' | 'year' | 'all_time';
+
   /**
    * The metric for the limit.
    */
@@ -117,11 +121,6 @@ export interface LimitCreateParams {
    * The value to test the limit against.
    */
   value: number;
-
-  /**
-   * The interval for the metric. Required if `metric` is `count` or `volume`.
-   */
-  interval?: 'transaction' | 'day' | 'week' | 'month' | 'year' | 'all_time';
 }
 
 export interface LimitUpdateParams {

package/resources/oauth-connections.ts

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

package/resources/pending-transactions.ts

@@ -3,8 +3,8 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
-import { Page, PageParams } from '~/pagination';
 import * as Shared from '~/resources/shared';
+import { Page, PageParams } from '~/pagination';
 
 export class PendingTransactions extends APIResource {
   /**
@@ -32,7 +32,6 @@ export class PendingTransactions extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/pending_transactions', PendingTransactionsPage, { query, ...options });
   }
 }
@@ -55,6 +54,12 @@ export interface PendingTransaction {
    */
   amount: number;
 
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
+   * Transaction was completed.
+   */
+  completed_at: string | null;
+
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
    * Transaction occured.
@@ -89,7 +94,7 @@ export interface PendingTransaction {
   /**
    * The type of the route this Pending Transaction came through.
    */
-  route_type: string | null;
+  route_type: 'account_number' | 'card' | null;
 
   /**
    * This is an object giving more details on the network-level event that caused the
@@ -112,6 +117,11 @@ export interface PendingTransaction {
 }
 
 export namespace PendingTransaction {
+  /**
+   * This is an object giving more details on the network-level event that caused the
+   * Pending Transaction. For example, for a card transaction this lists the
+   * merchant's industry and location.
+   */
   export interface Source {
     /**
      * A Account Transfer Instruction object. This field will be present in the JSON
@@ -173,6 +183,13 @@ export namespace PendingTransaction {
      */
     inbound_funds_hold: Source.InboundFundsHold | null;
 
+    /**
+     * A Real Time Payments Transfer Instruction object. This field will be present in
+     * the JSON response if and only if `category` is equal to
+     * `real_time_payments_transfer_instruction`.
+     */
+    real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
+
     /**
      * A Wire Drawdown Payment Instruction object. This field will be present in the
      * JSON response if and only if `category` is equal to
@@ -188,6 +205,10 @@ export namespace PendingTransaction {
   }
 
   export namespace Source {
+    /**
+     * A Account Transfer Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `account_transfer_instruction`.
+     */
     export interface AccountTransferInstruction {
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -207,6 +228,10 @@ export namespace PendingTransaction {
       transfer_id: string;
     }
 
+    /**
+     * A ACH Transfer Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `ach_transfer_instruction`.
+     */
     export interface ACHTransferInstruction {
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -220,6 +245,10 @@ export namespace PendingTransaction {
       transfer_id: string;
     }
 
+    /**
+     * A Card Authorization object. This field will be present in the JSON response if
+     * and only if `category` is equal to `card_authorization`.
+     */
     export interface CardAuthorization {
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -239,6 +268,17 @@ export namespace PendingTransaction {
        */
       digital_wallet_token_id: string | null;
 
+      /**
+       * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
+       * will expire and the pending transaction will be released.
+       */
+      expires_at: string;
+
+      /**
+       * The Card Authorization identifier.
+       */
+      id: string;
+
       /**
        * The merchant identifier (commonly abbreviated as MID) of the merchant the card
        * is transacting with.
@@ -276,14 +316,28 @@ export namespace PendingTransaction {
        */
       network_details: CardAuthorization.NetworkDetails;
 
+      /**
+       * The identifier of the Pending Transaction associated with this Transaction.
+       */
+      pending_transaction_id: string | null;
+
       /**
        * The identifier of the Real-Time Decision sent to approve or decline this
        * transaction.
        */
       real_time_decision_id: string | null;
+
+      /**
+       * A constant representing the object's type. For this resource it will always be
+       * `card_authorization`.
+       */
+      type: 'card_authorization';
     }
 
     export namespace CardAuthorization {
+      /**
+       * Fields specific to the `network`
+       */
       export interface NetworkDetails {
         /**
          * Fields specific to the `visa` network
@@ -292,6 +346,9 @@ export namespace PendingTransaction {
       }
 
       export namespace NetworkDetails {
+        /**
+         * Fields specific to the `visa` network
+         */
         export interface Visa {
           /**
            * For electronic commerce transactions, this identifies the level of security used
@@ -313,11 +370,15 @@ export namespace PendingTransaction {
            * The method used to enter the cardholder's primary account number and card
            * expiration date
            */
-          point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
+          point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
         }
       }
     }
 
+    /**
+     * A Check Deposit Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `check_deposit_instruction`.
+     */
     export interface CheckDepositInstruction {
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -349,6 +410,10 @@ export namespace PendingTransaction {
       front_image_file_id: string;
     }
 
+    /**
+     * A Check Transfer Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `check_transfer_instruction`.
+     */
     export interface CheckTransferInstruction {
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -368,6 +433,10 @@ export namespace PendingTransaction {
       transfer_id: string;
     }
 
+    /**
+     * A Inbound Funds Hold object. This field will be present in the JSON response if
+     * and only if `category` is equal to `inbound_funds_hold`.
+     */
     export interface InboundFundsHold {
       /**
        * The held amount in the minor unit of the account's currency. For dollars, for
@@ -381,6 +450,12 @@ export namespace PendingTransaction {
        */
       automatically_releases_at: string;
 
+      /**
+       * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
+       * was created.
+       */
+      created_at: string;
+
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
        * currency.
@@ -392,6 +467,11 @@ export namespace PendingTransaction {
        */
       held_transaction_id: string | null;
 
+      /**
+       * The ID of the Pending Transaction representing the held funds.
+       */
+      pending_transaction_id: string | null;
+
       /**
        * When the hold was released (if it has been released).
        */
@@ -403,6 +483,10 @@ export namespace PendingTransaction {
       status: 'held' | 'complete';
     }
 
+    /**
+     * A Deprecated Card Authorization object. This field will be present in the JSON
+     * response if and only if `category` is equal to `card_route_authorization`.
+     */
     export interface CardRouteAuthorization {
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -429,6 +513,30 @@ export namespace PendingTransaction {
       merchant_state: string | null;
     }
 
+    /**
+     * A Real Time Payments Transfer Instruction object. This field will be present in
+     * the JSON response if and only if `category` is equal to
+     * `real_time_payments_transfer_instruction`.
+     */
+    export interface RealTimePaymentsTransferInstruction {
+      /**
+       * The pending amount in the minor unit of the transaction's currency. For dollars,
+       * for example, this is cents.
+       */
+      amount: number;
+
+      /**
+       * The identifier of the Real Time Payments Transfer that led to this Pending
+       * Transaction.
+       */
+      transfer_id: string;
+    }
+
+    /**
+     * A Wire Drawdown Payment Instruction object. This field will be present in the
+     * JSON response if and only if `category` is equal to
+     * `wire_drawdown_payment_instruction`.
+     */
     export interface WireDrawdownPaymentInstruction {
       account_number: string;
 
@@ -443,6 +551,10 @@ export namespace PendingTransaction {
       routing_number: string;
     }
 
+    /**
+     * A Wire Transfer Instruction object. This field will be present in the JSON
+     * response if and only if `category` is equal to `wire_transfer_instruction`.
+     */
     export interface WireTransferInstruction {
       account_number: string;
 
@@ -467,6 +579,30 @@ export interface PendingTransactionListParams 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;
+
   /**
    * Filter pending transactions to those belonging to the specified Route.
    */
@@ -477,15 +613,49 @@ export interface PendingTransactionListParams extends PageParams {
    */
   source_id?: string;
 
-  status?: PendingTransactionListParams.Status;
+  /**
+   * Filter Pending Transactions for those with the specified status. By default only
+   * Pending Transactions in with status `pending` will be returned. For GET
+   * requests, this should be encoded as a comma-delimited string, such as
+   * `?in=one,two,three`.
+   */
+  'status.in'?: Array<'pending' | 'complete'>;
 }
 
 export namespace PendingTransactionListParams {
   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 Pending Transactions for those with the specified status. By default only
+     * Pending Transactions in with status `pending` will be returned. For GET
+     * requests, this should be encoded as a comma-delimited string, such as
+     * `?in=one,two,three`.
      */
     in?: Array<'pending' | 'complete'>;
   }
+
+  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/programs.ts

@@ -0,0 +1,70 @@
+// 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 Programs extends APIResource {
+  /**
+   * Retrieve a Program
+   */
+  retrieve(programId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Program>> {
+    return this.get(`/programs/${programId}`, options);
+  }
+
+  /**
+   * List Programs
+   */
+  list(query?: ProgramListParams, options?: Core.RequestOptions): Core.PagePromise<ProgramsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ProgramsPage>;
+  list(
+    query: ProgramListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ProgramsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/programs', ProgramsPage, { query, ...options });
+  }
+}
+
+export class ProgramsPage extends Page<Program> {}
+
+/**
+ * Programs determine the compliance and commercial terms of Accounts. By default,
+ * you have a Commercial Banking program for managing your own funds. If you are
+ * lending or managing funds on behalf of your customers, or otherwise engaged in
+ * regulated activity, we will work together to create additional Programs for you.
+ */
+export interface Program {
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program
+   * was created.
+   */
+  created_at: string;
+
+  /**
+   * The Program identifier.
+   */
+  id: string;
+
+  /**
+   * The name of the Program.
+   */
+  name: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `program`.
+   */
+  type: 'program';
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program
+   * was last updated.
+   */
+  updated_at: string;
+}
+
+export interface ProgramListParams extends PageParams {}

package/resources/real-time-decisions.ts

@@ -87,6 +87,9 @@ export interface RealTimeDecision {
 }
 
 export namespace RealTimeDecision {
+  /**
+   * Fields related to a card authorization.
+   */
   export interface CardAuthorization {
     /**
      * The identifier of the Account the authorization will debit.
@@ -167,6 +170,9 @@ export namespace RealTimeDecision {
   }
 
   export namespace CardAuthorization {
+    /**
+     * Fields specific to the `network`
+     */
     export interface NetworkDetails {
       /**
        * Fields specific to the `visa` network
@@ -175,6 +181,9 @@ export namespace RealTimeDecision {
     }
 
     export namespace NetworkDetails {
+      /**
+       * Fields specific to the `visa` network
+       */
       export interface Visa {
         /**
          * For electronic commerce transactions, this identifies the level of security used
@@ -196,11 +205,14 @@ export namespace RealTimeDecision {
          * The method used to enter the cardholder's primary account number and card
          * expiration date
          */
-        point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
+        point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
       }
     }
   }
 
+  /**
+   * Fields related to a digital wallet token provisioning attempt.
+   */
   export interface DigitalWalletToken {
     /**
      * The identifier of the Card that is being tokenized.
@@ -226,6 +238,9 @@ export namespace RealTimeDecision {
     digital_wallet: 'apple_pay' | 'google_pay';
   }
 
+  /**
+   * Fields related to a digital wallet authentication attempt.
+   */
   export interface DigitalWalletAuthentication {
     /**
      * The identifier of the Card that is being tokenized.
@@ -286,6 +301,10 @@ export interface RealTimeDecisionActionParams {
 }
 
 export namespace RealTimeDecisionActionParams {
+  /**
+   * If the Real-Time Decision relates to a card authorization attempt, this object
+   * contains your response to the authorization.
+   */
   export interface CardAuthorization {
     /**
      * Whether the card authorization should be approved or declined.
@@ -293,6 +312,10 @@ export namespace RealTimeDecisionActionParams {
     decision: 'approve' | 'decline';
   }
 
+  /**
+   * If the Real-Time Decision relates to a digital wallet token provisioning
+   * attempt, this object contains your response to the attempt.
+   */
   export interface DigitalWalletToken {
     /**
      * If your application approves the provisioning attempt, this contains metadata
@@ -308,6 +331,10 @@ export namespace RealTimeDecisionActionParams {
   }
 
   export namespace DigitalWalletToken {
+    /**
+     * If your application approves the provisioning attempt, this contains metadata
+     * about the digital wallet token that will be generated.
+     */
     export interface Approval {
       /**
        * The identifier of the Card Profile to assign to the Digital Wallet token.
@@ -327,6 +354,10 @@ export namespace RealTimeDecisionActionParams {
       phone?: string;
     }
 
+    /**
+     * If your application declines the provisioning attempt, this contains details
+     * about the decline.
+     */
     export interface Decline {
       /**
        * Why the tokenization attempt was declined. This is for logging purposes only and
@@ -336,10 +367,91 @@ export namespace RealTimeDecisionActionParams {
     }
   }
 
+  /**
+   * If the Real-Time Decision relates to a digital wallet authentication attempt,
+   * this object contains your response to the authentication.
+   */
+  export interface DigitalWalletAuthentication {
+    /**
+     * Whether your application was able to deliver the one-time passcode.
+     */
+    result: 'success' | 'failure';
+  }
+
+  /**
+   * If the Real-Time Decision relates to a card authorization attempt, this object
+   * contains your response to the authorization.
+   */
+  export interface CardAuthorization {
+    /**
+     * Whether the card authorization should be approved or declined.
+     */
+    decision: 'approve' | 'decline';
+  }
+
+  /**
+   * If the Real-Time Decision relates to a digital wallet authentication attempt,
+   * this object contains your response to the authentication.
+   */
   export interface DigitalWalletAuthentication {
     /**
      * Whether your application was able to deliver the one-time passcode.
      */
     result: 'success' | 'failure';
   }
+
+  /**
+   * If the Real-Time Decision relates to a digital wallet token provisioning
+   * attempt, this object contains your response to the attempt.
+   */
+  export interface DigitalWalletToken {
+    /**
+     * If your application approves the provisioning attempt, this contains metadata
+     * about the digital wallet token that will be generated.
+     */
+    approval?: DigitalWalletToken.Approval;
+
+    /**
+     * If your application declines the provisioning attempt, this contains details
+     * about the decline.
+     */
+    decline?: DigitalWalletToken.Decline;
+  }
+
+  export namespace DigitalWalletToken {
+    /**
+     * If your application approves the provisioning attempt, this contains metadata
+     * about the digital wallet token that will be generated.
+     */
+    export interface Approval {
+      /**
+       * The identifier of the Card Profile to assign to the Digital Wallet token.
+       */
+      card_profile_id: string;
+
+      /**
+       * An email address that can be used to verify the cardholder via one-time
+       * passcode.
+       */
+      email?: string;
+
+      /**
+       * A phone number that can be used to verify the cardholder via one-time passcode
+       * over SMS.
+       */
+      phone?: string;
+    }
+
+    /**
+     * If your application declines the provisioning attempt, this contains details
+     * about the decline.
+     */
+    export interface Decline {
+      /**
+       * Why the tokenization attempt was declined. This is for logging purposes only and
+       * is not displayed to the end-user.
+       */
+      reason?: string;
+    }
+  }
 }