increase 1.354.0 → 1.355.0

data/rbi/increase/resources/physical_check_batches.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class PhysicalCheckBatches
+      # Create a Physical Check Batch
+      sig do
+        params(
+          mailing_address:
+            Increase::PhysicalCheckBatchCreateParams::MailingAddress::OrHash,
+          return_address:
+            Increase::PhysicalCheckBatchCreateParams::ReturnAddress::OrHash,
+          shipping_method:
+            Increase::PhysicalCheckBatchCreateParams::ShippingMethod::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCheckBatch)
+      end
+      def create(
+        # Details for where the parcel will be mailed.
+        mailing_address:,
+        # Details for where the parcel should return if it is unable to be delivered.
+        return_address:,
+        # How to ship the batch.
+        #
+        # Defaults to `usps_first_class`.
+        shipping_method: nil,
+        request_options: {}
+      )
+      end
+
+      # Cancel a pending Physical Check Batch, which cancels all of its related checks.
+      sig do
+        params(
+          physical_check_batch_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCheckBatch)
+      end
+      def cancel(
+        # The identifier of the pending Physical Check Batch to cancel.
+        physical_check_batch_id,
+        request_options: {}
+      )
+      end
+
+      # Completing a Physical Check Batch closes it to new Physical Checks and begins
+      # the process of printing and mailing it.
+      sig do
+        params(
+          physical_check_batch_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCheckBatch)
+      end
+      def complete(
+        # The identifier of the Physical Check Batch to complete.
+        physical_check_batch_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/real_time_payments_requests_for_payment.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class RealTimePaymentsRequestsForPayment
+      # Create a Real-Time Payments Request for Payment
+      sig do
+        params(
+          account_number_id: String,
+          amount: Integer,
+          debtor:
+            Increase::RealTimePaymentsRequestsForPaymentCreateParams::Debtor::OrHash,
+          debtor_account_number: String,
+          debtor_routing_number: String,
+          expires_at: Time,
+          requested_execution_at: Time,
+          unstructured_remittance_information: String,
+          creditor_name: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsRequestForPayment)
+      end
+      def create(
+        # The identifier of the Account Number where the funds will land.
+        account_number_id:,
+        # The requested amount in USD cents. Must be positive.
+        amount:,
+        # Details of the person being requested to pay.
+        debtor:,
+        # The debtor's account number, which the funds will be requested from.
+        debtor_account_number:,
+        # The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
+        debtor_routing_number:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
+        # the request for payment is no longer valid. After this time the debtor's bank
+        # should no longer allow the debtor to pay it. Must not be before
+        # `requested_execution_at`.
+        expires_at:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
+        # you are requesting the payment to be made.
+        requested_execution_at:,
+        # Unstructured information that will show on the recipient's bank statement.
+        unstructured_remittance_information:,
+        # The name of the creditor requesting the payment. If not provided, defaults to
+        # the name of the account's entity.
+        creditor_name: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Real-Time Payments Request for Payment
+      sig do
+        params(
+          real_time_payments_request_for_payment_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsRequestForPayment)
+      end
+      def retrieve(
+        # The identifier of the Real-Time Payments Request for Payment.
+        real_time_payments_request_for_payment_id,
+        request_options: {}
+      )
+      end
+
+      # List Real-Time Payments Requests for Payment
+      sig do
+        params(
+          account_id: String,
+          created_at:
+            Increase::RealTimePaymentsRequestsForPaymentListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(
+          Increase::Internal::Page[Increase::RealTimePaymentsRequestForPayment]
+        )
+      end
+      def list(
+        # Filter Real-Time Payments Requests for Payment to those destined 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.
+        #
+        # Defaults to `100`.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Cancels a Real-Time Payments Request for Payment that is still awaiting payment.
+      sig do
+        params(
+          real_time_payments_request_for_payment_id: String,
+          additional_information: String,
+          reason:
+            Increase::RealTimePaymentsRequestsForPaymentCancelParams::Reason::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsRequestForPayment)
+      end
+      def cancel(
+        # The identifier of the Real-Time Payments Request for Payment to cancel.
+        real_time_payments_request_for_payment_id,
+        # Additional information about the cancellation to pass on to the recipient bank.
+        additional_information: nil,
+        # The reason the request for payment is being canceled. Defaults to
+        # `requested_by_customer`.
+        reason: 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/fednow_transfers.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class FednowTransfers
+        # Simulates submission of a [FedNow Transfer](#fednow-transfers) and handling the
+        # response from the destination financial institution. This transfer must first
+        # have a `status` of `pending_submitting`.
+        sig do
+          params(
+            fednow_transfer_id: String,
+            rejection:
+              Increase::Simulations::FednowTransferCompleteParams::Rejection::OrHash,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::FednowTransfer)
+        end
+        def complete(
+          # The identifier of the FedNow Transfer you wish to complete.
+          fednow_transfer_id,
+          # If set, the simulation will reject the transfer.
+          rejection: nil,
+          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/inbound_check_deposits.rbi

@@ -36,6 +36,22 @@ module Increase
         )
         end
 
+        # Simulates the acceptance of an [Inbound Check Deposit](#inbound-check-deposits),
+        # creating a Transaction as a result. The Inbound Check Deposit must first have a
+        # `status` of `pending`.
+        sig do
+          params(
+            inbound_check_deposit_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::InboundCheckDeposit)
+        end
+        def accept(
+          # The identifier of the Inbound Check Deposit you wish to accept.
+          inbound_check_deposit_id,
+          request_options: {}
+        )
+        end
+
         # Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
         # must have a `status` of `accepted`.
         sig do

data/rbi/increase/resources/simulations.rbi

@@ -93,6 +93,9 @@ module Increase
       end
       attr_reader :inbound_real_time_payments_transfers
 
+      sig { returns(Increase::Resources::Simulations::FednowTransfers) }
+      attr_reader :fednow_transfers
+
       sig { returns(Increase::Resources::Simulations::InboundFednowTransfers) }
       attr_reader :inbound_fednow_transfers
 

data/sig/increase/client.rbs

@@ -39,6 +39,8 @@ module Increase
 
     attr_reader digital_wallet_tokens: Increase::Resources::DigitalWalletTokens
 
+    attr_reader digital_wallet_token_requests: Increase::Resources::DigitalWalletTokenRequests
+
     attr_reader transactions: Increase::Resources::Transactions
 
     attr_reader pending_transactions: Increase::Resources::PendingTransactions
@@ -67,6 +69,10 @@ module Increase
 
     attr_reader inbound_real_time_payments_transfers: Increase::Resources::InboundRealTimePaymentsTransfers
 
+    attr_reader real_time_payments_requests_for_payment: Increase::Resources::RealTimePaymentsRequestsForPayment
+
+    attr_reader inbound_real_time_payments_requests_for_payment: Increase::Resources::InboundRealTimePaymentsRequestsForPayment
+
     attr_reader fednow_transfers: Increase::Resources::FednowTransfers
 
     attr_reader inbound_fednow_transfers: Increase::Resources::InboundFednowTransfers
@@ -129,6 +135,8 @@ module Increase
 
     attr_reader card_validations: Increase::Resources::CardValidations
 
+    attr_reader physical_check_batches: Increase::Resources::PhysicalCheckBatches
+
     attr_reader simulations: Increase::Resources::Simulations
 
     private def auth_headers: -> ::Hash[String, String]

data/sig/increase/models/card_create_details_token_params.rbs

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

data/sig/increase/models/card_details_token.rbs

@@ -0,0 +1,40 @@
+module Increase
+  module Models
+    type card_details_token =
+      {
+        token: String,
+        expires_at: Time,
+        type: Increase::Models::CardDetailsToken::type_
+      }
+
+    class CardDetailsToken < Increase::Internal::Type::BaseModel
+      attr_accessor token: String
+
+      attr_accessor expires_at: Time
+
+      attr_accessor type: Increase::Models::CardDetailsToken::type_
+
+      def initialize: (
+        token: String,
+        expires_at: Time,
+        type: Increase::Models::CardDetailsToken::type_
+      ) -> void
+
+      def to_hash: -> {
+        token: String,
+        expires_at: Time,
+        type: Increase::Models::CardDetailsToken::type_
+      }
+
+      type type_ = :card_details_token
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CARD_DETAILS_TOKEN: :card_details_token
+
+        def self?.values: -> ::Array[Increase::Models::CardDetailsToken::type_]
+      end
+    end
+  end
+end

data/sig/increase/models/card_payment.rbs

@@ -6177,6 +6177,7 @@ module Increase
             merchant_name: String,
             merchant_postal_code: String?,
             merchant_state: String?,
+            network: Increase::Models::CardPayment::Element::CardRefund::network,
             network_identifiers: Increase::CardPayment::Element::CardRefund::NetworkIdentifiers,
             presentment_amount: Integer,
             presentment_currency: String,
@@ -6213,6 +6214,8 @@ module Increase
 
           attr_accessor merchant_state: String?
 
+          attr_accessor network: Increase::Models::CardPayment::Element::CardRefund::network
+
           attr_accessor network_identifiers: Increase::CardPayment::Element::CardRefund::NetworkIdentifiers
 
           attr_accessor presentment_amount: Integer
@@ -6241,6 +6244,7 @@ module Increase
             merchant_name: String,
             merchant_postal_code: String?,
             merchant_state: String?,
+            network: Increase::Models::CardPayment::Element::CardRefund::network,
             network_identifiers: Increase::CardPayment::Element::CardRefund::NetworkIdentifiers,
             presentment_amount: Integer,
             presentment_currency: String,
@@ -6264,6 +6268,7 @@ module Increase
             merchant_name: String,
             merchant_postal_code: String?,
             merchant_state: String?,
+            network: Increase::Models::CardPayment::Element::CardRefund::network,
             network_identifiers: Increase::CardPayment::Element::CardRefund::NetworkIdentifiers,
             presentment_amount: Integer,
             presentment_currency: String,
@@ -6355,6 +6360,20 @@ module Increase
             end
           end
 
+          type network = :visa | :pulse
+
+          module Network
+            extend Increase::Internal::Type::Enum
+
+            # Visa
+            VISA: :visa
+
+            # Pulse
+            PULSE: :pulse
+
+            def self?.values: -> ::Array[Increase::Models::CardPayment::Element::CardRefund::network]
+          end
+
           type network_identifiers =
             {
               acquirer_business_id: String,

data/sig/increase/models/digital_wallet_token.rbs

@@ -271,7 +271,8 @@ module Increase
         def self?.values: -> ::Array[Increase::Models::DigitalWalletToken::status]
       end
 
-      type token_requestor = :apple_pay | :google_pay | :samsung_pay | :unknown
+      type token_requestor =
+        :apple_pay | :google_pay | :samsung_pay | :garmin_pay | :unknown
 
       module TokenRequestor
         extend Increase::Internal::Type::Enum
@@ -285,6 +286,9 @@ module Increase
         # Samsung Pay
         SAMSUNG_PAY: :samsung_pay
 
+        # Garmin Pay
+        GARMIN_PAY: :garmin_pay
+
         # Unknown
         UNKNOWN: :unknown
 

data/sig/increase/models/digital_wallet_token_request.rbs

@@ -0,0 +1,260 @@
+module Increase
+  module Models
+    type digital_wallet_token_request =
+      {
+        id: String,
+        card_id: String,
+        created_at: Time,
+        declined: Increase::DigitalWalletTokenRequest::Declined?,
+        device: Increase::DigitalWalletTokenRequest::Device,
+        outcome: Increase::Models::DigitalWalletTokenRequest::outcome,
+        provisioned: Increase::DigitalWalletTokenRequest::Provisioned?,
+        token_reference_identifier: String,
+        token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor,
+        type: Increase::Models::DigitalWalletTokenRequest::type_
+      }
+
+    class DigitalWalletTokenRequest < Increase::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor card_id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor declined: Increase::DigitalWalletTokenRequest::Declined?
+
+      attr_accessor device: Increase::DigitalWalletTokenRequest::Device
+
+      attr_accessor outcome: Increase::Models::DigitalWalletTokenRequest::outcome
+
+      attr_accessor provisioned: Increase::DigitalWalletTokenRequest::Provisioned?
+
+      attr_accessor token_reference_identifier: String
+
+      attr_accessor token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor
+
+      attr_accessor type: Increase::Models::DigitalWalletTokenRequest::type_
+
+      def initialize: (
+        id: String,
+        card_id: String,
+        created_at: Time,
+        declined: Increase::DigitalWalletTokenRequest::Declined?,
+        device: Increase::DigitalWalletTokenRequest::Device,
+        outcome: Increase::Models::DigitalWalletTokenRequest::outcome,
+        provisioned: Increase::DigitalWalletTokenRequest::Provisioned?,
+        token_reference_identifier: String,
+        token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor,
+        type: Increase::Models::DigitalWalletTokenRequest::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        card_id: String,
+        created_at: Time,
+        declined: Increase::DigitalWalletTokenRequest::Declined?,
+        device: Increase::DigitalWalletTokenRequest::Device,
+        outcome: Increase::Models::DigitalWalletTokenRequest::outcome,
+        provisioned: Increase::DigitalWalletTokenRequest::Provisioned?,
+        token_reference_identifier: String,
+        token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor,
+        type: Increase::Models::DigitalWalletTokenRequest::type_
+      }
+
+      type declined =
+        {
+          reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+        }
+
+      class Declined < Increase::Internal::Type::BaseModel
+        attr_accessor reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+
+        def initialize: (
+          reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+        ) -> void
+
+        def to_hash: -> {
+          reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+        }
+
+        type reason =
+          :card_not_active
+          | :no_verification_method
+          | :webhook_timed_out
+          | :webhook_declined
+          | :incorrect_card_verification_code
+          | :declined_by_token_requestor
+          | :group_locked
+          | :account_closed
+          | :entity_not_active
+
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The card is not active.
+          CARD_NOT_ACTIVE: :card_not_active
+
+          # The card does not have a two-factor authentication method.
+          NO_VERIFICATION_METHOD: :no_verification_method
+
+          # Your webhook timed out when evaluating the token provisioning attempt.
+          WEBHOOK_TIMED_OUT: :webhook_timed_out
+
+          # Your webhook declined the token provisioning attempt.
+          WEBHOOK_DECLINED: :webhook_declined
+
+          # The tokenization attempt failed because the Card Verification Code (CVC) was incorrect.
+          INCORRECT_CARD_VERIFICATION_CODE: :incorrect_card_verification_code
+
+          # The tokenization attempt was declined by the token requestor.
+          DECLINED_BY_TOKEN_REQUESTOR: :declined_by_token_requestor
+
+          # The group was locked.
+          GROUP_LOCKED: :group_locked
+
+          # The account has been closed.
+          ACCOUNT_CLOSED: :account_closed
+
+          # The account's entity was not active.
+          ENTITY_NOT_ACTIVE: :entity_not_active
+
+          def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::Declined::reason]
+        end
+      end
+
+      type device =
+        {
+          device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?,
+          identifier: String?,
+          ip_address: String?,
+          name: String?
+        }
+
+      class Device < Increase::Internal::Type::BaseModel
+        attr_accessor device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?
+
+        attr_accessor identifier: String?
+
+        attr_accessor ip_address: String?
+
+        attr_accessor name: String?
+
+        def initialize: (
+          device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?,
+          identifier: String?,
+          ip_address: String?,
+          name: String?
+        ) -> void
+
+        def to_hash: -> {
+          device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?,
+          identifier: String?,
+          ip_address: String?,
+          name: String?
+        }
+
+        type device_type =
+          :unknown
+          | :mobile_phone
+          | :tablet
+          | :watch
+          | :mobilephone_or_tablet
+          | :pc
+          | :household_device
+          | :wearable_device
+          | :automobile_device
+
+        module DeviceType
+          extend Increase::Internal::Type::Enum
+
+          # Unknown
+          UNKNOWN: :unknown
+
+          # Mobile Phone
+          MOBILE_PHONE: :mobile_phone
+
+          # Tablet
+          TABLET: :tablet
+
+          # Watch
+          WATCH: :watch
+
+          # Mobile Phone or Tablet
+          MOBILEPHONE_OR_TABLET: :mobilephone_or_tablet
+
+          # PC
+          PC: :pc
+
+          # Household Device
+          HOUSEHOLD_DEVICE: :household_device
+
+          # Wearable Device
+          WEARABLE_DEVICE: :wearable_device
+
+          # Automobile Device
+          AUTOMOBILE_DEVICE: :automobile_device
+
+          def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::Device::device_type]
+        end
+      end
+
+      type outcome = :provisioned | :declined
+
+      module Outcome
+        extend Increase::Internal::Type::Enum
+
+        # The tokenization request was approved and a Digital Wallet Token was provisioned.
+        PROVISIONED: :provisioned
+
+        # The tokenization request was declined.
+        DECLINED: :declined
+
+        def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::outcome]
+      end
+
+      type provisioned = { digital_wallet_token_id: String }
+
+      class Provisioned < Increase::Internal::Type::BaseModel
+        attr_accessor digital_wallet_token_id: String
+
+        def initialize: (digital_wallet_token_id: String) -> void
+
+        def to_hash: -> { digital_wallet_token_id: String }
+      end
+
+      type token_requestor =
+        :apple_pay | :google_pay | :samsung_pay | :garmin_pay | :unknown
+
+      module TokenRequestor
+        extend Increase::Internal::Type::Enum
+
+        # Apple Pay
+        APPLE_PAY: :apple_pay
+
+        # Google Pay
+        GOOGLE_PAY: :google_pay
+
+        # Samsung Pay
+        SAMSUNG_PAY: :samsung_pay
+
+        # Garmin Pay
+        GARMIN_PAY: :garmin_pay
+
+        # Unknown
+        UNKNOWN: :unknown
+
+        def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::token_requestor]
+      end
+
+      type type_ = :digital_wallet_token_request
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        DIGITAL_WALLET_TOKEN_REQUEST: :digital_wallet_token_request
+
+        def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::type_]
+      end
+    end
+  end
+end