increase 0.11.2 → 0.11.4

package/src/resources/physical-cards.ts

@@ -0,0 +1,394 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../e/core";
+import { APIResource } from "../e/resource";
+import { isRequestOptions } from "../e/core";
+import * as API from './index';
+import { Page, PageParams } from "../e/pagination";
+
+export class PhysicalCards extends APIResource {
+  /**
+   * Create a Physical Card
+   */
+  create(body: PhysicalCardCreateParams, options?: Core.RequestOptions): Core.APIPromise<PhysicalCard> {
+    return this.post('/physical_cards', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Physical Card
+   */
+  retrieve(physicalCardId: string, options?: Core.RequestOptions): Core.APIPromise<PhysicalCard> {
+    return this.get(`/physical_cards/${physicalCardId}`, options);
+  }
+
+  /**
+   * Update a Physical Card
+   */
+  update(
+    physicalCardId: string,
+    body: PhysicalCardUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PhysicalCard> {
+    return this.patch(`/physical_cards/${physicalCardId}`, { body, ...options });
+  }
+
+  /**
+   * List Physical Cards
+   */
+  list(
+    query?: PhysicalCardListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PhysicalCardsPage, PhysicalCard>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PhysicalCardsPage, PhysicalCard>;
+  list(
+    query: PhysicalCardListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PhysicalCardsPage, PhysicalCard> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/physical_cards', PhysicalCardsPage, { query, ...options });
+  }
+}
+
+export class PhysicalCardsPage extends Page<PhysicalCard> {}
+// alias so we can export it in the namespace
+type _PhysicalCardsPage = PhysicalCardsPage;
+
+/**
+ * Custom physical Visa cards that are shipped to your customers. The artwork is
+ * configurable by a connected [Card Profile](/documentation/api#card-profiles).
+ * The same Card can be used for multiple Physical Cards. Printing cards incurs a
+ * fee. Please contact [support@increase.com](mailto:support@increase.com) for
+ * pricing!
+ */
+export interface PhysicalCard {
+  /**
+   * The physical card identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier for the Card this Physical Card represents.
+   */
+  card_id: string;
+
+  /**
+   * The Card Profile used for this Physical Card.
+   */
+  card_profile_id: string | null;
+
+  /**
+   * Details about the cardholder, as it appears on the printed card.
+   */
+  cardholder: PhysicalCard.Cardholder | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the Physical Card was created.
+   */
+  created_at: string;
+
+  /**
+   * The details used to ship this physical card.
+   */
+  shipment: PhysicalCard.Shipment;
+
+  /**
+   * The status of the Physical Card.
+   *
+   * - `active` - The physical card is active.
+   * - `disabled` - The physical card is temporarily disabled.
+   * - `canceled` - The physical card is permanently canceled.
+   */
+  status: 'active' | 'disabled' | 'canceled';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `physical_card`.
+   */
+  type: 'physical_card';
+}
+
+export namespace PhysicalCard {
+  /**
+   * Details about the cardholder, as it appears on the printed card.
+   */
+  export interface Cardholder {
+    /**
+     * The cardholder's first name.
+     */
+    first_name: string;
+
+    /**
+     * The cardholder's last name.
+     */
+    last_name: string;
+  }
+
+  /**
+   * The details used to ship this physical card.
+   */
+  export interface Shipment {
+    /**
+     * The location to where the card's packing label is addressed.
+     */
+    address: Shipment.Address;
+
+    /**
+     * The shipping method.
+     *
+     * - `usps` - USPS Post with tracking.
+     * - `fedex_priority_overnight` - FedEx Priority Overnight, no signature.
+     * - `fedex_2_day` - FedEx 2-day.
+     */
+    method: 'usps' | 'fedex_priority_overnight' | 'fedex_2_day';
+
+    /**
+     * The status of this shipment.
+     *
+     * - `pending` - The physical card has not yet been shipped.
+     * - `canceled` - The physical card shipment was canceled prior to submission.
+     * - `submitted` - The physical card shipment has been submitted to the card
+     *   fulfillment provider.
+     * - `acknowledged` - The physical card shipment has been acknowledged by the card
+     *   fulfillment provider and will be processed in their next batch.
+     * - `rejected` - The physical card shipment was rejected by the card printer due
+     *   to an error.
+     * - `shipped` - The physical card has been shipped.
+     * - `returned` - The physical card shipment was returned to the sender and
+     *   destroyed by the production facility.
+     */
+    status: 'pending' | 'canceled' | 'submitted' | 'acknowledged' | 'rejected' | 'shipped' | 'returned';
+
+    /**
+     * Tracking details for the shipment.
+     */
+    tracking: Shipment.Tracking | null;
+  }
+
+  export namespace Shipment {
+    /**
+     * The location to where the card's packing label is addressed.
+     */
+    export interface Address {
+      /**
+       * The city of the shipping address.
+       */
+      city: string;
+
+      /**
+       * The first line of the shipping address.
+       */
+      line1: string;
+
+      /**
+       * The second line of the shipping address.
+       */
+      line2: string | null;
+
+      /**
+       * The third line of the shipping address.
+       */
+      line3: string | null;
+
+      /**
+       * The name of the recipient.
+       */
+      name: string;
+
+      /**
+       * The postal code of the shipping address.
+       */
+      postal_code: string;
+
+      /**
+       * The US state of the shipping address.
+       */
+      state: string;
+    }
+
+    /**
+     * Tracking details for the shipment.
+     */
+    export interface Tracking {
+      /**
+       * The tracking number.
+       */
+      number: string;
+
+      /**
+       * For returned shipments, this describes why the package was returned.
+       */
+      return_reason: string | null;
+
+      /**
+       * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+       * the fulfillment provider marked the card as ready for pick-up by the shipment
+       * carrier.
+       */
+      shipped_at: string;
+    }
+  }
+}
+
+export interface PhysicalCardCreateParams {
+  /**
+   * The underlying card representing this physical card.
+   */
+  card_id: string;
+
+  /**
+   * The card profile to use for this physical card.
+   */
+  card_profile_id: string;
+
+  /**
+   * Details about the cardholder, as it will appear on the physical card.
+   */
+  cardholder: PhysicalCardCreateParams.Cardholder;
+
+  /**
+   * The details used to ship this physical card.
+   */
+  shipment: PhysicalCardCreateParams.Shipment;
+}
+
+export namespace PhysicalCardCreateParams {
+  /**
+   * Details about the cardholder, as it will appear on the physical card.
+   */
+  export interface Cardholder {
+    /**
+     * The cardholder's first name.
+     */
+    first_name: string;
+
+    /**
+     * The cardholder's last name.
+     */
+    last_name: string;
+  }
+
+  /**
+   * The details used to ship this physical card.
+   */
+  export interface Shipment {
+    /**
+     * The address to where the card should be shipped.
+     */
+    address: Shipment.Address;
+
+    /**
+     * The shipping method to use.
+     *
+     * - `usps` - USPS Post with tracking.
+     * - `fedex_priority_overnight` - FedEx Priority Overnight, no signature.
+     * - `fedex_2_day` - FedEx 2-day.
+     */
+    method: 'usps' | 'fedex_priority_overnight' | 'fedex_2_day';
+  }
+
+  export namespace Shipment {
+    /**
+     * The address to where the card should be shipped.
+     */
+    export interface Address {
+      /**
+       * The city of the shipping address.
+       */
+      city: string;
+
+      /**
+       * The first line of the shipping address.
+       */
+      line1: string;
+
+      /**
+       * The name of the recipient.
+       */
+      name: string;
+
+      /**
+       * The postal code of the shipping address.
+       */
+      postal_code: string;
+
+      /**
+       * The US state of the shipping address.
+       */
+      state: string;
+
+      /**
+       * The second line of the shipping address.
+       */
+      line2?: string;
+
+      /**
+       * The third line of the shipping address.
+       */
+      line3?: string;
+
+      /**
+       * The phone number of the receipient.
+       */
+      phone_number?: string;
+    }
+  }
+}
+
+export interface PhysicalCardUpdateParams {
+  /**
+   * The status to update the Physical Card to.
+   *
+   * - `active` - The physical card is active.
+   * - `disabled` - The physical card is temporarily disabled.
+   * - `canceled` - The physical card is permanently canceled.
+   */
+  status: 'active' | 'disabled' | 'canceled';
+}
+
+export interface PhysicalCardListParams extends PageParams {
+  /**
+   * Filter Physical Cards to ones belonging to the specified Card.
+   */
+  card_id?: string;
+
+  created_at?: PhysicalCardListParams.CreatedAt;
+}
+
+export namespace PhysicalCardListParams {
+  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 PhysicalCards {
+  export import PhysicalCard = API.PhysicalCard;
+  export type PhysicalCardsPage = _PhysicalCardsPage;
+  export import PhysicalCardCreateParams = API.PhysicalCardCreateParams;
+  export import PhysicalCardUpdateParams = API.PhysicalCardUpdateParams;
+  export import PhysicalCardListParams = API.PhysicalCardListParams;
+}

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

@@ -1047,6 +1047,12 @@ export namespace ACHTransferSimulation {
          */
         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.
          */
@@ -1238,10 +1244,10 @@ export namespace ACHTransferSimulation {
        * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
        *   `card_dispute_acceptance` object.
        * - `card_refund` - Card Refund: details will be under the `card_refund` object.
-       * - `card_revenue_payment` - Card Revenue Payment: details will be under the
-       *   `card_revenue_payment` object.
        * - `card_settlement` - Card Settlement: details will be under the
        *   `card_settlement` object.
+       * - `card_revenue_payment` - Card Revenue Payment: details will be under the
+       *   `card_revenue_payment` object.
        * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
        *   the `check_deposit_acceptance` object.
        * - `check_deposit_return` - Check Deposit Return: details will be under the
@@ -1265,11 +1271,11 @@ export namespace ACHTransferSimulation {
        * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
        *   Payments Transfer Confirmation: details will be under the
        *   `inbound_real_time_payments_transfer_confirmation` object.
-       * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
-       *   be under the `inbound_wire_drawdown_payment` object.
        * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
        *   Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
        *   object.
+       * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
+       *   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
@@ -1296,8 +1302,8 @@ export namespace ACHTransferSimulation {
         | 'ach_transfer_return'
         | 'card_dispute_acceptance'
         | 'card_refund'
-        | 'card_revenue_payment'
         | 'card_settlement'
+        | 'card_revenue_payment'
         | 'check_deposit_acceptance'
         | 'check_deposit_return'
         | 'check_transfer_deposit'
@@ -1309,8 +1315,8 @@ export namespace ACHTransferSimulation {
         | 'inbound_check'
         | 'inbound_international_ach_transfer'
         | 'inbound_real_time_payments_transfer_confirmation'
-        | 'inbound_wire_drawdown_payment'
         | 'inbound_wire_drawdown_payment_reversal'
+        | 'inbound_wire_drawdown_payment'
         | 'inbound_wire_reversal'
         | 'inbound_wire_transfer'
         | 'interest_payment'
@@ -3908,6 +3914,12 @@ export namespace ACHTransferSimulation {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * An Increase-created concatenation of the Originator-to-Beneficiary lines.
          */
@@ -3970,6 +3982,12 @@ export namespace ACHTransferSimulation {
          */
         input_source: string;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * The Fedwire cycle date for the wire transfer that was reversed.
          */
@@ -4038,6 +4056,12 @@ export namespace ACHTransferSimulation {
          */
         input_source: string;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * The Fedwire cycle date for the wire transfer that is being reversed by this
          * message.
@@ -4143,6 +4167,12 @@ export namespace ACHTransferSimulation {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * An Increase-created concatenation of the Originator-to-Beneficiary lines.
          */
@@ -4427,6 +4457,12 @@ export namespace ACHTransferSimulation {
      */
     originator_company_name: string;
 
+    /**
+     * The American Banking Association (ABA) routing number of the bank originating
+     * the transfer.
+     */
+    originator_routing_number: string;
+
     /**
      * The id of the receiver of the transfer.
      */

package/src/resources/simulations/cards.ts

@@ -1028,6 +1028,12 @@ export namespace CardAuthorizationSimulation {
          */
         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.
          */

package/src/resources/simulations/index.ts

@@ -36,6 +36,7 @@ export {
   InterestPaymentCreateParams,
   InterestPayments,
 } from './interest-payments';
+export { PhysicalCardShipmentAdvanceParams, PhysicalCards } from './physical-cards';
 export { ProgramCreateParams, Programs } from './programs';
 export { Simulations } from './simulations';
 export { WireTransferSimulation, WireTransferCreateInboundParams, WireTransfers } from './wire-transfers';

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

@@ -183,10 +183,10 @@ export namespace InterestPaymentSimulationResult {
        * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
        *   `card_dispute_acceptance` object.
        * - `card_refund` - Card Refund: details will be under the `card_refund` object.
-       * - `card_revenue_payment` - Card Revenue Payment: details will be under the
-       *   `card_revenue_payment` object.
        * - `card_settlement` - Card Settlement: details will be under the
        *   `card_settlement` object.
+       * - `card_revenue_payment` - Card Revenue Payment: details will be under the
+       *   `card_revenue_payment` object.
        * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
        *   the `check_deposit_acceptance` object.
        * - `check_deposit_return` - Check Deposit Return: details will be under the
@@ -210,11 +210,11 @@ export namespace InterestPaymentSimulationResult {
        * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
        *   Payments Transfer Confirmation: details will be under the
        *   `inbound_real_time_payments_transfer_confirmation` object.
-       * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
-       *   be under the `inbound_wire_drawdown_payment` object.
        * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
        *   Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
        *   object.
+       * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
+       *   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
@@ -241,8 +241,8 @@ export namespace InterestPaymentSimulationResult {
         | 'ach_transfer_return'
         | 'card_dispute_acceptance'
         | 'card_refund'
-        | 'card_revenue_payment'
         | 'card_settlement'
+        | 'card_revenue_payment'
         | 'check_deposit_acceptance'
         | 'check_deposit_return'
         | 'check_transfer_deposit'
@@ -254,8 +254,8 @@ export namespace InterestPaymentSimulationResult {
         | 'inbound_check'
         | 'inbound_international_ach_transfer'
         | 'inbound_real_time_payments_transfer_confirmation'
-        | 'inbound_wire_drawdown_payment'
         | 'inbound_wire_drawdown_payment_reversal'
+        | 'inbound_wire_drawdown_payment'
         | 'inbound_wire_reversal'
         | 'inbound_wire_transfer'
         | 'interest_payment'
@@ -2853,6 +2853,12 @@ export namespace InterestPaymentSimulationResult {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * An Increase-created concatenation of the Originator-to-Beneficiary lines.
          */
@@ -2915,6 +2921,12 @@ export namespace InterestPaymentSimulationResult {
          */
         input_source: string;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * The Fedwire cycle date for the wire transfer that was reversed.
          */
@@ -2983,6 +2995,12 @@ export namespace InterestPaymentSimulationResult {
          */
         input_source: string;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * The Fedwire cycle date for the wire transfer that is being reversed by this
          * message.
@@ -3088,6 +3106,12 @@ export namespace InterestPaymentSimulationResult {
          */
         originator_name: string | null;
 
+        /**
+         * The American Banking Association (ABA) routing number of the bank originating
+         * the transfer.
+         */
+        originator_routing_number: string | null;
+
         /**
          * An Increase-created concatenation of the Originator-to-Beneficiary lines.
          */

package/src/resources/simulations/physical-cards.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../e/core";
+import { APIResource } from "../../e/resource";
+import * as PhysicalCards_ from "../../e/resources/physical-cards";
+import * as API from './index';
+
+export class PhysicalCards extends APIResource {
+  /**
+   * This endpoint allows you to simulate advancing the shipment status of a Physical
+   * Card, to simulate e.g., that a physical card was attempted shipped but then
+   * failed delivery.
+   */
+  shipmentAdvance(
+    physicalCardId: string,
+    body: PhysicalCardShipmentAdvanceParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PhysicalCards_.PhysicalCard> {
+    return this.post(`/simulations/physical_cards/${physicalCardId}/shipment_advance`, { body, ...options });
+  }
+}
+
+export interface PhysicalCardShipmentAdvanceParams {
+  /**
+   * The shipment status to move the Physical Card to.
+   *
+   * - `pending` - The physical card has not yet been shipped.
+   * - `canceled` - The physical card shipment was canceled prior to submission.
+   * - `submitted` - The physical card shipment has been submitted to the card
+   *   fulfillment provider.
+   * - `acknowledged` - The physical card shipment has been acknowledged by the card
+   *   fulfillment provider and will be processed in their next batch.
+   * - `rejected` - The physical card shipment was rejected by the card printer due
+   *   to an error.
+   * - `shipped` - The physical card has been shipped.
+   * - `returned` - The physical card shipment was returned to the sender and
+   *   destroyed by the production facility.
+   */
+  shipment_status:
+    | 'pending'
+    | 'canceled'
+    | 'submitted'
+    | 'acknowledged'
+    | 'rejected'
+    | 'shipped'
+    | 'returned';
+}
+
+export namespace PhysicalCards {
+  export import PhysicalCardShipmentAdvanceParams = API.PhysicalCardShipmentAdvanceParams;
+}