increase 0.3.2 → 1.0.0

data/rbi/increase/resources/physical_card_profiles.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class PhysicalCardProfiles
+      # Create a Physical Card Profile
+      sig do
+        params(
+          carrier_image_file_id: String,
+          contact_phone: String,
+          description: String,
+          front_image_file_id: String,
+          program_id: String,
+          front_text:
+            Increase::PhysicalCardProfileCreateParams::FrontText::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCardProfile)
+      end
+      def create(
+        # The identifier of the File containing the physical card's carrier image.
+        carrier_image_file_id:,
+        # A phone number the user can contact to receive support for their card.
+        contact_phone:,
+        # A description you can use to identify the Card Profile.
+        description:,
+        # The identifier of the File containing the physical card's front image.
+        front_image_file_id:,
+        # The identifier for the Program that this Physical Card Profile falls under.
+        program_id:,
+        # Text printed on the front of the card. Reach out to
+        # [support@increase.com](mailto:support@increase.com) for more information.
+        front_text: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Card Profile
+      sig do
+        params(
+          physical_card_profile_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCardProfile)
+      end
+      def retrieve(
+        # The identifier of the Card Profile.
+        physical_card_profile_id,
+        request_options: {}
+      )
+      end
+
+      # List Physical Card Profiles
+      sig do
+        params(
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::PhysicalCardProfileListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::PhysicalCardProfile])
+      end
+      def list(
+        # 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
+
+      # Archive a Physical Card Profile
+      sig do
+        params(
+          physical_card_profile_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCardProfile)
+      end
+      def archive(
+        # The identifier of the Physical Card Profile to archive.
+        physical_card_profile_id,
+        request_options: {}
+      )
+      end
+
+      # Clone a Physical Card Profile
+      sig do
+        params(
+          physical_card_profile_id: String,
+          carrier_image_file_id: String,
+          contact_phone: String,
+          description: String,
+          front_image_file_id: String,
+          front_text:
+            Increase::PhysicalCardProfileCloneParams::FrontText::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCardProfile)
+      end
+      def clone_(
+        # The identifier of the Physical Card Profile to clone.
+        physical_card_profile_id,
+        # The identifier of the File containing the physical card's carrier image.
+        carrier_image_file_id: nil,
+        # A phone number the user can contact to receive support for their card.
+        contact_phone: nil,
+        # A description you can use to identify the Card Profile.
+        description: nil,
+        # The identifier of the File containing the physical card's front image.
+        front_image_file_id: nil,
+        # Text printed on the front of the card. Reach out to
+        # [support@increase.com](mailto:support@increase.com) for more information.
+        front_text: 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/physical_cards.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class PhysicalCards
+      # Create a Physical Card
+      sig do
+        params(
+          card_id: String,
+          cardholder: Increase::PhysicalCardCreateParams::Cardholder::OrHash,
+          shipment: Increase::PhysicalCardCreateParams::Shipment::OrHash,
+          physical_card_profile_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCard)
+      end
+      def create(
+        # The underlying card representing this physical card.
+        card_id:,
+        # Details about the cardholder, as it will appear on the physical card.
+        cardholder:,
+        # The details used to ship this physical card.
+        shipment:,
+        # The physical card profile to use for this physical card. The latest default
+        # physical card profile will be used if not provided.
+        physical_card_profile_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Physical Card
+      sig do
+        params(
+          physical_card_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCard)
+      end
+      def retrieve(
+        # The identifier of the Physical Card.
+        physical_card_id,
+        request_options: {}
+      )
+      end
+
+      # Update a Physical Card
+      sig do
+        params(
+          physical_card_id: String,
+          status: Increase::PhysicalCardUpdateParams::Status::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PhysicalCard)
+      end
+      def update(
+        # The Physical Card identifier.
+        physical_card_id,
+        # The status to update the Physical Card to.
+        status:,
+        request_options: {}
+      )
+      end
+
+      # List Physical Cards
+      sig do
+        params(
+          card_id: String,
+          created_at: Increase::PhysicalCardListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::PhysicalCard])
+      end
+      def list(
+        # Filter Physical Cards to ones belonging to the specified Card.
+        card_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,
+        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/programs.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Programs
+      # Retrieve a Program
+      sig do
+        params(
+          program_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Program)
+      end
+      def retrieve(
+        # The identifier of the Program to retrieve.
+        program_id,
+        request_options: {}
+      )
+      end
+
+      # List Programs
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::Program])
+      end
+      def list(
+        # 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
+
+      # @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_decisions.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class RealTimeDecisions
+      # Retrieve a Real-Time Decision
+      sig do
+        params(
+          real_time_decision_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimeDecision)
+      end
+      def retrieve(
+        # The identifier of the Real-Time Decision.
+        real_time_decision_id,
+        request_options: {}
+      )
+      end
+
+      # Action a Real-Time Decision
+      sig do
+        params(
+          real_time_decision_id: String,
+          card_authentication:
+            Increase::RealTimeDecisionActionParams::CardAuthentication::OrHash,
+          card_authentication_challenge:
+            Increase::RealTimeDecisionActionParams::CardAuthenticationChallenge::OrHash,
+          card_authorization:
+            Increase::RealTimeDecisionActionParams::CardAuthorization::OrHash,
+          digital_wallet_authentication:
+            Increase::RealTimeDecisionActionParams::DigitalWalletAuthentication::OrHash,
+          digital_wallet_token:
+            Increase::RealTimeDecisionActionParams::DigitalWalletToken::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimeDecision)
+      end
+      def action(
+        # The identifier of the Real-Time Decision.
+        real_time_decision_id,
+        # If the Real-Time Decision relates to a 3DS card authentication attempt, this
+        # object contains your response to the authentication.
+        card_authentication: nil,
+        # If the Real-Time Decision relates to 3DS card authentication challenge delivery,
+        # this object contains your response.
+        card_authentication_challenge: nil,
+        # If the Real-Time Decision relates to a card authorization attempt, this object
+        # contains your response to the authorization.
+        card_authorization: nil,
+        # If the Real-Time Decision relates to a digital wallet authentication attempt,
+        # this object contains your response to the authentication.
+        digital_wallet_authentication: nil,
+        # If the Real-Time Decision relates to a digital wallet token provisioning
+        # attempt, this object contains your response to the attempt.
+        digital_wallet_token: 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/real_time_payments_transfers.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class RealTimePaymentsTransfers
+      # Create a Real-Time Payments Transfer
+      sig do
+        params(
+          amount: Integer,
+          creditor_name: String,
+          remittance_information: String,
+          source_account_number_id: String,
+          debtor_name: String,
+          destination_account_number: String,
+          destination_routing_number: String,
+          external_account_id: String,
+          require_approval: T::Boolean,
+          ultimate_creditor_name: String,
+          ultimate_debtor_name: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsTransfer)
+      end
+      def create(
+        # The transfer amount in USD cents. For Real-Time Payments transfers, must be
+        # positive.
+        amount:,
+        # The name of the transfer's recipient.
+        creditor_name:,
+        # Unstructured information that will show on the recipient's bank statement.
+        remittance_information:,
+        # The identifier of the Account Number from which to send the transfer.
+        source_account_number_id:,
+        # The name of the transfer's sender. If not provided, defaults to the name of the
+        # account's entity.
+        debtor_name: nil,
+        # The destination account number.
+        destination_account_number: nil,
+        # The destination American Bankers' Association (ABA) Routing Transit Number
+        # (RTN).
+        destination_routing_number: nil,
+        # The ID of an External Account to initiate a transfer to. If this parameter is
+        # provided, `destination_account_number` and `destination_routing_number` must be
+        # absent.
+        external_account_id: nil,
+        # Whether the transfer requires explicit approval via the dashboard or API.
+        require_approval: nil,
+        # The name of the ultimate recipient of the transfer. Set this if the creditor is
+        # an intermediary receiving the payment for someone else.
+        ultimate_creditor_name: nil,
+        # The name of the ultimate sender of the transfer. Set this if the funds are being
+        # sent on behalf of someone who is not the account holder at Increase.
+        ultimate_debtor_name: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Real-Time Payments Transfer
+      sig do
+        params(
+          real_time_payments_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsTransfer)
+      end
+      def retrieve(
+        # The identifier of the Real-Time Payments Transfer.
+        real_time_payments_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # List Real-Time Payments Transfers
+      sig do
+        params(
+          account_id: String,
+          created_at:
+            Increase::RealTimePaymentsTransferListParams::CreatedAt::OrHash,
+          cursor: String,
+          external_account_id: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::RealTimePaymentsTransferListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::RealTimePaymentsTransfer])
+      end
+      def list(
+        # Filter Real-Time Payments Transfers to those belonging to the specified Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter Real-Time Payments Transfers to those made to the specified External
+        # Account.
+        external_account_id: 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 an Real-Time Payments Transfer in a pending_approval state.
+      sig do
+        params(
+          real_time_payments_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsTransfer)
+      end
+      def approve(
+        # The identifier of the Real-Time Payments Transfer to approve.
+        real_time_payments_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # Cancels an Real-Time Payments Transfer in a pending_approval state.
+      sig do
+        params(
+          real_time_payments_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::RealTimePaymentsTransfer)
+      end
+      def cancel(
+        # The identifier of the pending Real-Time Payments Transfer to cancel.
+        real_time_payments_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/routing_numbers.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class RoutingNumbers
+      # You can use this API to confirm if a routing number is valid, such as when a
+      # user is providing you with bank account details. Since routing numbers uniquely
+      # identify a bank, this will always return 0 or 1 entry. In Sandbox, the only
+      # valid routing number for this method is 110000000.
+      sig do
+        params(
+          routing_number: String,
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(
+          Increase::Internal::Page[Increase::Models::RoutingNumberListResponse]
+        )
+      end
+      def list(
+        # Filter financial institutions by routing number.
+        routing_number:,
+        # 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
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/account_statements.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class AccountStatements
+        # Simulates an [Account Statement](#account-statements) being created for an
+        # account. In production, Account Statements are generated once per month.
+        sig do
+          params(
+            account_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::AccountStatement)
+        end
+        def create(
+          # The identifier of the Account the statement 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/account_transfers.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class AccountTransfers
+        # If your account is configured to require approval for each transfer, this
+        # endpoint simulates the approval of an [Account Transfer](#account-transfers).
+        # You can also approve sandbox Account Transfers in the dashboard. This transfer
+        # must first have a `status` of `pending_approval`.
+        sig do
+          params(
+            account_transfer_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::AccountTransfer)
+        end
+        def complete(
+          # The identifier of the Account Transfer you wish to complete.
+          account_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/ach_transfers.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class ACHTransfers
+        # Simulates the acknowledgement of an [ACH Transfer](#ach-transfers) by the
+        # Federal Reserve. This transfer must first have a `status` of `submitted` . In
+        # production, the Federal Reserve generally acknowledges submitted ACH files
+        # within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal
+        # Reserve, this endpoint allows you to skip that delay and add the acknowledgment
+        # subresource to the ACH Transfer.
+        sig do
+          params(
+            ach_transfer_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::ACHTransfer)
+        end
+        def acknowledge(
+          # The identifier of the ACH Transfer you wish to become acknowledged.
+          ach_transfer_id,
+          request_options: {}
+        )
+        end
+
+        # Simulates receiving a Notification of Change for an
+        # [ACH Transfer](#ach-transfers).
+        sig do
+          params(
+            ach_transfer_id: String,
+            change_code:
+              Increase::Simulations::ACHTransferCreateNotificationOfChangeParams::ChangeCode::OrSymbol,
+            corrected_data: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::ACHTransfer)
+        end
+        def create_notification_of_change(
+          # The identifier of the ACH Transfer you wish to create a notification of change
+          # for.
+          ach_transfer_id,
+          # The reason for the notification of change.
+          change_code:,
+          # The corrected data for the notification of change (e.g., a new routing number).
+          corrected_data:,
+          request_options: {}
+        )
+        end
+
+        # Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve
+        # due to an error condition. This will also create a Transaction to account for
+        # the returned funds. This transfer must first have a `status` of `submitted`.
+        sig do
+          params(
+            ach_transfer_id: String,
+            reason:
+              Increase::Simulations::ACHTransferReturnParams::Reason::OrSymbol,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::ACHTransfer)
+        end
+        def return_(
+          # The identifier of the ACH Transfer you wish to return.
+          ach_transfer_id,
+          # The reason why the Federal Reserve or destination bank returned this transfer.
+          # Defaults to `no_account`.
+          reason: nil,
+          request_options: {}
+        )
+        end
+
+        # Simulates the settlement of an [ACH Transfer](#ach-transfers) by the Federal
+        # Reserve. This transfer must first have a `status` of `pending_submission` or
+        # `submitted`. For convenience, if the transfer is in `status`:
+        # `pending_submission`, the simulation will also submit the transfer. Without this
+        # simulation the transfer will eventually settle on its own following the same
+        # Federal Reserve timeline as in production.
+        sig do
+          params(
+            ach_transfer_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::ACHTransfer)
+        end
+        def settle(
+          # The identifier of the ACH Transfer you wish to become settled.
+          ach_transfer_id,
+          request_options: {}
+        )
+        end
+
+        # Simulates the submission of an [ACH Transfer](#ach-transfers) to the Federal
+        # Reserve. This transfer must first have a `status` of `pending_approval` or
+        # `pending_submission`. In production, Increase submits ACH Transfers to the
+        # Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are
+        # not submitted to the Federal Reserve, this endpoint allows you to skip that
+        # delay and transition the ACH Transfer to a status of `submitted`.
+        sig do
+          params(
+            ach_transfer_id: String,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::ACHTransfer)
+        end
+        def submit(
+          # The identifier of the ACH Transfer you wish to submit.
+          ach_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