increase 0.24.3 → 0.26.0

package/src/resources/simulations/ach-transfers.ts

@@ -1142,93 +1142,9 @@ export namespace ACHTransferSimulation {
        */
       export interface WireDecline {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * A free-form address field set by the sender.
-         */
-        beneficiary_address_line1: string | null;
-
-        /**
-         * A free-form address field set by the sender.
+         * The identifier of the Inbound Wire Transfer that was declined.
          */
-        beneficiary_address_line2: string | null;
-
-        /**
-         * A free-form address field set by the sender.
-         */
-        beneficiary_address_line3: string | null;
-
-        /**
-         * A name set by the sender.
-         */
-        beneficiary_name: string | null;
-
-        /**
-         * A free-form reference string set by the sender, to help identify the transfer.
-         */
-        beneficiary_reference: string | null;
-
-        /**
-         * An Increase-constructed description of the declined transaction.
-         */
-        description: string;
-
-        /**
-         * A unique identifier available to the originating and receiving banks, commonly
-         * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
-         * service and is helpful when debugging wires with the originating bank.
-         */
-        input_message_accountability_data: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line1: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line2: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line3: string | null;
-
-        /**
-         * The originator of the wire, set by the sending bank.
-         */
-        originator_name: string | null;
-
-        /**
-         * The American Banking Association (ABA) routing number of the bank originating
-         * the transfer.
-         */
-        originator_routing_number: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line1: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line2: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line3: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line4: string | null;
+        inbound_wire_transfer_id: string;
 
         /**
          * Why the wire transfer was declined.
@@ -1435,8 +1351,8 @@ export namespace ACHTransferSimulation {
        *   be under the `inbound_wire_drawdown_payment` object.
        * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
        *   `inbound_wire_reversal` object.
-       * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
-       *   `inbound_wire_transfer` object.
+       * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
+       *   under the `inbound_wire_transfer` object.
        * - `interest_payment` - Interest Payment: details will be under the
        *   `interest_payment` object.
        * - `internal_source` - Internal Source: details will be under the
@@ -1567,8 +1483,8 @@ export namespace ACHTransferSimulation {
       inbound_wire_reversal: Source.InboundWireReversal | null;
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       inbound_wire_transfer: Source.InboundWireTransfer | null;
 
@@ -4394,8 +4310,8 @@ export namespace ACHTransferSimulation {
       }
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       export interface InboundWireTransfer {
         /**
@@ -4490,6 +4406,11 @@ export namespace ACHTransferSimulation {
          * A free-form message set by the wire originator.
          */
         originator_to_beneficiary_information_line4: string | null;
+
+        /**
+         * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
+         */
+        transfer_id: string;
       }
 
       /**
@@ -4682,7 +4603,7 @@ export namespace ACHTransferSimulation {
    */
   export interface Transfer {
     /**
-     * The inbound ach transfer's identifier.
+     * The inbound ACH transfer's identifier.
      */
     id: string;
 

package/src/resources/simulations/cards.ts

@@ -1123,93 +1123,9 @@ export namespace CardAuthorizationSimulation {
        */
       export interface WireDecline {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * A free-form address field set by the sender.
-         */
-        beneficiary_address_line1: string | null;
-
-        /**
-         * A free-form address field set by the sender.
-         */
-        beneficiary_address_line2: string | null;
-
-        /**
-         * A free-form address field set by the sender.
-         */
-        beneficiary_address_line3: string | null;
-
-        /**
-         * A name set by the sender.
-         */
-        beneficiary_name: string | null;
-
-        /**
-         * A free-form reference string set by the sender, to help identify the transfer.
-         */
-        beneficiary_reference: string | null;
-
-        /**
-         * An Increase-constructed description of the declined transaction.
-         */
-        description: string;
-
-        /**
-         * A unique identifier available to the originating and receiving banks, commonly
-         * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
-         * service and is helpful when debugging wires with the originating bank.
-         */
-        input_message_accountability_data: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line1: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line2: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line3: string | null;
-
-        /**
-         * The originator of the wire, set by the sending bank.
-         */
-        originator_name: string | null;
-
-        /**
-         * The American Banking Association (ABA) routing number of the bank originating
-         * the transfer.
-         */
-        originator_routing_number: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line1: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line2: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line3: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
+         * The identifier of the Inbound Wire Transfer that was declined.
          */
-        originator_to_beneficiary_information_line4: string | null;
+        inbound_wire_transfer_id: string;
 
         /**
          * Why the wire transfer was declined.

package/src/resources/simulations/interest-payments.ts

@@ -217,8 +217,8 @@ export namespace InterestPaymentSimulationResult {
        *   be under the `inbound_wire_drawdown_payment` object.
        * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
        *   `inbound_wire_reversal` object.
-       * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
-       *   `inbound_wire_transfer` object.
+       * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
+       *   under the `inbound_wire_transfer` object.
        * - `interest_payment` - Interest Payment: details will be under the
        *   `interest_payment` object.
        * - `internal_source` - Internal Source: details will be under the
@@ -349,8 +349,8 @@ export namespace InterestPaymentSimulationResult {
       inbound_wire_reversal: Source.InboundWireReversal | null;
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       inbound_wire_transfer: Source.InboundWireTransfer | null;
 
@@ -3176,8 +3176,8 @@ export namespace InterestPaymentSimulationResult {
       }
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       export interface InboundWireTransfer {
         /**
@@ -3272,6 +3272,11 @@ export namespace InterestPaymentSimulationResult {
          * A free-form message set by the wire originator.
          */
         originator_to_beneficiary_information_line4: string | null;
+
+        /**
+         * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
+         */
+        transfer_id: string;
       }
 
       /**

package/src/resources/simulations/real-time-payments-transfers.ts

@@ -1122,93 +1122,9 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
        */
       export interface WireDecline {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
-         */
-        amount: number;
-
-        /**
-         * A free-form address field set by the sender.
-         */
-        beneficiary_address_line1: string | null;
-
-        /**
-         * A free-form address field set by the sender.
+         * The identifier of the Inbound Wire Transfer that was declined.
          */
-        beneficiary_address_line2: string | null;
-
-        /**
-         * A free-form address field set by the sender.
-         */
-        beneficiary_address_line3: string | null;
-
-        /**
-         * A name set by the sender.
-         */
-        beneficiary_name: string | null;
-
-        /**
-         * A free-form reference string set by the sender, to help identify the transfer.
-         */
-        beneficiary_reference: string | null;
-
-        /**
-         * An Increase-constructed description of the declined transaction.
-         */
-        description: string;
-
-        /**
-         * A unique identifier available to the originating and receiving banks, commonly
-         * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
-         * service and is helpful when debugging wires with the originating bank.
-         */
-        input_message_accountability_data: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line1: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line2: string | null;
-
-        /**
-         * The address of the wire originator, set by the sending bank.
-         */
-        originator_address_line3: string | null;
-
-        /**
-         * The originator of the wire, set by the sending bank.
-         */
-        originator_name: string | null;
-
-        /**
-         * The American Banking Association (ABA) routing number of the bank originating
-         * the transfer.
-         */
-        originator_routing_number: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line1: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line2: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line3: string | null;
-
-        /**
-         * A free-form message set by the wire originator.
-         */
-        originator_to_beneficiary_information_line4: string | null;
+        inbound_wire_transfer_id: string;
 
         /**
          * Why the wire transfer was declined.
@@ -1415,8 +1331,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
        *   be under the `inbound_wire_drawdown_payment` object.
        * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
        *   `inbound_wire_reversal` object.
-       * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
-       *   `inbound_wire_transfer` object.
+       * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
+       *   under the `inbound_wire_transfer` object.
        * - `interest_payment` - Interest Payment: details will be under the
        *   `interest_payment` object.
        * - `internal_source` - Internal Source: details will be under the
@@ -1547,8 +1463,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
       inbound_wire_reversal: Source.InboundWireReversal | null;
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       inbound_wire_transfer: Source.InboundWireTransfer | null;
 
@@ -4374,8 +4290,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
       }
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       export interface InboundWireTransfer {
         /**
@@ -4470,6 +4386,11 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
          * A free-form message set by the wire originator.
          */
         originator_to_beneficiary_information_line4: string | null;
+
+        /**
+         * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
+         */
+        transfer_id: string;
       }
 
       /**

package/src/resources/simulations/wire-transfers.ts

@@ -218,8 +218,8 @@ export namespace WireTransferSimulation {
        *   be under the `inbound_wire_drawdown_payment` object.
        * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
        *   `inbound_wire_reversal` object.
-       * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
-       *   `inbound_wire_transfer` object.
+       * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
+       *   under the `inbound_wire_transfer` object.
        * - `interest_payment` - Interest Payment: details will be under the
        *   `interest_payment` object.
        * - `internal_source` - Internal Source: details will be under the
@@ -350,8 +350,8 @@ export namespace WireTransferSimulation {
       inbound_wire_reversal: Source.InboundWireReversal | null;
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       inbound_wire_transfer: Source.InboundWireTransfer | null;
 
@@ -3177,8 +3177,8 @@ export namespace WireTransferSimulation {
       }
 
       /**
-       * An Inbound Wire Transfer object. This field will be present in the JSON response
-       * if and only if `category` is equal to `inbound_wire_transfer`.
+       * An Inbound Wire Transfer Intention object. This field will be present in the
+       * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
        */
       export interface InboundWireTransfer {
         /**
@@ -3273,6 +3273,11 @@ export namespace WireTransferSimulation {
          * A free-form message set by the wire originator.
          */
         originator_to_beneficiary_information_line4: string | null;
+
+        /**
+         * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
+         */
+        transfer_id: string;
       }
 
       /**

package/src/resources/transactions.ts

@@ -217,8 +217,8 @@ export namespace Transaction {
      *   be under the `inbound_wire_drawdown_payment` object.
      * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
      *   `inbound_wire_reversal` object.
-     * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
-     *   `inbound_wire_transfer` object.
+     * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
+     *   under the `inbound_wire_transfer` object.
      * - `interest_payment` - Interest Payment: details will be under the
      *   `interest_payment` object.
      * - `internal_source` - Internal Source: details will be under the
@@ -349,8 +349,8 @@ export namespace Transaction {
     inbound_wire_reversal: Source.InboundWireReversal | null;
 
     /**
-     * An Inbound Wire Transfer object. This field will be present in the JSON response
-     * if and only if `category` is equal to `inbound_wire_transfer`.
+     * An Inbound Wire Transfer Intention object. This field will be present in the
+     * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
      */
     inbound_wire_transfer: Source.InboundWireTransfer | null;
 
@@ -3176,8 +3176,8 @@ export namespace Transaction {
     }
 
     /**
-     * An Inbound Wire Transfer object. This field will be present in the JSON response
-     * if and only if `category` is equal to `inbound_wire_transfer`.
+     * An Inbound Wire Transfer Intention object. This field will be present in the
+     * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
      */
     export interface InboundWireTransfer {
       /**
@@ -3272,6 +3272,11 @@ export namespace Transaction {
        * A free-form message set by the wire originator.
        */
       originator_to_beneficiary_information_line4: string | null;
+
+      /**
+       * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
+       */
+      transfer_id: string;
     }
 
     /**

package/src/resources/webhooks.ts

@@ -1,5 +1,111 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import { APIResource } from "../resource";
+import { HeadersLike } from "../core";
+import { createHmac } from 'crypto';
+import { getRequiredHeader } from "../core";
 
-export class Webhooks extends APIResource {}
+export class Webhooks extends APIResource {
+  /**
+   * Validates that the given payload was sent by Increase and parses the payload.
+   */
+  unwrap(
+    payload: string,
+    headers: HeadersLike,
+    secret: string | undefined | null = this._client.webhookSecret,
+  ): Record<string, unknown> {
+    if (secret) {
+      this.verifySignature(payload, headers, secret);
+    }
+
+    return JSON.parse(payload);
+  }
+
+  private validateSecret(secret: string | null | undefined): asserts secret is string {
+    if (typeof secret !== 'string') {
+      throw new Error(
+        `The webhook secret must either be set using the env var, INCREASE_WEBHOOK_SECRET, on the client class, Increase({ webhook_secret: '123' }), or passed to this function`,
+      );
+    }
+  }
+
+  private signPayload(payload: string, { timestamp, secret }: { timestamp: string; secret: string }) {
+    const hmac = createHmac('sha256', secret);
+    hmac.update(`${timestamp}.${payload}`);
+
+    return hmac.digest('hex');
+  }
+
+  /** Make an assertion, if not `true`, then throw. */
+  private assert(expr: unknown, msg = ''): asserts expr {
+    if (!expr) {
+      throw new Error(msg);
+    }
+  }
+
+  /** Compare to array buffers or data views in a way that timing based attacks
+   * cannot gain information about the platform. */
+  private timingSafeEqual(
+    a: ArrayBufferView | ArrayBufferLike | DataView,
+    b: ArrayBufferView | ArrayBufferLike | DataView,
+  ): boolean {
+    if (a.byteLength !== b.byteLength) {
+      return false;
+    }
+    if (!(a instanceof DataView)) {
+      a = new DataView(ArrayBuffer.isView(a) ? a.buffer : a);
+    }
+    if (!(b instanceof DataView)) {
+      b = new DataView(ArrayBuffer.isView(b) ? b.buffer : b);
+    }
+    this.assert(a instanceof DataView);
+    this.assert(b instanceof DataView);
+    const length = a.byteLength;
+    let out = 0;
+    let i = -1;
+    while (++i < length) {
+      out |= a.getUint8(i) ^ b.getUint8(i);
+    }
+    return out === 0;
+  }
+
+  /**
+   * Validates whether or not the webhook payload was sent by Increase.
+   *
+   * An error will be raised if the webhook payload was not sent by Increase.
+   */
+  verifySignature(
+    payload: string,
+    headers: HeadersLike,
+    secret: string | undefined | null = this._client.webhookSecret,
+  ): void {
+    this.validateSecret(secret);
+
+    interface ParsedSignature {
+      t?: string;
+      v1?: string;
+    }
+
+    const { t: timestamp, v1: signature } = getRequiredHeader(headers, 'Increase-Webhook-Signature')
+      .split(',')
+      .map((kv) => kv.split('='))
+      .reduce((acc, [k, v]) => ({ ...acc, [k as string]: v }), {} as ParsedSignature);
+
+    if (timestamp === undefined) {
+      throw new Error('Unable to verify signature, missing timestamp');
+    }
+
+    if (signature === undefined) {
+      throw new Error('Unable to verify signature, missing signature');
+    }
+
+    const expectedSignature = this.signPayload(payload, { timestamp, secret });
+
+    const textEncoder = new TextEncoder();
+    if (this.timingSafeEqual(textEncoder.encode(signature), textEncoder.encode(expectedSignature))) {
+      return;
+    }
+
+    throw new Error('The given webhook signature does not match the expected signature');
+  }
+}