increase 0.1.0

package/resources/files.ts

@@ -0,0 +1,188 @@
+// 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 type * as FormData from 'formdata-node';
+import { multipartFormRequestOptions } from '~/core';
+
+export class Files extends APIResource {
+  /**
+   * To upload a file to Increase, you'll need to send a request of Content-Type
+   * `multipart/form-data`. The request should contain the file you would like to
+   * upload, as well as the parameters for creating a file.
+   */
+  create(body: FileCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<File>> {
+    return this.post('/files', multipartFormRequestOptions({ body, ...options }));
+  }
+
+  /**
+   * Retrieve a File
+   */
+  retrieve(fileId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<File>> {
+    return this.get(`/files/${fileId}`, options);
+  }
+
+  /**
+   * List Files
+   */
+  list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<FilesPage>;
+  list(
+    query: FileListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FilesPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/files', FilesPage, { query, ...options });
+  }
+}
+
+export class FilesPage extends Page<File> {}
+
+/**
+ * Files are objects that represent a file hosted on Increase's servers. The file
+ * may have been uploaded by you (for example, when uploading a check image) or it
+ * may have been created by Increase (for example, an autogenerated statement PDF).
+ */
+export interface File {
+  /**
+   * The time the File was created.
+   */
+  created_at: string;
+
+  /**
+   * A description of the File.
+   */
+  description: string | null;
+
+  /**
+   * Whether the File was generated by Increase or by you and sent to Increase.
+   */
+  direction: 'to_increase' | 'from_increase';
+
+  /**
+   * A URL from where the File can be downloaded at this point in time. The location
+   * of this URL may change over time.
+   */
+  download_url: string | null;
+
+  /**
+   * The filename that was provided upon upload or generated by Increase.
+   */
+  filename: string | null;
+
+  /**
+   * The File's identifier.
+   */
+  id: string;
+
+  /**
+   * What the File will be used for. We may add additional possible values for this
+   * enum over time; your application should be able to handle such additions
+   * gracefully.
+   */
+  purpose:
+    | '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'
+    | 'entity_supplemental_document';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `file`.
+   */
+  type: 'file';
+}
+
+export interface FileCreateParams {
+  /**
+   * The file contents. This should follow the specifications of
+   * [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file
+   * transfers for the multipart/form-data protocol.
+   */
+  file: FormData.Blob | FormData.File;
+
+  /**
+   * What the File will be used for in Increase's systems.
+   */
+  purpose:
+    | 'check_image_front'
+    | 'check_image_back'
+    | 'form_ss_4'
+    | 'identity_document'
+    | 'other'
+    | 'trust_formation_document'
+    | 'digital_wallet_artwork'
+    | 'digital_wallet_app_icon'
+    | 'entity_supplemental_document';
+
+  /**
+   * The description you choose to give the File.
+   */
+  description?: string;
+}
+
+export interface FileListParams extends PageParams {
+  created_at?: FileListParams.CreatedAt;
+
+  purpose?: FileListParams.Purpose;
+}
+
+export namespace FileListParams {
+  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 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`.
+     */
+    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'
+      | 'entity_supplemental_document'
+    >;
+  }
+}

package/resources/groups.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+
+export class Groups extends APIResource {
+  /**
+   * Returns details for the currently authenticated Group.
+   */
+  retrieveDetails(options?: Core.RequestOptions): Promise<Core.APIResponse<Group>> {
+    return this.get('/groups/current', options);
+  }
+}
+
+/**
+ * Groups represent organizations using Increase. You can retrieve information
+ * about your own organization via the API, or (more commonly) OAuth platforms can
+ * retrieve information about the organizations that have granted them access.
+ */
+export interface Group {
+  /**
+   * If the Group is allowed to create ACH debits.
+   */
+  ach_debit_status: 'disabled' | 'enabled';
+
+  /**
+   * If the Group is activated or not.
+   */
+  activation_status: 'unactivated' | 'activated';
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
+   * was created.
+   */
+  created_at: string;
+
+  /**
+   * The Group identifier.
+   */
+  id: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `group`.
+   */
+  type: 'group';
+}

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

@@ -0,0 +1,142 @@
+// 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 InboundACHTransferReturns extends APIResource {
+  /**
+   * Create an ACH Return
+   */
+  create(
+    body: InboundACHTransferReturnCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<InboundACHTransferReturn>> {
+    return this.post('/inbound_ach_transfer_returns', { body, ...options });
+  }
+
+  /**
+   * Retrieve an Inbound ACH Transfer Return
+   */
+  retrieve(
+    inboundACHTransferReturnId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<InboundACHTransferReturn>> {
+    return this.get(`/inbound_ach_transfer_returns/${inboundACHTransferReturnId}`, options);
+  }
+
+  /**
+   * List Inbound ACH Transfer Returns
+   */
+  list(
+    query?: InboundACHTransferReturnListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundACHTransferReturnsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InboundACHTransferReturnsPage>;
+  list(
+    query: InboundACHTransferReturnListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundACHTransferReturnsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/inbound_ach_transfer_returns', InboundACHTransferReturnsPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class InboundACHTransferReturnsPage extends Page<InboundACHTransferReturn> {}
+
+/**
+ * If unauthorized activity occurs via ACH, you can create an Inbound ACH Transfer
+ * Return and we'll reverse the transaction. You can create an Inbound ACH Transfer
+ * return the first two days after receiving an Inbound ACH Transfer.
+ */
+export interface InboundACHTransferReturn {
+  /**
+   * The ID of the Inbound ACH Transfer Return.
+   */
+  id: string;
+
+  /**
+   * The ID for the Transaction that is being returned.
+   */
+  inbound_ach_transfer_transaction_id: string;
+
+  /**
+   * The reason why this transfer will be returned. This is sent to the initiating
+   * bank.
+   */
+  reason:
+    | 'authorization_revoked_by_customer'
+    | 'payment_stopped'
+    | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
+    | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+    | 'beneficiary_or_account_holder_deceased'
+    | 'credit_entry_refused_by_receiver'
+    | 'duplicate_entry'
+    | 'corporate_customer_advised_not_authorized';
+
+  /**
+   * The lifecycle status of the transfer.
+   */
+  status: 'pending_submitting' | 'submitted';
+
+  /**
+   * After the return is submitted to FedACH, this will contain supplemental details.
+   */
+  submission: InboundACHTransferReturn.Submission | null;
+
+  /**
+   * The ID for the transaction refunding the transfer.
+   */
+  transaction_id: string | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `inbound_ach_transfer_return`.
+   */
+  type: 'inbound_ach_transfer_return';
+}
+
+export namespace InboundACHTransferReturn {
+  export interface Submission {
+    /**
+     * When the ACH transfer return was sent to FedACH.
+     */
+    submitted_at: string;
+
+    /**
+     * The trace number for the submission.
+     */
+    trace_number: string;
+  }
+}
+
+export interface InboundACHTransferReturnCreateParams {
+  /**
+   * The reason why this transfer will be returned. The most usual return codes are
+   * `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
+   */
+  reason:
+    | 'authorization_revoked_by_customer'
+    | 'payment_stopped'
+    | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
+    | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+    | 'beneficiary_or_account_holder_deceased'
+    | 'credit_entry_refused_by_receiver'
+    | 'duplicate_entry'
+    | 'corporate_customer_advised_not_authorized';
+
+  /**
+   * The transaction identifier of the Inbound ACH Transfer to return to the
+   * originating financial institution.
+   */
+  transaction_id: string;
+}
+
+export interface InboundACHTransferReturnListParams extends PageParams {}

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

@@ -0,0 +1,168 @@
+// 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 InboundWireDrawdownRequests extends APIResource {
+  /**
+   * Retrieve an Inbound Wire Drawdown Request
+   */
+  retrieve(
+    inboundWireDrawdownRequestId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<InboundWireDrawdownRequest>> {
+    return this.get(`/inbound_wire_drawdown_requests/${inboundWireDrawdownRequestId}`, options);
+  }
+
+  /**
+   * List Inbound Wire Drawdown Requests
+   */
+  list(
+    query?: InboundWireDrawdownRequestListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundWireDrawdownRequestsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InboundWireDrawdownRequestsPage>;
+  list(
+    query: InboundWireDrawdownRequestListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundWireDrawdownRequestsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/inbound_wire_drawdown_requests', InboundWireDrawdownRequestsPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class InboundWireDrawdownRequestsPage extends Page<InboundWireDrawdownRequest> {}
+
+/**
+ * Inbound wire drawdown requests are requests from someone else to send them a
+ * wire. This feature is in beta; reach out to
+ * [support@increase.com](mailto:support@increase.com) to learn more.
+ */
+export interface InboundWireDrawdownRequest {
+  /**
+   * The amount being requested in cents.
+   */
+  amount: number;
+
+  /**
+   * The drawdown request's beneficiary's account number.
+   */
+  beneficiary_account_number: string;
+
+  /**
+   * Line 1 of the drawdown request's beneficiary's address.
+   */
+  beneficiary_address_line1: string | null;
+
+  /**
+   * Line 2 of the drawdown request's beneficiary's address.
+   */
+  beneficiary_address_line2: string | null;
+
+  /**
+   * Line 3 of the drawdown request's beneficiary's address.
+   */
+  beneficiary_address_line3: string | null;
+
+  /**
+   * The drawdown request's beneficiary's name.
+   */
+  beneficiary_name: string | null;
+
+  /**
+   * The drawdown request's beneficiary's routing number.
+   */
+  beneficiary_routing_number: string;
+
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+   * requested. Will always be "USD".
+   */
+  currency: string;
+
+  /**
+   * The Wire drawdown request identifier.
+   */
+  id: string;
+
+  /**
+   * A message from the drawdown request's originator.
+   */
+  message_to_recipient: string | null;
+
+  /**
+   * The drawdown request's originator's account number.
+   */
+  originator_account_number: string;
+
+  /**
+   * Line 1 of the drawdown request's originator's address.
+   */
+  originator_address_line1: string | null;
+
+  /**
+   * Line 2 of the drawdown request's originator's address.
+   */
+  originator_address_line2: string | null;
+
+  /**
+   * Line 3 of the drawdown request's originator's address.
+   */
+  originator_address_line3: string | null;
+
+  /**
+   * The drawdown request's originator's name.
+   */
+  originator_name: string | null;
+
+  /**
+   * The drawdown request's originator's routing number.
+   */
+  originator_routing_number: string;
+
+  /**
+   * Line 1 of the information conveyed from the originator of the message to the
+   * beneficiary.
+   */
+  originator_to_beneficiary_information_line1: string | null;
+
+  /**
+   * Line 2 of the information conveyed from the originator of the message to the
+   * beneficiary.
+   */
+  originator_to_beneficiary_information_line2: string | null;
+
+  /**
+   * Line 3 of the information conveyed from the originator of the message to the
+   * beneficiary.
+   */
+  originator_to_beneficiary_information_line3: string | null;
+
+  /**
+   * Line 4 of the information conveyed from the originator of the message to the
+   * beneficiary.
+   */
+  originator_to_beneficiary_information_line4: string | null;
+
+  /**
+   * The Account Number from which the recipient of this request is being requested
+   * to send funds.
+   */
+  recipient_account_number_id: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `inbound_wire_drawdown_request`.
+   */
+  type: 'inbound_wire_drawdown_request';
+}
+
+export interface InboundWireDrawdownRequestListParams extends PageParams {}

package/resources/index.ts

@@ -0,0 +1,165 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export * from './shared';
+export {
+  ACHPrenotification,
+  ACHPrenotificationCreateParams,
+  ACHPrenotificationListParams,
+  ACHPrenotificationsPage,
+  ACHPrenotifications,
+} from './ach-prenotifications';
+export {
+  ACHTransfer,
+  ACHTransferCreateParams,
+  ACHTransferListParams,
+  ACHTransfersPage,
+  ACHTransfers,
+} from './ach-transfers';
+export {
+  Account,
+  AccountCreateParams,
+  AccountUpdateParams,
+  AccountListParams,
+  AccountsPage,
+  Accounts,
+} from './accounts';
+export {
+  AccountNumber,
+  AccountNumberCreateParams,
+  AccountNumberUpdateParams,
+  AccountNumberListParams,
+  AccountNumbersPage,
+  AccountNumbers,
+} from './account-numbers';
+export {
+  AccountStatement,
+  AccountStatementListParams,
+  AccountStatementsPage,
+  AccountStatements,
+} from './account-statements';
+export {
+  AccountTransfer,
+  AccountTransferCreateParams,
+  AccountTransferListParams,
+  AccountTransfersPage,
+  AccountTransfers,
+} from './account-transfers';
+export {
+  Card,
+  CardDetails,
+  CardCreateParams,
+  CardUpdateParams,
+  CardListParams,
+  CardsPage,
+  Cards,
+} from './cards';
+export {
+  CardDispute,
+  CardDisputeCreateParams,
+  CardDisputeListParams,
+  CardDisputesPage,
+  CardDisputes,
+} from './card-disputes';
+export {
+  CardProfile,
+  CardProfileCreateParams,
+  CardProfileListParams,
+  CardProfilesPage,
+  CardProfiles,
+} from './card-profiles';
+export {
+  CheckDeposit,
+  CheckDepositCreateParams,
+  CheckDepositListParams,
+  CheckDepositsPage,
+  CheckDeposits,
+} from './check-deposits';
+export {
+  CheckTransfer,
+  CheckTransferCreateParams,
+  CheckTransferListParams,
+  CheckTransfersPage,
+  CheckTransfers,
+} from './check-transfers';
+export {
+  DeclinedTransaction,
+  DeclinedTransactionListParams,
+  DeclinedTransactionsPage,
+  DeclinedTransactions,
+} from './declined-transactions';
+export {
+  DigitalWalletToken,
+  DigitalWalletTokenListParams,
+  DigitalWalletTokensPage,
+  DigitalWalletTokens,
+} from './digital-wallet-tokens';
+export { Document, DocumentListParams, DocumentsPage, Documents } from './documents';
+export { Entity, EntityCreateParams, EntityListParams, EntitiesPage, Entities } from './entities/entities';
+export { Event, EventListParams, EventsPage, Events } from './events';
+export {
+  EventSubscription,
+  EventSubscriptionCreateParams,
+  EventSubscriptionUpdateParams,
+  EventSubscriptionListParams,
+  EventSubscriptionsPage,
+  EventSubscriptions,
+} from './event-subscriptions';
+export {
+  ExternalAccount,
+  ExternalAccountCreateParams,
+  ExternalAccountUpdateParams,
+  ExternalAccountListParams,
+  ExternalAccountsPage,
+  ExternalAccounts,
+} from './external-accounts';
+export { File, FileCreateParams, FileListParams, FilesPage, Files } from './files';
+export { Group, Groups } from './groups';
+export {
+  InboundACHTransferReturn,
+  InboundACHTransferReturnCreateParams,
+  InboundACHTransferReturnListParams,
+  InboundACHTransferReturnsPage,
+  InboundACHTransferReturns,
+} from './inbound-ach-transfer-returns';
+export {
+  InboundWireDrawdownRequest,
+  InboundWireDrawdownRequestListParams,
+  InboundWireDrawdownRequestsPage,
+  InboundWireDrawdownRequests,
+} from './inbound-wire-drawdown-requests';
+export { Limit, LimitCreateParams, LimitUpdateParams, LimitListParams, LimitsPage, Limits } from './limits';
+export {
+  OauthConnection,
+  OauthConnectionListParams,
+  OauthConnectionsPage,
+  OauthConnections,
+} from './oauth-connections';
+export {
+  PendingTransaction,
+  PendingTransactionListParams,
+  PendingTransactionsPage,
+  PendingTransactions,
+} from './pending-transactions';
+export { RealTimeDecision, RealTimeDecisionActionParams, RealTimeDecisions } from './real-time-decisions';
+export {
+  RoutingNumber,
+  RoutingNumberListParams,
+  RoutingNumbersPage,
+  RoutingNumbers,
+} from './routing-numbers';
+export { Simulations } from './simulations/simulations';
+export { Transaction, TransactionListParams, TransactionsPage, Transactions } from './transactions';
+export {
+  WireDrawdownRequest,
+  WireDrawdownRequestCreateParams,
+  WireDrawdownRequestListParams,
+  WireDrawdownRequestsPage,
+  WireDrawdownRequests,
+} from './wire-drawdown-requests';
+export {
+  WireTransfer,
+  WireTransferCreateParams,
+  WireTransferListParams,
+  WireTransfersPage,
+  WireTransfers,
+} from './wire-transfers';