increase 0.2.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

@@ -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'
@@ -179,6 +180,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'

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'
@@ -130,36 +131,11 @@ export interface EventListParams extends PageParams {
 }
 
 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 {
     /**
-     * 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 +151,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'
@@ -212,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

@@ -0,0 +1,204 @@
+// 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 {
+  /**
+   * The type of Export to create.
+   */
+  category: 'transaction_csv' | 'balance_csv';
+
+  /**
+   * Options for the created export. Required if `category` is equal to
+   * `balance_csv`.
+   */
+  balance_csv?: ExportCreateParams.BalanceCsv;
+
+  /**
+   * 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
+   * `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 });
   }
 }
@@ -154,8 +153,9 @@ export interface ExternalAccountListParams extends PageParams {
 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
@@ -125,6 +126,7 @@ export interface FileCreateParams {
     | 'trust_formation_document'
     | 'digital_wallet_artwork'
     | 'digital_wallet_app_icon'
+    | 'document_request'
     | 'entity_supplemental_document';
 
   /**
@@ -168,8 +170,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 +184,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,

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

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