increase 0.28.0 → 0.29.0

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

@@ -0,0 +1,348 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import { isRequestOptions } from "../core";
+import * as DigitalCardProfilesAPI from "./digital-card-profiles";
+import { Page, type PageParams } from "../pagination";
+
+export class DigitalCardProfiles extends APIResource {
+  /**
+   * Create a Digital Card Profile
+   */
+  create(
+    body: DigitalCardProfileCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DigitalCardProfile> {
+    return this._client.post('/digital_card_profiles', { body, ...options });
+  }
+
+  /**
+   * Retrieve a Digital Card Profile
+   */
+  retrieve(digitalCardProfileId: string, options?: Core.RequestOptions): Core.APIPromise<DigitalCardProfile> {
+    return this._client.get(`/digital_card_profiles/${digitalCardProfileId}`, options);
+  }
+
+  /**
+   * List Card Profiles
+   */
+  list(
+    query?: DigitalCardProfileListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<DigitalCardProfilesPage, DigitalCardProfile>;
+  list(options?: Core.RequestOptions): Core.PagePromise<DigitalCardProfilesPage, DigitalCardProfile>;
+  list(
+    query: DigitalCardProfileListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<DigitalCardProfilesPage, DigitalCardProfile> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/digital_card_profiles', DigitalCardProfilesPage, { query, ...options });
+  }
+
+  /**
+   * Archive a Digital Card Profile
+   */
+  archive(digitalCardProfileId: string, options?: Core.RequestOptions): Core.APIPromise<DigitalCardProfile> {
+    return this._client.post(`/digital_card_profiles/${digitalCardProfileId}/archive`, options);
+  }
+
+  /**
+   * Clones a Digital Card Profile
+   */
+  clone(
+    digitalCardProfileId: string,
+    body: DigitalCardProfileCloneParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DigitalCardProfile> {
+    return this._client.post(`/digital_card_profiles/${digitalCardProfileId}/clone`, { body, ...options });
+  }
+}
+
+export class DigitalCardProfilesPage extends Page<DigitalCardProfile> {}
+
+/**
+ * This contains artwork and metadata relating to a Card's appearance in digital
+ * wallet apps like Apple Pay and Google Pay. For more information, see our guide
+ * on [digital card artwork](https://increase.com/documentation/card-art).
+ */
+export interface DigitalCardProfile {
+  /**
+   * The Card Profile identifier.
+   */
+  id: string;
+
+  /**
+   * The identifier of the File containing the card's icon image.
+   */
+  app_icon_file_id: string;
+
+  /**
+   * The identifier of the File containing the card's front image.
+   */
+  background_image_file_id: string;
+
+  /**
+   * A user-facing description for the card itself.
+   */
+  card_description: string;
+
+  /**
+   * An email address the user can contact to receive support for their card.
+   */
+  contact_email: string | null;
+
+  /**
+   * A phone number the user can contact to receive support for their card.
+   */
+  contact_phone: string | null;
+
+  /**
+   * A website the user can visit to view and receive support for their card.
+   */
+  contact_website: 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;
+
+  /**
+   * A description you can use to identify the Card Profile.
+   */
+  description: 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;
+
+  /**
+   * Whether this Digital Card Profile is the default for all cards in its Increase
+   * group.
+   */
+  is_default: boolean;
+
+  /**
+   * A user-facing description for whoever is issuing the card.
+   */
+  issuer_name: string;
+
+  /**
+   * The status of the Card Profile.
+   *
+   * - `pending` - The Card Profile is awaiting review from Increase and/or
+   *   processing by card networks.
+   * - `rejected` - There is an issue with the Card Profile preventing it from use.
+   * - `active` - The Card Profile can be assigned to Cards.
+   * - `archived` - The Card Profile is no longer in use.
+   */
+  status: 'pending' | 'rejected' | 'active' | 'archived';
+
+  /**
+   * The Card's text color, specified as an RGB triple.
+   */
+  text_color: DigitalCardProfile.TextColor;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `digital_card_profile`.
+   */
+  type: 'digital_card_profile';
+}
+
+export namespace DigitalCardProfile {
+  /**
+   * The Card's text color, specified as an RGB triple.
+   */
+  export interface TextColor {
+    /**
+     * The value of the blue channel in the RGB color.
+     */
+    blue: number;
+
+    /**
+     * The value of the green channel in the RGB color.
+     */
+    green: number;
+
+    /**
+     * The value of the red channel in the RGB color.
+     */
+    red: number;
+  }
+}
+
+export interface DigitalCardProfileCreateParams {
+  /**
+   * The identifier of the File containing the card's icon image.
+   */
+  app_icon_file_id: string;
+
+  /**
+   * The identifier of the File containing the card's front image.
+   */
+  background_image_file_id: string;
+
+  /**
+   * A user-facing description for the card itself.
+   */
+  card_description: string;
+
+  /**
+   * A description you can use to identify the Card Profile.
+   */
+  description: string;
+
+  /**
+   * A user-facing description for whoever is issuing the card.
+   */
+  issuer_name: string;
+
+  /**
+   * An email address the user can contact to receive support for their card.
+   */
+  contact_email?: string;
+
+  /**
+   * A phone number the user can contact to receive support for their card.
+   */
+  contact_phone?: string;
+
+  /**
+   * A website the user can visit to view and receive support for their card.
+   */
+  contact_website?: string;
+
+  /**
+   * The Card's text color, specified as an RGB triple. The default is white.
+   */
+  text_color?: DigitalCardProfileCreateParams.TextColor;
+}
+
+export namespace DigitalCardProfileCreateParams {
+  /**
+   * The Card's text color, specified as an RGB triple. The default is white.
+   */
+  export interface TextColor {
+    /**
+     * The value of the blue channel in the RGB color.
+     */
+    blue: number;
+
+    /**
+     * The value of the green channel in the RGB color.
+     */
+    green: number;
+
+    /**
+     * The value of the red channel in the RGB color.
+     */
+    red: number;
+  }
+}
+
+export interface DigitalCardProfileListParams 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?: DigitalCardProfileListParams.Status;
+}
+
+export namespace DigitalCardProfileListParams {
+  export interface Status {
+    /**
+     * Filter Digital Card Profiles for those with the specified digital wallet status
+     * or statuses. For GET requests, this should be encoded as a comma-delimited
+     * string, such as `?in=one,two,three`.
+     */
+    in?: Array<'pending' | 'rejected' | 'active' | 'archived'>;
+  }
+}
+
+export interface DigitalCardProfileCloneParams {
+  /**
+   * The identifier of the File containing the card's icon image.
+   */
+  app_icon_file_id?: string;
+
+  /**
+   * The identifier of the File containing the card's front image.
+   */
+  background_image_file_id?: string;
+
+  /**
+   * A user-facing description for the card itself.
+   */
+  card_description?: string;
+
+  /**
+   * An email address the user can contact to receive support for their card.
+   */
+  contact_email?: string;
+
+  /**
+   * A phone number the user can contact to receive support for their card.
+   */
+  contact_phone?: string;
+
+  /**
+   * A website the user can visit to view and receive support for their card.
+   */
+  contact_website?: string;
+
+  /**
+   * A description you can use to identify the Card Profile.
+   */
+  description?: string;
+
+  /**
+   * A user-facing description for whoever is issuing the card.
+   */
+  issuer_name?: string;
+
+  /**
+   * The Card's text color, specified as an RGB triple. The default is white.
+   */
+  text_color?: DigitalCardProfileCloneParams.TextColor;
+}
+
+export namespace DigitalCardProfileCloneParams {
+  /**
+   * The Card's text color, specified as an RGB triple. The default is white.
+   */
+  export interface TextColor {
+    /**
+     * The value of the blue channel in the RGB color.
+     */
+    blue: number;
+
+    /**
+     * The value of the green channel in the RGB color.
+     */
+    green: number;
+
+    /**
+     * The value of the red channel in the RGB color.
+     */
+    red: number;
+  }
+}
+
+export namespace DigitalCardProfiles {
+  export import DigitalCardProfile = DigitalCardProfilesAPI.DigitalCardProfile;
+  export import DigitalCardProfilesPage = DigitalCardProfilesAPI.DigitalCardProfilesPage;
+  export import DigitalCardProfileCreateParams = DigitalCardProfilesAPI.DigitalCardProfileCreateParams;
+  export import DigitalCardProfileListParams = DigitalCardProfilesAPI.DigitalCardProfileListParams;
+  export import DigitalCardProfileCloneParams = DigitalCardProfilesAPI.DigitalCardProfileCloneParams;
+}

package/src/resources/entities/entities.ts

@@ -86,6 +86,13 @@ export interface Entity {
    */
   description: 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;
+
   /**
    * Details of the joint entity. Will be present if `structure` is equal to `joint`.
    */
@@ -527,6 +534,13 @@ export namespace Entity {
      */
     file_id: 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;
+
     /**
      * A constant representing the object's type. For this resource it will always be
      * `entity_supplemental_document`.
@@ -2075,6 +2089,14 @@ export namespace EntityCreateParams {
 export interface EntityListParams extends PageParams {
   created_at?: EntityListParams.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;
+
   status?: EntityListParams.Status;
 }
 

package/src/resources/entities/supplemental-documents.ts

@@ -50,6 +50,13 @@ export interface SupplementalDocument {
    */
   file_id: 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;
+
   /**
    * A constant representing the object's type. For this resource it will always be
    * `entity_supplemental_document`.
@@ -69,6 +76,14 @@ export interface SupplementalDocumentListParams extends PageParams {
    * The identifier of the Entity to list supplemental documents for.
    */
   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 SupplementalDocuments {

package/src/resources/event-subscriptions.ts

@@ -75,6 +75,13 @@ export interface EventSubscription {
    */
   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;
+
   /**
    * If specified, this subscription will only receive webhooks for Events with the
    * specified `category`.
@@ -537,7 +544,15 @@ export interface EventSubscriptionUpdateParams {
   status?: 'active' | 'disabled' | 'deleted';
 }
 
-export interface EventSubscriptionListParams extends PageParams {}
+export interface EventSubscriptionListParams 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;
+}
 
 export namespace EventSubscriptions {
   export import EventSubscription = EventSubscriptionsAPI.EventSubscription;

package/src/resources/exports.ts

@@ -89,6 +89,13 @@ export interface Export {
    */
   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;
+
   /**
    * The status of the Export.
    *

package/src/resources/external-accounts.ts

@@ -63,6 +63,15 @@ export interface ExternalAccount {
    */
   id: string;
 
+  /**
+   * The type of entity that owns the External Account.
+   *
+   * - `business` - The External Account is owned by a business.
+   * - `individual` - The External Account is owned by an individual.
+   * - `unknown` - It's unknown what kind of entity owns the External Account.
+   */
+  account_holder: 'business' | 'individual' | 'unknown';
+
   /**
    * The destination account number.
    */
@@ -88,6 +97,13 @@ export interface ExternalAccount {
    */
   funding: 'checking' | 'savings' | 'other';
 
+  /**
+   * 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 American Bankers' Association (ABA) Routing Transit Number (RTN).
    */
@@ -135,6 +151,15 @@ export interface ExternalAccountCreateParams {
    */
   routing_number: string;
 
+  /**
+   * The type of entity that owns the External Account.
+   *
+   * - `business` - The External Account is owned by a business.
+   * - `individual` - The External Account is owned by an individual.
+   * - `unknown` - It's unknown what kind of entity owns the External Account.
+   */
+  account_holder?: 'business' | 'individual' | 'unknown';
+
   /**
    * The type of the destination account. Defaults to `checking`.
    *
@@ -146,6 +171,14 @@ export interface ExternalAccountCreateParams {
 }
 
 export interface ExternalAccountUpdateParams {
+  /**
+   * The type of entity that owns the External Account.
+   *
+   * - `business` - The External Account is owned by a business.
+   * - `individual` - The External Account is owned by an individual.
+   */
+  account_holder?: 'business' | 'individual';
+
   /**
    * The description you choose to give the external account.
    */
@@ -162,6 +195,14 @@ export interface ExternalAccountUpdateParams {
 }
 
 export interface ExternalAccountListParams 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;
+
   /**
    * Filter External Accounts to those with the specified Routing Number.
    */

package/src/resources/files.ts

@@ -82,6 +82,13 @@ export interface File {
    */
   filename: 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 MIME type of the file.
    */
@@ -199,6 +206,14 @@ export interface FileCreateParams {
 export interface FileListParams extends PageParams {
   created_at?: FileListParams.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;
+
   purpose?: FileListParams.Purpose;
 }
 

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

@@ -381,6 +381,11 @@ export interface InboundACHTransferListParams extends PageParams {
    */
   account_id?: string;
 
+  /**
+   * Filter Inbound ACH Tranfers to ones belonging to the specified Account Number.
+   */
+  account_number_id?: string;
+
   created_at?: InboundACHTransferListParams.CreatedAt;
 
   /**

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

@@ -178,6 +178,11 @@ export interface InboundWireTransferListParams extends PageParams {
    */
   account_id?: string;
 
+  /**
+   * Filter Inbound Wire Tranfers to ones belonging to the specified Account Number.
+   */
+  account_number_id?: string;
+
   created_at?: InboundWireTransferListParams.CreatedAt;
 
   /**

package/src/resources/index.ts

@@ -85,13 +85,6 @@ export {
   CardDisputes,
 } from './card-disputes';
 export { CardPayment, CardPaymentListParams, CardPaymentsPage, CardPayments } from './card-payments';
-export {
-  CardProfile,
-  CardProfileCreateParams,
-  CardProfileListParams,
-  CardProfilesPage,
-  CardProfiles,
-} from './card-profiles';
 export {
   CardPurchaseSupplement,
   CardPurchaseSupplementListParams,
@@ -119,6 +112,14 @@ export {
   DeclinedTransactionsPage,
   DeclinedTransactions,
 } from './declined-transactions';
+export {
+  DigitalCardProfile,
+  DigitalCardProfileCreateParams,
+  DigitalCardProfileListParams,
+  DigitalCardProfileCloneParams,
+  DigitalCardProfilesPage,
+  DigitalCardProfiles,
+} from './digital-card-profiles';
 export {
   DigitalWalletToken,
   DigitalWalletTokenListParams,
@@ -196,6 +197,14 @@ export {
   PhysicalCardsPage,
   PhysicalCards,
 } from './physical-cards';
+export {
+  PhysicalCardProfile,
+  PhysicalCardProfileCreateParams,
+  PhysicalCardProfileListParams,
+  PhysicalCardProfileCloneParams,
+  PhysicalCardProfilesPage,
+  PhysicalCardProfiles,
+} from './physical-card-profiles';
 export { Program, ProgramListParams, ProgramsPage, Programs } from './programs';
 export {
   ProofOfAuthorizationRequest,
@@ -231,7 +240,13 @@ export {
   RoutingNumbersPage,
   RoutingNumbers,
 } from './routing-numbers';
-export { Simulations } from './simulations/simulations';
+export {
+  SimulationCardAuthorizationExpirationsParams,
+  SimulationCardFuelConfirmationsParams,
+  SimulationCardIncrementsParams,
+  SimulationCardReversalsParams,
+  Simulations,
+} from './simulations/simulations';
 export { Transaction, TransactionListParams, TransactionsPage, Transactions } from './transactions';
 export { Webhooks } from './webhooks';
 export {

package/src/resources/intrafi/account-enrollments.ts

@@ -82,6 +82,13 @@ export interface IntrafiAccountEnrollment {
    */
   account_id: 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 identifier of the account in IntraFi's system. This identifier will be
    * printed on any IntraFi statements or documents.
@@ -128,6 +135,14 @@ export interface AccountEnrollmentListParams extends PageParams {
    */
   account_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;
+
   status?: AccountEnrollmentListParams.Status;
 }