increase 0.3.2 → 1.0.0

data/rbi/increase/resources/inbound_wire_drawdown_requests.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class InboundWireDrawdownRequests
+      # Retrieve an Inbound Wire Drawdown Request
+      sig do
+        params(
+          inbound_wire_drawdown_request_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::InboundWireDrawdownRequest)
+      end
+      def retrieve(
+        # The identifier of the Inbound Wire Drawdown Request to retrieve.
+        inbound_wire_drawdown_request_id,
+        request_options: {}
+      )
+      end
+
+      # List Inbound Wire Drawdown Requests
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(
+          Increase::Internal::Page[Increase::InboundWireDrawdownRequest]
+        )
+      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/inbound_wire_transfers.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class InboundWireTransfers
+      # Retrieve an Inbound Wire Transfer
+      sig do
+        params(
+          inbound_wire_transfer_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::InboundWireTransfer)
+      end
+      def retrieve(
+        # The identifier of the Inbound Wire Transfer to get details for.
+        inbound_wire_transfer_id,
+        request_options: {}
+      )
+      end
+
+      # List Inbound Wire Transfers
+      sig do
+        params(
+          account_id: String,
+          account_number_id: String,
+          created_at:
+            Increase::InboundWireTransferListParams::CreatedAt::OrHash,
+          cursor: String,
+          limit: Integer,
+          status: Increase::InboundWireTransferListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::InboundWireTransfer])
+      end
+      def list(
+        # Filter Inbound Wire Transfers to ones belonging to the specified Account.
+        account_id: nil,
+        # Filter Inbound Wire Transfers to ones belonging to the specified Account Number.
+        account_number_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Reverse an Inbound Wire Transfer
+      sig do
+        params(
+          inbound_wire_transfer_id: String,
+          reason: Increase::InboundWireTransferReverseParams::Reason::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::InboundWireTransfer)
+      end
+      def reverse(
+        # The identifier of the Inbound Wire Transfer to reverse.
+        inbound_wire_transfer_id,
+        # Reason for the reversal.
+        reason:,
+        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/intrafi_account_enrollments.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class IntrafiAccountEnrollments
+      # Enroll an account in the IntraFi deposit sweep network
+      sig do
+        params(
+          account_id: String,
+          email_address: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::IntrafiAccountEnrollment)
+      end
+      def create(
+        # The identifier for the account to be added to IntraFi.
+        account_id:,
+        # The contact email for the account owner, to be shared with IntraFi.
+        email_address:,
+        request_options: {}
+      )
+      end
+
+      # Get an IntraFi Account Enrollment
+      sig do
+        params(
+          intrafi_account_enrollment_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::IntrafiAccountEnrollment)
+      end
+      def retrieve(
+        # The identifier of the IntraFi Account Enrollment to retrieve.
+        intrafi_account_enrollment_id,
+        request_options: {}
+      )
+      end
+
+      # List IntraFi Account Enrollments
+      sig do
+        params(
+          account_id: String,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::IntrafiAccountEnrollmentListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::IntrafiAccountEnrollment])
+      end
+      def list(
+        # Filter IntraFi Account Enrollments to the one belonging to an account.
+        account_id: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter records to the one with the specified `idempotency_key` you chose for
+        # that object. This value is unique across Increase and is used to ensure that a
+        # request is only processed once. Learn more about
+        # [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Unenroll an account from IntraFi
+      sig do
+        params(
+          intrafi_account_enrollment_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::IntrafiAccountEnrollment)
+      end
+      def unenroll(
+        # The Identifier of the IntraFi Account Enrollment to remove from IntraFi.
+        intrafi_account_enrollment_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/intrafi_balances.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class IntrafiBalances
+      # Returns the IntraFi balance for the given account. IntraFi may sweep funds to
+      # multiple banks. This endpoint will include both the total balance and the amount
+      # swept to each institution.
+      sig do
+        params(
+          account_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::IntrafiBalance)
+      end
+      def intrafi_balance(
+        # The identifier of the Account to get balances 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

data/rbi/increase/resources/intrafi_exclusions.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class IntrafiExclusions
+      # Create an IntraFi Exclusion
+      sig do
+        params(
+          bank_name: String,
+          entity_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::IntrafiExclusion)
+      end
+      def create(
+        # The name of the financial institution to be excluded.
+        bank_name:,
+        # The identifier of the Entity whose deposits will be excluded.
+        entity_id:,
+        request_options: {}
+      )
+      end
+
+      # Get an IntraFi Exclusion
+      sig do
+        params(
+          intrafi_exclusion_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::IntrafiExclusion)
+      end
+      def retrieve(
+        # The identifier of the IntraFi Exclusion to retrieve.
+        intrafi_exclusion_id,
+        request_options: {}
+      )
+      end
+
+      # List IntraFi Exclusions
+      sig do
+        params(
+          cursor: String,
+          entity_id: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::IntrafiExclusion])
+      end
+      def list(
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter IntraFi Exclusions for those belonging to the specified Entity.
+        entity_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,
+        request_options: {}
+      )
+      end
+
+      # Archive an IntraFi Exclusion
+      sig do
+        params(
+          intrafi_exclusion_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::IntrafiExclusion)
+      end
+      def archive(
+        # The identifier of the IntraFi Exclusion request to archive. It may take 5
+        # business days for an exclusion removal to be processed. Removing an exclusion
+        # does not guarantee that funds will be swept to the previously-excluded bank.
+        intrafi_exclusion_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/lockboxes.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Lockboxes
+      # Create a Lockbox
+      sig do
+        params(
+          account_id: String,
+          description: String,
+          recipient_name: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Lockbox)
+      end
+      def create(
+        # The Account checks sent to this Lockbox should be deposited into.
+        account_id:,
+        # The description you choose for the Lockbox, for display purposes.
+        description: nil,
+        # The name of the recipient that will receive mail at this location.
+        recipient_name: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Lockbox
+      sig do
+        params(
+          lockbox_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Lockbox)
+      end
+      def retrieve(
+        # The identifier of the Lockbox to retrieve.
+        lockbox_id,
+        request_options: {}
+      )
+      end
+
+      # Update a Lockbox
+      sig do
+        params(
+          lockbox_id: String,
+          description: String,
+          recipient_name: String,
+          status: Increase::LockboxUpdateParams::Status::OrSymbol,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Lockbox)
+      end
+      def update(
+        # The identifier of the Lockbox.
+        lockbox_id,
+        # The description you choose for the Lockbox.
+        description: nil,
+        # The recipient name you choose for the Lockbox.
+        recipient_name: nil,
+        # This indicates if checks can be sent to the Lockbox.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # List Lockboxes
+      sig do
+        params(
+          account_id: String,
+          created_at: Increase::LockboxListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::Lockbox])
+      end
+      def list(
+        # Filter Lockboxes to those associated with the provided Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter records to the one with the specified `idempotency_key` you chose for
+        # that object. This value is unique across Increase and is used to ensure that a
+        # request is only processed once. Learn more about
+        # [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        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/oauth_applications.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class OAuthApplications
+      # Retrieve an OAuth Application
+      sig do
+        params(
+          oauth_application_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::OAuthApplication)
+      end
+      def retrieve(
+        # The identifier of the OAuth Application.
+        oauth_application_id,
+        request_options: {}
+      )
+      end
+
+      # List OAuth Applications
+      sig do
+        params(
+          created_at: Increase::OAuthApplicationListParams::CreatedAt::OrHash,
+          cursor: String,
+          limit: Integer,
+          status: Increase::OAuthApplicationListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::OAuthApplication])
+      end
+      def list(
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/oauth_connections.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class OAuthConnections
+      # Retrieve an OAuth Connection
+      sig do
+        params(
+          oauth_connection_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::OAuthConnection)
+      end
+      def retrieve(
+        # The identifier of the OAuth Connection.
+        oauth_connection_id,
+        request_options: {}
+      )
+      end
+
+      # List OAuth Connections
+      sig do
+        params(
+          cursor: String,
+          limit: Integer,
+          oauth_application_id: String,
+          status: Increase::OAuthConnectionListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::OAuthConnection])
+      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,
+        # Filter results to only include OAuth Connections for a specific OAuth
+        # Application.
+        oauth_application_id: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/oauth_tokens.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class OAuthTokens
+      # Create an OAuth Token
+      sig do
+        params(
+          grant_type: Increase::OAuthTokenCreateParams::GrantType::OrSymbol,
+          client_id: String,
+          client_secret: String,
+          code: String,
+          production_token: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::OAuthToken)
+      end
+      def create(
+        # The credential you request in exchange for the code. In Production, this is
+        # always `authorization_code`. In Sandbox, you can pass either enum value.
+        grant_type:,
+        # The public identifier for your application.
+        client_id: nil,
+        # The secret that confirms you own the application. This is redundent given that
+        # the request is made with your API key but it's a required component of OAuth
+        # 2.0.
+        client_secret: nil,
+        # The authorization code generated by the user and given to you as a query
+        # parameter.
+        code: nil,
+        # The production token you want to exchange for a sandbox token. This is only
+        # available in Sandbox. Set `grant_type` to `production_token` to use this
+        # parameter.
+        production_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/pending_transactions.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class PendingTransactions
+      # Creates a pending transaction on an account. This can be useful to hold funds
+      # for an external payment or known future transaction outside of Increase. The
+      # resulting Pending Transaction will have a `category` of `user_initiated_hold`
+      # and can be released via the API to unlock the held funds.
+      sig do
+        params(
+          account_id: String,
+          amount: Integer,
+          description: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PendingTransaction)
+      end
+      def create(
+        # The Account to place the hold on.
+        account_id:,
+        # The amount to hold in the minor unit of the account's currency. For dollars, for
+        # example, this is cents. This should be a negative amount - to hold $1.00 from
+        # the account, you would pass -100.
+        amount:,
+        # The description you choose to give the hold.
+        description: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Pending Transaction
+      sig do
+        params(
+          pending_transaction_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PendingTransaction)
+      end
+      def retrieve(
+        # The identifier of the Pending Transaction.
+        pending_transaction_id,
+        request_options: {}
+      )
+      end
+
+      # List Pending Transactions
+      sig do
+        params(
+          account_id: String,
+          category: Increase::PendingTransactionListParams::Category::OrHash,
+          created_at: Increase::PendingTransactionListParams::CreatedAt::OrHash,
+          cursor: String,
+          limit: Integer,
+          route_id: String,
+          status: Increase::PendingTransactionListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::PendingTransaction])
+      end
+      def list(
+        # Filter pending transactions to those belonging to the specified Account.
+        account_id: nil,
+        category: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        # Filter pending transactions to those belonging to the specified Route.
+        route_id: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Release a Pending Transaction you had previously created. The Pending
+      # Transaction must have a `category` of `user_initiated_hold` and a `status` of
+      # `pending`. This will unlock the held funds and mark the Pending Transaction as
+      # complete.
+      sig do
+        params(
+          pending_transaction_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::PendingTransaction)
+      end
+      def release(
+        # The identifier of the Pending Transaction to release.
+        pending_transaction_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end