increase 1.216.0 → 1.218.0

data/rbi/increase/models/simulations/card_authentication_challenges_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class CardAuthenticationChallengesParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::CardAuthenticationChallengesParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Increase::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: Increase::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/simulations/card_authentication_create_params.rbi

@@ -0,0 +1,238 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class CardAuthenticationCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::CardAuthenticationCreateParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Card to be authorized.
+        sig { returns(String) }
+        attr_accessor :card_id
+
+        # The category of the card authentication attempt.
+        sig do
+          returns(
+            T.nilable(
+              Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol
+            )
+          )
+        end
+        attr_reader :category
+
+        sig do
+          params(
+            category:
+              Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol
+          ).void
+        end
+        attr_writer :category
+
+        # The device channel of the card authentication attempt.
+        sig do
+          returns(
+            T.nilable(
+              Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol
+            )
+          )
+        end
+        attr_reader :device_channel
+
+        sig do
+          params(
+            device_channel:
+              Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol
+          ).void
+        end
+        attr_writer :device_channel
+
+        # The merchant identifier (commonly abbreviated as MID) of the merchant the card
+        # is transacting with.
+        sig { returns(T.nilable(String)) }
+        attr_reader :merchant_acceptor_id
+
+        sig { params(merchant_acceptor_id: String).void }
+        attr_writer :merchant_acceptor_id
+
+        # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+        # card is transacting with.
+        sig { returns(T.nilable(String)) }
+        attr_reader :merchant_category_code
+
+        sig { params(merchant_category_code: String).void }
+        attr_writer :merchant_category_code
+
+        # The country the merchant resides in.
+        sig { returns(T.nilable(String)) }
+        attr_reader :merchant_country
+
+        sig { params(merchant_country: String).void }
+        attr_writer :merchant_country
+
+        # The name of the merchant
+        sig { returns(T.nilable(String)) }
+        attr_reader :merchant_name
+
+        sig { params(merchant_name: String).void }
+        attr_writer :merchant_name
+
+        # The purchase amount in cents.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :purchase_amount
+
+        sig { params(purchase_amount: Integer).void }
+        attr_writer :purchase_amount
+
+        sig do
+          params(
+            card_id: String,
+            category:
+              Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol,
+            device_channel:
+              Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol,
+            merchant_acceptor_id: String,
+            merchant_category_code: String,
+            merchant_country: String,
+            merchant_name: String,
+            purchase_amount: Integer,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Card to be authorized.
+          card_id:,
+          # The category of the card authentication attempt.
+          category: nil,
+          # The device channel of the card authentication attempt.
+          device_channel: nil,
+          # The merchant identifier (commonly abbreviated as MID) of the merchant the card
+          # is transacting with.
+          merchant_acceptor_id: nil,
+          # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+          # card is transacting with.
+          merchant_category_code: nil,
+          # The country the merchant resides in.
+          merchant_country: nil,
+          # The name of the merchant
+          merchant_name: nil,
+          # The purchase amount in cents.
+          purchase_amount: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              card_id: String,
+              category:
+                Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol,
+              device_channel:
+                Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol,
+              merchant_acceptor_id: String,
+              merchant_category_code: String,
+              merchant_country: String,
+              merchant_name: String,
+              purchase_amount: Integer,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The category of the card authentication attempt.
+        module Category
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::Simulations::CardAuthenticationCreateParams::Category
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The authentication attempt is for a payment.
+          PAYMENT_AUTHENTICATION =
+            T.let(
+              :payment_authentication,
+              Increase::Simulations::CardAuthenticationCreateParams::Category::TaggedSymbol
+            )
+
+          # The authentication attempt is not for a payment.
+          NON_PAYMENT_AUTHENTICATION =
+            T.let(
+              :non_payment_authentication,
+              Increase::Simulations::CardAuthenticationCreateParams::Category::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::Simulations::CardAuthenticationCreateParams::Category::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The device channel of the card authentication attempt.
+        module DeviceChannel
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The authentication attempt was made from an app.
+          APP =
+            T.let(
+              :app,
+              Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
+            )
+
+          # The authentication attempt was made from a browser.
+          BROWSER =
+            T.let(
+              :browser,
+              Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
+            )
+
+          # The authentication attempt was initiated by the 3DS Requestor.
+          THREE_DS_REQUESTOR_INITIATED =
+            T.let(
+              :three_ds_requestor_initiated,
+              Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/card_authentications.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardAuthentications
+        # Simulates a Card Authentication attempt on a [Card](#cards). The attempt always
+        # results in a [Card Payment](#card_payments) being created, either with a status
+        # that allows further action or a terminal failed status.
+        sig do
+          params(
+            card_id: String,
+            category:
+              Increase::Simulations::CardAuthenticationCreateParams::Category::OrSymbol,
+            device_channel:
+              Increase::Simulations::CardAuthenticationCreateParams::DeviceChannel::OrSymbol,
+            merchant_acceptor_id: String,
+            merchant_category_code: String,
+            merchant_country: String,
+            merchant_name: String,
+            purchase_amount: Integer,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardPayment)
+        end
+        def create(
+          # The identifier of the Card to be authorized.
+          card_id:,
+          # The category of the card authentication attempt.
+          category: nil,
+          # The device channel of the card authentication attempt.
+          device_channel: nil,
+          # The merchant identifier (commonly abbreviated as MID) of the merchant the card
+          # is transacting with.
+          merchant_acceptor_id: nil,
+          # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+          # card is transacting with.
+          merchant_category_code: nil,
+          # The country the merchant resides in.
+          merchant_country: nil,
+          # The name of the merchant
+          merchant_name: nil,
+          # The purchase amount in cents.
+          purchase_amount: nil,
+          request_options: {}
+        )
+        end
+
+        # Simulates an attempt at a Card Authentication Challenge. This updates the
+        # `card_authentications` object under the [Card Payment](#card_payments). You can
+        # also attempt the challenge by navigating to
+        # https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
+        sig do
+          params(
+            card_payment_id: String,
+            one_time_code: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardPayment)
+        end
+        def challenge_attempts(
+          # The identifier of the Card Payment to be challenged.
+          card_payment_id,
+          # The one-time code to be validated.
+          one_time_code:,
+          request_options: {}
+        )
+        end
+
+        # Simulates starting a Card Authentication Challenge for an existing Card
+        # Authentication. This updates the `card_authentications` object under the
+        # [Card Payment](#card_payments). To attempt the challenge, use the
+        # `/simulations/card_authentications/:card_payment_id/challenge_attempts` endpoint
+        # or navigate to
+        # https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
+        sig do
+          params(
+            card_payment_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardPayment)
+        end
+        def challenges(
+          # The identifier of the Card Payment to be challenged.
+          card_payment_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations.rbi

@@ -35,6 +35,9 @@ module Increase
       sig { returns(Increase::Resources::Simulations::CardRefunds) }
       attr_reader :card_refunds
 
+      sig { returns(Increase::Resources::Simulations::CardAuthentications) }
+      attr_reader :card_authentications
+
       sig { returns(Increase::Resources::Simulations::CardDisputes) }
       attr_reader :card_disputes
 

data/sig/increase/models/check_deposit.rbs

@@ -8,6 +8,7 @@ module Increase
         back_image_file_id: String?,
         created_at: Time,
         deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?,
+        deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment],
         deposit_rejection: Increase::CheckDeposit::DepositRejection?,
         deposit_return: Increase::CheckDeposit::DepositReturn?,
         deposit_submission: Increase::CheckDeposit::DepositSubmission?,
@@ -35,6 +36,8 @@ module Increase
 
       attr_accessor deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?
 
+      attr_accessor deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment]
+
       attr_accessor deposit_rejection: Increase::CheckDeposit::DepositRejection?
 
       attr_accessor deposit_return: Increase::CheckDeposit::DepositReturn?
@@ -66,6 +69,7 @@ module Increase
         back_image_file_id: String?,
         created_at: Time,
         deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?,
+        deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment],
         deposit_rejection: Increase::CheckDeposit::DepositRejection?,
         deposit_return: Increase::CheckDeposit::DepositReturn?,
         deposit_submission: Increase::CheckDeposit::DepositSubmission?,
@@ -87,6 +91,7 @@ module Increase
         back_image_file_id: String?,
         created_at: Time,
         deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?,
+        deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment],
         deposit_rejection: Increase::CheckDeposit::DepositRejection?,
         deposit_return: Increase::CheckDeposit::DepositReturn?,
         deposit_submission: Increase::CheckDeposit::DepositSubmission?,
@@ -159,6 +164,66 @@ module Increase
         end
       end
 
+      type deposit_adjustment =
+        {
+          adjusted_at: Time,
+          amount: Integer,
+          reason: Increase::Models::CheckDeposit::DepositAdjustment::reason,
+          transaction_id: String
+        }
+
+      class DepositAdjustment < Increase::Internal::Type::BaseModel
+        attr_accessor adjusted_at: Time
+
+        attr_accessor amount: Integer
+
+        attr_accessor reason: Increase::Models::CheckDeposit::DepositAdjustment::reason
+
+        attr_accessor transaction_id: String
+
+        def initialize: (
+          adjusted_at: Time,
+          amount: Integer,
+          reason: Increase::Models::CheckDeposit::DepositAdjustment::reason,
+          transaction_id: String
+        ) -> void
+
+        def to_hash: -> {
+          adjusted_at: Time,
+          amount: Integer,
+          reason: Increase::Models::CheckDeposit::DepositAdjustment::reason,
+          transaction_id: String
+        }
+
+        type reason =
+          :late_return
+          | :wrong_payee_credit
+          | :adjusted_amount
+          | :non_conforming_item
+          | :paid
+
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
+          LATE_RETURN: :late_return
+
+          # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
+          WRONG_PAYEE_CREDIT: :wrong_payee_credit
+
+          # The check was deposited with a different amount than what was written on the check.
+          ADJUSTED_AMOUNT: :adjusted_amount
+
+          # The recipient was not able to process the check. This usually happens for e.g., low quality images.
+          NON_CONFORMING_ITEM: :non_conforming_item
+
+          # The check has already been deposited elsewhere and so this is a duplicate.
+          PAID: :paid
+
+          def self?.values: -> ::Array[Increase::Models::CheckDeposit::DepositAdjustment::reason]
+        end
+      end
+
       type deposit_rejection =
         {
           amount: Integer,

data/sig/increase/models/simulations/card_authentication_challenge_attempts_params.rbs

@@ -0,0 +1,25 @@
+module Increase
+  module Models
+    module Simulations
+      type card_authentication_challenge_attempts_params =
+        { one_time_code: String } & Increase::Internal::Type::request_parameters
+
+      class CardAuthenticationChallengeAttemptsParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        attr_accessor one_time_code: String
+
+        def initialize: (
+          one_time_code: String,
+          ?request_options: Increase::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          one_time_code: String,
+          request_options: Increase::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/increase/models/simulations/card_authentication_challenges_params.rbs

@@ -0,0 +1,17 @@
+module Increase
+  module Models
+    module Simulations
+      type card_authentication_challenges_params =
+        {  } & Increase::Internal::Type::request_parameters
+
+      class CardAuthenticationChallengesParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Increase::request_opts) -> void
+
+        def to_hash: -> { request_options: Increase::RequestOptions }
+      end
+    end
+  end
+end

data/sig/increase/models/simulations/card_authentication_create_params.rbs

@@ -0,0 +1,112 @@
+module Increase
+  module Models
+    module Simulations
+      type card_authentication_create_params =
+        {
+          card_id: String,
+          category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
+          device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
+          merchant_acceptor_id: String,
+          merchant_category_code: String,
+          merchant_country: String,
+          merchant_name: String,
+          purchase_amount: Integer
+        }
+        & Increase::Internal::Type::request_parameters
+
+      class CardAuthenticationCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        attr_accessor card_id: String
+
+        attr_reader category: Increase::Models::Simulations::CardAuthenticationCreateParams::category?
+
+        def category=: (
+          Increase::Models::Simulations::CardAuthenticationCreateParams::category
+        ) -> Increase::Models::Simulations::CardAuthenticationCreateParams::category
+
+        attr_reader device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel?
+
+        def device_channel=: (
+          Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel
+        ) -> Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel
+
+        attr_reader merchant_acceptor_id: String?
+
+        def merchant_acceptor_id=: (String) -> String
+
+        attr_reader merchant_category_code: String?
+
+        def merchant_category_code=: (String) -> String
+
+        attr_reader merchant_country: String?
+
+        def merchant_country=: (String) -> String
+
+        attr_reader merchant_name: String?
+
+        def merchant_name=: (String) -> String
+
+        attr_reader purchase_amount: Integer?
+
+        def purchase_amount=: (Integer) -> Integer
+
+        def initialize: (
+          card_id: String,
+          ?category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
+          ?device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
+          ?merchant_acceptor_id: String,
+          ?merchant_category_code: String,
+          ?merchant_country: String,
+          ?merchant_name: String,
+          ?purchase_amount: Integer,
+          ?request_options: Increase::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          card_id: String,
+          category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
+          device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
+          merchant_acceptor_id: String,
+          merchant_category_code: String,
+          merchant_country: String,
+          merchant_name: String,
+          purchase_amount: Integer,
+          request_options: Increase::RequestOptions
+        }
+
+        type category = :payment_authentication | :non_payment_authentication
+
+        module Category
+          extend Increase::Internal::Type::Enum
+
+          # The authentication attempt is for a payment.
+          PAYMENT_AUTHENTICATION: :payment_authentication
+
+          # The authentication attempt is not for a payment.
+          NON_PAYMENT_AUTHENTICATION: :non_payment_authentication
+
+          def self?.values: -> ::Array[Increase::Models::Simulations::CardAuthenticationCreateParams::category]
+        end
+
+        type device_channel = :app | :browser | :three_ds_requestor_initiated
+
+        module DeviceChannel
+          extend Increase::Internal::Type::Enum
+
+          # The authentication attempt was made from an app.
+          APP: :app
+
+          # The authentication attempt was made from a browser.
+          BROWSER: :browser
+
+          # The authentication attempt was initiated by the 3DS Requestor.
+          THREE_DS_REQUESTOR_INITIATED: :three_ds_requestor_initiated
+
+          def self?.values: -> ::Array[Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel]
+        end
+      end
+    end
+  end
+end

data/sig/increase/resources/simulations/card_authentications.rbs

@@ -0,0 +1,32 @@
+module Increase
+  module Resources
+    class Simulations
+      class CardAuthentications
+        def create: (
+          card_id: String,
+          ?category: Increase::Models::Simulations::CardAuthenticationCreateParams::category,
+          ?device_channel: Increase::Models::Simulations::CardAuthenticationCreateParams::device_channel,
+          ?merchant_acceptor_id: String,
+          ?merchant_category_code: String,
+          ?merchant_country: String,
+          ?merchant_name: String,
+          ?purchase_amount: Integer,
+          ?request_options: Increase::request_opts
+        ) -> Increase::CardPayment
+
+        def challenge_attempts: (
+          String card_payment_id,
+          one_time_code: String,
+          ?request_options: Increase::request_opts
+        ) -> Increase::CardPayment
+
+        def challenges: (
+          String card_payment_id,
+          ?request_options: Increase::request_opts
+        ) -> Increase::CardPayment
+
+        def initialize: (client: Increase::Client) -> void
+      end
+    end
+  end
+end

data/sig/increase/resources/simulations.rbs

@@ -21,6 +21,8 @@ module Increase
 
       attr_reader card_refunds: Increase::Resources::Simulations::CardRefunds
 
+      attr_reader card_authentications: Increase::Resources::Simulations::CardAuthentications
+
       attr_reader card_disputes: Increase::Resources::Simulations::CardDisputes
 
       attr_reader physical_cards: Increase::Resources::Simulations::PhysicalCards