increase 0.1.0

package/resources/limits.ts

@@ -0,0 +1,144 @@
+// 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 Limits extends APIResource {
+  /**
+   * Create a Limit
+   */
+  create(body: LimitCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Limit>> {
+    return this.post('/limits', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Limit
+   */
+  retrieve(limitId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Limit>> {
+    return this.get(`/limits/${limitId}`, options);
+  }
+
+  /**
+   * Update a Limit
+   */
+  update(
+    limitId: string,
+    body: LimitUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Limit>> {
+    return this.patch(`/limits/${limitId}`, { body, ...options });
+  }
+
+  /**
+   * List Limits
+   */
+  list(query?: LimitListParams, options?: Core.RequestOptions): Core.PagePromise<LimitsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LimitsPage>;
+  list(
+    query: LimitListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<LimitsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/limits', LimitsPage, { query, ...options });
+  }
+}
+
+export class LimitsPage extends Page<Limit> {}
+
+/**
+ * You can set limits at the Account, Account Number, or Card level. Limits applied
+ * to Accounts will apply to all Account Numbers and Cards in the Account. You can
+ * specify any number of Limits and they will all be applied to inbound debits and
+ * card authorizations. Volume and count Limits are designed to prevent
+ * unauthorized debits.
+ */
+export interface Limit {
+  /**
+   * The Limit identifier.
+   */
+  id: string;
+
+  /**
+   * The interval for the metric. This is required if `metric` is `count` or
+   * `volume`.
+   */
+  interval: 'transaction' | 'day' | 'week' | 'month' | 'year' | 'all_time' | null;
+
+  /**
+   * The metric for the Limit.
+   */
+  metric: 'count' | 'volume';
+
+  /**
+   * The identifier of the Account Number, Account, or Card the Limit applies to.
+   */
+  model_id: string;
+
+  /**
+   * The type of the model you wish to associate the Limit with.
+   */
+  model_type: 'account' | 'account_number' | 'card';
+
+  /**
+   * The current status of the Limit.
+   */
+  status: 'active' | 'inactive';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `limit`.
+   */
+  type: 'limit';
+
+  /**
+   * The value to evaluate the Limit against.
+   */
+  value: number;
+}
+
+export interface LimitCreateParams {
+  /**
+   * The metric for the limit.
+   */
+  metric: 'count' | 'volume';
+
+  /**
+   * The identifier of the Account or Account Number you wish to associate the limit
+   * with.
+   */
+  model_id: string;
+
+  /**
+   * 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 {
+  /**
+   * The status to update the limit with.
+   */
+  status: 'inactive' | 'active';
+}
+
+export interface LimitListParams extends PageParams {
+  /**
+   * The model to retrieve limits for.
+   */
+  model_id?: string;
+
+  /**
+   * The status to retrieve limits for.
+   */
+  status?: string;
+}

package/resources/oauth-connections.ts

@@ -0,0 +1,74 @@
+// 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 OauthConnections extends APIResource {
+  /**
+   * Retrieve an OAuth Connection
+   */
+  retrieve(
+    oauthConnectionId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<OauthConnection>> {
+    return this.get(`/oauth_connections/${oauthConnectionId}`, options);
+  }
+
+  /**
+   * List OAuth Connections
+   */
+  list(
+    query?: OauthConnectionListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<OauthConnectionsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<OauthConnectionsPage>;
+  list(
+    query: OauthConnectionListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<OauthConnectionsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/oauth_connections', OauthConnectionsPage, { query, ...options });
+  }
+}
+
+export class OauthConnectionsPage extends Page<OauthConnection> {}
+
+/**
+ * When a user authorizes your OAuth application, an OAuth Connection object is
+ * created.
+ */
+export interface OauthConnection {
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+   * Connection was created.
+   */
+  created_at: string;
+
+  /**
+   * The identifier of the Group that has authorized your OAuth application.
+   */
+  group_id: string;
+
+  /**
+   * The OAuth Connection's identifier.
+   */
+  id: string;
+
+  /**
+   * Whether the connection is active.
+   */
+  status: 'active' | 'inactive';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `oauth_connection`.
+   */
+  type: 'oauth_connection';
+}
+
+export interface OauthConnectionListParams extends PageParams {}

package/resources/pending-transactions.ts

@@ -0,0 +1,491 @@
+// 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';
+import * as Shared from '~/resources/shared';
+
+export class PendingTransactions extends APIResource {
+  /**
+   * Retrieve a Pending Transaction
+   */
+  retrieve(
+    pendingTransactionId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<PendingTransaction>> {
+    return this.get(`/pending_transactions/${pendingTransactionId}`, options);
+  }
+
+  /**
+   * List Pending Transactions
+   */
+  list(
+    query?: PendingTransactionListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PendingTransactionsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PendingTransactionsPage>;
+  list(
+    query: PendingTransactionListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PendingTransactionsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/pending_transactions', PendingTransactionsPage, { query, ...options });
+  }
+}
+
+export class PendingTransactionsPage extends Page<PendingTransaction> {}
+
+/**
+ * Pending Transactions are potential future additions and removals of money from
+ * your bank account.
+ */
+export interface PendingTransaction {
+  /**
+   * The identifier for the account this Pending Transaction belongs to.
+   */
+  account_id: string;
+
+  /**
+   * The Pending Transaction amount in the minor unit of its currency. For dollars,
+   * for example, this is cents.
+   */
+  amount: number;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
+   * Transaction occured.
+   */
+  created_at: string;
+
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
+   * Transaction's currency. This will match the currency on the Pending
+   * Transcation's Account.
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+  /**
+   * For a Pending Transaction related to a transfer, this is the description you
+   * provide. For a Pending Transaction related to a payment, this is the description
+   * the vendor provides.
+   */
+  description: string;
+
+  /**
+   * The Pending Transaction identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier for the route this Pending Transaction came through. Routes are
+   * things like cards and ACH details.
+   */
+  route_id: string | null;
+
+  /**
+   * The type of the route this Pending Transaction came through.
+   */
+  route_type: string | null;
+
+  /**
+   * 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.
+   */
+  source: PendingTransaction.Source;
+
+  /**
+   * Whether the Pending Transaction has been confirmed and has an associated
+   * Transaction.
+   */
+  status: 'pending' | 'complete';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `pending_transaction`.
+   */
+  type: 'pending_transaction';
+}
+
+export namespace PendingTransaction {
+  export interface 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`.
+     */
+    account_transfer_instruction: Source.AccountTransferInstruction | null;
+
+    /**
+     * 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`.
+     */
+    ach_transfer_instruction: Source.ACHTransferInstruction | null;
+
+    /**
+     * A Card Authorization object. This field will be present in the JSON response if
+     * and only if `category` is equal to `card_authorization`.
+     */
+    card_authorization: Source.CardAuthorization | null;
+
+    /**
+     * 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`.
+     */
+    card_route_authorization: Source.CardRouteAuthorization | null;
+
+    /**
+     * The type of transaction that took place. We may add additional possible values
+     * for this enum over time; your application should be able to handle such
+     * additions gracefully.
+     */
+    category:
+      | 'account_transfer_instruction'
+      | 'ach_transfer_instruction'
+      | 'card_authorization'
+      | 'check_deposit_instruction'
+      | 'check_transfer_instruction'
+      | 'inbound_funds_hold'
+      | 'card_route_authorization'
+      | 'real_time_payments_transfer_instruction'
+      | 'wire_drawdown_payment_instruction'
+      | 'wire_transfer_instruction'
+      | 'other';
+
+    /**
+     * 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`.
+     */
+    check_deposit_instruction: Source.CheckDepositInstruction | null;
+
+    /**
+     * 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`.
+     */
+    check_transfer_instruction: Source.CheckTransferInstruction | null;
+
+    /**
+     * 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`.
+     */
+    inbound_funds_hold: Source.InboundFundsHold | null;
+
+    /**
+     * 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`.
+     */
+    wire_drawdown_payment_instruction: Source.WireDrawdownPaymentInstruction | null;
+
+    /**
+     * 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`.
+     */
+    wire_transfer_instruction: Source.WireTransferInstruction | null;
+  }
+
+  export namespace Source {
+    export interface AccountTransferInstruction {
+      /**
+       * The pending amount in the minor unit of the transaction's currency. For dollars,
+       * for example, this is cents.
+       */
+      amount: number;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
+       * account currency.
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      /**
+       * The identifier of the Account Transfer that led to this Pending Transaction.
+       */
+      transfer_id: string;
+    }
+
+    export interface ACHTransferInstruction {
+      /**
+       * 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 ACH Transfer that led to this Pending Transaction.
+       */
+      transfer_id: string;
+    }
+
+    export interface CardAuthorization {
+      /**
+       * The pending amount in the minor unit of the transaction's currency. For dollars,
+       * for example, this is cents.
+       */
+      amount: number;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+       * transaction's currency.
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      /**
+       * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
+       * purchase), the identifier of the token that was used.
+       */
+      digital_wallet_token_id: string | null;
+
+      /**
+       * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+       * is transacting with.
+       */
+      merchant_acceptor_id: string;
+
+      /**
+       * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+       * card is transacting with.
+       */
+      merchant_category_code: string | null;
+
+      /**
+       * The city the merchant resides in.
+       */
+      merchant_city: string | null;
+
+      /**
+       * The country the merchant resides in.
+       */
+      merchant_country: string | null;
+
+      /**
+       * The merchant descriptor of the merchant the card is transacting with.
+       */
+      merchant_descriptor: string;
+
+      /**
+       * The payment network used to process this card authorization
+       */
+      network: 'visa';
+
+      /**
+       * Fields specific to the `network`
+       */
+      network_details: CardAuthorization.NetworkDetails;
+
+      /**
+       * The identifier of the Real-Time Decision sent to approve or decline this
+       * transaction.
+       */
+      real_time_decision_id: string | null;
+    }
+
+    export namespace CardAuthorization {
+      export interface NetworkDetails {
+        /**
+         * Fields specific to the `visa` network
+         */
+        visa: NetworkDetails.Visa;
+      }
+
+      export namespace NetworkDetails {
+        export interface Visa {
+          /**
+           * For electronic commerce transactions, this identifies the level of security used
+           * in obtaining the customer's payment credential. For mail or telephone order
+           * transactions, identifies the type of mail or telephone order.
+           */
+          electronic_commerce_indicator:
+            | 'mail_phone_order'
+            | 'recurring'
+            | 'installment'
+            | 'unknown_mail_phone_order'
+            | 'secure_electronic_commerce'
+            | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
+            | 'non_authenticated_security_transaction'
+            | 'non_secure_transaction'
+            | null;
+
+          /**
+           * The method used to enter the cardholder's primary account number and card
+           * expiration date
+           */
+          point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
+        }
+      }
+    }
+
+    export interface CheckDepositInstruction {
+      /**
+       * 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 File containing the image of the back of the check that
+       * was deposited.
+       */
+      back_image_file_id: string | null;
+
+      /**
+       * The identifier of the Check Deposit.
+       */
+      check_deposit_id: string | null;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+       * transaction's currency.
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      /**
+       * The identifier of the File containing the image of the front of the check that
+       * was deposited.
+       */
+      front_image_file_id: string;
+    }
+
+    export interface CheckTransferInstruction {
+      /**
+       * The pending amount in the minor unit of the transaction's currency. For dollars,
+       * for example, this is cents.
+       */
+      amount: number;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
+       * currency.
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      /**
+       * The identifier of the Check Transfer that led to this Pending Transaction.
+       */
+      transfer_id: string;
+    }
+
+    export interface InboundFundsHold {
+      /**
+       * The held amount in the minor unit of the account's currency. For dollars, for
+       * example, this is cents.
+       */
+      amount: number;
+
+      /**
+       * When the hold will be released automatically. Certain conditions may cause it to
+       * be released before this time.
+       */
+      automatically_releases_at: string;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
+       * currency.
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      /**
+       * The ID of the Transaction for which funds were held.
+       */
+      held_transaction_id: string | null;
+
+      /**
+       * When the hold was released (if it has been released).
+       */
+      released_at: string | null;
+
+      /**
+       * The status of the hold.
+       */
+      status: 'held' | 'complete';
+    }
+
+    export interface CardRouteAuthorization {
+      /**
+       * The pending amount in the minor unit of the transaction's currency. For dollars,
+       * for example, this is cents.
+       */
+      amount: number;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+       * transaction's currency.
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      merchant_acceptor_id: string;
+
+      merchant_category_code: string;
+
+      merchant_city: string | null;
+
+      merchant_country: string;
+
+      merchant_descriptor: string;
+
+      merchant_state: string | null;
+    }
+
+    export interface WireDrawdownPaymentInstruction {
+      account_number: string;
+
+      /**
+       * The pending amount in the minor unit of the transaction's currency. For dollars,
+       * for example, this is cents.
+       */
+      amount: number;
+
+      message_to_recipient: string;
+
+      routing_number: string;
+    }
+
+    export interface WireTransferInstruction {
+      account_number: string;
+
+      /**
+       * The pending amount in the minor unit of the transaction's currency. For dollars,
+       * for example, this is cents.
+       */
+      amount: number;
+
+      message_to_recipient: string;
+
+      routing_number: string;
+
+      transfer_id: string;
+    }
+  }
+}
+
+export interface PendingTransactionListParams extends PageParams {
+  /**
+   * Filter pending transactions to those belonging to the specified Account.
+   */
+  account_id?: string;
+
+  /**
+   * Filter pending transactions to those belonging to the specified Route.
+   */
+  route_id?: string;
+
+  /**
+   * Filter pending transactions to those caused by the specified source.
+   */
+  source_id?: string;
+
+  status?: PendingTransactionListParams.Status;
+}
+
+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`.
+     */
+    in?: Array<'pending' | 'complete'>;
+  }
+}