increase 1.32.0 → 1.34.0

data/lib/increase/resources/card_push_transfers.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class CardPushTransfers
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardPushTransferCreateParams} for more details.
+      #
+      # Create a Card Push Transfer
+      #
+      # @overload create(amount:, business_application_identifier:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, require_approval: nil, request_options: {})
+      #
+      # @param amount [Integer] The transfer amount in USD cents. For Card Push transfers, must be positive.
+      #
+      # @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier] The Business Application Identifier describes the type of transaction being perf
+      #
+      # @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
+      #
+      # @param merchant_category_code [String] The merchant category code (MCC) of the merchant (generally your business) sendi
+      #
+      # @param merchant_city_name [String] The city name of the merchant (generally your business) sending the transfer.
+      #
+      # @param merchant_name [String] The merchant name shows up as the statement descriptor for the transfer. This is
+      #
+      # @param merchant_name_prefix [String] For certain Business Application Identifiers, the statement descriptor is `merch
+      #
+      # @param merchant_postal_code [String] The postal code of the merchant (generally your business) sending the transfer.
+      #
+      # @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
+      #
+      # @param recipient_name [String] The name of the funds recipient.
+      #
+      # @param sender_address_city [String] The city of the sender.
+      #
+      # @param sender_address_line1 [String] The address line 1 of the sender.
+      #
+      # @param sender_address_postal_code [String] The postal code of the sender.
+      #
+      # @param sender_address_state [String] The state of the sender.
+      #
+      # @param sender_name [String] The name of the funds originator.
+      #
+      # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer.
+      #
+      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardPushTransfer]
+      #
+      # @see Increase::Models::CardPushTransferCreateParams
+      def create(params)
+        parsed, options = Increase::CardPushTransferCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "card_push_transfers",
+          body: parsed,
+          model: Increase::CardPushTransfer,
+          options: options
+        )
+      end
+
+      # Retrieve a Card Push Transfer
+      #
+      # @overload retrieve(card_push_transfer_id, request_options: {})
+      #
+      # @param card_push_transfer_id [String] The identifier of the Card Push Transfer.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardPushTransfer]
+      #
+      # @see Increase::Models::CardPushTransferRetrieveParams
+      def retrieve(card_push_transfer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["card_push_transfers/%1$s", card_push_transfer_id],
+          model: Increase::CardPushTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardPushTransferListParams} for more details.
+      #
+      # List Card Push Transfers
+      #
+      # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Card Push Transfers to ones belonging to the specified Account.
+      #
+      # @param created_at [Increase::Models::CardPushTransferListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param status [Increase::Models::CardPushTransferListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::CardPushTransfer>]
+      #
+      # @see Increase::Models::CardPushTransferListParams
+      def list(params = {})
+        parsed, options = Increase::CardPushTransferListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "card_push_transfers",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::CardPushTransfer,
+          options: options
+        )
+      end
+
+      # Approves a Card Push Transfer in a pending_approval state.
+      #
+      # @overload approve(card_push_transfer_id, request_options: {})
+      #
+      # @param card_push_transfer_id [String] The identifier of the Card Push Transfer to approve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardPushTransfer]
+      #
+      # @see Increase::Models::CardPushTransferApproveParams
+      def approve(card_push_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["card_push_transfers/%1$s/approve", card_push_transfer_id],
+          model: Increase::CardPushTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Cancels a Card Push Transfer in a pending_approval state.
+      #
+      # @overload cancel(card_push_transfer_id, request_options: {})
+      #
+      # @param card_push_transfer_id [String] The identifier of the pending Card Push Transfer to cancel.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardPushTransfer]
+      #
+      # @see Increase::Models::CardPushTransferCancelParams
+      def cancel(card_push_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["card_push_transfers/%1$s/cancel", card_push_transfer_id],
+          model: Increase::CardPushTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/card_tokens.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class CardTokens
+      # Retrieve a Card Token
+      #
+      # @overload retrieve(card_token_id, request_options: {})
+      #
+      # @param card_token_id [String] The identifier of the Card Token.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardToken]
+      #
+      # @see Increase::Models::CardTokenRetrieveParams
+      def retrieve(card_token_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["card_tokens/%1$s", card_token_id],
+          model: Increase::CardToken,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardTokenListParams} for more details.
+      #
+      # List Card Tokens
+      #
+      # @overload list(created_at: nil, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param created_at [Increase::Models::CardTokenListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::CardToken>]
+      #
+      # @see Increase::Models::CardTokenListParams
+      def list(params = {})
+        parsed, options = Increase::CardTokenListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "card_tokens",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::CardToken,
+          options: 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.
+      #
+      # @overload capabilities(card_token_id, request_options: {})
+      #
+      # @param card_token_id [String] The identifier of the Card Token.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardTokenCapabilities]
+      #
+      # @see Increase::Models::CardTokenCapabilitiesParams
+      def capabilities(card_token_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["card_tokens/%1$s/capabilities", card_token_id],
+          model: Increase::CardTokenCapabilities,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/card_validations.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class CardValidations
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardValidationCreateParams} for more details.
+      #
+      # Create a Card Validation
+      #
+      # @overload create(account_id:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, cardholder_first_name: nil, cardholder_last_name: nil, cardholder_middle_name: nil, cardholder_postal_code: nil, cardholder_street_address: nil, request_options: {})
+      #
+      # @param account_id [String] The identifier of the Account from which to send the validation.
+      #
+      # @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
+      #
+      # @param merchant_category_code [String] A four-digit code (MCC) identifying the type of business or service provided by
+      #
+      # @param merchant_city_name [String] The city where the merchant (typically your business) is located.
+      #
+      # @param merchant_name [String] The merchant name that will appear in the cardholder’s statement descriptor. Typ
+      #
+      # @param merchant_postal_code [String] The postal code for the merchant’s (typically your business’s) location.
+      #
+      # @param merchant_state [String] The U.S. state where the merchant (typically your business) is located.
+      #
+      # @param cardholder_first_name [String] The cardholder's first name.
+      #
+      # @param cardholder_last_name [String] The cardholder's last name.
+      #
+      # @param cardholder_middle_name [String] The cardholder's middle name.
+      #
+      # @param cardholder_postal_code [String] The postal code of the cardholder's address.
+      #
+      # @param cardholder_street_address [String] The cardholder's street address.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardValidation]
+      #
+      # @see Increase::Models::CardValidationCreateParams
+      def create(params)
+        parsed, options = Increase::CardValidationCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "card_validations",
+          body: parsed,
+          model: Increase::CardValidation,
+          options: options
+        )
+      end
+
+      # Retrieve a Card Validation
+      #
+      # @overload retrieve(card_validation_id, request_options: {})
+      #
+      # @param card_validation_id [String] The identifier of the Card Validation.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardValidation]
+      #
+      # @see Increase::Models::CardValidationRetrieveParams
+      def retrieve(card_validation_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["card_validations/%1$s", card_validation_id],
+          model: Increase::CardValidation,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardValidationListParams} for more details.
+      #
+      # List Card Validations
+      #
+      # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Card Validations to ones belonging to the specified Account.
+      #
+      # @param created_at [Increase::Models::CardValidationListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param status [Increase::Models::CardValidationListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::CardValidation>]
+      #
+      # @see Increase::Models::CardValidationListParams
+      def list(params = {})
+        parsed, options = Increase::CardValidationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "card_validations",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::CardValidation,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CardTokens
+        # Simulates tokenizing a card in the sandbox environment.
+        #
+        # @overload create(capabilities: nil, expiration: nil, last4: nil, prefix: nil, primary_account_number_length: nil, request_options: {})
+        #
+        # @param capabilities [Array<Increase::Models::Simulations::CardTokenCreateParams::Capability>] The capabilities of the outbound card token.
+        #
+        # @param expiration [Date] The expiration date of the card.
+        #
+        # @param last4 [String] The last 4 digits of the card number.
+        #
+        # @param prefix [String] The prefix of the card number, usually the first 8 digits.
+        #
+        # @param primary_account_number_length [Integer] The total length of the card number, including prefix and last4.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CardToken]
+        #
+        # @see Increase::Models::Simulations::CardTokenCreateParams
+        def create(params = {})
+          parsed, options = Increase::Simulations::CardTokenCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/card_tokens",
+            body: parsed,
+            model: Increase::CardToken,
+            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

@@ -87,6 +87,9 @@ module Increase
       # @return [Increase::Resources::Simulations::Documents]
       attr_reader :documents
 
+      # @return [Increase::Resources::Simulations::CardTokens]
+      attr_reader :card_tokens
+
       # @api private
       #
       # @param client [Increase::Client]
@@ -125,6 +128,7 @@ module Increase
         @programs = Increase::Resources::Simulations::Programs.new(client: client)
         @account_statements = Increase::Resources::Simulations::AccountStatements.new(client: client)
         @documents = Increase::Resources::Simulations::Documents.new(client: client)
+        @card_tokens = Increase::Resources::Simulations::CardTokens.new(client: client)
       end
     end
   end

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -111,8 +111,23 @@ require_relative "increase/models/card_payment_retrieve_params"
 require_relative "increase/models/card_purchase_supplement"
 require_relative "increase/models/card_purchase_supplement_list_params"
 require_relative "increase/models/card_purchase_supplement_retrieve_params"
+require_relative "increase/models/card_push_transfer"
+require_relative "increase/models/card_push_transfer_approve_params"
+require_relative "increase/models/card_push_transfer_cancel_params"
+require_relative "increase/models/card_push_transfer_create_params"
+require_relative "increase/models/card_push_transfer_list_params"
+require_relative "increase/models/card_push_transfer_retrieve_params"
 require_relative "increase/models/card_retrieve_params"
+require_relative "increase/models/card_token"
+require_relative "increase/models/card_token_capabilities"
+require_relative "increase/models/card_token_capabilities_params"
+require_relative "increase/models/card_token_list_params"
+require_relative "increase/models/card_token_retrieve_params"
 require_relative "increase/models/card_update_params"
+require_relative "increase/models/card_validation"
+require_relative "increase/models/card_validation_create_params"
+require_relative "increase/models/card_validation_list_params"
+require_relative "increase/models/card_validation_retrieve_params"
 require_relative "increase/models/check_deposit"
 require_relative "increase/models/check_deposit_create_params"
 require_relative "increase/models/check_deposit_list_params"
@@ -272,6 +287,7 @@ require_relative "increase/models/simulations/card_increment_create_params"
 require_relative "increase/models/simulations/card_refund_create_params"
 require_relative "increase/models/simulations/card_reversal_create_params"
 require_relative "increase/models/simulations/card_settlement_create_params"
+require_relative "increase/models/simulations/card_token_create_params"
 require_relative "increase/models/simulations/check_deposit_reject_params"
 require_relative "increase/models/simulations/check_deposit_return_params"
 require_relative "increase/models/simulations/check_deposit_submit_params"
@@ -323,7 +339,10 @@ require_relative "increase/resources/bookkeeping_entry_sets"
 require_relative "increase/resources/card_disputes"
 require_relative "increase/resources/card_payments"
 require_relative "increase/resources/card_purchase_supplements"
+require_relative "increase/resources/card_push_transfers"
 require_relative "increase/resources/cards"
+require_relative "increase/resources/card_tokens"
+require_relative "increase/resources/card_validations"
 require_relative "increase/resources/check_deposits"
 require_relative "increase/resources/check_transfers"
 require_relative "increase/resources/declined_transactions"
@@ -370,6 +389,7 @@ require_relative "increase/resources/simulations/card_increments"
 require_relative "increase/resources/simulations/card_refunds"
 require_relative "increase/resources/simulations/card_reversals"
 require_relative "increase/resources/simulations/card_settlements"
+require_relative "increase/resources/simulations/card_tokens"
 require_relative "increase/resources/simulations/check_deposits"
 require_relative "increase/resources/simulations/check_transfers"
 require_relative "increase/resources/simulations/digital_wallet_token_requests"

data/rbi/increase/client.rbi

@@ -175,6 +175,15 @@ module Increase
     sig { returns(Increase::Resources::IntrafiExclusions) }
     attr_reader :intrafi_exclusions
 
+    sig { returns(Increase::Resources::CardTokens) }
+    attr_reader :card_tokens
+
+    sig { returns(Increase::Resources::CardPushTransfers) }
+    attr_reader :card_push_transfers
+
+    sig { returns(Increase::Resources::CardValidations) }
+    attr_reader :card_validations
+
     sig { returns(Increase::Resources::Simulations) }
     attr_reader :simulations