increase 1.87.0 → 1.89.0

data/rbi/increase/models/account_transfer.rbi

@@ -8,16 +8,16 @@ module Increase
           T.any(Increase::AccountTransfer, Increase::Internal::AnyHash)
         end
 
-      # The account transfer's identifier.
+      # The Account Transfer's identifier.
       sig { returns(String) }
       attr_accessor :id
 
-      # The Account to which the transfer belongs.
+      # The Account from which the transfer originated.
       sig { returns(String) }
       attr_accessor :account_id
 
-      # The transfer amount in the minor unit of the destination account currency. For
-      # dollars, for example, this is cents.
+      # The transfer amount in cents. This will always be positive and indicates the
+      # amount of money leaving the originating account.
       sig { returns(Integer) }
       attr_accessor :amount
 
@@ -62,20 +62,22 @@ module Increase
       end
       attr_writer :created_by
 
-      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-      # account currency.
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
+      # currency.
       sig { returns(Increase::AccountTransfer::Currency::TaggedSymbol) }
       attr_accessor :currency
 
-      # The description that will show on the transactions.
+      # An internal-facing description for the transfer for display in the API and
+      # dashboard. This will also show in the description of the created Transactions.
       sig { returns(String) }
       attr_accessor :description
 
-      # The destination account's identifier.
+      # The destination Account's identifier.
       sig { returns(String) }
       attr_accessor :destination_account_id
 
-      # The ID for the transaction receiving the transfer.
+      # The identifier of the Transaction on the destination Account representing the
+      # received funds.
       sig { returns(T.nilable(String)) }
       attr_accessor :destination_transaction_id
 
@@ -85,10 +87,6 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :idempotency_key
 
-      # The transfer's network.
-      sig { returns(Increase::AccountTransfer::Network::TaggedSymbol) }
-      attr_accessor :network
-
       # The ID for the pending transaction representing the transfer. A pending
       # transaction is created when the transfer
       # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
@@ -100,7 +98,8 @@ module Increase
       sig { returns(Increase::AccountTransfer::Status::TaggedSymbol) }
       attr_accessor :status
 
-      # The ID for the transaction funding the transfer.
+      # The identifier of the Transaction on the originating account representing the
+      # transferred funds.
       sig { returns(T.nilable(String)) }
       attr_accessor :transaction_id
 
@@ -109,7 +108,12 @@ module Increase
       sig { returns(Increase::AccountTransfer::Type::TaggedSymbol) }
       attr_accessor :type
 
-      # Account transfers move funds between your own accounts at Increase.
+      # Account transfers move funds between your own accounts at Increase (accounting
+      # systems often refer to these as Book Transfers). Account Transfers are free and
+      # synchronous. Upon creation they create two Transactions, one negative on the
+      # originating account and one positive on the destination account (unless the
+      # transfer requires approval, in which case the Transactions will be created when
+      # the transfer is approved).
       sig do
         params(
           id: String,
@@ -125,7 +129,6 @@ module Increase
           destination_account_id: String,
           destination_transaction_id: T.nilable(String),
           idempotency_key: T.nilable(String),
-          network: Increase::AccountTransfer::Network::OrSymbol,
           pending_transaction_id: T.nilable(String),
           status: Increase::AccountTransfer::Status::OrSymbol,
           transaction_id: T.nilable(String),
@@ -133,12 +136,12 @@ module Increase
         ).returns(T.attached_class)
       end
       def self.new(
-        # The account transfer's identifier.
+        # The Account Transfer's identifier.
         id:,
-        # The Account to which the transfer belongs.
+        # The Account from which the transfer originated.
         account_id:,
-        # The transfer amount in the minor unit of the destination account currency. For
-        # dollars, for example, this is cents.
+        # The transfer amount in cents. This will always be positive and indicates the
+        # amount of money leaving the originating account.
         amount:,
         # If your account requires approvals for transfers and the transfer was approved,
         # this will contain details of the approval.
@@ -151,21 +154,21 @@ module Increase
         created_at:,
         # What object created the transfer, either via the API or the dashboard.
         created_by:,
-        # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-        # account currency.
+        # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
+        # currency.
         currency:,
-        # The description that will show on the transactions.
+        # An internal-facing description for the transfer for display in the API and
+        # dashboard. This will also show in the description of the created Transactions.
         description:,
-        # The destination account's identifier.
+        # The destination Account's identifier.
         destination_account_id:,
-        # The ID for the transaction receiving the transfer.
+        # The identifier of the Transaction on the destination Account representing the
+        # received funds.
         destination_transaction_id:,
         # 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:,
-        # The transfer's network.
-        network:,
         # The ID for the pending transaction representing the transfer. A pending
         # transaction is created when the transfer
         # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
@@ -173,7 +176,8 @@ module Increase
         pending_transaction_id:,
         # The lifecycle status of the transfer.
         status:,
-        # The ID for the transaction funding the transfer.
+        # The identifier of the Transaction on the originating account representing the
+        # transferred funds.
         transaction_id:,
         # A constant representing the object's type. For this resource it will always be
         # `account_transfer`.
@@ -196,7 +200,6 @@ module Increase
             destination_account_id: String,
             destination_transaction_id: T.nilable(String),
             idempotency_key: T.nilable(String),
-            network: Increase::AccountTransfer::Network::TaggedSymbol,
             pending_transaction_id: T.nilable(String),
             status: Increase::AccountTransfer::Status::TaggedSymbol,
             transaction_id: T.nilable(String),
@@ -518,8 +521,8 @@ module Increase
         end
       end
 
-      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-      # account currency.
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
+      # currency.
       module Currency
         extend Increase::Internal::Type::Enum
 
@@ -554,26 +557,6 @@ module Increase
         end
       end
 
-      # The transfer's network.
-      module Network
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Increase::AccountTransfer::Network) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ACCOUNT =
-          T.let(:account, Increase::AccountTransfer::Network::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[Increase::AccountTransfer::Network::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
       # The lifecycle status of the transfer.
       module Status
         extend Increase::Internal::Type::Enum
@@ -582,14 +565,14 @@ module Increase
           T.type_alias { T.all(Symbol, Increase::AccountTransfer::Status) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        # The transfer is pending approval.
+        # The transfer is pending approval from your team.
         PENDING_APPROVAL =
           T.let(
             :pending_approval,
             Increase::AccountTransfer::Status::TaggedSymbol
           )
 
-        # The transfer has been canceled.
+        # The transfer was pending approval from your team and has been canceled.
         CANCELED =
           T.let(:canceled, Increase::AccountTransfer::Status::TaggedSymbol)
 

data/rbi/increase/models/account_transfer_create_params.rbi

@@ -14,7 +14,7 @@ module Increase
           )
         end
 
-      # The identifier for the account that will send the transfer.
+      # The identifier for the originating Account that will send the transfer.
       sig { returns(String) }
       attr_accessor :account_id
 
@@ -23,15 +23,18 @@ module Increase
       sig { returns(Integer) }
       attr_accessor :amount
 
-      # The description you choose to give the transfer.
+      # An internal-facing description for the transfer for display in the API and
+      # dashboard. This will also show in the description of the created Transactions.
       sig { returns(String) }
       attr_accessor :description
 
-      # The identifier for the account that will receive the transfer.
+      # The identifier for the destination Account that will receive the transfer.
       sig { returns(String) }
       attr_accessor :destination_account_id
 
-      # Whether the transfer requires explicit approval via the dashboard or API.
+      # Whether the transfer should require explicit approval via the dashboard or API.
+      # For more information, see
+      # [Transfer Approvals](/documentation/transfer-approvals).
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :require_approval
 
@@ -49,16 +52,19 @@ module Increase
         ).returns(T.attached_class)
       end
       def self.new(
-        # The identifier for the account that will send the transfer.
+        # The identifier for the originating Account that will send the transfer.
         account_id:,
         # The transfer amount in the minor unit of the account currency. For dollars, for
         # example, this is cents.
         amount:,
-        # The description you choose to give the transfer.
+        # An internal-facing description for the transfer for display in the API and
+        # dashboard. This will also show in the description of the created Transactions.
         description:,
-        # The identifier for the account that will receive the transfer.
+        # The identifier for the destination Account that will receive the transfer.
         destination_account_id:,
-        # Whether the transfer requires explicit approval via the dashboard or API.
+        # Whether the transfer should require explicit approval via the dashboard or API.
+        # For more information, see
+        # [Transfer Approvals](/documentation/transfer-approvals).
         require_approval: nil,
         request_options: {}
       )

data/rbi/increase/models/{card_detail_create_details_iframe_params.rbi → card_create_details_iframe_params.rbi}

@@ -2,19 +2,20 @@
 
 module Increase
   module Models
-    class CardDetailCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
+    class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Increase::CardDetailCreateDetailsIframeParams,
+            Increase::CardCreateDetailsIframeParams,
             Increase::Internal::AnyHash
           )
         end
 
-      # The identifier of the Physical Card to retrieve details for.
+      # The identifier of the Physical Card to create an iframe for. This will inform
+      # the appearance of the card rendered in the iframe.
       sig { returns(T.nilable(String)) }
       attr_reader :physical_card_id
 
@@ -28,7 +29,8 @@ module Increase
         ).returns(T.attached_class)
       end
       def self.new(
-        # The identifier of the Physical Card to retrieve details for.
+        # The identifier of the Physical Card to create an iframe for. This will inform
+        # the appearance of the card rendered in the iframe.
         physical_card_id: nil,
         request_options: {}
       )

data/rbi/increase/models/card_details.rbi

@@ -2,10 +2,10 @@
 
 module Increase
   module Models
-    class CardDetailsAPI < Increase::Internal::Type::BaseModel
+    class CardDetails < Increase::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(Increase::CardDetailsAPI, Increase::Internal::AnyHash)
+          T.any(Increase::CardDetails, Increase::Internal::AnyHash)
         end
 
       # The identifier for the Card for which sensitive details have been returned.
@@ -30,7 +30,7 @@ module Increase
 
       # A constant representing the object's type. For this resource it will always be
       # `card_details`.
-      sig { returns(Increase::CardDetailsAPI::Type::TaggedSymbol) }
+      sig { returns(Increase::CardDetails::Type::TaggedSymbol) }
       attr_accessor :type
 
       # The three-digit verification code for the card. It's also known as the Card
@@ -51,7 +51,7 @@ module Increase
           expiration_year: Integer,
           pin: String,
           primary_account_number: String,
-          type: Increase::CardDetailsAPI::Type::OrSymbol,
+          type: Increase::CardDetails::Type::OrSymbol,
           verification_code: String
         ).returns(T.attached_class)
       end
@@ -84,7 +84,7 @@ module Increase
             expiration_year: Integer,
             pin: String,
             primary_account_number: String,
-            type: Increase::CardDetailsAPI::Type::TaggedSymbol,
+            type: Increase::CardDetails::Type::TaggedSymbol,
             verification_code: String
           }
         )
@@ -98,16 +98,14 @@ module Increase
         extend Increase::Internal::Type::Enum
 
         TaggedSymbol =
-          T.type_alias { T.all(Symbol, Increase::CardDetailsAPI::Type) }
+          T.type_alias { T.all(Symbol, Increase::CardDetails::Type) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CARD_DETAILS =
-          T.let(:card_details, Increase::CardDetailsAPI::Type::TaggedSymbol)
+          T.let(:card_details, Increase::CardDetails::Type::TaggedSymbol)
 
         sig do
-          override.returns(
-            T::Array[Increase::CardDetailsAPI::Type::TaggedSymbol]
-          )
+          override.returns(T::Array[Increase::CardDetails::Type::TaggedSymbol])
         end
         def self.values
         end

data/rbi/increase/models/{card_detail_details_params.rbi → card_details_params.rbi}

@@ -2,13 +2,13 @@
 
 module Increase
   module Models
-    class CardDetailDetailsParams < Increase::Internal::Type::BaseModel
+    class CardDetailsParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
-          T.any(Increase::CardDetailDetailsParams, Increase::Internal::AnyHash)
+          T.any(Increase::CardDetailsParams, Increase::Internal::AnyHash)
         end
 
       sig do

data/rbi/increase/models/card_update_params.rbi

@@ -50,13 +50,6 @@ module Increase
       sig { params(entity_id: String).void }
       attr_writer :entity_id
 
-      # The 4-digit PIN for the card, for use with ATMs.
-      sig { returns(T.nilable(String)) }
-      attr_reader :pin
-
-      sig { params(pin: String).void }
-      attr_writer :pin
-
       # The status to update the Card with.
       sig { returns(T.nilable(Increase::CardUpdateParams::Status::OrSymbol)) }
       attr_reader :status
@@ -70,7 +63,6 @@ module Increase
           description: String,
           digital_wallet: Increase::CardUpdateParams::DigitalWallet::OrHash,
           entity_id: String,
-          pin: String,
           status: Increase::CardUpdateParams::Status::OrSymbol,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -87,8 +79,6 @@ module Increase
         # The Entity the card belongs to. You only need to supply this in rare situations
         # when the card is not for the Account holder.
         entity_id: nil,
-        # The 4-digit PIN for the card, for use with ATMs.
-        pin: nil,
         # The status to update the Card with.
         status: nil,
         request_options: {}
@@ -102,7 +92,6 @@ module Increase
             description: String,
             digital_wallet: Increase::CardUpdateParams::DigitalWallet,
             entity_id: String,
-            pin: String,
             status: Increase::CardUpdateParams::Status::OrSymbol,
             request_options: Increase::RequestOptions
           }

data/rbi/increase/models/{card_detail_update_params.rbi → card_update_pin_params.rbi}

@@ -2,13 +2,13 @@
 
 module Increase
   module Models
-    class CardDetailUpdateParams < Increase::Internal::Type::BaseModel
+    class CardUpdatePinParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
-          T.any(Increase::CardDetailUpdateParams, Increase::Internal::AnyHash)
+          T.any(Increase::CardUpdatePinParams, Increase::Internal::AnyHash)
         end
 
       # The 4-digit PIN for the card, for use with ATMs.

data/rbi/increase/models.rbi

@@ -104,16 +104,14 @@ module Increase
 
   Card = Increase::Models::Card
 
-  CardCreateParams = Increase::Models::CardCreateParams
-
-  CardDetailCreateDetailsIframeParams =
-    Increase::Models::CardDetailCreateDetailsIframeParams
+  CardCreateDetailsIframeParams =
+    Increase::Models::CardCreateDetailsIframeParams
 
-  CardDetailDetailsParams = Increase::Models::CardDetailDetailsParams
+  CardCreateParams = Increase::Models::CardCreateParams
 
-  CardDetailsAPI = Increase::Models::CardDetailsAPI
+  CardDetails = Increase::Models::CardDetails
 
-  CardDetailUpdateParams = Increase::Models::CardDetailUpdateParams
+  CardDetailsParams = Increase::Models::CardDetailsParams
 
   CardIframeURL = Increase::Models::CardIframeURL
 
@@ -161,6 +159,8 @@ module Increase
 
   CardUpdateParams = Increase::Models::CardUpdateParams
 
+  CardUpdatePinParams = Increase::Models::CardUpdatePinParams
+
   CardValidation = Increase::Models::CardValidation
 
   CardValidationCreateParams = Increase::Models::CardValidationCreateParams

data/rbi/increase/resources/account_transfers.rbi

@@ -15,16 +15,19 @@ module Increase
         ).returns(Increase::AccountTransfer)
       end
       def create(
-        # The identifier for the account that will send the transfer.
+        # The identifier for the originating Account that will send the transfer.
         account_id:,
         # The transfer amount in the minor unit of the account currency. For dollars, for
         # example, this is cents.
         amount:,
-        # The description you choose to give the transfer.
+        # An internal-facing description for the transfer for display in the API and
+        # dashboard. This will also show in the description of the created Transactions.
         description:,
-        # The identifier for the account that will receive the transfer.
+        # The identifier for the destination Account that will receive the transfer.
         destination_account_id:,
-        # Whether the transfer requires explicit approval via the dashboard or API.
+        # Whether the transfer should require explicit approval via the dashboard or API.
+        # For more information, see
+        # [Transfer Approvals](/documentation/transfer-approvals).
         require_approval: nil,
         request_options: {}
       )
@@ -73,7 +76,7 @@ module Increase
       )
       end
 
-      # Approve an Account Transfer
+      # Approves an Account Transfer in status `pending_approval`.
       sig do
         params(
           account_transfer_id: String,
@@ -87,7 +90,7 @@ module Increase
       )
       end
 
-      # Cancel an Account Transfer
+      # Cancels an Account Transfer in status `pending_approval`.
       sig do
         params(
           account_transfer_id: String,

data/rbi/increase/resources/cards.rbi

@@ -56,7 +56,6 @@ module Increase
           description: String,
           digital_wallet: Increase::CardUpdateParams::DigitalWallet::OrHash,
           entity_id: String,
-          pin: String,
           status: Increase::CardUpdateParams::Status::OrSymbol,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::Card)
@@ -75,8 +74,6 @@ module Increase
         # The Entity the card belongs to. You only need to supply this in rare situations
         # when the card is not for the Account holder.
         entity_id: nil,
-        # The 4-digit PIN for the card, for use with ATMs.
-        pin: nil,
         # The status to update the Card with.
         status: nil,
         request_options: {}
@@ -114,6 +111,58 @@ module Increase
       )
       end
 
+      # Create an iframe URL for a Card to display the card details. More details about
+      # styling and usage can be found in the
+      # [documentation](/documentation/embedded-card-component).
+      sig do
+        params(
+          card_id: String,
+          physical_card_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardIframeURL)
+      end
+      def create_details_iframe(
+        # The identifier of the Card to create an iframe for.
+        card_id,
+        # The identifier of the Physical Card to create an iframe for. This will inform
+        # the appearance of the card rendered in the iframe.
+        physical_card_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Sensitive details for a Card include the primary account number, expiry, card
+      # verification code, and PIN.
+      sig do
+        params(
+          card_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDetails)
+      end
+      def details(
+        # The identifier of the Card to retrieve details for.
+        card_id,
+        request_options: {}
+      )
+      end
+
+      # Update a Card's PIN
+      sig do
+        params(
+          card_id: String,
+          pin: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDetails)
+      end
+      def update_pin(
+        # The identifier of the Card to update the PIN for.
+        card_id,
+        # The 4-digit PIN for the card, for use with ATMs.
+        pin:,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Increase::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/increase/client.rbs

@@ -23,8 +23,6 @@ module Increase
 
     attr_reader cards: Increase::Resources::Cards
 
-    attr_reader card_details: Increase::Resources::CardDetails
-
     attr_reader card_payments: Increase::Resources::CardPayments
 
     attr_reader card_purchase_supplements: Increase::Resources::CardPurchaseSupplements

data/sig/increase/models/account_transfer.rbs

@@ -14,7 +14,6 @@ module Increase
         destination_account_id: String,
         destination_transaction_id: String?,
         idempotency_key: String?,
-        network: Increase::Models::AccountTransfer::network,
         pending_transaction_id: String?,
         status: Increase::Models::AccountTransfer::status,
         transaction_id: String?,
@@ -46,8 +45,6 @@ module Increase
 
       attr_accessor idempotency_key: String?
 
-      attr_accessor network: Increase::Models::AccountTransfer::network
-
       attr_accessor pending_transaction_id: String?
 
       attr_accessor status: Increase::Models::AccountTransfer::status
@@ -69,7 +66,6 @@ module Increase
         destination_account_id: String,
         destination_transaction_id: String?,
         idempotency_key: String?,
-        network: Increase::Models::AccountTransfer::network,
         pending_transaction_id: String?,
         status: Increase::Models::AccountTransfer::status,
         transaction_id: String?,
@@ -89,7 +85,6 @@ module Increase
         destination_account_id: String,
         destination_transaction_id: String?,
         idempotency_key: String?,
-        network: Increase::Models::AccountTransfer::network,
         pending_transaction_id: String?,
         status: Increase::Models::AccountTransfer::status,
         transaction_id: String?,
@@ -225,25 +220,15 @@ module Increase
         def self?.values: -> ::Array[Increase::Models::AccountTransfer::currency]
       end
 
-      type network = :account
-
-      module Network
-        extend Increase::Internal::Type::Enum
-
-        ACCOUNT: :account
-
-        def self?.values: -> ::Array[Increase::Models::AccountTransfer::network]
-      end
-
       type status = :pending_approval | :canceled | :complete
 
       module Status
         extend Increase::Internal::Type::Enum
 
-        # The transfer is pending approval.
+        # The transfer is pending approval from your team.
         PENDING_APPROVAL: :pending_approval
 
-        # The transfer has been canceled.
+        # The transfer was pending approval from your team and has been canceled.
         CANCELED: :canceled
 
         # The transfer has been completed.

data/sig/increase/models/{card_detail_create_details_iframe_params.rbs → card_create_details_iframe_params.rbs}

@@ -1,10 +1,10 @@
 module Increase
   module Models
-    type card_detail_create_details_iframe_params =
+    type card_create_details_iframe_params =
       { physical_card_id: String }
       & Increase::Internal::Type::request_parameters
 
-    class CardDetailCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
+    class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters