increase 1.158.0 → 1.159.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92fc559824b2bb8ae1c96093ae2e60d30d1d88f3a79997da678d66b31385d8b9
-  data.tar.gz: c25131750605e99718853e0c5688279beb278dfc1c42562802c12d42d0ee0bb3
+  metadata.gz: 2f3668625018cbbb0373043182c37ccfff475210b476453b2d362f13b4b5e165
+  data.tar.gz: f8809d73edc8a0543093fc8c4777edfeb1be707769c7b5297d74d741a49da86f
 SHA512:
-  metadata.gz: 39ef03ee114710fa3948f5049f4556a3537e8e19ebc1037a4d07ef2a95032bf8047e7d6a7002e797a4975aaea2765892f5cbefbaeddad865c5f626d7d49b82c8
-  data.tar.gz: a9809555c46b76e506cd3c4105eb316dd6b8f9e36219b5d7a853559d0f1504e8f999dd045fbc4096767f1ba5a4aabc45ed3cca9cfe0052ae28282244b84764c3
+  metadata.gz: ec99831b2ee0c08b397e09e9b85e39fdcfcdb970d7a7c13178de0db7fc23b9d1d50fc3be6ed324e676c152a48ccc39d8dbe50e634fb60431e7f44b46502820a9
+  data.tar.gz: 2bb769eefa10f18b5845f59097179fc45eda76b62fce4b7d8a30ed982c156679a422dbe630786c7dc003996994b3aac62b7b336ac70b793061aab664db8cc107

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.159.0 (2025-12-09)
+
+Full Changelog: [v1.158.0...v1.159.0](https://github.com/Increase/increase-ruby/compare/v1.158.0...v1.159.0)
+
+### Features
+
+* **api:** api update ([d0dd7a8](https://github.com/Increase/increase-ruby/commit/d0dd7a857cdca3db358aef4c46530944d606851f))
+
 ## 1.158.0 (2025-12-08)
 
 Full Changelog: [v1.157.0...v1.158.0](https://github.com/Increase/increase-ruby/compare/v1.157.0...v1.158.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.158.0"
+gem "increase", "~> 1.159.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::CardBalanceInquiries#create
+      class CardBalanceInquiryCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute balance
+        #   The balance amount in cents. The account balance will be used if not provided.
+        #
+        #   @return [Integer, nil]
+        optional :balance, Integer
+
+        # @!attribute card_id
+        #   The identifier of the Card to be authorized.
+        #
+        #   @return [String, nil]
+        optional :card_id, String
+
+        # @!attribute decline_reason
+        #   Forces a card decline with a specific reason. No real time decision will be
+        #   sent.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::DeclineReason, nil]
+        optional :decline_reason,
+                 enum: -> { Increase::Simulations::CardBalanceInquiryCreateParams::DeclineReason }
+
+        # @!attribute digital_wallet_token_id
+        #   The identifier of the Digital Wallet Token to be authorized.
+        #
+        #   @return [String, nil]
+        optional :digital_wallet_token_id, String
+
+        # @!attribute event_subscription_id
+        #   The identifier of the Event Subscription to use. If provided, will override the
+        #   default real time event subscription. Because you can only create one real time
+        #   decision event subscription, you can use this field to route events to any
+        #   specified event subscription for testing purposes.
+        #
+        #   @return [String, nil]
+        optional :event_subscription_id, String
+
+        # @!attribute merchant_acceptor_id
+        #   The merchant identifier (commonly abbreviated as MID) of the merchant the card
+        #   is transacting with.
+        #
+        #   @return [String, nil]
+        optional :merchant_acceptor_id, String
+
+        # @!attribute merchant_category_code
+        #   The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+        #   card is transacting with.
+        #
+        #   @return [String, nil]
+        optional :merchant_category_code, String
+
+        # @!attribute merchant_city
+        #   The city the merchant resides in.
+        #
+        #   @return [String, nil]
+        optional :merchant_city, String
+
+        # @!attribute merchant_country
+        #   The country the merchant resides in.
+        #
+        #   @return [String, nil]
+        optional :merchant_country, String
+
+        # @!attribute merchant_descriptor
+        #   The merchant descriptor of the merchant the card is transacting with.
+        #
+        #   @return [String, nil]
+        optional :merchant_descriptor, String
+
+        # @!attribute merchant_state
+        #   The state the merchant resides in.
+        #
+        #   @return [String, nil]
+        optional :merchant_state, String
+
+        # @!attribute network_details
+        #   Fields specific to a given card network.
+        #
+        #   @return [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails, nil]
+        optional :network_details, -> { Increase::Simulations::CardBalanceInquiryCreateParams::NetworkDetails }
+
+        # @!attribute network_risk_score
+        #   The risk score generated by the card network. For Visa this is the Visa Advanced
+        #   Authorization risk score, from 0 to 99, where 99 is the riskiest.
+        #
+        #   @return [Integer, nil]
+        optional :network_risk_score, Integer
+
+        # @!attribute physical_card_id
+        #   The identifier of the Physical Card to be authorized.
+        #
+        #   @return [String, nil]
+        optional :physical_card_id, String
+
+        # @!attribute terminal_id
+        #   The terminal identifier (commonly abbreviated as TID) of the terminal the card
+        #   is transacting with.
+        #
+        #   @return [String, nil]
+        optional :terminal_id, String
+
+        # @!method initialize(balance: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::CardBalanceInquiryCreateParams} for more
+        #   details.
+        #
+        #   @param balance [Integer] The balance amount in cents. The account balance will be used if not provided.
+        #
+        #   @param card_id [String] The identifier of the Card to be authorized.
+        #
+        #   @param decline_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::DeclineReason] Forces a card decline with a specific reason. No real time decision will be sent
+        #
+        #   @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized.
+        #
+        #   @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the
+        #
+        #   @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
+        #
+        #   @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
+        #
+        #   @param merchant_city [String] The city the merchant resides in.
+        #
+        #   @param merchant_country [String] The country the merchant resides in.
+        #
+        #   @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
+        #
+        #   @param merchant_state [String] The state the merchant resides in.
+        #
+        #   @param network_details [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails] Fields specific to a given card network.
+        #
+        #   @param network_risk_score [Integer] The risk score generated by the card network. For Visa this is the Visa Advanced
+        #
+        #   @param physical_card_id [String] The identifier of the Physical Card to be authorized.
+        #
+        #   @param terminal_id [String] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        # Forces a card decline with a specific reason. No real time decision will be
+        # sent.
+        module DeclineReason
+          extend Increase::Internal::Type::Enum
+
+          # The account has been closed.
+          ACCOUNT_CLOSED = :account_closed
+
+          # The Card was not active.
+          CARD_NOT_ACTIVE = :card_not_active
+
+          # The Card has been canceled.
+          CARD_CANCELED = :card_canceled
+
+          # The Physical Card was not active.
+          PHYSICAL_CARD_NOT_ACTIVE = :physical_card_not_active
+
+          # The account's entity was not active.
+          ENTITY_NOT_ACTIVE = :entity_not_active
+
+          # The account was inactive.
+          GROUP_LOCKED = :group_locked
+
+          # The Card's Account did not have a sufficient available balance.
+          INSUFFICIENT_FUNDS = :insufficient_funds
+
+          # The given CVV2 did not match the card's value.
+          CVV2_MISMATCH = :cvv2_mismatch
+
+          # The given PIN did not match the card's value.
+          PIN_MISMATCH = :pin_mismatch
+
+          # The given expiration date did not match the card's value. Only applies when a CVV2 is present.
+          CARD_EXPIRATION_MISMATCH = :card_expiration_mismatch
+
+          # The attempted card transaction is not allowed per Increase's terms.
+          TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
+
+          # The transaction was blocked by a Limit.
+          BREACHES_LIMIT = :breaches_limit
+
+          # Your application declined the transaction via webhook.
+          WEBHOOK_DECLINED = :webhook_declined
+
+          # Your application webhook did not respond without the required timeout.
+          WEBHOOK_TIMED_OUT = :webhook_timed_out
+
+          # Declined by stand-in processing.
+          DECLINED_BY_STAND_IN_PROCESSING = :declined_by_stand_in_processing
+
+          # The card read had an invalid CVV, dCVV, or authorization request cryptogram.
+          INVALID_PHYSICAL_CARD = :invalid_physical_card
+
+          # The original card authorization for this incremental authorization does not exist.
+          MISSING_ORIGINAL_AUTHORIZATION = :missing_original_authorization
+
+          # The transaction was declined because the 3DS authentication failed.
+          FAILED_3DS_AUTHENTICATION = :failed_3ds_authentication
+
+          # The transaction was suspected to be used by a card tester to test for valid card numbers.
+          SUSPECTED_CARD_TESTING = :suspected_card_testing
+
+          # The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information.
+          SUSPECTED_FRAUD = :suspected_fraud
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class NetworkDetails < Increase::Internal::Type::BaseModel
+          # @!attribute visa
+          #   Fields specific to the Visa network.
+          #
+          #   @return [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa]
+          required :visa, -> { Increase::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa }
+
+          # @!method initialize(visa:)
+          #   Fields specific to a given card network.
+          #
+          #   @param visa [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa] Fields specific to the Visa network.
+
+          # @see Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails#visa
+          class Visa < Increase::Internal::Type::BaseModel
+            # @!attribute stand_in_processing_reason
+            #   The reason code for the stand-in processing.
+            #
+            #   @return [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa::StandInProcessingReason, nil]
+            optional :stand_in_processing_reason,
+                     enum: -> { Increase::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa::StandInProcessingReason }
+
+            # @!method initialize(stand_in_processing_reason: nil)
+            #   Fields specific to the Visa network.
+            #
+            #   @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa::StandInProcessingReason] The reason code for the stand-in processing.
+
+            # The reason code for the stand-in processing.
+            #
+            # @see Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa#stand_in_processing_reason
+            module StandInProcessingReason
+              extend Increase::Internal::Type::Enum
+
+              # Increase failed to process the authorization in a timely manner.
+              ISSUER_ERROR = :issuer_error
+
+              # The physical card read had an invalid CVV, dCVV, or authorization request cryptogram.
+              INVALID_PHYSICAL_CARD = :invalid_physical_card
+
+              # The 3DS cardholder authentication verification value was invalid.
+              INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
+                :invalid_cardholder_authentication_verification_value
+
+              # An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays.
+              INTERNAL_VISA_ERROR = :internal_visa_error
+
+              # The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier.
+              MERCHANT_TRANSACTION_ADVISORY_SERVICE_AUTHENTICATION_REQUIRED =
+                :merchant_transaction_advisory_service_authentication_required
+
+              # The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing.
+              PAYMENT_FRAUD_DISRUPTION_ACQUIRER_BLOCK = :payment_fraud_disruption_acquirer_block
+
+              # An unspecific reason for stand-in processing.
+              OTHER = :other
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/card_balance_inquiries.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CardBalanceInquiries
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CardBalanceInquiryCreateParams} for more
+        # details.
+        #
+        # Simulates a balance inquiry on a [Card](#cards).
+        #
+        # @overload create(balance: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {})
+        #
+        # @param balance [Integer] The balance amount in cents. The account balance will be used if not provided.
+        #
+        # @param card_id [String] The identifier of the Card to be authorized.
+        #
+        # @param decline_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::DeclineReason] Forces a card decline with a specific reason. No real time decision will be sent
+        #
+        # @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized.
+        #
+        # @param event_subscription_id [String] The identifier of the Event Subscription to use. If provided, will override the
+        #
+        # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
+        #
+        # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
+        #
+        # @param merchant_city [String] The city the merchant resides in.
+        #
+        # @param merchant_country [String] The country the merchant resides in.
+        #
+        # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
+        #
+        # @param merchant_state [String] The state the merchant resides in.
+        #
+        # @param network_details [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails] Fields specific to a given card network.
+        #
+        # @param network_risk_score [Integer] The risk score generated by the card network. For Visa this is the Visa Advanced
+        #
+        # @param physical_card_id [String] The identifier of the Physical Card to be authorized.
+        #
+        # @param terminal_id [String] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CardPayment]
+        #
+        # @see Increase::Models::Simulations::CardBalanceInquiryCreateParams
+        def create(params = {})
+          parsed, options = Increase::Simulations::CardBalanceInquiryCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/card_balance_inquiries",
+            body: parsed,
+            model: Increase::CardPayment,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations.rb

@@ -12,6 +12,9 @@ module Increase
       # @return [Increase::Resources::Simulations::CardAuthorizations]
       attr_reader :card_authorizations
 
+      # @return [Increase::Resources::Simulations::CardBalanceInquiries]
+      attr_reader :card_balance_inquiries
+
       # @return [Increase::Resources::Simulations::CardAuthorizationExpirations]
       attr_reader :card_authorization_expirations
 
@@ -101,6 +104,7 @@ module Increase
         @interest_payments = Increase::Resources::Simulations::InterestPayments.new(client: client)
         @account_transfers = Increase::Resources::Simulations::AccountTransfers.new(client: client)
         @card_authorizations = Increase::Resources::Simulations::CardAuthorizations.new(client: client)
+        @card_balance_inquiries = Increase::Resources::Simulations::CardBalanceInquiries.new(client: client)
         @card_authorization_expirations =
           Increase::Resources::Simulations::CardAuthorizationExpirations.new(client: client)
         @card_settlements = Increase::Resources::Simulations::CardSettlements.new(client: client)

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.158.0"
+  VERSION = "1.159.0"
 end

data/lib/increase.rb

@@ -299,6 +299,7 @@ require_relative "increase/models/simulations/ach_transfer_submit_params"
 require_relative "increase/models/simulations/card_authorization_create_params"
 require_relative "increase/models/simulations/card_authorization_create_response"
 require_relative "increase/models/simulations/card_authorization_expiration_create_params"
+require_relative "increase/models/simulations/card_balance_inquiry_create_params"
 require_relative "increase/models/simulations/card_dispute_action_params"
 require_relative "increase/models/simulations/card_fuel_confirmation_create_params"
 require_relative "increase/models/simulations/card_increment_create_params"
@@ -404,6 +405,7 @@ require_relative "increase/resources/simulations/account_transfers"
 require_relative "increase/resources/simulations/ach_transfers"
 require_relative "increase/resources/simulations/card_authorization_expirations"
 require_relative "increase/resources/simulations/card_authorizations"
+require_relative "increase/resources/simulations/card_balance_inquiries"
 require_relative "increase/resources/simulations/card_disputes"
 require_relative "increase/resources/simulations/card_fuel_confirmations"
 require_relative "increase/resources/simulations/card_increments"