straddle 0.1.0.pre.alpha.1

data/rbi/straddle/resources/customers.rbi

@@ -0,0 +1,307 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Customers
+      sig { returns(Straddle::Resources::Customers::Review) }
+      attr_reader :review
+
+      # Creates a new customer record and automatically initiates identity, fraud, and
+      # risk assessment scores. This endpoint allows you to create a customer profile
+      # and associate it with paykeys and payments.
+      sig do
+        params(
+          device: Straddle::DeviceUnmaskedV1::OrHash,
+          email: String,
+          name: String,
+          phone: String,
+          type: Straddle::CustomerCreateParams::Type::OrSymbol,
+          address: T.nilable(Straddle::CustomerAddressV1::OrHash),
+          compliance_profile:
+            T.nilable(
+              T.any(
+                Straddle::CustomerCreateParams::ComplianceProfile::IndividualComplianceProfile::OrHash,
+                Straddle::CustomerCreateParams::ComplianceProfile::BusinessComplianceProfile::OrHash
+              )
+            ),
+          config: Straddle::CustomerCreateParams::Config::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CustomerV1)
+      end
+      def create(
+        # Body param:
+        device:,
+        # Body param: The customer's email address.
+        email:,
+        # Body param: Full name of the individual or business name.
+        name:,
+        # Body param: The customer's phone number in E.164 format. Mobile number is
+        # preferred.
+        phone:,
+        # Body param:
+        type:,
+        # Body param: An object containing the customer's address. **This is optional.**
+        # If used, all required fields must be present.
+        address: nil,
+        # Body param: An object containing the customer's compliance profile. **This is
+        # optional.** If all required fields must be present for the appropriate customer
+        # type.
+        compliance_profile: nil,
+        # Body param:
+        config: nil,
+        # Body param: Unique identifier for the customer in your database, used for
+        # cross-referencing between Straddle and your systems.
+        external_id: nil,
+        # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+        # additional information about the customer 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
+
+      # Updates an existing customer's information. This endpoint allows you to modify
+      # the customer's contact details, PII, and metadata.
+      sig do
+        params(
+          id: String,
+          device: Straddle::DeviceUnmaskedV1::OrHash,
+          email: String,
+          name: String,
+          phone: String,
+          status: Straddle::CustomerUpdateParams::Status::OrSymbol,
+          address: T.nilable(Straddle::CustomerAddressV1::OrHash),
+          compliance_profile:
+            T.nilable(
+              T.any(
+                Straddle::CustomerUpdateParams::ComplianceProfile::IndividualComplianceProfile::OrHash,
+                Straddle::CustomerUpdateParams::ComplianceProfile::BusinessComplianceProfile::OrHash
+              )
+            ),
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CustomerV1)
+      end
+      def update(
+        # Path param:
+        id,
+        # Body param:
+        device:,
+        # Body param: The customer's email address.
+        email:,
+        # Body param: The customer's full name or business name.
+        name:,
+        # Body param: The customer's phone number in E.164 format.
+        phone:,
+        # Body param:
+        status:,
+        # Body param: An object containing the customer's address. This is optional, but
+        # if provided, all required fields must be present.
+        address: nil,
+        # Body param: Individual PII data required to trigger Patriot Act compliant KYC
+        # verification.
+        compliance_profile: nil,
+        # Body param: Unique identifier for the customer in your database, used for
+        # cross-referencing between Straddle and your systems.
+        external_id: nil,
+        # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+        # additional information about the customer 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
+
+      # Lists or searches customers connected to your account. All supported query
+      # parameters are optional. If none are provided, the response will include all
+      # customers connected to your account. This endpoint supports advanced sorting and
+      # filtering options.
+      sig do
+        params(
+          created_from: Time,
+          created_to: Time,
+          email: String,
+          external_id: String,
+          name: String,
+          page_number: Integer,
+          page_size: Integer,
+          search_text: String,
+          sort_by: Straddle::CustomerListParams::SortBy::OrSymbol,
+          sort_order: Straddle::CustomerListParams::SortOrder::OrSymbol,
+          status: T::Array[Straddle::CustomerListParams::Status::OrSymbol],
+          types: T::Array[Straddle::CustomerListParams::Type::OrSymbol],
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(
+          Straddle::Internal::PageNumberSchema[
+            Straddle::CustomerSummaryPagedV1::Data
+          ]
+        )
+      end
+      def list(
+        # Query param: Start date for filtering by `created_at` date.
+        created_from: nil,
+        # Query param: End date for filtering by `created_at` date.
+        created_to: nil,
+        # Query param: Filter customers by `email` address.
+        email: nil,
+        # Query param: Filter by your system's `external_id`.
+        external_id: nil,
+        # Query param: Filter customers by `name` (partial match).
+        name: nil,
+        # Query param: Page number for paginated results. Starts at 1.
+        page_number: nil,
+        # Query param: Number of results per page. Maximum: 1000.
+        page_size: nil,
+        # Query param: General search term to filter customers.
+        search_text: nil,
+        # Query param:
+        sort_by: nil,
+        # Query param:
+        sort_order: nil,
+        # Query param: Filter customers by their current `status`.
+        status: nil,
+        # Query param: Filter by customer type `individual` or `business`.
+        types: 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` to set the scope
+        # of a request.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Permanently removes a customer record from Straddle. This action cannot be
+      # undone and should only be used to satisfy regulatory requirements or for privacy
+      # compliance.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CustomerV1)
+      end
+      def delete(
+        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
+
+      # Retrieves the details of an existing customer. Supply the unique customer ID
+      # that was returned from your 'create customer' request, and Straddle will return
+      # the corresponding customer information.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CustomerV1)
+      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
+
+      # Updates the decision of a customer's identity validation. This endpoint allows
+      # you to modify the outcome of a customer decision and is useful for correcting or
+      # updating the status of a customer's verification.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CustomerV1)
+      end
+      def refresh_review(
+        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
+
+      # Retrieves the unmasked details, including PII, of an existing customer. Supply
+      # the unique customer ID that was returned from your 'create customer' request,
+      # and Straddle will return the corresponding customer information. This endpoint
+      # needs to be enabled by Straddle and should only be used when absolutely
+      # necessary.
+      sig do
+        params(
+          id: String,
+          correlation_id: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CustomerUnmaskedV1)
+      end
+      def unmasked(
+        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/embed/accounts/capability_requests.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Embed
+      class Accounts
+        class CapabilityRequests
+          # Submits a request to enable a specific capability for an account. Use this
+          # endpoint to request additional features or services for an account.
+          sig do
+            params(
+              account_id: String,
+              businesses:
+                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Businesses::OrHash,
+              charges:
+                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Charges::OrHash,
+              individuals:
+                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Individuals::OrHash,
+              internet:
+                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Internet::OrHash,
+              payouts:
+                Straddle::Embed::Accounts::CapabilityRequestCreateParams::Payouts::OrHash,
+              signed_agreement:
+                Straddle::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement::OrHash,
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions::OrHash
+            ).returns(Straddle::Embed::Accounts::CapabilityRequestPagedV1)
+          end
+          def create(
+            # Path param:
+            account_id,
+            # Body param: Allows the account to accept payments from businesses.
+            businesses: nil,
+            # Body param: The charges capability settings for the account.
+            charges: nil,
+            # Body param: Allows the account to accept payments from individuals.
+            individuals: nil,
+            # Body param: Allows the account to accept payments authorized via the internet or
+            # mobile applications.
+            internet: nil,
+            # Body param: The payouts capability settings for the account.
+            payouts: nil,
+            # Body param: Allows the account to accept payments authorized by signed
+            # agreements or contracts.
+            signed_agreement: 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,
+            request_options: {}
+          )
+          end
+
+          # Retrieves a list of capability requests associated with an account. The requests
+          # are returned sorted by creation date, with the most recent requests appearing
+          # first. This endpoint supports advanced sorting and filtering options.
+          sig do
+            params(
+              account_id: String,
+              category:
+                Straddle::Embed::Accounts::CapabilityRequestListParams::Category::OrSymbol,
+              page_number: Integer,
+              page_size: Integer,
+              sort_by: String,
+              sort_order:
+                Straddle::Embed::Accounts::CapabilityRequestListParams::SortOrder::OrSymbol,
+              status:
+                Straddle::Embed::Accounts::CapabilityRequestListParams::Status::OrSymbol,
+              type:
+                Straddle::Embed::Accounts::CapabilityRequestListParams::Type::OrSymbol,
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions::OrHash
+            ).returns(
+              Straddle::Internal::PageNumberSchema[
+                Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data
+              ]
+            )
+          end
+          def list(
+            # Path param:
+            account_id,
+            # Query param: Filter capability requests by category.
+            category: nil,
+            # Query param: Results page number. Starts at page 1.
+            page_number: nil,
+            # Query param: Page size.Max value: 1000
+            page_size: nil,
+            # Query param: Sort By.
+            sort_by: nil,
+            # Query param: Sort Order.
+            sort_order: nil,
+            # Query param: Filter capability requests by their current status.
+            status: nil,
+            # Query param: Filter capability requests by the specific type of capability.
+            type: 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,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Straddle::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/resources/embed/accounts.rbi

@@ -0,0 +1,216 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    class Embed
+      class Accounts
+        sig do
+          returns(Straddle::Resources::Embed::Accounts::CapabilityRequests)
+        end
+        attr_reader :capability_requests
+
+        # Creates a new account associated with your Straddle platform integration. This
+        # endpoint allows you to set up an account with specified details, including
+        # business information and access levels.
+        sig do
+          params(
+            access_level:
+              Straddle::Embed::AccountCreateParams::AccessLevel::OrSymbol,
+            account_type:
+              Straddle::Embed::AccountCreateParams::AccountType::OrSymbol,
+            business_profile: Straddle::Embed::BusinessProfileV1::OrHash,
+            organization_id: String,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::AccountV1)
+        end
+        def create(
+          # Body param: The access level granted to the account. This is determined by your
+          # platform configuration. Use `standard` unless instructed otherwise by Straddle.
+          access_level:,
+          # Body param: The type of account to be created. Currently, only `business` is
+          # supported.
+          account_type:,
+          # Body param:
+          business_profile:,
+          # Body param: The unique identifier of the organization related to this account.
+          organization_id:,
+          # Body param: Unique identifier for the account in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: nil,
+          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+          # additional information about the account 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,
+          request_options: {}
+        )
+        end
+
+        # Updates an existing account's information. This endpoint allows you to update
+        # various account details during onboarding or after the account has been created.
+        sig do
+          params(
+            account_id: String,
+            business_profile: Straddle::Embed::BusinessProfileV1::OrHash,
+            external_id: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::AccountV1)
+        end
+        def update(
+          # Path param:
+          account_id,
+          # Body param:
+          business_profile:,
+          # Body param: Unique identifier for the account in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: nil,
+          # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
+          # additional information about the account 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,
+          request_options: {}
+        )
+        end
+
+        # Returns a list of accounts associated with your Straddle platform integration.
+        # The accounts are returned sorted by creation date, with the most recently
+        # created accounts appearing first. This endpoint supports advanced sorting and
+        # filtering options.
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            search_text: String,
+            sort_by: String,
+            sort_order: Straddle::Embed::AccountListParams::SortOrder::OrSymbol,
+            status: Straddle::Embed::AccountListParams::Status::OrSymbol,
+            type: Straddle::Embed::AccountListParams::Type::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(
+            Straddle::Internal::PageNumberSchema[
+              Straddle::Embed::AccountPagedV1::Data
+            ]
+          )
+        end
+        def list(
+          # Query param: Results page number. Starts at page 1. Default value: 1
+          page_number: nil,
+          # Query param: Page size. Default value: 100. Max value: 1000
+          page_size: nil,
+          # Query param:
+          search_text: nil,
+          # Query param: Sort By. Default value: 'id'.
+          sort_by: nil,
+          # Query param: Sort Order. Default value: 'asc'.
+          sort_order: nil,
+          # Query param:
+          status: nil,
+          # Query param:
+          type: 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,
+          request_options: {}
+        )
+        end
+
+        # Retrieves the details of an account that has previously been created. Supply the
+        # unique account ID that was returned from your previous request, and Straddle
+        # will return the corresponding account information.
+        sig do
+          params(
+            account_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::AccountV1)
+        end
+        def get(
+          # The unique identifier of the account to retrieve.
+          account_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,
+          request_options: {}
+        )
+        end
+
+        # Initiates the onboarding process for a new account. This endpoint can only be
+        # used for accounts where at least one representative and one bank account have
+        # already been created.
+        sig do
+          params(
+            account_id: String,
+            terms_of_service: Straddle::Embed::TermsOfServiceV1::OrHash,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::AccountV1)
+        end
+        def onboard(
+          # Path param:
+          account_id,
+          # Body param:
+          terms_of_service:,
+          # 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,
+          request_options: {}
+        )
+        end
+
+        # Simulate the status transitions for sandbox accounts. This endpoint can only be
+        # used for sandbox accounts.
+        sig do
+          params(
+            account_id: String,
+            final_status:
+              Straddle::Embed::AccountSimulateParams::FinalStatus::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(Straddle::Embed::AccountV1)
+        end
+        def simulate(
+          # Path param:
+          account_id,
+          # Query param:
+          final_status: 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,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Straddle::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end