straddle 0.1.0.pre.alpha.1

data/rbi/straddle/models/embed/representative_create_params.rbi

@@ -0,0 +1,225 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class RepresentativeCreateParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Embed::RepresentativeCreateParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier of the account this representative is associated with.
+        sig { returns(String) }
+        attr_accessor :account_id
+
+        # Date of birth for the representative in ISO 8601 format (YYYY-MM-DD).
+        sig { returns(Date) }
+        attr_accessor :dob
+
+        # The company email address of the representative.
+        sig { returns(String) }
+        attr_accessor :email
+
+        # The first name of the representative.
+        sig { returns(String) }
+        attr_accessor :first_name
+
+        # The last name of the representative.
+        sig { returns(String) }
+        attr_accessor :last_name
+
+        # The mobile phone number of the representative.
+        sig { returns(String) }
+        attr_accessor :mobile_number
+
+        sig do
+          returns(Straddle::Embed::RepresentativeCreateParams::Relationship)
+        end
+        attr_reader :relationship
+
+        sig do
+          params(
+            relationship:
+              Straddle::Embed::RepresentativeCreateParams::Relationship::OrHash
+          ).void
+        end
+        attr_writer :relationship
+
+        # The last 4 digits of the representative's Social Security Number.
+        sig { returns(String) }
+        attr_accessor :ssn_last4
+
+        # Unique identifier for the representative in your database, used for
+        # cross-referencing between Straddle and your systems.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        sig do
+          params(
+            account_id: String,
+            dob: Date,
+            email: String,
+            first_name: String,
+            last_name: String,
+            mobile_number: String,
+            relationship:
+              Straddle::Embed::RepresentativeCreateParams::Relationship::OrHash,
+            ssn_last4: String,
+            external_id: T.nilable(String),
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier of the account this representative is associated with.
+          account_id:,
+          # Date of birth for the representative in ISO 8601 format (YYYY-MM-DD).
+          dob:,
+          # The company email address of the representative.
+          email:,
+          # The first name of the representative.
+          first_name:,
+          # The last name of the representative.
+          last_name:,
+          # The mobile phone number of the representative.
+          mobile_number:,
+          relationship:,
+          # The last 4 digits of the representative's Social Security Number.
+          ssn_last4:,
+          # Unique identifier for the representative in your database, used for
+          # cross-referencing between Straddle and your systems.
+          external_id: nil,
+          correlation_id: nil,
+          request_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_id: String,
+              dob: Date,
+              email: String,
+              first_name: String,
+              last_name: String,
+              mobile_number: String,
+              relationship:
+                Straddle::Embed::RepresentativeCreateParams::Relationship,
+              ssn_last4: String,
+              external_id: T.nilable(String),
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Relationship < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::Embed::RepresentativeCreateParams::Relationship,
+                Straddle::Internal::AnyHash
+              )
+            end
+
+          # Whether the representative has significant responsibility to control, manage, or
+          # direct the organization. One representative must be identified under the control
+          # prong for each legal entity.
+          sig { returns(T::Boolean) }
+          attr_accessor :control
+
+          # Whether the representative owns any percentage of of the equity interests of the
+          # legal entity.
+          sig { returns(T::Boolean) }
+          attr_accessor :owner
+
+          # Whether the person is authorized as the primary representative of the account.
+          # This is the person chosen by the business to provide information about
+          # themselves, general information about the account, and who consented to the
+          # services agreement.
+          #
+          # There can be only one primary representative for an account at a time.
+          sig { returns(T::Boolean) }
+          attr_accessor :primary
+
+          # The percentage of ownership the representative has. Required if 'Owner' is true.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :percent_ownership
+
+          # The job title of the representative.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :title
+
+          sig do
+            params(
+              control: T::Boolean,
+              owner: T::Boolean,
+              primary: T::Boolean,
+              percent_ownership: T.nilable(Float),
+              title: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Whether the representative has significant responsibility to control, manage, or
+            # direct the organization. One representative must be identified under the control
+            # prong for each legal entity.
+            control:,
+            # Whether the representative owns any percentage of of the equity interests of the
+            # legal entity.
+            owner:,
+            # Whether the person is authorized as the primary representative of the account.
+            # This is the person chosen by the business to provide information about
+            # themselves, general information about the account, and who consented to the
+            # services agreement.
+            #
+            # There can be only one primary representative for an account at a time.
+            primary:,
+            # The percentage of ownership the representative has. Required if 'Owner' is true.
+            percent_ownership: nil,
+            # The job title of the representative.
+            title: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                control: T::Boolean,
+                owner: T::Boolean,
+                primary: T::Boolean,
+                percent_ownership: T.nilable(Float),
+                title: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/embed/representative_get_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class RepresentativeGetParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Embed::RepresentativeGetParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        sig do
+          params(
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(correlation_id: nil, request_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/embed/representative_list_params.rbi

@@ -0,0 +1,229 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class RepresentativeListParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Embed::RepresentativeListParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier of the account to list representatives for.
+        sig { returns(T.nilable(String)) }
+        attr_reader :account_id
+
+        sig { params(account_id: String).void }
+        attr_writer :account_id
+
+        sig do
+          returns(
+            T.nilable(
+              Straddle::Embed::RepresentativeListParams::Level::OrSymbol
+            )
+          )
+        end
+        attr_reader :level
+
+        sig do
+          params(
+            level: Straddle::Embed::RepresentativeListParams::Level::OrSymbol
+          ).void
+        end
+        attr_writer :level
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :organization_id
+
+        sig { params(organization_id: String).void }
+        attr_writer :organization_id
+
+        # Results page number. Starts at page 1.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Page size. Max value: 1000
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :platform_id
+
+        sig { params(platform_id: String).void }
+        attr_writer :platform_id
+
+        # Sort By.
+        sig { returns(T.nilable(String)) }
+        attr_reader :sort_by
+
+        sig { params(sort_by: String).void }
+        attr_writer :sort_by
+
+        # Sort Order.
+        sig do
+          returns(
+            T.nilable(
+              Straddle::Embed::RepresentativeListParams::SortOrder::OrSymbol
+            )
+          )
+        end
+        attr_reader :sort_order
+
+        sig do
+          params(
+            sort_order:
+              Straddle::Embed::RepresentativeListParams::SortOrder::OrSymbol
+          ).void
+        end
+        attr_writer :sort_order
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        sig do
+          params(
+            account_id: String,
+            level: Straddle::Embed::RepresentativeListParams::Level::OrSymbol,
+            organization_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            platform_id: String,
+            sort_by: String,
+            sort_order:
+              Straddle::Embed::RepresentativeListParams::SortOrder::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier of the account to list representatives for.
+          account_id: nil,
+          level: nil,
+          organization_id: nil,
+          # Results page number. Starts at page 1.
+          page_number: nil,
+          # Page size. Max value: 1000
+          page_size: nil,
+          platform_id: nil,
+          # Sort By.
+          sort_by: nil,
+          # Sort Order.
+          sort_order: nil,
+          correlation_id: nil,
+          request_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_id: String,
+              level: Straddle::Embed::RepresentativeListParams::Level::OrSymbol,
+              organization_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              platform_id: String,
+              sort_by: String,
+              sort_order:
+                Straddle::Embed::RepresentativeListParams::SortOrder::OrSymbol,
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Level
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Embed::RepresentativeListParams::Level)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACCOUNT =
+            T.let(
+              :account,
+              Straddle::Embed::RepresentativeListParams::Level::TaggedSymbol
+            )
+          PLATFORM =
+            T.let(
+              :platform,
+              Straddle::Embed::RepresentativeListParams::Level::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Embed::RepresentativeListParams::Level::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Sort Order.
+        module SortOrder
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Straddle::Embed::RepresentativeListParams::SortOrder
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ASC =
+            T.let(
+              :asc,
+              Straddle::Embed::RepresentativeListParams::SortOrder::TaggedSymbol
+            )
+          DESC =
+            T.let(
+              :desc,
+              Straddle::Embed::RepresentativeListParams::SortOrder::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Embed::RepresentativeListParams::SortOrder::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end