increase 0.3.0 → 0.4.0

package/resources/entities/index.ts

@@ -1,4 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
 export { Entity, EntityCreateParams, EntityListParams, EntitiesPage } from './entities';
-export { SupplementalDocumentCreateParams } from './supplemental-documents';
+export {
+  SupplementalDocument,
+  SupplementalDocumentCreateParams,
+  SupplementalDocumentListParams,
+  SupplementalDocumentsPage,
+} from './supplemental-documents';

package/resources/entities/supplemental-documents.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import * as Entities from '~/resources/entities';
+import { Page, PageParams } from '~/pagination';
 
 export class SupplementalDocuments extends APIResource {
   /**
@@ -15,6 +16,44 @@ export class SupplementalDocuments extends APIResource {
   ): Promise<Core.APIResponse<Entities.Entity>> {
     return this.post(`/entities/${entityId}/supplemental_documents`, { body, ...options });
   }
+
+  /**
+   * List Entity Supplemental Document Submissionss
+   */
+  list(
+    query: SupplementalDocumentListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SupplementalDocumentsPage> {
+    return this.getAPIList('/entity_supplemental_documents', SupplementalDocumentsPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class SupplementalDocumentsPage extends Page<SupplementalDocument> {}
+
+/**
+ * Supplemental Documents are uploaded files connected to an Entity during
+ * onboarding.
+ */
+export interface SupplementalDocument {
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+   * Supplemental Document was created.
+   */
+  created_at: string;
+
+  /**
+   * The File containing the document.
+   */
+  file_id: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `entity_supplemental_document`.
+   */
+  type: 'entity_supplemental_document';
 }
 
 export interface SupplementalDocumentCreateParams {
@@ -23,3 +62,10 @@ export interface SupplementalDocumentCreateParams {
    */
   file_id: string;
 }
+
+export interface SupplementalDocumentListParams extends PageParams {
+  /**
+   * The identifier of the Entity to list supplemental documents for.
+   */
+  entity_id: string;
+}

package/resources/event-subscriptions.ts

@@ -157,6 +157,11 @@ export interface EventSubscription {
 }
 
 export interface EventSubscriptionCreateParams {
+  /**
+   * The URL you'd like us to send webhooks to.
+   */
+  url: string;
+
   /**
    * If specified, this subscription will only receive webhooks for Events with the
    * specified `category`.
@@ -218,11 +223,6 @@ export interface EventSubscriptionCreateParams {
    * string will be used as default.
    */
   shared_secret?: string;
-
-  /**
-   * The URL you'd like us to send webhooks to.
-   */
-  url: string;
 }
 
 export interface EventSubscriptionUpdateParams {

package/resources/events.ts

@@ -125,116 +125,12 @@ export interface EventListParams extends PageParams {
    */
   associated_object_id?: string;
 
-  /**
-   * Filter Events for those with the specified category or categories. For GET
-   * requests, this should be encoded as a comma-delimited string, such as
-   * `?in=one,two,three`.
-   */
-  'category.in'?: Array<
-    | 'account.created'
-    | 'account.updated'
-    | 'account_number.created'
-    | 'account_number.updated'
-    | 'account_statement.created'
-    | 'account_transfer.created'
-    | 'account_transfer.updated'
-    | 'ach_prenotification.created'
-    | 'ach_prenotification.updated'
-    | 'ach_transfer.created'
-    | 'ach_transfer.updated'
-    | 'card.created'
-    | 'card.updated'
-    | 'card_payment.created'
-    | 'card_payment.updated'
-    | 'card_dispute.created'
-    | 'card_dispute.updated'
-    | 'check_deposit.created'
-    | 'check_deposit.updated'
-    | 'check_transfer.created'
-    | 'check_transfer.updated'
-    | 'declined_transaction.created'
-    | 'digital_wallet_token.created'
-    | 'digital_wallet_token.updated'
-    | 'document.created'
-    | 'entity.created'
-    | 'entity.updated'
-    | 'external_account.created'
-    | 'file.created'
-    | 'group.updated'
-    | 'group.heartbeat'
-    | 'inbound_ach_transfer_return.created'
-    | 'inbound_ach_transfer_return.updated'
-    | 'inbound_wire_drawdown_request.created'
-    | 'oauth_connection.created'
-    | 'oauth_connection.deactivated'
-    | 'pending_transaction.created'
-    | 'pending_transaction.updated'
-    | 'real_time_decision.card_authorization_requested'
-    | 'real_time_decision.digital_wallet_token_requested'
-    | 'real_time_decision.digital_wallet_authentication_requested'
-    | 'real_time_payments_transfer.created'
-    | 'real_time_payments_transfer.updated'
-    | 'real_time_payments_request_for_payment.created'
-    | 'real_time_payments_request_for_payment.updated'
-    | 'transaction.created'
-    | 'wire_drawdown_request.created'
-    | 'wire_drawdown_request.updated'
-    | 'wire_transfer.created'
-    | 'wire_transfer.updated'
-  >;
-
-  /**
-   * 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;
+  category?: EventListParams.Category;
 
-  /**
-   * 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;
+  created_at?: EventListParams.CreatedAt;
 }
 
 export namespace EventListParams {
-  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;
-  }
-
   export interface Category {
     /**
      * Filter Events for those with the specified category or categories. For GET
@@ -294,4 +190,30 @@ export namespace EventListParams {
       | 'wire_transfer.updated'
     >;
   }
+
+  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/exports.ts

@@ -87,12 +87,6 @@ export interface Export {
 }
 
 export interface ExportCreateParams {
-  /**
-   * Options for the created export. Required if `category` is equal to
-   * `balance_csv`.
-   */
-  balance_csv?: ExportCreateParams.BalanceCsv;
-
   /**
    * The type of Export to create.
    */
@@ -100,106 +94,18 @@ export interface ExportCreateParams {
 
   /**
    * Options for the created export. Required if `category` is equal to
-   * `transaction_csv`.
+   * `balance_csv`.
    */
-  transaction_csv?: ExportCreateParams.TransactionCsv;
-}
+  balance_csv?: ExportCreateParams.BalanceCsv;
 
-export namespace ExportCreateParams {
   /**
    * Options for the created export. Required if `category` is equal to
    * `transaction_csv`.
    */
-  export interface TransactionCsv {
-    /**
-     * Filter exported Transactions to the specified Account.
-     */
-    account_id?: string;
-
-    /**
-     * Filter results by time range on the `created_at` attribute.
-     */
-    created_at?: TransactionCsv.CreatedAt;
-  }
-
-  export namespace TransactionCsv {
-    /**
-     * Filter results by time range on the `created_at` attribute.
-     */
-    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;
-    }
-  }
-
-  /**
-   * Options for the created export. Required if `category` is equal to
-   * `balance_csv`.
-   */
-  export interface BalanceCsv {
-    /**
-     * Filter exported Transactions to the specified Account.
-     */
-    account_id?: string;
-
-    /**
-     * Filter results by time range on the `created_at` attribute.
-     */
-    created_at?: BalanceCsv.CreatedAt;
-  }
-
-  export namespace BalanceCsv {
-    /**
-     * Filter results by time range on the `created_at` attribute.
-     */
-    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;
-    }
-  }
+  transaction_csv?: ExportCreateParams.TransactionCsv;
+}
 
+export namespace ExportCreateParams {
   /**
    * Options for the created export. Required if `category` is equal to
    * `balance_csv`.

package/resources/external-accounts.ts

@@ -122,16 +122,16 @@ export interface ExternalAccountCreateParams {
    */
   description: string;
 
-  /**
-   * The type of the destination account. Defaults to `checking`.
-   */
-  funding?: 'checking' | 'savings' | 'other';
-
   /**
    * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
    * destination account.
    */
   routing_number: string;
+
+  /**
+   * The type of the destination account. Defaults to `checking`.
+   */
+  funding?: 'checking' | 'savings' | 'other';
 }
 
 export interface ExternalAccountUpdateParams {
@@ -147,12 +147,7 @@ export interface ExternalAccountUpdateParams {
 }
 
 export interface ExternalAccountListParams extends PageParams {
-  /**
-   * Filter External Accounts 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`.
-   */
-  'status.in'?: Array<'active' | 'archived'>;
+  status?: ExternalAccountListParams.Status;
 }
 
 export namespace ExternalAccountListParams {

package/resources/files.ts

@@ -107,11 +107,6 @@ export interface File {
 }
 
 export interface FileCreateParams {
-  /**
-   * The description you choose to give the File.
-   */
-  description?: string;
-
   /**
    * The file contents. This should follow the specifications of
    * [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file
@@ -133,52 +128,17 @@ export interface FileCreateParams {
     | 'digital_wallet_app_icon'
     | 'document_request'
     | 'entity_supplemental_document';
-}
 
-export interface FileListParams 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.
+   * The description you choose to give the File.
    */
-  'created_at.on_or_after'?: string;
+  description?: string;
+}
 
-  /**
-   * Return results on or before this
-   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
-   */
-  'created_at.on_or_before'?: string;
+export interface FileListParams extends PageParams {
+  created_at?: FileListParams.CreatedAt;
 
-  /**
-   * Filter Files for those with the specified purpose or purposes. For GET requests,
-   * this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
-   */
-  'purpose.in'?: Array<
-    | 'check_image_front'
-    | 'check_image_back'
-    | 'form_1099_int'
-    | 'form_ss_4'
-    | 'identity_document'
-    | 'increase_statement'
-    | 'other'
-    | 'trust_formation_document'
-    | 'digital_wallet_artwork'
-    | 'digital_wallet_app_icon'
-    | 'document_request'
-    | 'entity_supplemental_document'
-    | 'export'
-  >;
+  purpose?: FileListParams.Purpose;
 }
 
 export namespace FileListParams {

package/resources/limits.ts

@@ -101,11 +101,6 @@ 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.
    */
@@ -121,6 +116,11 @@ 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/pending-transactions.ts

@@ -141,12 +141,6 @@ export namespace PendingTransaction {
      */
     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
@@ -159,9 +153,7 @@ export namespace PendingTransaction {
       | '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';
 
@@ -190,13 +182,6 @@ export namespace PendingTransaction {
      */
     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
-     * `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`.
@@ -483,36 +468,6 @@ 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,
-       * 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;
-    }
-
     /**
      * A Real Time Payments Transfer Instruction object. This field will be present in
      * the JSON response if and only if `category` is equal to
@@ -532,25 +487,6 @@ export namespace PendingTransaction {
       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;
-
-      /**
-       * 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;
-    }
-
     /**
      * 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`.
@@ -579,29 +515,7 @@ 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;
+  created_at?: PendingTransactionListParams.CreatedAt;
 
   /**
    * Filter pending transactions to those belonging to the specified Route.
@@ -613,26 +527,10 @@ export interface PendingTransactionListParams extends PageParams {
    */
   source_id?: string;
 
-  /**
-   * 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'>;
+  status?: PendingTransactionListParams.Status;
 }
 
 export namespace PendingTransactionListParams {
-  export interface 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`.
-     */
-    in?: Array<'pending' | 'complete'>;
-  }
-
   export interface CreatedAt {
     /**
      * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
@@ -658,4 +556,14 @@ export namespace PendingTransactionListParams {
      */
     on_or_before?: string;
   }
+
+  export interface 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`.
+     */
+    in?: Array<'pending' | 'complete'>;
+  }
 }