straddle 0.1.0.pre.alpha.1

data/rbi/straddle/resources/bridge/link.rbi

@@ -0,0 +1,175 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Bridge
+      class Link
+        # Use Bridge to create a new paykey using a bank routing and account number as the
+        # source. This endpoint allows you to create a secure payment token linked to a
+        # specific bank account.
+        sig do
+          params(
+            account_number: String,
+            account_type:
+              Straddle::Bridge::LinkBankAccountParams::AccountType::OrSymbol,
+            customer_id: String,
+            routing_number: String,
+            config: Straddle::Bridge::LinkBankAccountParams::Config::OrHash,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::PaykeyV1)
+        end
+        def bank_account(
+          # Body param: The bank account number.
+          account_number:,
+          # Body param:
+          account_type:,
+          # Body param: Unique identifier of the related customer object.
+          customer_id:,
+          # Body param: The routing number of the bank account.
+          routing_number:,
+          # Body param:
+          config: nil,
+          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+          # additional information about the paykey in a structured format.
+          metadata: nil,
+          # Header param: Optional client generated identifier to trace and debug a series
+          # of requests.
+          correlation_id: nil,
+          # Header param: Optional client generated identifier to trace and debug a request.
+          request_id: nil,
+          # Header param: For use by platforms to specify an account id and set scope of a
+          # request.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Creates a new paykey using a Quiltt token as the source. This endpoint allows
+        # you to create a secure payment token linked to a bank account authenticated
+        # through Quiltt.
+        sig do
+          params(
+            customer_id: String,
+            quiltt_token: String,
+            config: Straddle::Bridge::LinkCreatePaykeyParams::Config::OrHash,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Models::Bridge::LinkCreatePaykeyResponse)
+        end
+        def create_paykey(
+          # Body param: Unique identifier of the related customer object.
+          customer_id:,
+          # Body param: Quiltt processor token generated by your application for use with
+          # the Straddle API.
+          quiltt_token:,
+          # Body param:
+          config: nil,
+          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+          # additional information about the paykey in a structured format.
+          metadata: nil,
+          # Header param: Optional client generated identifier to trace and debug a series
+          # of requests.
+          correlation_id: nil,
+          # Header param: Optional client generated identifier to trace and debug a request.
+          request_id: nil,
+          # Header param: For use by platforms to specify an account id and set scope of a
+          # request.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            account_type:
+              Straddle::Bridge::LinkCreateTanParams::AccountType::OrSymbol,
+            customer_id: String,
+            routing_number: String,
+            tan: String,
+            config: Straddle::Bridge::LinkCreateTanParams::Config::OrHash,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Models::Bridge::LinkCreateTanResponse)
+        end
+        def create_tan(
+          # Body param:
+          account_type:,
+          # Body param: Unique identifier of the related customer object.
+          customer_id:,
+          # Body param: Bank routing number.
+          routing_number:,
+          # Body param: Tokenized account number.
+          tan:,
+          # Body param:
+          config: nil,
+          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+          # additional information about the paykey in a structured format.
+          metadata: nil,
+          # Header param: Optional client generated identifier to trace and debug a series
+          # of requests.
+          correlation_id: nil,
+          # Header param: Optional client generated identifier to trace and debug a request.
+          request_id: nil,
+          # Header param: For use by platforms to specify an account id and set scope of a
+          # request.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Use Bridge to create a new paykey using a Plaid token as the source. This
+        # endpoint allows you to create a secure payment token linked to a bank account
+        # authenticated through Plaid.
+        sig do
+          params(
+            customer_id: String,
+            plaid_token: String,
+            config: Straddle::Bridge::LinkPlaidParams::Config::OrHash,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::PaykeyV1)
+        end
+        def plaid(
+          # Body param: Unique identifier of the related customer object.
+          customer_id:,
+          # Body param: Plaid processor token generated by your application for use with the
+          # Straddle API.
+          plaid_token:,
+          # Body param:
+          config: nil,
+          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+          # additional information about the paykey in a structured format.
+          metadata: nil,
+          # Header param: Optional client generated identifier to trace and debug a series
+          # of requests.
+          correlation_id: nil,
+          # Header param: Optional client generated identifier to trace and debug a request.
+          request_id: nil,
+          # Header param: For use by platforms to specify an account id and set scope of a
+          # request.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Straddle::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/resources/bridge.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Bridge
+      sig { returns(Straddle::Resources::Bridge::Link) }
+      attr_reader :link
+
+      # Use this endpoint to generate a session token for use in the Bridge widget.
+      sig do
+        params(
+          customer_id: String,
+          config: Straddle::BridgeInitializeParams::Config::OrHash,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::BridgeTokenV1)
+      end
+      def initialize_(
+        # Body param: The Straddle generated unique identifier of the `customer` to create
+        # a bridge token for.
+        customer_id:,
+        # Body param:
+        config: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Straddle::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/straddle/resources/charges.rbi

@@ -0,0 +1,242 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Charges
+      # Use charges to collect money from a customer for the sale of goods or services.
+      sig do
+        params(
+          amount: Integer,
+          config: Straddle::ChargeCreateParams::Config::OrHash,
+          consent_type: Straddle::ChargeCreateParams::ConsentType::OrSymbol,
+          currency: String,
+          description: String,
+          device: Straddle::DeviceInfoV1::OrHash,
+          external_id: String,
+          paykey: String,
+          payment_date: Date,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::ChargeV1)
+      end
+      def create(
+        # Body param: The amount of the charge in cents.
+        amount:,
+        # Body param:
+        config:,
+        # Body param: The channel or mechanism through which the payment was authorized.
+        # Use `internet` for payments made online or through a mobile app and `signed` for
+        # signed agreements where there is a consent form or contract. Use `signed` for
+        # PDF signatures.
+        consent_type:,
+        # Body param: The currency of the charge. Only USD is supported.
+        currency:,
+        # Body param: An arbitrary description for the charge.
+        description:,
+        # Body param:
+        device:,
+        # Body param: Unique identifier for the charge in your database. This value must
+        # be unique across all charges.
+        external_id:,
+        # Body param: Value of the `paykey` used for the charge.
+        paykey:,
+        # Body param: The desired date on which the payment should be occur. For charges,
+        # this means the date you want the customer to be debited on.
+        payment_date:,
+        # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+        # additional information about the charge in a structured format.
+        metadata: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Change the values of parameters associated with a charge prior to processing.
+      # The status of the charge must be `created`, `scheduled`, or `on_hold`.
+      sig do
+        params(
+          id: String,
+          amount: Integer,
+          description: String,
+          payment_date: Date,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::ChargeV1)
+      end
+      def update(
+        # Path param:
+        id,
+        # Body param: The amount of the charge in cents.
+        amount:,
+        # Body param: An arbitrary description for the charge.
+        description:,
+        # Body param: The desired date on which the payment should be occur. For charges,
+        # this means the date you want the customer to be debited on.
+        payment_date:,
+        # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+        # additional information about the charge in a structured format.
+        metadata: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Cancel a charge to prevent it from being originated for processing. The status
+      # of the charge must be `created`, `scheduled`, or `on_hold`.
+      sig do
+        params(
+          id: String,
+          reason: T.nilable(String),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::ChargeV1)
+      end
+      def cancel(
+        # Path param:
+        id,
+        # Body param: Details about why the charge status was updated.
+        reason: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves the details of an existing charge. Supply the unique charge `id`, and
+      # Straddle will return the corresponding charge information.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::ChargeV1)
+      end
+      def get(
+        id,
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # For use by platforms to specify an account id and set scope of a request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Place a charge on hold to prevent it from being originated for processing. The
+      # status of the charge must be `created` or `scheduled`.
+      sig do
+        params(
+          id: String,
+          reason: T.nilable(String),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::ChargeV1)
+      end
+      def hold(
+        # Path param:
+        id,
+        # Body param: Details about why the charge status was updated.
+        reason: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Release a charge from an `on_hold` status to allow it to be rescheduled for
+      # processing.
+      sig do
+        params(
+          id: String,
+          reason: T.nilable(String),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::ChargeV1)
+      end
+      def release(
+        # Path param:
+        id,
+        # Body param: Details about why the charge status was updated.
+        reason: nil,
+        # Header param: Optional client generated identifier to trace and debug a series
+        # of requests.
+        correlation_id: nil,
+        # Header param: Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # Header param: For use by platforms to specify an account id and set scope of a
+        # request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a charge by id.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::Models::ChargeUnmaskResponse)
+      end
+      def unmask(
+        id,
+        # Optional client generated identifier to trace and debug a series of requests.
+        correlation_id: nil,
+        # Optional client generated identifier to trace and debug a request.
+        request_id: nil,
+        # For use by platforms to specify an account id and set scope of a request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Straddle::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/straddle/resources/customers/review.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Customers
+      class Review
+        # Updates the status of a customer's identity decision. This endpoint allows you
+        # to modify the outcome of a customer risk screening and is useful for correcting
+        # or updating the status of a customer's verification. Note that this endpoint is
+        # only available for customers with a current status of `review`.
+        sig do
+          params(
+            id: String,
+            status: Straddle::Customers::ReviewDecisionParams::Status::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::CustomerV1)
+        end
+        def decision(
+          # Path param:
+          id,
+          # Body param: The final status of the customer review.
+          status:,
+          # Header param: Optional client generated identifier to trace and debug a series
+          # of requests.
+          correlation_id: nil,
+          # Header param: Optional client generated identifier to trace and debug a request.
+          request_id: nil,
+          # Header param: For use by platforms to specify an account id and set scope of a
+          # request.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves and analyzes the results of a customer's identity validation and fraud
+        # score. This endpoint provides a comprehensive breakdown of the validation
+        # outcome, including:
+        #
+        # - Risk and correlation scores
+        # - Reason codes for the decision
+        # - Results of watchlist screening
+        # - Any network alerts detected Use this endpoint to gain insights into the
+        #   verification process and make informed decisions about customer onboarding.
+        sig do
+          params(
+            id: String,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Customers::CustomerReviewV1)
+        end
+        def get(
+          id,
+          # Optional client generated identifier to trace and debug a series of requests.
+          correlation_id: nil,
+          # Optional client generated identifier to trace and debug a request.
+          request_id: nil,
+          # For use by platforms to specify an account id and set scope of a request.
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Straddle::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end