increase 0.4.0 → 0.5.0

package/resources/transactions.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class Transactions extends APIResource {
@@ -36,6 +37,11 @@ export class TransactionsPage extends Page<Transaction> {}
  * account. They're the equivalent of line items on your bank statement.
  */
 export interface Transaction {
+  /**
+   * The Transaction identifier.
+   */
+  id: string;
+
   /**
    * The identifier for the Account the Transaction belongs to.
    */
@@ -67,11 +73,6 @@ export interface Transaction {
    */
   description: string;
 
-  /**
-   * The Transaction identifier.
-   */
-  id: string;
-
   /**
    * The identifier for the route this Transaction came through. Routes are things
    * like cards and ACH details.
@@ -166,13 +167,14 @@ export namespace Transaction {
       | 'ach_transfer_return'
       | 'card_dispute_acceptance'
       | 'card_refund'
-      | 'card_settlement'
       | 'card_revenue_payment'
+      | 'card_settlement'
       | 'check_deposit_acceptance'
       | 'check_deposit_return'
+      | 'check_transfer_deposit'
       | 'check_transfer_intention'
-      | 'check_transfer_return'
       | 'check_transfer_rejection'
+      | 'check_transfer_return'
       | 'check_transfer_stop_payment_request'
       | 'fee_payment'
       | 'inbound_ach_transfer'
@@ -180,8 +182,8 @@ export namespace Transaction {
       | 'inbound_check'
       | 'inbound_international_ach_transfer'
       | 'inbound_real_time_payments_transfer_confirmation'
-      | 'inbound_wire_drawdown_payment_reversal'
       | 'inbound_wire_drawdown_payment'
+      | 'inbound_wire_drawdown_payment_reversal'
       | 'inbound_wire_reversal'
       | 'inbound_wire_transfer'
       | 'interest_payment'
@@ -204,6 +206,12 @@ export namespace Transaction {
      */
     check_deposit_return: Source.CheckDepositReturn | null;
 
+    /**
+     * A Check Transfer Deposit object. This field will be present in the JSON response
+     * if and only if `category` is equal to `check_transfer_deposit`.
+     */
+    check_transfer_deposit: Source.CheckTransferDeposit | null;
+
     /**
      * A Check Transfer Intention object. This field will be present in the JSON
      * response if and only if `category` is equal to `check_transfer_intention`.
@@ -438,7 +446,6 @@ export namespace Transaction {
         | 'returned_per_odfi_request'
         | 'limited_participation_dfi'
         | 'incorrectly_coded_outbound_international_payment'
-        | 'other'
         | 'account_sold_to_another_dfi'
         | 'addenda_error'
         | 'beneficiary_or_account_holder_deceased'
@@ -528,6 +535,11 @@ export namespace Transaction {
      * only if `category` is equal to `card_refund`.
      */
     export interface CardRefund {
+      /**
+       * The Card Refund identifier.
+       */
+      id: string;
+
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
        * for example, this is cents.
@@ -540,11 +552,6 @@ export namespace Transaction {
        */
       currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
-      /**
-       * The Card Refund identifier.
-       */
-      id: string;
-
       /**
        * The merchant identifier (commonly abbreviated as MID) of the merchant the card
        * is transacting with.
@@ -583,11 +590,49 @@ export namespace Transaction {
       type: 'card_refund';
     }
 
+    /**
+     * A Card Revenue Payment object. This field will be present in the JSON response
+     * if and only if `category` is equal to `card_revenue_payment`.
+     */
+    export interface CardRevenuePayment {
+      /**
+       * The amount in the minor unit of the transaction's currency. For dollars, for
+       * example, this is cents.
+       */
+      amount: number;
+
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
+       * currency.
+       */
+      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+
+      /**
+       * The end of the period for which this transaction paid interest.
+       */
+      period_end: string;
+
+      /**
+       * The start of the period for which this transaction paid interest.
+       */
+      period_start: string;
+
+      /**
+       * The account the card belonged to.
+       */
+      transacted_on_account_id: string | null;
+    }
+
     /**
      * A Card Settlement object. This field will be present in the JSON response if and
      * only if `category` is equal to `card_settlement`.
      */
     export interface CardSettlement {
+      /**
+       * The Card Settlement identifier.
+       */
+      id: string;
+
       /**
        * The amount in the minor unit of the transaction's settlement currency. For
        * dollars, for example, this is cents.
@@ -606,11 +651,6 @@ export namespace Transaction {
        */
       currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
-      /**
-       * The Card Settlement identifier.
-       */
-      id: string;
-
       /**
        * The merchant identifier (commonly abbreviated as MID) of the merchant the card
        * is transacting with.
@@ -665,39 +705,6 @@ export namespace Transaction {
       type: 'card_settlement';
     }
 
-    /**
-     * A Card Revenue Payment object. This field will be present in the JSON response
-     * if and only if `category` is equal to `card_revenue_payment`.
-     */
-    export interface CardRevenuePayment {
-      /**
-       * The amount in the minor unit of the transaction's currency. For dollars, for
-       * example, this is cents.
-       */
-      amount: number;
-
-      /**
-       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
-       * currency.
-       */
-      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-      /**
-       * The end of the period for which this transaction paid interest.
-       */
-      period_end: string;
-
-      /**
-       * The start of the period for which this transaction paid interest.
-       */
-      period_start: string;
-
-      /**
-       * The account the card belonged to.
-       */
-      transacted_on_account_id: string | null;
-    }
-
     /**
      * A Check Deposit Acceptance object. This field will be present in the JSON
      * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -792,6 +799,35 @@ export namespace Transaction {
       transaction_id: string;
     }
 
+    /**
+     * A Check Transfer Deposit object. This field will be present in the JSON response
+     * if and only if `category` is equal to `check_transfer_deposit`.
+     */
+    export interface CheckTransferDeposit {
+      /**
+       * The identifier of the API File object containing an image of the back of the
+       * deposited check.
+       */
+      back_image_file_id: string | null;
+
+      /**
+       * When the check was deposited.
+       */
+      deposited_at: string;
+
+      /**
+       * The identifier of the API File object containing an image of the front of the
+       * deposited check.
+       */
+      front_image_file_id: string | null;
+
+      /**
+       * A constant representing the object's type. For this resource it will always be
+       * `check_transfer_deposit`.
+       */
+      type: 'check_transfer_deposit';
+    }
+
     /**
      * A Check Transfer Intention object. This field will be present in the JSON
      * response if and only if `category` is equal to `check_transfer_intention`.
@@ -800,12 +836,12 @@ export namespace Transaction {
       /**
        * The city of the check's destination.
        */
-      address_city: string;
+      address_city: string | null;
 
       /**
        * The street address of the check's destination.
        */
-      address_line1: string;
+      address_line1: string | null;
 
       /**
        * The second line of the address of the check's destination.
@@ -815,12 +851,12 @@ export namespace Transaction {
       /**
        * The state of the check's destination.
        */
-      address_state: string;
+      address_state: string | null;
 
       /**
        * The postal code of the check's destination.
        */
-      address_zip: string;
+      address_zip: string | null;
 
       /**
        * The transfer amount in USD cents.
@@ -836,7 +872,7 @@ export namespace Transaction {
       /**
        * The name that will be printed on the check.
        */
-      recipient_name: string;
+      recipient_name: string | null;
 
       /**
        * The identifier of the Check Transfer with which this is associated.
@@ -844,6 +880,17 @@ export namespace Transaction {
       transfer_id: string;
     }
 
+    /**
+     * A Check Transfer Rejection object. This field will be present in the JSON
+     * response if and only if `category` is equal to `check_transfer_rejection`.
+     */
+    export interface CheckTransferRejection {
+      /**
+       * The identifier of the Check Transfer that led to this Transaction.
+       */
+      transfer_id: string;
+    }
+
     /**
      * A Check Transfer Return object. This field will be present in the JSON response
      * if and only if `category` is equal to `check_transfer_return`.
@@ -877,17 +924,6 @@ export namespace Transaction {
       transfer_id: string;
     }
 
-    /**
-     * A Check Transfer Rejection object. This field will be present in the JSON
-     * response if and only if `category` is equal to `check_transfer_rejection`.
-     */
-    export interface CheckTransferRejection {
-      /**
-       * The identifier of the Check Transfer that led to this Transaction.
-       */
-      transfer_id: string;
-    }
-
     /**
      * A Check Transfer Stop Payment Request object. This field will be present in the
      * JSON response if and only if `category` is equal to
@@ -1118,6 +1154,42 @@ export namespace Transaction {
       transaction_identification: string;
     }
 
+    /**
+     * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
+     * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
+     */
+    export interface InboundWireDrawdownPayment {
+      /**
+       * The amount in the minor unit of the transaction's currency. For dollars, for
+       * example, this is cents.
+       */
+      amount: number;
+
+      beneficiary_address_line1: string | null;
+
+      beneficiary_address_line2: string | null;
+
+      beneficiary_address_line3: string | null;
+
+      beneficiary_name: string | null;
+
+      beneficiary_reference: string | null;
+
+      description: string;
+
+      input_message_accountability_data: string | null;
+
+      originator_address_line1: string | null;
+
+      originator_address_line2: string | null;
+
+      originator_address_line3: string | null;
+
+      originator_name: string | null;
+
+      originator_to_beneficiary_information: string | null;
+    }
+
     /**
      * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
      * the JSON response if and only if `category` is equal to
@@ -1175,42 +1247,6 @@ export namespace Transaction {
       previous_message_input_source: string;
     }
 
-    /**
-     * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
-     * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
-     */
-    export interface InboundWireDrawdownPayment {
-      /**
-       * The amount in the minor unit of the transaction's currency. For dollars, for
-       * example, this is cents.
-       */
-      amount: number;
-
-      beneficiary_address_line1: string | null;
-
-      beneficiary_address_line2: string | null;
-
-      beneficiary_address_line3: string | null;
-
-      beneficiary_name: string | null;
-
-      beneficiary_reference: string | null;
-
-      description: string;
-
-      input_message_accountability_data: string | null;
-
-      originator_address_line1: string | null;
-
-      originator_address_line2: string | null;
-
-      originator_address_line3: string | null;
-
-      originator_name: string | null;
-
-      originator_to_beneficiary_information: string | null;
-    }
-
     /**
      * A Inbound Wire Reversal object. This field will be present in the JSON response
      * if and only if `category` is equal to `inbound_wire_reversal`.
@@ -1514,13 +1550,14 @@ export namespace TransactionListParams {
       | 'ach_transfer_return'
       | 'card_dispute_acceptance'
       | 'card_refund'
-      | 'card_settlement'
       | 'card_revenue_payment'
+      | 'card_settlement'
       | 'check_deposit_acceptance'
       | 'check_deposit_return'
+      | 'check_transfer_deposit'
       | 'check_transfer_intention'
-      | 'check_transfer_return'
       | 'check_transfer_rejection'
+      | 'check_transfer_return'
       | 'check_transfer_stop_payment_request'
       | 'fee_payment'
       | 'inbound_ach_transfer'
@@ -1528,8 +1565,8 @@ export namespace TransactionListParams {
       | 'inbound_check'
       | 'inbound_international_ach_transfer'
       | 'inbound_real_time_payments_transfer_confirmation'
-      | 'inbound_wire_drawdown_payment_reversal'
       | 'inbound_wire_drawdown_payment'
+      | 'inbound_wire_drawdown_payment_reversal'
       | 'inbound_wire_reversal'
       | 'inbound_wire_transfer'
       | 'interest_payment'
@@ -1568,3 +1605,9 @@ export namespace TransactionListParams {
     on_or_before?: string;
   }
 }
+
+export namespace Transactions {
+  export import Transaction = API.Transaction;
+  export import TransactionsPage = API.TransactionsPage;
+  export import TransactionListParams = API.TransactionListParams;
+}

package/resources/wire-drawdown-requests.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class WireDrawdownRequests extends APIResource {
@@ -53,6 +54,11 @@ export class WireDrawdownRequestsPage extends Page<WireDrawdownRequest> {}
  * [support@increase.com](mailto:support@increase.com) to learn more.
  */
 export interface WireDrawdownRequest {
+  /**
+   * The Wire drawdown request identifier.
+   */
+  id: string;
+
   /**
    * The Account Number to which the recipient of this request is being requested to
    * send funds.
@@ -76,11 +82,6 @@ export interface WireDrawdownRequest {
    */
   fulfillment_transaction_id: string | null;
 
-  /**
-   * The Wire drawdown request identifier.
-   */
-  id: string;
-
   /**
    * The message the recipient will see as part of the drawdown request.
    */
@@ -196,3 +197,10 @@ export interface WireDrawdownRequestCreateParams {
 }
 
 export interface WireDrawdownRequestListParams extends PageParams {}
+
+export namespace WireDrawdownRequests {
+  export import WireDrawdownRequest = API.WireDrawdownRequest;
+  export import WireDrawdownRequestsPage = API.WireDrawdownRequestsPage;
+  export import WireDrawdownRequestCreateParams = API.WireDrawdownRequestCreateParams;
+  export import WireDrawdownRequestListParams = API.WireDrawdownRequestListParams;
+}

package/resources/wire-transfers.ts

@@ -3,6 +3,7 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
+import * as API from './';
 import { Page, PageParams } from '~/pagination';
 
 export class WireTransfers extends APIResource {
@@ -79,6 +80,11 @@ export class WireTransfersPage extends Page<WireTransfer> {}
  * accessible by Fedwire.
  */
 export interface WireTransfer {
+  /**
+   * The wire transfer's identifier.
+   */
+  id: string;
+
   /**
    * The Account to which the transfer belongs.
    */
@@ -143,11 +149,6 @@ export interface WireTransfer {
    */
   external_account_id: string | null;
 
-  /**
-   * The wire transfer's identifier.
-   */
-  id: string;
-
   /**
    * The message that will show on the recipient's bank statement.
    */
@@ -434,3 +435,10 @@ export namespace WireTransferListParams {
     on_or_before?: string;
   }
 }
+
+export namespace WireTransfers {
+  export import WireTransfer = API.WireTransfer;
+  export import WireTransfersPage = API.WireTransfersPage;
+  export import WireTransferCreateParams = API.WireTransferCreateParams;
+  export import WireTransferListParams = API.WireTransferListParams;
+}

package/streaming.ts

@@ -1,4 +1,4 @@
-import type { Response } from 'node-fetch';
+import type { Response } from 'increase/_shims/fetch';
 import { APIResponse, Headers, createResponseHeaders } from '~/core';
 
 type ServerSentEvent = {
@@ -88,6 +88,8 @@ export class Stream<Item> implements AsyncIterable<Item>, APIResponse<Stream<Ite
       let text;
       if (chunk instanceof Buffer) {
         text = chunk.toString();
+      } else if ((chunk as any) instanceof Uint8Array) {
+        text = Buffer.from(chunk).toString();
       } else {
         text = chunk;
       }

package/uploads.ts

@@ -0,0 +1,81 @@
+import type { Readable } from 'node:stream';
+import type { RequestOptions } from './core';
+import { type BodyInit } from 'increase/_shims/fetch';
+import { FormData } from 'increase/_shims/formdata';
+import { getMultipartRequestOptions } from 'increase/_shims/getMultipartRequestOptions';
+import { isUploadable } from 'increase/_shims/uploadable';
+import { toFile } from 'increase/_shims/toFile';
+import { fileFromPath } from 'increase/_shims/fileFromPath';
+
+export { toFile, fileFromPath };
+
+type MultipartBody = {
+  __multipartBody__: Readable | BodyInit;
+};
+
+export const isMultipartBody = (body: any): body is MultipartBody =>
+  typeof body === 'object' && body?.__multipartBody__ != null;
+
+/**
+ * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
+ * Otherwise returns the request as is.
+ */
+export const maybeMultipartFormRequestOptions = async <T extends {} = Record<string, unknown>>(
+  opts: RequestOptions<T>,
+): Promise<RequestOptions<T | MultipartBody>> => {
+  if (!hasUploadableValue(opts.body)) return opts;
+
+  const form = await createForm(opts.body);
+  return getMultipartRequestOptions(form, opts);
+};
+
+export const multipartFormRequestOptions = async <T extends {} = Record<string, unknown>>(
+  opts: RequestOptions<T>,
+): Promise<RequestOptions<T | MultipartBody>> => {
+  const form = await createForm(opts.body);
+  return getMultipartRequestOptions(form, opts);
+};
+
+export const createForm = async <T = Record<string, unknown>>(body: T | undefined): Promise<FormData> => {
+  const form = new FormData();
+  await Promise.all(Object.entries(body || {}).map(([key, value]) => addFormValue(form, key, value)));
+  return form;
+};
+
+const hasUploadableValue = (value: unknown): boolean => {
+  if (isUploadable(value)) return true;
+  if (Array.isArray(value)) return value.some(hasUploadableValue);
+  if (value && typeof value === 'object') {
+    for (const k in value) {
+      if (hasUploadableValue((value as any)[k])) return true;
+    }
+  }
+  return false;
+};
+
+const addFormValue = async (form: FormData, key: string, value: unknown): Promise<void> => {
+  if (value === undefined) return;
+  if (value == null) {
+    throw new TypeError(
+      `Received null for "${key}"; to pass null in FormData, you must use the string 'null'`,
+    );
+  }
+
+  // TODO: make nested formats configurable
+  if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+    form.append(key, value);
+  } else if (isUploadable(value)) {
+    const file = await toFile(value);
+    form.append(key, file);
+  } else if (Array.isArray(value)) {
+    await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
+  } else if (typeof value === 'object') {
+    await Promise.all(
+      Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
+    );
+  } else {
+    throw new TypeError(
+      `Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
+    );
+  }
+};

package/version.ts

@@ -1 +1 @@
-export const VERSION = '0.4.0'; // x-release-please-version
+export const VERSION = '0.5.0'; // x-release-please-version

package/.eslintrc.js

@@ -1,10 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'unused-imports', 'prettier'],
-  rules: {
-    'no-unused-vars': 'off',
-    'prettier/prettier': 'error',
-    'unused-imports/no-unused-imports': 'error',
-  },
-  root: true,
-};

package/.prettierignore

@@ -1 +0,0 @@
-CHANGELOG.md

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "arrowParens": "always",
-  "trailingComma": "all",
-  "singleQuote": true,
-  "printWidth": 110
-}

package/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.4.0"
-}

package/.stats.yml

@@ -1 +0,0 @@
-configured_endpoints: 133