straddle 0.4.0 → 1.0.0

data/rbi/straddle/models/representative_list_params.rbi

@@ -0,0 +1,217 @@
+# typed: strong
+
+module Straddle
+  module Models
+    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::RepresentativeListParams, Straddle::Internal::AnyHash)
+        end
+
+      # Account ID used to filter the results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # Scope of representatives to return.
+      sig do
+        returns(T.nilable(Straddle::RepresentativeListParams::Level::OrSymbol))
+      end
+      attr_reader :level
+
+      sig do
+        params(level: Straddle::RepresentativeListParams::Level::OrSymbol).void
+      end
+      attr_writer :level
+
+      # Organization ID used to filter the results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :organization_id
+
+      sig { params(organization_id: String).void }
+      attr_writer :organization_id
+
+      # Page number. Defaults to `1`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Number of results per page. Defaults to `100`. Maximum `1000`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Platform ID used to filter the results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :platform_id
+
+      sig { params(platform_id: String).void }
+      attr_writer :platform_id
+
+      # Field used to sort results. Defaults to `id`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sort_by
+
+      sig { params(sort_by: String).void }
+      attr_writer :sort_by
+
+      # Sort direction. Defaults to `asc`.
+      sig do
+        returns(
+          T.nilable(Straddle::RepresentativeListParams::SortOrder::OrSymbol)
+        )
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order: Straddle::RepresentativeListParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated identifier for tracing one request.
+      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::RepresentativeListParams::Level::OrSymbol,
+          organization_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          platform_id: String,
+          sort_by: String,
+          sort_order: Straddle::RepresentativeListParams::SortOrder::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Account ID used to filter the results.
+        account_id: nil,
+        # Scope of representatives to return.
+        level: nil,
+        # Organization ID used to filter the results.
+        organization_id: nil,
+        # Page number. Defaults to `1`.
+        page_number: nil,
+        # Number of results per page. Defaults to `100`. Maximum `1000`.
+        page_size: nil,
+        # Platform ID used to filter the results.
+        platform_id: nil,
+        # Field used to sort results. Defaults to `id`.
+        sort_by: nil,
+        # Sort direction. Defaults to `asc`.
+        sort_order: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            level: Straddle::RepresentativeListParams::Level::OrSymbol,
+            organization_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            platform_id: String,
+            sort_by: String,
+            sort_order: Straddle::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::RepresentativeListParams::Level)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCOUNT =
+          T.let(
+            :account,
+            Straddle::RepresentativeListParams::Level::TaggedSymbol
+          )
+        PLATFORM =
+          T.let(
+            :platform,
+            Straddle::RepresentativeListParams::Level::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::RepresentativeListParams::Level::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::RepresentativeListParams::SortOrder)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(
+            :asc,
+            Straddle::RepresentativeListParams::SortOrder::TaggedSymbol
+          )
+        DESC =
+          T.let(
+            :desc,
+            Straddle::RepresentativeListParams::SortOrder::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::RepresentativeListParams::SortOrder::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/representative_list_unmasked_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class RepresentativeListUnmaskedParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::RepresentativeListUnmaskedParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :representative_id
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig do
+        params(
+          representative_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        representative_id:,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            representative_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/representative_relationship.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class RepresentativeRelationship < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::RepresentativeRelationship,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Whether the representative controls, manages, or directs the business. Each
+      # legal entity must have one representative with `control` set to `true`.
+      sig { returns(T::Boolean) }
+      attr_accessor :control
+
+      # Whether the representative owns any equity in the business.
+      sig { returns(T::Boolean) }
+      attr_accessor :owner
+
+      # Whether this person is the account's primary representative. The primary
+      # representative provides personal and business information and accepts the
+      # services agreement. An account can have only one primary representative.
+      sig { returns(T::Boolean) }
+      attr_accessor :primary
+
+      # The representative's ownership percentage. Required when `owner` is `true`.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :percent_ownership
+
+      # The representative's job title.
+      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 controls, manages, or directs the business. Each
+        # legal entity must have one representative with `control` set to `true`.
+        control:,
+        # Whether the representative owns any equity in the business.
+        owner:,
+        # Whether this person is the account's primary representative. The primary
+        # representative provides personal and business information and accepts the
+        # services agreement. An account can have only one primary representative.
+        primary:,
+        # The representative's ownership percentage. Required when `owner` is `true`.
+        percent_ownership: nil,
+        # The representative's job title.
+        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

data/rbi/straddle/models/representative_response.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class RepresentativeResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::RepresentativeResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::Representative) }
+      attr_reader :data
+
+      sig { params(data: Straddle::Representative::OrHash).void }
+      attr_writer :data
+
+      # Metadata for an API request.
+      sig { returns(Straddle::ResponseMetadata) }
+      attr_reader :meta
+
+      sig { params(meta: Straddle::ResponseMetadata::OrHash).void }
+      attr_writer :meta
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      sig do
+        returns(Straddle::RepresentativeResponse::ResponseType::TaggedSymbol)
+      end
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: Straddle::Representative::OrHash,
+          meta: Straddle::ResponseMetadata::OrHash,
+          response_type:
+            Straddle::RepresentativeResponse::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Metadata for an API request.
+        meta:,
+        # Indicates how the response content is structured.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of objects.
+        # - `error` means `error` contains error details.
+        # - `none` means the response has no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Straddle::Representative,
+            meta: Straddle::ResponseMetadata,
+            response_type:
+              Straddle::RepresentativeResponse::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::RepresentativeResponse::ResponseType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OBJECT =
+          T.let(
+            :object,
+            Straddle::RepresentativeResponse::ResponseType::TaggedSymbol
+          )
+        ARRAY =
+          T.let(
+            :array,
+            Straddle::RepresentativeResponse::ResponseType::TaggedSymbol
+          )
+        ERROR =
+          T.let(
+            :error,
+            Straddle::RepresentativeResponse::ResponseType::TaggedSymbol
+          )
+        NONE =
+          T.let(
+            :none,
+            Straddle::RepresentativeResponse::ResponseType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Straddle::RepresentativeResponse::ResponseType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/representative_retrieve_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class RepresentativeRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::RepresentativeRetrieveParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :representative_id
+
+      # Optional client-generated identifier for tracing a series of related requests.
+      sig { returns(T.nilable(String)) }
+      attr_reader :correlation_id
+
+      sig { params(correlation_id: String).void }
+      attr_writer :correlation_id
+
+      # Optional client-generated identifier for tracing one request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :request_id
+
+      sig { params(request_id: String).void }
+      attr_writer :request_id
+
+      sig do
+        params(
+          representative_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        representative_id:,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            representative_id: String,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/representative_status_detail.rbi

@@ -0,0 +1,153 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class RepresentativeStatusDetail < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::RepresentativeStatusDetail,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      # Machine-readable status code from the source.
+      sig { returns(String) }
+      attr_accessor :code
+
+      # Human-readable description of the representative's status.
+      sig { returns(String) }
+      attr_accessor :message
+
+      # Machine-readable reason for the representative's status.
+      sig do
+        returns(Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol)
+      end
+      attr_accessor :reason
+
+      # System that produced the representative status detail.
+      sig do
+        returns(Straddle::RepresentativeStatusDetail::Source::TaggedSymbol)
+      end
+      attr_accessor :source
+
+      sig do
+        params(
+          code: String,
+          message: String,
+          reason: Straddle::RepresentativeStatusDetail::Reason::OrSymbol,
+          source: Straddle::RepresentativeStatusDetail::Source::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Machine-readable status code from the source.
+        code:,
+        # Human-readable description of the representative's status.
+        message:,
+        # Machine-readable reason for the representative's status.
+        reason:,
+        # System that produced the representative status detail.
+        source:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: String,
+            message: String,
+            reason: Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol,
+            source: Straddle::RepresentativeStatusDetail::Source::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Machine-readable reason for the representative's status.
+      module Reason
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::RepresentativeStatusDetail::Reason)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UNVERIFIED =
+          T.let(
+            :unverified,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+        IN_REVIEW =
+          T.let(
+            :in_review,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :pending,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+        STUCK =
+          T.let(
+            :stuck,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+        VERIFIED =
+          T.let(
+            :verified,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+        FAILED_VERIFICATION =
+          T.let(
+            :failed_verification,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+        DISABLED =
+          T.let(
+            :disabled,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+        NEW =
+          T.let(
+            :new,
+            Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::RepresentativeStatusDetail::Reason::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # System that produced the representative status detail.
+      module Source
+        extend Straddle::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Straddle::RepresentativeStatusDetail::Source)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WATCHTOWER =
+          T.let(
+            :watchtower,
+            Straddle::RepresentativeStatusDetail::Source::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Straddle::RepresentativeStatusDetail::Source::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end