increase 0.2.0 → 0.3.0

package/resources/event-subscriptions.ts

@@ -52,7 +52,6 @@ export class EventSubscriptions extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/event_subscriptions', EventSubscriptionsPage, { query, ...options });
   }
 }
@@ -96,6 +95,8 @@ export interface EventSubscription {
     | 'ach_transfer.updated'
     | 'card.created'
     | 'card.updated'
+    | 'card_payment.created'
+    | 'card_payment.updated'
     | 'card_dispute.created'
     | 'card_dispute.updated'
     | 'check_deposit.created'
@@ -156,11 +157,6 @@ 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`.
@@ -179,6 +175,8 @@ export interface EventSubscriptionCreateParams {
     | 'ach_transfer.updated'
     | 'card.created'
     | 'card.updated'
+    | 'card_payment.created'
+    | 'card_payment.updated'
     | 'card_dispute.created'
     | 'card_dispute.updated'
     | 'check_deposit.created'
@@ -220,6 +218,11 @@ 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

@@ -25,7 +25,6 @@ export class Events extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/events', EventsPage, { query, ...options });
   }
 }
@@ -65,6 +64,8 @@ export interface Event {
     | 'ach_transfer.updated'
     | 'card.created'
     | 'card.updated'
+    | 'card_payment.created'
+    | 'card_payment.updated'
     | 'card_dispute.created'
     | 'card_dispute.updated'
     | 'check_deposit.created'
@@ -124,9 +125,87 @@ export interface EventListParams extends PageParams {
    */
   associated_object_id?: string;
 
-  category?: EventListParams.Category;
+  /**
+   * 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'
+  >;
 
-  created_at?: EventListParams.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 EventListParams {
@@ -158,8 +237,9 @@ export namespace EventListParams {
 
   export interface Category {
     /**
-     * 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 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`.
      */
     in?: Array<
       | 'account.created'
@@ -175,6 +255,8 @@ export namespace EventListParams {
       | 'ach_transfer.updated'
       | 'card.created'
       | 'card.updated'
+      | 'card_payment.created'
+      | 'card_payment.updated'
       | 'card_dispute.created'
       | 'card_dispute.updated'
       | 'check_deposit.created'

package/resources/exports.ts

@@ -0,0 +1,298 @@
+// 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 Exports extends APIResource {
+  /**
+   * Create an Export
+   */
+  create(body: ExportCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Export>> {
+    return this.post('/exports', { body, ...options });
+  }
+
+  /**
+   * Retrieve an Export
+   */
+  retrieve(exportId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Export>> {
+    return this.get(`/exports/${exportId}`, options);
+  }
+
+  /**
+   * List Exports
+   */
+  list(query?: ExportListParams, options?: Core.RequestOptions): Core.PagePromise<ExportsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ExportsPage>;
+  list(
+    query: ExportListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ExportsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/exports', ExportsPage, { query, ...options });
+  }
+}
+
+export class ExportsPage extends Page<Export> {}
+
+/**
+ * Exports are batch summaries of your Increase data. You can make them from the
+ * API or dashboard. Since they can take a while, they are generated
+ * asynchronously. We send a webhook when they are ready. For more information,
+ * please read our
+ * [Exports documentation](https://increase.com/documentation/exports).
+ */
+export interface Export {
+  /**
+   * The category of the Export. We may add additional possible values for this enum
+   * over time; your application should be able to handle that gracefully.
+   */
+  category: 'transaction_csv' | 'balance_csv';
+
+  /**
+   * The time the Export was created.
+   */
+  created_at: string;
+
+  /**
+   * A URL at which the Export's file can be downloaded. This will be present when
+   * the Export's status transitions to `complete`.
+   */
+  file_download_url: string | null;
+
+  /**
+   * The File containing the contents of the Export. This will be present when the
+   * Export's status transitions to `complete`.
+   */
+  file_id: string | null;
+
+  /**
+   * The Export identifier.
+   */
+  id: string;
+
+  /**
+   * The status of the Export.
+   */
+  status: 'pending' | 'complete';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `export`.
+   */
+  type: '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.
+   */
+  category: 'transaction_csv' | 'balance_csv';
+
+  /**
+   * Options for the created export. Required if `category` is equal to
+   * `transaction_csv`.
+   */
+  transaction_csv?: ExportCreateParams.TransactionCsv;
+}
+
+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;
+    }
+  }
+
+  /**
+   * 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;
+    }
+  }
+
+  /**
+   * 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;
+    }
+  }
+}
+
+export interface ExportListParams extends PageParams {}

package/resources/external-accounts.ts

@@ -52,7 +52,6 @@ export class ExternalAccounts extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/external_accounts', ExternalAccountsPage, { query, ...options });
   }
 }
@@ -124,15 +123,15 @@ export interface ExternalAccountCreateParams {
   description: string;
 
   /**
-   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
-   * destination account.
+   * The type of the destination account. Defaults to `checking`.
    */
-  routing_number: string;
+  funding?: 'checking' | 'savings' | 'other';
 
   /**
-   * The type of the destination account. Defaults to `checking`.
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+   * destination account.
    */
-  funding?: 'checking' | 'savings' | 'other';
+  routing_number: string;
 }
 
 export interface ExternalAccountUpdateParams {
@@ -148,14 +147,20 @@ export interface ExternalAccountUpdateParams {
 }
 
 export interface ExternalAccountListParams extends PageParams {
-  status?: ExternalAccountListParams.Status;
+  /**
+   * 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'>;
 }
 
 export namespace ExternalAccountListParams {
   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 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`.
      */
     in?: Array<'active' | 'archived'>;
   }

package/resources/files.ts

@@ -3,8 +3,8 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
-import { Page, PageParams } from '~/pagination';
 import type * as FormData from 'formdata-node';
+import { Page, PageParams } from '~/pagination';
 import { multipartFormRequestOptions } from '~/core';
 
 export class Files extends APIResource {
@@ -36,7 +36,6 @@ export class Files extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/files', FilesPage, { query, ...options });
   }
 }
@@ -96,7 +95,9 @@ export interface File {
     | 'trust_formation_document'
     | 'digital_wallet_artwork'
     | 'digital_wallet_app_icon'
-    | 'entity_supplemental_document';
+    | 'document_request'
+    | 'entity_supplemental_document'
+    | 'export';
 
   /**
    * A constant representing the object's type. For this resource it will always be
@@ -106,6 +107,11 @@ 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
@@ -125,18 +131,54 @@ export interface FileCreateParams {
     | 'trust_formation_document'
     | 'digital_wallet_artwork'
     | 'digital_wallet_app_icon'
+    | 'document_request'
     | 'entity_supplemental_document';
+}
 
+export interface FileListParams extends PageParams {
   /**
-   * The description you choose to give the File.
+   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
    */
-  description?: string;
-}
+  'created_at.after'?: string;
 
-export interface FileListParams extends PageParams {
-  created_at?: FileListParams.CreatedAt;
+  /**
+   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.before'?: string;
 
-  purpose?: FileListParams.Purpose;
+  /**
+   * 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 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'
+  >;
 }
 
 export namespace FileListParams {
@@ -168,8 +210,8 @@ export namespace FileListParams {
 
   export interface Purpose {
     /**
-     * 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 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`.
      */
     in?: Array<
       | 'check_image_front'
@@ -182,7 +224,9 @@ export namespace FileListParams {
       | 'trust_formation_document'
       | 'digital_wallet_artwork'
       | 'digital_wallet_app_icon'
+      | 'document_request'
       | 'entity_supplemental_document'
+      | 'export'
     >;
   }
 }

package/resources/inbound-ach-transfer-returns.ts

@@ -41,7 +41,6 @@ export class InboundACHTransferReturns extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/inbound_ach_transfer_returns', InboundACHTransferReturnsPage, {
       query,
       ...options,
@@ -104,6 +103,9 @@ export interface InboundACHTransferReturn {
 }
 
 export namespace InboundACHTransferReturn {
+  /**
+   * After the return is submitted to FedACH, this will contain supplemental details.
+   */
   export interface Submission {
     /**
      * When the ACH transfer return was sent to FedACH.

package/resources/inbound-wire-drawdown-requests.ts

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