increase 1.33.0 → 1.35.0

data/rbi/increase/models/simulations/card_token_create_params.rbi

@@ -0,0 +1,297 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class CardTokenCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::CardTokenCreateParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The capabilities of the outbound card token.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Increase::Simulations::CardTokenCreateParams::Capability]
+            )
+          )
+        end
+        attr_reader :capabilities
+
+        sig do
+          params(
+            capabilities:
+              T::Array[
+                Increase::Simulations::CardTokenCreateParams::Capability::OrHash
+              ]
+          ).void
+        end
+        attr_writer :capabilities
+
+        # The expiration date of the card.
+        sig { returns(T.nilable(Date)) }
+        attr_reader :expiration
+
+        sig { params(expiration: Date).void }
+        attr_writer :expiration
+
+        # The last 4 digits of the card number.
+        sig { returns(T.nilable(String)) }
+        attr_reader :last4
+
+        sig { params(last4: String).void }
+        attr_writer :last4
+
+        # The prefix of the card number, usually the first 8 digits.
+        sig { returns(T.nilable(String)) }
+        attr_reader :prefix
+
+        sig { params(prefix: String).void }
+        attr_writer :prefix
+
+        # The total length of the card number, including prefix and last4.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :primary_account_number_length
+
+        sig { params(primary_account_number_length: Integer).void }
+        attr_writer :primary_account_number_length
+
+        sig do
+          params(
+            capabilities:
+              T::Array[
+                Increase::Simulations::CardTokenCreateParams::Capability::OrHash
+              ],
+            expiration: Date,
+            last4: String,
+            prefix: String,
+            primary_account_number_length: Integer,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The capabilities of the outbound card token.
+          capabilities: nil,
+          # The expiration date of the card.
+          expiration: nil,
+          # The last 4 digits of the card number.
+          last4: nil,
+          # The prefix of the card number, usually the first 8 digits.
+          prefix: nil,
+          # The total length of the card number, including prefix and last4.
+          primary_account_number_length: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              capabilities:
+                T::Array[
+                  Increase::Simulations::CardTokenCreateParams::Capability
+                ],
+              expiration: Date,
+              last4: String,
+              prefix: String,
+              primary_account_number_length: Integer,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Capability < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::Simulations::CardTokenCreateParams::Capability,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The cross-border push transfers capability.
+          sig do
+            returns(
+              Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers::OrSymbol
+            )
+          end
+          attr_accessor :cross_border_push_transfers
+
+          # The domestic push transfers capability.
+          sig do
+            returns(
+              Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers::OrSymbol
+            )
+          end
+          attr_accessor :domestic_push_transfers
+
+          # The route of the capability.
+          sig do
+            returns(
+              Increase::Simulations::CardTokenCreateParams::Capability::Route::OrSymbol
+            )
+          end
+          attr_accessor :route
+
+          sig do
+            params(
+              cross_border_push_transfers:
+                Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers::OrSymbol,
+              domestic_push_transfers:
+                Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers::OrSymbol,
+              route:
+                Increase::Simulations::CardTokenCreateParams::Capability::Route::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The cross-border push transfers capability.
+            cross_border_push_transfers:,
+            # The domestic push transfers capability.
+            domestic_push_transfers:,
+            # The route of the capability.
+            route:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                cross_border_push_transfers:
+                  Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers::OrSymbol,
+                domestic_push_transfers:
+                  Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers::OrSymbol,
+                route:
+                  Increase::Simulations::CardTokenCreateParams::Capability::Route::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The cross-border push transfers capability.
+          module CrossBorderPushTransfers
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # The capability is supported.
+            SUPPORTED =
+              T.let(
+                :supported,
+                Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers::TaggedSymbol
+              )
+
+            # The capability is not supported.
+            NOT_SUPPORTED =
+              T.let(
+                :not_supported,
+                Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The domestic push transfers capability.
+          module DomesticPushTransfers
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # The capability is supported.
+            SUPPORTED =
+              T.let(
+                :supported,
+                Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers::TaggedSymbol
+              )
+
+            # The capability is not supported.
+            NOT_SUPPORTED =
+              T.let(
+                :not_supported,
+                Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The route of the capability.
+          module Route
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::Simulations::CardTokenCreateParams::Capability::Route
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # Visa and Interlink
+            VISA =
+              T.let(
+                :visa,
+                Increase::Simulations::CardTokenCreateParams::Capability::Route::TaggedSymbol
+              )
+
+            # Mastercard and Maestro
+            MASTERCARD =
+              T.let(
+                :mastercard,
+                Increase::Simulations::CardTokenCreateParams::Capability::Route::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::Simulations::CardTokenCreateParams::Capability::Route::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models.rbi

@@ -134,10 +134,42 @@ module Increase
   CardPurchaseSupplementRetrieveParams =
     Increase::Models::CardPurchaseSupplementRetrieveParams
 
+  CardPushTransfer = Increase::Models::CardPushTransfer
+
+  CardPushTransferApproveParams =
+    Increase::Models::CardPushTransferApproveParams
+
+  CardPushTransferCancelParams = Increase::Models::CardPushTransferCancelParams
+
+  CardPushTransferCreateParams = Increase::Models::CardPushTransferCreateParams
+
+  CardPushTransferListParams = Increase::Models::CardPushTransferListParams
+
+  CardPushTransferRetrieveParams =
+    Increase::Models::CardPushTransferRetrieveParams
+
   CardRetrieveParams = Increase::Models::CardRetrieveParams
 
+  CardToken = Increase::Models::CardToken
+
+  CardTokenCapabilities = Increase::Models::CardTokenCapabilities
+
+  CardTokenCapabilitiesParams = Increase::Models::CardTokenCapabilitiesParams
+
+  CardTokenListParams = Increase::Models::CardTokenListParams
+
+  CardTokenRetrieveParams = Increase::Models::CardTokenRetrieveParams
+
   CardUpdateParams = Increase::Models::CardUpdateParams
 
+  CardValidation = Increase::Models::CardValidation
+
+  CardValidationCreateParams = Increase::Models::CardValidationCreateParams
+
+  CardValidationListParams = Increase::Models::CardValidationListParams
+
+  CardValidationRetrieveParams = Increase::Models::CardValidationRetrieveParams
+
   CheckDeposit = Increase::Models::CheckDeposit
 
   CheckDepositCreateParams = Increase::Models::CheckDepositCreateParams

data/rbi/increase/resources/card_push_transfers.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class CardPushTransfers
+      # Create a Card Push Transfer
+      sig do
+        params(
+          amount: Integer,
+          business_application_identifier:
+            Increase::CardPushTransferCreateParams::BusinessApplicationIdentifier::OrSymbol,
+          card_token_id: String,
+          merchant_category_code: String,
+          merchant_city_name: String,
+          merchant_name: String,
+          merchant_name_prefix: String,
+          merchant_postal_code: String,
+          merchant_state: String,
+          recipient_name: String,
+          sender_address_city: String,
+          sender_address_line1: String,
+          sender_address_postal_code: String,
+          sender_address_state: String,
+          sender_name: String,
+          source_account_number_id: String,
+          require_approval: T::Boolean,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardPushTransfer)
+      end
+      def create(
+        # The transfer amount in USD cents. For Card Push transfers, must be positive.
+        amount:,
+        # The Business Application Identifier describes the type of transaction being
+        # performed. Your program must be approved for the specified Business Application
+        # Identifier in order to use it.
+        business_application_identifier:,
+        # The Increase identifier for the Card Token that represents the card number
+        # you're pushing funds to.
+        card_token_id:,
+        # The merchant category code (MCC) of the merchant (generally your business)
+        # sending the transfer. This is a four-digit code that describes the type of
+        # business or service provided by the merchant. Your program must be approved for
+        # the specified MCC in order to use it.
+        merchant_category_code:,
+        # The city name of the merchant (generally your business) sending the transfer.
+        merchant_city_name:,
+        # The merchant name shows up as the statement descriptor for the transfer. This is
+        # typically the name of your business or organization.
+        merchant_name:,
+        # For certain Business Application Identifiers, the statement descriptor is
+        # `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to
+        # four character prefix that identifies the merchant.
+        merchant_name_prefix:,
+        # The postal code of the merchant (generally your business) sending the transfer.
+        merchant_postal_code:,
+        # The state of the merchant (generally your business) sending the transfer.
+        merchant_state:,
+        # The name of the funds recipient.
+        recipient_name:,
+        # The city of the sender.
+        sender_address_city:,
+        # The address line 1 of the sender.
+        sender_address_line1:,
+        # The postal code of the sender.
+        sender_address_postal_code:,
+        # The state of the sender.
+        sender_address_state:,
+        # The name of the funds originator.
+        sender_name:,
+        # The identifier of the Account Number from which to send the transfer.
+        source_account_number_id:,
+        # Whether the transfer requires explicit approval via the dashboard or API.
+        require_approval: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Card Push Transfer
+      sig do
+        params(
+          card_push_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardPushTransfer)
+      end
+      def retrieve(
+        # The identifier of the Card Push Transfer.
+        card_push_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # List Card Push Transfers
+      sig do
+        params(
+          account_id: String,
+          created_at: Increase::CardPushTransferListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::CardPushTransferListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::CardPushTransfer])
+      end
+      def list(
+        # Filter Card Push Transfers to ones belonging to the specified Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # 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: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Approves a Card Push Transfer in a pending_approval state.
+      sig do
+        params(
+          card_push_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardPushTransfer)
+      end
+      def approve(
+        # The identifier of the Card Push Transfer to approve.
+        card_push_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # Cancels a Card Push Transfer in a pending_approval state.
+      sig do
+        params(
+          card_push_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardPushTransfer)
+      end
+      def cancel(
+        # The identifier of the pending Card Push Transfer to cancel.
+        card_push_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/card_tokens.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class CardTokens
+      # Retrieve a Card Token
+      sig do
+        params(
+          card_token_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardToken)
+      end
+      def retrieve(
+        # The identifier of the Card Token.
+        card_token_id,
+        request_options: {}
+      )
+      end
+
+      # List Card Tokens
+      sig do
+        params(
+          created_at: Increase::CardTokenListParams::CreatedAt::OrHash,
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::CardToken])
+      end
+      def list(
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # The capabilities of a Card Token describe whether the card can be used for
+      # specific operations, such as Card Push Transfers. The capabilities can change
+      # over time based on the issuing bank's configuration of the card range.
+      sig do
+        params(
+          card_token_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardTokenCapabilities)
+      end
+      def capabilities(
+        # The identifier of the Card Token.
+        card_token_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/card_validations.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class CardValidations
+      # Create a Card Validation
+      sig do
+        params(
+          account_id: String,
+          card_token_id: String,
+          merchant_category_code: String,
+          merchant_city_name: String,
+          merchant_name: String,
+          merchant_postal_code: String,
+          merchant_state: String,
+          cardholder_first_name: String,
+          cardholder_last_name: String,
+          cardholder_middle_name: String,
+          cardholder_postal_code: String,
+          cardholder_street_address: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardValidation)
+      end
+      def create(
+        # The identifier of the Account from which to send the validation.
+        account_id:,
+        # The Increase identifier for the Card Token that represents the card number
+        # you're validating.
+        card_token_id:,
+        # A four-digit code (MCC) identifying the type of business or service provided by
+        # the merchant.
+        merchant_category_code:,
+        # The city where the merchant (typically your business) is located.
+        merchant_city_name:,
+        # The merchant name that will appear in the cardholder’s statement descriptor.
+        # Typically your business name.
+        merchant_name:,
+        # The postal code for the merchant’s (typically your business’s) location.
+        merchant_postal_code:,
+        # The U.S. state where the merchant (typically your business) is located.
+        merchant_state:,
+        # The cardholder's first name.
+        cardholder_first_name: nil,
+        # The cardholder's last name.
+        cardholder_last_name: nil,
+        # The cardholder's middle name.
+        cardholder_middle_name: nil,
+        # The postal code of the cardholder's address.
+        cardholder_postal_code: nil,
+        # The cardholder's street address.
+        cardholder_street_address: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Card Validation
+      sig do
+        params(
+          card_validation_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardValidation)
+      end
+      def retrieve(
+        # The identifier of the Card Validation.
+        card_validation_id,
+        request_options: {}
+      )
+      end
+
+      # List Card Validations
+      sig do
+        params(
+          account_id: String,
+          created_at: Increase::CardValidationListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::CardValidationListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::CardValidation])
+      end
+      def list(
+        # Filter Card Validations to ones belonging to the specified Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # 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: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/card_tokens.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardTokens
+        # Simulates tokenizing a card in the sandbox environment.
+        sig do
+          params(
+            capabilities:
+              T::Array[
+                Increase::Simulations::CardTokenCreateParams::Capability::OrHash
+              ],
+            expiration: Date,
+            last4: String,
+            prefix: String,
+            primary_account_number_length: Integer,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardToken)
+        end
+        def create(
+          # The capabilities of the outbound card token.
+          capabilities: nil,
+          # The expiration date of the card.
+          expiration: nil,
+          # The last 4 digits of the card number.
+          last4: nil,
+          # The prefix of the card number, usually the first 8 digits.
+          prefix: nil,
+          # The total length of the card number, including prefix and last4.
+          primary_account_number_length: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end