increase 0.28.0 → 0.29.0

package/src/resources/intrafi/exclusions.ts

@@ -82,6 +82,13 @@ export interface IntrafiExclusion {
    */
   fdic_certificate_number: string | null;
 
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
   /**
    * The status of the exclusion request.
    *
@@ -120,6 +127,14 @@ export interface ExclusionListParams extends PageParams {
    * Filter IntraFi Exclusions for those belonging to the specified Entity.
    */
   entity_id?: string;
+
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
 }
 
 export namespace Exclusions {

package/src/resources/physical-card-profiles.ts

@@ -0,0 +1,241 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import { isRequestOptions } from "../core";
+import * as PhysicalCardProfilesAPI from "./physical-card-profiles";
+import { Page, type PageParams } from "../pagination";
+
+export class PhysicalCardProfiles extends APIResource {
+  /**
+   * Create a Physical Card Profile
+   */
+  create(
+    body: PhysicalCardProfileCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PhysicalCardProfile> {
+    return this._client.post('/physical_card_profiles', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Card Profile
+   */
+  retrieve(
+    physicalCardProfileId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PhysicalCardProfile> {
+    return this._client.get(`/physical_card_profiles/${physicalCardProfileId}`, options);
+  }
+
+  /**
+   * List Physical Card Profiles
+   */
+  list(
+    query?: PhysicalCardProfileListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PhysicalCardProfilesPage, PhysicalCardProfile>;
+  list(options?: Core.RequestOptions): Core.PagePromise<PhysicalCardProfilesPage, PhysicalCardProfile>;
+  list(
+    query: PhysicalCardProfileListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PhysicalCardProfilesPage, PhysicalCardProfile> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/physical_card_profiles', PhysicalCardProfilesPage, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Archive a Physical Card Profile
+   */
+  archive(
+    physicalCardProfileId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PhysicalCardProfile> {
+    return this._client.post(`/physical_card_profiles/${physicalCardProfileId}/archive`, options);
+  }
+
+  /**
+   * Clone a Physical Card Profile
+   */
+  clone(
+    physicalCardProfileId: string,
+    body: PhysicalCardProfileCloneParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<PhysicalCardProfile> {
+    return this._client.post(`/physical_card_profiles/${physicalCardProfileId}/clone`, { body, ...options });
+  }
+}
+
+export class PhysicalCardProfilesPage extends Page<PhysicalCardProfile> {}
+
+/**
+ * This contains artwork and metadata relating to a Physical Card's appearance. For
+ * more information, see our guide on
+ * [physical card artwork](https://increase.com/documentation/card-art-physical-cards).
+ */
+export interface PhysicalCardProfile {
+  /**
+   * The Card Profile identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier of the File containing the physical card's back image.
+   */
+  back_image_file_id: string | null;
+
+  /**
+   * The identifier of the File containing the physical card's carrier image.
+   */
+  carrier_image_file_id: string | null;
+
+  /**
+   * A phone number the user can contact to receive support for their card.
+   */
+  contact_phone: string | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the Card Dispute was created.
+   */
+  created_at: string;
+
+  /**
+   * The creator of this Physical Card Profile.
+   *
+   * - `increase` - This Physical Card Profile was created by Increase.
+   * - `user` - This Physical Card Profile was created by you.
+   */
+  creator: 'increase' | 'user';
+
+  /**
+   * A description you can use to identify the Physical Card Profile.
+   */
+  description: string;
+
+  /**
+   * The identifier of the File containing the physical card's front image.
+   */
+  front_image_file_id: string | null;
+
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
+  /**
+   * Whether this Physical Card Profile is the default for all cards in its Increase
+   * group.
+   */
+  is_default: boolean;
+
+  /**
+   * The status of the Physical Card Profile.
+   *
+   * - `pending_creating` - The Card Profile has not yet been processed by Increase.
+   * - `pending_reviewing` - The card profile is awaiting review by Increase.
+   * - `rejected` - There is an issue with the Physical Card Profile preventing it
+   *   from use.
+   * - `pending_submitting` - The card profile is awaiting submission to the
+   *   fulfillment provider.
+   * - `active` - The Physical Card Profile has been submitted to the fulfillment
+   *   provider and is ready to use.
+   * - `archived` - The Physical Card Profile has been archived.
+   */
+  status:
+    | 'pending_creating'
+    | 'pending_reviewing'
+    | 'rejected'
+    | 'pending_submitting'
+    | 'active'
+    | 'archived';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `physical_card_profile`.
+   */
+  type: 'physical_card_profile';
+}
+
+export interface PhysicalCardProfileCreateParams {
+  /**
+   * The identifier of the File containing the physical card's carrier image.
+   */
+  carrier_image_file_id: string;
+
+  /**
+   * A phone number the user can contact to receive support for their card.
+   */
+  contact_phone: string;
+
+  /**
+   * A description you can use to identify the Card Profile.
+   */
+  description: string;
+
+  /**
+   * The identifier of the File containing the physical card's front image.
+   */
+  front_image_file_id: string;
+}
+
+export interface PhysicalCardProfileListParams extends PageParams {
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
+
+  status?: PhysicalCardProfileListParams.Status;
+}
+
+export namespace PhysicalCardProfileListParams {
+  export interface Status {
+    /**
+     * Filter Physical Card Profiles for those with the specified statuses. For GET
+     * requests, this should be encoded as a comma-delimited string, such as
+     * `?in=one,two,three`.
+     */
+    in?: Array<
+      'pending_creating' | 'pending_reviewing' | 'rejected' | 'pending_submitting' | 'active' | 'archived'
+    >;
+  }
+}
+
+export interface PhysicalCardProfileCloneParams {
+  /**
+   * The identifier of the File containing the physical card's carrier image.
+   */
+  carrier_image_file_id?: string;
+
+  /**
+   * A phone number the user can contact to receive support for their card.
+   */
+  contact_phone?: string;
+
+  /**
+   * A description you can use to identify the Card Profile.
+   */
+  description?: string;
+
+  /**
+   * The identifier of the File containing the physical card's front image.
+   */
+  front_image_file_id?: string;
+}
+
+export namespace PhysicalCardProfiles {
+  export import PhysicalCardProfile = PhysicalCardProfilesAPI.PhysicalCardProfile;
+  export import PhysicalCardProfilesPage = PhysicalCardProfilesAPI.PhysicalCardProfilesPage;
+  export import PhysicalCardProfileCreateParams = PhysicalCardProfilesAPI.PhysicalCardProfileCreateParams;
+  export import PhysicalCardProfileListParams = PhysicalCardProfilesAPI.PhysicalCardProfileListParams;
+  export import PhysicalCardProfileCloneParams = PhysicalCardProfilesAPI.PhysicalCardProfileCloneParams;
+}

package/src/resources/physical-cards.ts

@@ -87,6 +87,18 @@ export interface PhysicalCard {
    */
   created_at: string;
 
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
+  /**
+   * The Physical Card Profile used for this Physical Card.
+   */
+  physical_card_profile_id: string | null;
+
   /**
    * The details used to ship this physical card.
    */
@@ -241,11 +253,6 @@ export interface PhysicalCardCreateParams {
    */
   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.
    */
@@ -363,6 +370,14 @@ export interface PhysicalCardListParams extends PageParams {
   card_id?: string;
 
   created_at?: PhysicalCardListParams.CreatedAt;
+
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
 }
 
 export namespace PhysicalCardListParams {

package/src/resources/programs.ts

@@ -44,6 +44,11 @@ export interface Program {
    */
   id: string;
 
+  /**
+   * The Program billing account.
+   */
+  billing_account_id: string | null;
+
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program
    * was created.

package/src/resources/proof-of-authorization-request-submissions.ts

@@ -105,6 +105,13 @@ export interface ProofOfAuthorizationRequestSubmission {
    */
   created_at: string;
 
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
   /**
    * ID of the proof of authorization request.
    */
@@ -172,6 +179,14 @@ export interface ProofOfAuthorizationRequestSubmissionCreateParams {
 }
 
 export interface ProofOfAuthorizationRequestSubmissionListParams extends PageParams {
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
+
   /**
    * ID of the proof of authorization request.
    */

package/src/resources/real-time-decisions.ts

@@ -646,7 +646,13 @@ export namespace RealTimeDecisionActionParams {
       /**
        * The identifier of the Card Profile to assign to the Digital Wallet token.
        */
-      card_profile_id: string;
+      card_profile_id?: string;
+
+      /**
+       * The identifier of the Digital Card Profile to assign to the Digital Wallet
+       * token.
+       */
+      digital_card_profile_id?: string;
 
       /**
        * An email address that can be used to verify the cardholder via one-time

package/src/resources/real-time-payments-request-for-payments.ts

@@ -115,6 +115,13 @@ export interface RealTimePaymentsRequestForPayment {
    */
   fulfillment_transaction_id: string | null;
 
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
   /**
    * If the request for payment is refused by the destination financial institution
    * or the receiving customer, this will contain supplemental details.
@@ -412,6 +419,14 @@ export interface RealTimePaymentsRequestForPaymentListParams extends PageParams
   account_id?: string;
 
   created_at?: RealTimePaymentsRequestForPaymentListParams.CreatedAt;
+
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
 }
 
 export namespace RealTimePaymentsRequestForPaymentListParams {

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

@@ -131,6 +131,13 @@ export interface RealTimePaymentsTransfer {
    */
   external_account_id: string | null;
 
+  /**
+   * The idempotency key you chose for this object. This value is unique across
+   * Increase and is used to ensure that a request is only processed once. Learn more
+   * about [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key: string | null;
+
   /**
    * The ID for the pending transaction representing the transfer. A pending
    * transaction is created when the transfer
@@ -204,11 +211,6 @@ export interface RealTimePaymentsTransfer {
    * The name of the the party on whose behalf the debtor is instructing the payment.
    */
   ultimate_debtor_name: string | null;
-
-  /**
-   * The unique identifier you chose for this object.
-   */
-  unique_identifier: string | null;
 }
 
 export namespace RealTimePaymentsTransfer {
@@ -420,13 +422,6 @@ export interface RealTimePaymentsTransferCreateParams {
    * The name of the the party on whose behalf the debtor is instructing the payment.
    */
   ultimate_debtor_name?: string;
-
-  /**
-   * A unique identifier you choose for the transfer. Reusing this identifier for
-   * another transfer will result in an error. You can query for the transfer
-   * associated with this identifier using the List endpoint.
-   */
-  unique_identifier?: string;
 }
 
 export interface RealTimePaymentsTransferListParams extends PageParams {
@@ -444,9 +439,12 @@ export interface RealTimePaymentsTransferListParams extends PageParams {
   external_account_id?: string;
 
   /**
-   * Filter records to the one with the specified `unique_identifier`.
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
    */
-  unique_identifier?: string;
+  idempotency_key?: string;
 }
 
 export namespace RealTimePaymentsTransferListParams {

package/src/resources/simulations/cards.ts

@@ -738,6 +738,9 @@ export namespace CardAuthorizationSimulation {
          *   Increase.
          * - `no_account_number_found` - The account number on the check does not exist at
          *   Increase.
+         * - `refer_to_image` - The check is not readable. Please refer to the image.
+         * - `unable_to_process` - The check cannot be processed. This is rare: please
+         *   contact support.
          */
         reason:
           | 'ach_route_disabled'
@@ -751,7 +754,9 @@ export namespace CardAuthorizationSimulation {
           | 'not_authorized'
           | 'amount_mismatch'
           | 'not_our_item'
-          | 'no_account_number_found';
+          | 'no_account_number_found'
+          | 'refer_to_image'
+          | 'unable_to_process';
       }
 
       /**

package/src/resources/simulations/index.ts

@@ -5,7 +5,6 @@ export { AccountStatementCreateParams, AccountStatements } from './account-state
 export { AccountTransfers } from './account-transfers';
 export { CardAuthorizationSimulation, CardAuthorizeParams, CardSettlementParams, Cards } from './cards';
 export { CardDisputeActionParams, CardDisputes } from './card-disputes';
-export { CardProfiles } from './card-profiles';
 export { CardRefundCreateParams, CardRefunds } from './card-refunds';
 export { CheckDeposits } from './check-deposits';
 export { CheckTransfers } from './check-transfers';
@@ -26,12 +25,14 @@ export {
   InboundWireDrawdownRequestCreateParams,
   InboundWireDrawdownRequests,
 } from './inbound-wire-drawdown-requests';
-export {
-  InterestPaymentSimulationResult,
-  InterestPaymentCreateParams,
-  InterestPayments,
-} from './interest-payments';
+export { InterestPaymentCreateParams, InterestPayments } from './interest-payments';
 export { PhysicalCardShipmentAdvanceParams, PhysicalCards } from './physical-cards';
 export { ProgramCreateParams, Programs } from './programs';
-export { Simulations } from './simulations';
+export {
+  SimulationCardAuthorizationExpirationsParams,
+  SimulationCardFuelConfirmationsParams,
+  SimulationCardIncrementsParams,
+  SimulationCardReversalsParams,
+  Simulations,
+} from './simulations';
 export { WireTransferCreateInboundParams, WireTransfers } from './wire-transfers';