increase 0.3.2 → 1.0.0

data/rbi/increase/resources/simulations/card_authorization_expirations.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardAuthorizationExpirations
+        # Simulates expiring a Card Authorization immediately.
+        sig do
+          params(
+            card_payment_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardPayment)
+        end
+        def create(
+          # The identifier of the Card Payment to expire.
+          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/card_authorizations.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardAuthorizations
+        # Simulates a purchase authorization on a [Card](#cards). Depending on the balance
+        # available to the card and the `amount` submitted, the authorization activity
+        # will result in a [Pending Transaction](#pending-transactions) of type
+        # `card_authorization` or a [Declined Transaction](#declined-transactions) of type
+        # `card_decline`. You can pass either a Card id or a
+        # [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
+        # ways purchases can be made.
+        sig do
+          params(
+            amount: Integer,
+            authenticated_card_payment_id: String,
+            card_id: String,
+            decline_reason:
+              Increase::Simulations::CardAuthorizationCreateParams::DeclineReason::OrSymbol,
+            digital_wallet_token_id: String,
+            direction:
+              Increase::Simulations::CardAuthorizationCreateParams::Direction::OrSymbol,
+            event_subscription_id: String,
+            merchant_acceptor_id: String,
+            merchant_category_code: String,
+            merchant_city: String,
+            merchant_country: String,
+            merchant_descriptor: String,
+            merchant_state: String,
+            network_details:
+              Increase::Simulations::CardAuthorizationCreateParams::NetworkDetails::OrHash,
+            network_risk_score: Integer,
+            physical_card_id: String,
+            terminal_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(
+            Increase::Models::Simulations::CardAuthorizationCreateResponse
+          )
+        end
+        def create(
+          # The authorization amount in cents.
+          amount:,
+          # The identifier of a Card Payment with a `card_authentication` if you want to
+          # simulate an authenticated authorization.
+          authenticated_card_payment_id: nil,
+          # The identifier of the Card to be authorized.
+          card_id: nil,
+          # Forces a card decline with a specific reason. No real time decision will be
+          # sent.
+          decline_reason: nil,
+          # The identifier of the Digital Wallet Token to be authorized.
+          digital_wallet_token_id: nil,
+          # The direction describes the direction the funds will move, either from the
+          # cardholder to the merchant or from the merchant to the cardholder.
+          direction: nil,
+          # 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.
+          event_subscription_id: 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 city the merchant resides in.
+          merchant_city: nil,
+          # The country the merchant resides in.
+          merchant_country: nil,
+          # The merchant descriptor of the merchant the card is transacting with.
+          merchant_descriptor: nil,
+          # The state the merchant resides in.
+          merchant_state: nil,
+          # Fields specific to a given card network.
+          network_details: nil,
+          # 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.
+          network_risk_score: nil,
+          # The identifier of the Physical Card to be authorized.
+          physical_card_id: nil,
+          # The terminal identifier (commonly abbreviated as TID) of the terminal the card
+          # is transacting with.
+          terminal_id: 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/card_disputes.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardDisputes
+        # After a [Card Dispute](#card-disputes) is created in production, the dispute
+        # will be reviewed. Since no review happens in sandbox, this endpoint simulates
+        # moving a Card Dispute into a rejected or accepted state. A Card Dispute can only
+        # be actioned one time and must have a status of `pending_reviewing`.
+        sig do
+          params(
+            card_dispute_id: String,
+            status:
+              Increase::Simulations::CardDisputeActionParams::Status::OrSymbol,
+            explanation: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardDispute)
+        end
+        def action(
+          # The dispute you would like to action.
+          card_dispute_id,
+          # The status to move the dispute to.
+          status:,
+          # Why the dispute was rejected. Not required for accepting disputes.
+          explanation: 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/card_fuel_confirmations.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardFuelConfirmations
+        # Simulates the fuel confirmation of an authorization by a card acquirer. This
+        # happens asynchronously right after a fuel pump transaction is completed. A fuel
+        # confirmation can only happen once per authorization.
+        sig do
+          params(
+            amount: Integer,
+            card_payment_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardPayment)
+        end
+        def create(
+          # The amount of the fuel_confirmation in minor units in the card authorization's
+          # currency.
+          amount:,
+          # The identifier of the Card Payment to create a fuel_confirmation on.
+          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/card_increments.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardIncrements
+        # Simulates the increment of an authorization by a card acquirer. An authorization
+        # can be incremented multiple times.
+        sig do
+          params(
+            amount: Integer,
+            card_payment_id: String,
+            event_subscription_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardPayment)
+        end
+        def create(
+          # The amount of the increment in minor units in the card authorization's currency.
+          amount:,
+          # The identifier of the Card Payment to create a increment on.
+          card_payment_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.
+          event_subscription_id: 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/card_refunds.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardRefunds
+        # Simulates refunding a card transaction. The full value of the original sandbox
+        # transaction is refunded.
+        sig do
+          params(
+            transaction_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::Transaction)
+        end
+        def create(
+          # The identifier for the Transaction to refund. The Transaction's source must have
+          # a category of card_settlement.
+          transaction_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/card_reversals.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardReversals
+        # Simulates the reversal of an authorization by a card acquirer. An authorization
+        # can be partially reversed multiple times, up until the total authorized amount.
+        # Marks the pending transaction as complete if the authorization is fully
+        # reversed.
+        sig do
+          params(
+            card_payment_id: String,
+            amount: Integer,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardPayment)
+        end
+        def create(
+          # The identifier of the Card Payment to create a reversal on.
+          card_payment_id:,
+          # The amount of the reversal in minor units in the card authorization's currency.
+          # This defaults to the authorization amount.
+          amount: 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/card_settlements.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardSettlements
+        # Simulates the settlement of an authorization by a card acquirer. After a card
+        # authorization is created, the merchant will eventually send a settlement. This
+        # simulates that event, which may occur many days after the purchase in
+        # production. The amount settled can be different from the amount originally
+        # authorized, for example, when adding a tip to a restaurant bill.
+        sig do
+          params(
+            card_id: String,
+            pending_transaction_id: String,
+            amount: Integer,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::Transaction)
+        end
+        def create(
+          # The identifier of the Card to create a settlement on.
+          card_id:,
+          # The identifier of the Pending Transaction for the Card Authorization you wish to
+          # settle.
+          pending_transaction_id:,
+          # The amount to be settled. This defaults to the amount of the Pending Transaction
+          # being settled.
+          amount: 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/check_deposits.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CheckDeposits
+        # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
+        # factors like poor image quality. This Check Deposit must first have a `status`
+        # of `pending`.
+        sig do
+          params(
+            check_deposit_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CheckDeposit)
+        end
+        def reject(
+          # The identifier of the Check Deposit you wish to reject.
+          check_deposit_id,
+          request_options: {}
+        )
+        end
+
+        # Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit
+        # must first have a `status` of `submitted`.
+        sig do
+          params(
+            check_deposit_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CheckDeposit)
+        end
+        def return_(
+          # The identifier of the Check Deposit you wish to return.
+          check_deposit_id,
+          request_options: {}
+        )
+        end
+
+        # Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
+        # Reserve. This Check Deposit must first have a `status` of `pending`.
+        sig do
+          params(
+            check_deposit_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CheckDeposit)
+        end
+        def submit(
+          # The identifier of the Check Deposit you wish to submit.
+          check_deposit_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/check_transfers.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CheckTransfers
+        # Simulates the mailing of a [Check Transfer](#check-transfers), which happens
+        # periodically throughout the day in production but can be sped up in sandbox.
+        # This transfer must first have a `status` of `pending_approval` or
+        # `pending_submission`.
+        sig do
+          params(
+            check_transfer_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CheckTransfer)
+        end
+        def mail(
+          # The identifier of the Check Transfer you wish to mail.
+          check_transfer_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/digital_wallet_token_requests.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class DigitalWalletTokenRequests
+        # Simulates a user attempting add a [Card](#cards) to a digital wallet such as
+        # Apple Pay.
+        sig do
+          params(
+            card_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(
+            Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse
+          )
+        end
+        def create(
+          # The identifier of the Card to be authorized.
+          card_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/documents.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class Documents
+        # Simulates an tax document being created for an account.
+        sig do
+          params(
+            account_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::Document)
+        end
+        def create(
+          # The identifier of the Account the tax document is for.
+          account_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/inbound_ach_transfers.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundACHTransfers
+        # Simulates an inbound ACH transfer to your account. This imitates initiating a
+        # transfer to an Increase account from a different financial institution. The
+        # transfer may be either a credit or a debit depending on if the `amount` is
+        # positive or negative. The result of calling this API will contain the created
+        # transfer. You can pass a `resolve_at` parameter to allow for a window to
+        # [action on the Inbound ACH Transfer](https://increase.com/documentation/receiving-ach-transfers).
+        # Alternatively, if you don't pass the `resolve_at` parameter the result will
+        # contain either a [Transaction](#transactions) or a
+        # [Declined Transaction](#declined-transactions) depending on whether or not the
+        # transfer is allowed.
+        sig do
+          params(
+            account_number_id: String,
+            amount: Integer,
+            addenda:
+              Increase::Simulations::InboundACHTransferCreateParams::Addenda::OrHash,
+            company_descriptive_date: String,
+            company_discretionary_data: String,
+            company_entry_description: String,
+            company_id: String,
+            company_name: String,
+            receiver_id_number: String,
+            receiver_name: String,
+            resolve_at: Time,
+            standard_entry_class_code:
+              Increase::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode::OrSymbol,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::InboundACHTransfer)
+        end
+        def create(
+          # The identifier of the Account Number the inbound ACH Transfer is for.
+          account_number_id:,
+          # The transfer amount in cents. A positive amount originates a credit transfer
+          # pushing funds to the receiving account. A negative amount originates a debit
+          # transfer pulling funds from the receiving account.
+          amount:,
+          # Additional information to include in the transfer.
+          addenda: nil,
+          # The description of the date of the transfer.
+          company_descriptive_date: nil,
+          # Data associated with the transfer set by the sender.
+          company_discretionary_data: nil,
+          # The description of the transfer set by the sender.
+          company_entry_description: nil,
+          # The sender's company ID.
+          company_id: nil,
+          # The name of the sender.
+          company_name: nil,
+          # The ID of the receiver of the transfer.
+          receiver_id_number: nil,
+          # The name of the receiver of the transfer.
+          receiver_name: nil,
+          # The time at which the transfer should be resolved. If not provided will resolve
+          # immediately.
+          resolve_at: nil,
+          # The standard entry class code for the transfer.
+          standard_entry_class_code: 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

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundCheckDeposits
+        # Simulates an Inbound Check Deposit against your account. This imitates someone
+        # depositing a check at their bank that was issued from your account. It may or
+        # may not be associated with a Check Transfer. Increase will evaluate the Check
+        # Deposit as we would in production and either create a Transaction or a Declined
+        # Transaction as a result. You can inspect the resulting Inbound Check Deposit
+        # object to see the result.
+        sig do
+          params(
+            account_number_id: String,
+            amount: Integer,
+            check_number: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::InboundCheckDeposit)
+        end
+        def create(
+          # The identifier of the Account Number the Inbound Check Deposit will be against.
+          account_number_id:,
+          # The check amount in cents.
+          amount:,
+          # The check number on the check to be deposited.
+          check_number:,
+          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_funds_holds.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundFundsHolds
+        # This endpoint simulates immediately releasing an Inbound Funds Hold, which might
+        # be created as a result of e.g., an ACH debit.
+        sig do
+          params(
+            inbound_funds_hold_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(
+            Increase::Models::Simulations::InboundFundsHoldReleaseResponse
+          )
+        end
+        def release(
+          # The inbound funds hold to release.
+          inbound_funds_hold_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/inbound_mail_items.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class InboundMailItems
+        # Simulates an inbound mail item to your account, as if someone had mailed a
+        # physical check to one of your account's Lockboxes.
+        sig do
+          params(
+            amount: Integer,
+            lockbox_id: String,
+            contents_file_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::InboundMailItem)
+        end
+        def create(
+          # The amount of the check to be simulated, in cents.
+          amount:,
+          # The identifier of the Lockbox to simulate inbound mail to.
+          lockbox_id:,
+          # The file containing the PDF contents. If not present, a default check image file
+          # will be used.
+          contents_file_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end