increase 0.4.0 → 0.6.0

package/src/resources/account-statements.ts

@@ -0,0 +1,140 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import { isRequestOptions } from 'increase/core';
+import * as API from './';
+import { Page, PageParams } from 'increase/pagination';
+
+export class AccountStatements extends APIResource {
+  /**
+   * Retrieve an Account Statement
+   */
+  retrieve(
+    accountStatementId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<AccountStatement>> {
+    return this.get(`/account_statements/${accountStatementId}`, options);
+  }
+
+  /**
+   * List Account Statements
+   */
+  list(
+    query?: AccountStatementListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AccountStatementsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountStatementsPage>;
+  list(
+    query: AccountStatementListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AccountStatementsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/account_statements', AccountStatementsPage, { query, ...options });
+  }
+}
+
+export class AccountStatementsPage extends Page<AccountStatement> {}
+// alias so we can export it in the namespace
+type _AccountStatementsPage = AccountStatementsPage;
+
+/**
+ * Account Statements are generated monthly for every active Account. You can
+ * access the statement's data via the API or retrieve a PDF with its details via
+ * its associated File.
+ */
+export interface AccountStatement {
+  /**
+   * The Account Statement identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier for the Account this Account Statement belongs to.
+   */
+  account_id: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+   * Statement was created.
+   */
+  created_at: string;
+
+  /**
+   * The Account's balance at the start of its statement period.
+   */
+  ending_balance: number;
+
+  /**
+   * The identifier of the File containing a PDF of the statement.
+   */
+  file_id: string;
+
+  /**
+   * The Account's balance at the start of its statement period.
+   */
+  starting_balance: number;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
+   * of the period the Account Statement covers.
+   */
+  statement_period_end: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
+   * start of the period the Account Statement covers.
+   */
+  statement_period_start: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `account_statement`.
+   */
+  type: 'account_statement';
+}
+
+export interface AccountStatementListParams extends PageParams {
+  /**
+   * Filter Account Statements to those belonging to the specified Account.
+   */
+  account_id?: string;
+
+  statement_period_start?: AccountStatementListParams.StatementPeriodStart;
+}
+
+export namespace AccountStatementListParams {
+  export interface StatementPeriodStart {
+    /**
+     * 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 namespace AccountStatements {
+  export import AccountStatement = API.AccountStatement;
+  export type AccountStatementsPage = _AccountStatementsPage;
+  export import AccountStatementListParams = API.AccountStatementListParams;
+}

package/src/resources/account-transfers.ts

@@ -0,0 +1,273 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import { isRequestOptions } from 'increase/core';
+import * as API from './';
+import { Page, PageParams } from 'increase/pagination';
+
+export class AccountTransfers extends APIResource {
+  /**
+   * Create an Account Transfer
+   */
+  create(
+    body: AccountTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<AccountTransfer>> {
+    return this.post('/account_transfers', { body, ...options });
+  }
+
+  /**
+   * Retrieve an Account Transfer
+   */
+  retrieve(
+    accountTransferId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<AccountTransfer>> {
+    return this.get(`/account_transfers/${accountTransferId}`, options);
+  }
+
+  /**
+   * List Account Transfers
+   */
+  list(
+    query?: AccountTransferListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AccountTransfersPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountTransfersPage>;
+  list(
+    query: AccountTransferListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AccountTransfersPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/account_transfers', AccountTransfersPage, { query, ...options });
+  }
+
+  /**
+   * Approve an Account Transfer
+   */
+  approve(
+    accountTransferId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<AccountTransfer>> {
+    return this.post(`/account_transfers/${accountTransferId}/approve`, options);
+  }
+
+  /**
+   * Cancel an Account Transfer
+   */
+  cancel(
+    accountTransferId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<AccountTransfer>> {
+    return this.post(`/account_transfers/${accountTransferId}/cancel`, options);
+  }
+}
+
+export class AccountTransfersPage extends Page<AccountTransfer> {}
+// alias so we can export it in the namespace
+type _AccountTransfersPage = AccountTransfersPage;
+
+/**
+ * Account transfers move funds between your own accounts at Increase.
+ */
+export interface AccountTransfer {
+  /**
+   * The account transfer's identifier.
+   */
+  id: string;
+
+  /**
+   * The Account to which the transfer belongs.
+   */
+  account_id: string;
+
+  /**
+   * The transfer amount in the minor unit of the destination account currency. For
+   * dollars, for example, this is cents.
+   */
+  amount: number;
+
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  approval: AccountTransfer.Approval | null;
+
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  cancellation: AccountTransfer.Cancellation | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the transfer was created.
+   */
+  created_at: string;
+
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
+   * account currency.
+   *
+   * - `CAD` - Canadian Dollar (CAD)
+   * - `CHF` - Swiss Franc (CHF)
+   * - `EUR` - Euro (EUR)
+   * - `GBP` - British Pound (GBP)
+   * - `JPY` - Japanese Yen (JPY)
+   * - `USD` - US Dollar (USD)
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+  /**
+   * The description that will show on the transactions.
+   */
+  description: string;
+
+  /**
+   * The destination account's identifier.
+   */
+  destination_account_id: string;
+
+  /**
+   * The ID for the transaction receiving the transfer.
+   */
+  destination_transaction_id: string | null;
+
+  /**
+   * The transfer's network.
+   */
+  network: 'account';
+
+  /**
+   * The lifecycle status of the transfer.
+   *
+   * - `pending_approval` - The transfer is pending approval.
+   * - `canceled` - The transfer has been canceled.
+   * - `complete` - The transfer has been completed.
+   */
+  status: 'pending_approval' | 'canceled' | 'complete';
+
+  /**
+   * The ID for the transaction funding the transfer.
+   */
+  transaction_id: string | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `account_transfer`.
+   */
+  type: 'account_transfer';
+}
+
+export namespace AccountTransfer {
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  export interface Approval {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was approved.
+     */
+    approved_at: string;
+
+    /**
+     * If the Transfer was approved by a user in the dashboard, the email address of
+     * that user.
+     */
+    approved_by: string | null;
+  }
+
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  export interface Cancellation {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Transfer was canceled.
+     */
+    canceled_at: string;
+
+    /**
+     * If the Transfer was canceled by a user in the dashboard, the email address of
+     * that user.
+     */
+    canceled_by: string | null;
+  }
+}
+
+export interface AccountTransferCreateParams {
+  /**
+   * The identifier for the account that will send the transfer.
+   */
+  account_id: string;
+
+  /**
+   * The transfer amount in the minor unit of the account currency. For dollars, for
+   * example, this is cents.
+   */
+  amount: number;
+
+  /**
+   * The description you choose to give the transfer.
+   */
+  description: string;
+
+  /**
+   * The identifier for the account that will receive the transfer.
+   */
+  destination_account_id: string;
+
+  /**
+   * Whether the transfer requires explicit approval via the dashboard or API.
+   */
+  require_approval?: boolean;
+}
+
+export interface AccountTransferListParams extends PageParams {
+  /**
+   * Filter Account Transfers to those that originated from the specified Account.
+   */
+  account_id?: string;
+
+  created_at?: AccountTransferListParams.CreatedAt;
+}
+
+export namespace AccountTransferListParams {
+  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 namespace AccountTransfers {
+  export import AccountTransfer = API.AccountTransfer;
+  export type AccountTransfersPage = _AccountTransfersPage;
+  export import AccountTransferCreateParams = API.AccountTransferCreateParams;
+  export import AccountTransferListParams = API.AccountTransferListParams;
+}

package/src/resources/accounts.ts

@@ -0,0 +1,228 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import { isRequestOptions } from 'increase/core';
+import * as API from './';
+import { Page, PageParams } from 'increase/pagination';
+
+export class Accounts extends APIResource {
+  /**
+   * Create an Account
+   */
+  create(body: AccountCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Account>> {
+    return this.post('/accounts', { body, ...options });
+  }
+
+  /**
+   * Retrieve an Account
+   */
+  retrieve(accountId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Account>> {
+    return this.get(`/accounts/${accountId}`, options);
+  }
+
+  /**
+   * Update an Account
+   */
+  update(
+    accountId: string,
+    body: AccountUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Account>> {
+    return this.patch(`/accounts/${accountId}`, { body, ...options });
+  }
+
+  /**
+   * List Accounts
+   */
+  list(query?: AccountListParams, options?: Core.RequestOptions): Core.PagePromise<AccountsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AccountsPage>;
+  list(
+    query: AccountListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AccountsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/accounts', AccountsPage, { query, ...options });
+  }
+
+  /**
+   * Close an Account
+   */
+  close(accountId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Account>> {
+    return this.post(`/accounts/${accountId}/close`, options);
+  }
+}
+
+export class AccountsPage extends Page<Account> {}
+// alias so we can export it in the namespace
+type _AccountsPage = AccountsPage;
+
+/**
+ * Accounts are your bank accounts with Increase. They store money, receive
+ * transfers, and send payments. They earn interest and have depository insurance.
+ */
+export interface Account {
+  /**
+   * The Account identifier.
+   */
+  id: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
+   * was created.
+   */
+  created_at: string;
+
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
+   * currency.
+   *
+   * - `CAD` - Canadian Dollar (CAD)
+   * - `CHF` - Swiss Franc (CHF)
+   * - `EUR` - Euro (EUR)
+   * - `GBP` - British Pound (GBP)
+   * - `JPY` - Japanese Yen (JPY)
+   * - `USD` - US Dollar (USD)
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+  /**
+   * The identifier for the Entity the Account belongs to.
+   */
+  entity_id: string | null;
+
+  /**
+   * The identifier of an Entity that, while not owning the Account, is associated
+   * with its activity.
+   */
+  informational_entity_id: string | null;
+
+  /**
+   * The interest accrued but not yet paid, expressed as a string containing a
+   * floating-point value.
+   */
+  interest_accrued: string;
+
+  /**
+   * The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which
+   * interest was accrued.
+   */
+  interest_accrued_at: string | null;
+
+  /**
+   * The Interest Rate currently being earned on the account, as a string containing
+   * a decimal number. For example, a 1% interest rate would be represented as
+   * "0.01".
+   */
+  interest_rate: string;
+
+  /**
+   * The name you choose for the Account.
+   */
+  name: string;
+
+  /**
+   * The status of the Account.
+   *
+   * - `open` - Open Accounts that are ready to use.
+   * - `closed` - Closed Accounts on which no new activity can occur.
+   */
+  status: 'open' | 'closed';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `account`.
+   */
+  type: 'account';
+}
+
+export interface AccountCreateParams {
+  /**
+   * The name you choose for the Account.
+   */
+  name: string;
+
+  /**
+   * The identifier for the Entity that will own the Account.
+   */
+  entity_id?: string;
+
+  /**
+   * The identifier of an Entity that, while not owning the Account, is associated
+   * with its activity. Its relationship to your group must be `informational`.
+   */
+  informational_entity_id?: string;
+
+  /**
+   * The identifier for the Program that this Account falls under. Required if you
+   * operate more than one Program.
+   */
+  program_id?: string;
+}
+
+export interface AccountUpdateParams {
+  /**
+   * The new name of the Account.
+   */
+  name?: string;
+}
+
+export interface AccountListParams extends PageParams {
+  created_at?: AccountListParams.CreatedAt;
+
+  /**
+   * Filter Accounts for those belonging to the specified Entity.
+   */
+  entity_id?: string;
+
+  /**
+   * Filter Accounts for those belonging to the specified Entity as informational.
+   */
+  informational_entity_id?: string;
+
+  /**
+   * Filter Accounts for those with the specified status.
+   *
+   * - `open` - Open Accounts that are ready to use.
+   * - `closed` - Closed Accounts on which no new activity can occur.
+   */
+  status?: 'open' | 'closed';
+}
+
+export namespace AccountListParams {
+  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 namespace Accounts {
+  export import Account = API.Account;
+  export type AccountsPage = _AccountsPage;
+  export import AccountCreateParams = API.AccountCreateParams;
+  export import AccountUpdateParams = API.AccountUpdateParams;
+  export import AccountListParams = API.AccountListParams;
+}