increase 0.1.0

package/resources/wire-drawdown-requests.ts

@@ -0,0 +1,195 @@
+// 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 WireDrawdownRequests extends APIResource {
+  /**
+   * Create a Wire Drawdown Request
+   */
+  create(
+    body: WireDrawdownRequestCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<WireDrawdownRequest>> {
+    return this.post('/wire_drawdown_requests', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Wire Drawdown Request
+   */
+  retrieve(
+    wireDrawdownRequestId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<WireDrawdownRequest>> {
+    return this.get(`/wire_drawdown_requests/${wireDrawdownRequestId}`, options);
+  }
+
+  /**
+   * List Wire Drawdown Requests
+   */
+  list(
+    query?: WireDrawdownRequestListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<WireDrawdownRequestsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<WireDrawdownRequestsPage>;
+  list(
+    query: WireDrawdownRequestListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<WireDrawdownRequestsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/wire_drawdown_requests', WireDrawdownRequestsPage, { query, ...options });
+  }
+}
+
+export class WireDrawdownRequestsPage extends Page<WireDrawdownRequest> {}
+
+/**
+ * Wire drawdown requests enable you to request that someone else send you a wire.
+ * This feature is in beta; reach out to
+ * [support@increase.com](mailto:support@increase.com) to learn more.
+ */
+export interface WireDrawdownRequest {
+  /**
+   * The Account Number to which the recipient of this request is being requested to
+   * send funds.
+   */
+  account_number_id: string;
+
+  /**
+   * The amount being requested in cents.
+   */
+  amount: number;
+
+  /**
+   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+   * requested. Will always be "USD".
+   */
+  currency: string;
+
+  /**
+   * If the recipient fulfills the drawdown request by sending funds, then this will
+   * be the identifier of the corresponding Transaction.
+   */
+  fulfillment_transaction_id: string | null;
+
+  /**
+   * The Wire drawdown request identifier.
+   */
+  id: string;
+
+  /**
+   * The message the recipient will see as part of the drawdown request.
+   */
+  message_to_recipient: string;
+
+  /**
+   * The drawdown request's recipient's account number.
+   */
+  recipient_account_number: string;
+
+  /**
+   * Line 1 of the drawdown request's recipient's address.
+   */
+  recipient_address_line1: string | null;
+
+  /**
+   * Line 2 of the drawdown request's recipient's address.
+   */
+  recipient_address_line2: string | null;
+
+  /**
+   * Line 3 of the drawdown request's recipient's address.
+   */
+  recipient_address_line3: string | null;
+
+  /**
+   * The drawdown request's recipient's name.
+   */
+  recipient_name: string | null;
+
+  /**
+   * The drawdown request's recipient's routing number.
+   */
+  recipient_routing_number: string;
+
+  /**
+   * The lifecycle status of the drawdown request.
+   */
+  status: 'pending_submission' | 'pending_response' | 'fulfilled' | 'refused';
+
+  /**
+   * After the drawdown request is submitted to Fedwire, this will contain
+   * supplemental details.
+   */
+  submission: WireDrawdownRequest.Submission | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `wire_drawdown_request`.
+   */
+  type: 'wire_drawdown_request';
+}
+
+export namespace WireDrawdownRequest {
+  export interface Submission {
+    /**
+     * The input message accountability data (IMAD) uniquely identifying the submission
+     * with Fedwire.
+     */
+    input_message_accountability_data: string;
+  }
+}
+
+export interface WireDrawdownRequestCreateParams {
+  /**
+   * The Account Number to which the recipient should send funds.
+   */
+  account_number_id: string;
+
+  /**
+   * The amount requested from the recipient, in cents.
+   */
+  amount: number;
+
+  /**
+   * A message the recipient will see as part of the request.
+   */
+  message_to_recipient: string;
+
+  /**
+   * The drawdown request's recipient's account number.
+   */
+  recipient_account_number: string;
+
+  /**
+   * The drawdown request's recipient's name.
+   */
+  recipient_name: string;
+
+  /**
+   * The drawdown request's recipient's routing number.
+   */
+  recipient_routing_number: string;
+
+  /**
+   * Line 1 of the drawdown request's recipient's address.
+   */
+  recipient_address_line1?: string;
+
+  /**
+   * Line 2 of the drawdown request's recipient's address.
+   */
+  recipient_address_line2?: string;
+
+  /**
+   * Line 3 of the drawdown request's recipient's address.
+   */
+  recipient_address_line3?: string;
+}
+
+export interface WireDrawdownRequestListParams extends PageParams {}

package/resources/wire-transfers.ts

@@ -0,0 +1,399 @@
+// 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 WireTransfers extends APIResource {
+  /**
+   * Create a Wire Transfer
+   */
+  create(
+    body: WireTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<WireTransfer>> {
+    return this.post('/wire_transfers', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Wire Transfer
+   */
+  retrieve(wireTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<WireTransfer>> {
+    return this.get(`/wire_transfers/${wireTransferId}`, options);
+  }
+
+  /**
+   * List Wire Transfers
+   */
+  list(query?: WireTransferListParams, options?: Core.RequestOptions): Core.PagePromise<WireTransfersPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<WireTransfersPage>;
+  list(
+    query: WireTransferListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<WireTransfersPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/wire_transfers', WireTransfersPage, { query, ...options });
+  }
+
+  /**
+   * Approve a Wire Transfer
+   */
+  approve(wireTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<WireTransfer>> {
+    return this.post(`/wire_transfers/${wireTransferId}/approve`, options);
+  }
+
+  /**
+   * Cancel a pending Wire Transfer
+   */
+  cancel(wireTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<WireTransfer>> {
+    return this.post(`/wire_transfers/${wireTransferId}/cancel`, options);
+  }
+
+  /**
+   * Simulates the reversal of a [Wire Transfer](#wire-transfers) by the Federal
+   * Reserve due to error conditions. This will also create a
+   * [Transaction](#transaction) to account for the returned funds. This Wire
+   * Transfer must first have a `status` of `complete`.'
+   */
+  reverse(wireTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<WireTransfer>> {
+    return this.post(`/simulations/wire_transfers/${wireTransferId}/reverse`, options);
+  }
+
+  /**
+   * Simulates the submission of a [Wire Transfer](#wire-transfers) to the Federal
+   * Reserve. This transfer must first have a `status` of `pending_approval` or
+   * `pending_creating`.
+   */
+  submit(wireTransferId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<WireTransfer>> {
+    return this.post(`/simulations/wire_transfers/${wireTransferId}/submit`, options);
+  }
+}
+
+export class WireTransfersPage extends Page<WireTransfer> {}
+
+/**
+ * Wire transfers move funds between your Increase account and any other account
+ * accessible by Fedwire.
+ */
+export interface WireTransfer {
+  /**
+   * The Account to which the transfer belongs.
+   */
+  account_id: string;
+
+  /**
+   * The destination account number.
+   */
+  account_number: string;
+
+  /**
+   * The transfer amount in USD cents.
+   */
+  amount: number;
+
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  approval: WireTransfer.Approval | null;
+
+  /**
+   * The beneficiary's address line 1.
+   */
+  beneficiary_address_line1: string | null;
+
+  /**
+   * The beneficiary's address line 2.
+   */
+  beneficiary_address_line2: string | null;
+
+  /**
+   * The beneficiary's address line 3.
+   */
+  beneficiary_address_line3: string | null;
+
+  /**
+   * The beneficiary's name.
+   */
+  beneficiary_name: string | null;
+
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  cancellation: WireTransfer.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 transfer's
+   * currency. For wire transfers this is always equal to `usd`.
+   */
+  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+  /**
+   * The identifier of the External Account the transfer was made to, if any.
+   */
+  external_account_id: string | null;
+
+  /**
+   * The wire transfer's identifier.
+   */
+  id: string;
+
+  /**
+   * The message that will show on the recipient's bank statement.
+   */
+  message_to_recipient: string | null;
+
+  /**
+   * The transfer's network.
+   */
+  network: 'wire';
+
+  /**
+   * If your transfer is reversed, this will contain details of the reversal.
+   */
+  reversal: WireTransfer.Reversal | null;
+
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN).
+   */
+  routing_number: string;
+
+  /**
+   * The lifecycle status of the transfer.
+   */
+  status:
+    | 'canceled'
+    | 'requires_attention'
+    | 'pending_approval'
+    | 'rejected'
+    | 'reversed'
+    | 'complete'
+    | 'pending_creating';
+
+  /**
+   * After the transfer is submitted to Fedwire, this will contain supplemental
+   * details.
+   */
+  submission: WireTransfer.Submission | null;
+
+  /**
+   * If the transfer was created from a template, this will be the template's ID.
+   */
+  template_id: string | null;
+
+  /**
+   * 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
+   * `wire_transfer`.
+   */
+  type: 'wire_transfer';
+}
+
+export namespace WireTransfer {
+  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;
+  }
+
+  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;
+  }
+
+  export interface Reversal {
+    /**
+     * The amount that was reversed.
+     */
+    amount: number;
+
+    /**
+     * The description on the reversal message from Fedwire.
+     */
+    description: string;
+
+    /**
+     * Additional financial institution information included in the wire reversal.
+     */
+    financial_institution_to_financial_institution_information: string | null;
+
+    /**
+     * The Fedwire cycle date for the wire reversal.
+     */
+    input_cycle_date: string;
+
+    /**
+     * The Fedwire transaction identifier.
+     */
+    input_message_accountability_data: string;
+
+    /**
+     * The Fedwire sequence number.
+     */
+    input_sequence_number: string;
+
+    /**
+     * The Fedwire input source identifier.
+     */
+    input_source: string;
+
+    /**
+     * The Fedwire cycle date for the wire transfer that was reversed.
+     */
+    previous_message_input_cycle_date: string;
+
+    /**
+     * The Fedwire transaction identifier for the wire transfer that was reversed.
+     */
+    previous_message_input_message_accountability_data: string;
+
+    /**
+     * The Fedwire sequence number for the wire transfer that was reversed.
+     */
+    previous_message_input_sequence_number: string;
+
+    /**
+     * The Fedwire input source identifier for the wire transfer that was reversed.
+     */
+    previous_message_input_source: string;
+
+    /**
+     * Information included in the wire reversal for the receiving financial
+     * institution.
+     */
+    receiver_financial_institution_information: string | null;
+  }
+
+  export interface Submission {
+    /**
+     * The accountability data for the submission.
+     */
+    input_message_accountability_data: string;
+
+    /**
+     * When this wire transfer was submitted to Fedwire.
+     */
+    submitted_at: string;
+  }
+}
+
+export interface WireTransferCreateParams {
+  /**
+   * The identifier for the account that will send the transfer.
+   */
+  account_id: string;
+
+  /**
+   * The transfer amount in cents.
+   */
+  amount: number;
+
+  /**
+   * The beneficiary's name.
+   */
+  beneficiary_name: string;
+
+  /**
+   * The message that will show on the recipient's bank statement.
+   */
+  message_to_recipient: string;
+
+  /**
+   * The account number for the destination account.
+   */
+  account_number?: string;
+
+  /**
+   * The beneficiary's address line 1.
+   */
+  beneficiary_address_line1?: string;
+
+  /**
+   * The beneficiary's address line 2.
+   */
+  beneficiary_address_line2?: string;
+
+  /**
+   * The beneficiary's address line 3.
+   */
+  beneficiary_address_line3?: string;
+
+  /**
+   * The ID of an External Account to initiate a transfer to. If this parameter is
+   * provided, `account_number` and `routing_number` must be absent.
+   */
+  external_account_id?: string;
+
+  /**
+   * Whether the transfer requires explicit approval via the dashboard or API.
+   */
+  require_approval?: boolean;
+
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+   * destination account.
+   */
+  routing_number?: string;
+}
+
+export interface WireTransferListParams extends PageParams {
+  /**
+   * Filter Wire Transfers to those belonging to the specified Account.
+   */
+  account_id?: string;
+
+  created_at?: WireTransferListParams.CreatedAt;
+
+  /**
+   * Filter Wire Transfers to those made to the specified External Account.
+   */
+  external_account_id?: string;
+}
+
+export namespace WireTransferListParams {
+  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/tests/api-resources/account-numbers.test.ts

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Increase from '~/index';
+const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource account_numbers', () => {
+  test('create', async () => {
+    const response = await increase.accountNumbers.create({
+      account_id: 'account_in71c4amph0vgo2qllky',
+      name: 'Rent payments',
+    });
+  });
+
+  test('retrieve', async () => {
+    const response = await increase.accountNumbers.retrieve('account_number_v18nkfqm6afpsrvy82b2');
+  });
+
+  test('retrieve: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      increase.accountNumbers.retrieve('account_number_v18nkfqm6afpsrvy82b2', {
+        path: '/_stainless_unknown_path',
+      }),
+    ).rejects.toThrow(Increase.NotFoundError);
+  });
+
+  test('update: only required params', async () => {
+    const response = await increase.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2', {});
+  });
+
+  test('update: required and optional params', async () => {
+    const response = await increase.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2', {
+      name: 'x',
+      status: 'disabled',
+    });
+  });
+
+  test('list: only required params', async () => {
+    const response = await increase.accountNumbers.list();
+  });
+
+  test('list: required and optional params', async () => {
+    const response = await increase.accountNumbers.list({
+      cursor: 'string',
+      limit: 0,
+      status: 'active',
+      account_id: 'string',
+    });
+  });
+
+  test('list: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(increase.accountNumbers.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Increase.NotFoundError,
+    );
+  });
+
+  test('list: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      increase.accountNumbers.list(
+        { cursor: 'string', limit: 0, status: 'active', account_id: 'string' },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(Increase.NotFoundError);
+  });
+});