straddle 0.1.0.pre.alpha.1

data/rbi/straddle/models/embed/organization_list_params.rbi

@@ -0,0 +1,169 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class OrganizationListParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Embed::OrganizationListParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        # List organizations by their external ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :external_id
+
+        sig { params(external_id: String).void }
+        attr_writer :external_id
+
+        # List organizations by name (partial match supported).
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # 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
+
+        # 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::OrganizationListParams::SortOrder::OrSymbol
+            )
+          )
+        end
+        attr_reader :sort_order
+
+        sig do
+          params(
+            sort_order:
+              Straddle::Embed::OrganizationListParams::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(
+            external_id: String,
+            name: String,
+            page_number: Integer,
+            page_size: Integer,
+            sort_by: String,
+            sort_order:
+              Straddle::Embed::OrganizationListParams::SortOrder::OrSymbol,
+            correlation_id: String,
+            request_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # List organizations by their external ID.
+          external_id: nil,
+          # List organizations by name (partial match supported).
+          name: nil,
+          # Results page number. Starts at page 1.
+          page_number: nil,
+          # Page size. Max value: 1000
+          page_size: nil,
+          # Sort By.
+          sort_by: nil,
+          # Sort Order.
+          sort_order: nil,
+          correlation_id: nil,
+          request_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              external_id: String,
+              name: String,
+              page_number: Integer,
+              page_size: Integer,
+              sort_by: String,
+              sort_order:
+                Straddle::Embed::OrganizationListParams::SortOrder::OrSymbol,
+              correlation_id: String,
+              request_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Sort Order.
+        module SortOrder
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Embed::OrganizationListParams::SortOrder)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ASC =
+            T.let(
+              :asc,
+              Straddle::Embed::OrganizationListParams::SortOrder::TaggedSymbol
+            )
+          DESC =
+            T.let(
+              :desc,
+              Straddle::Embed::OrganizationListParams::SortOrder::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Embed::OrganizationListParams::SortOrder::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/embed/organization_paged_v1.rbi

@@ -0,0 +1,206 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class OrganizationPagedV1 < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Embed::OrganizationPagedV1,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[Straddle::Embed::OrganizationPagedV1::Data]) }
+        attr_accessor :data
+
+        # Metadata about the API request, including an identifier, timestamp, and
+        # pagination details.
+        sig { returns(Straddle::PagedResponseMetadata) }
+        attr_reader :meta
+
+        sig { params(meta: Straddle::PagedResponseMetadata::OrHash).void }
+        attr_writer :meta
+
+        # Indicates the structure of the returned content.
+        #
+        # - "object" means the `data` field contains a single JSON object.
+        # - "array" means the `data` field contains an array of objects.
+        # - "error" means the `data` field contains an error object with details of the
+        #   issue.
+        # - "none" means no data is returned.
+        sig do
+          returns(
+            Straddle::Embed::OrganizationPagedV1::ResponseType::TaggedSymbol
+          )
+        end
+        attr_accessor :response_type
+
+        sig do
+          params(
+            data: T::Array[Straddle::Embed::OrganizationPagedV1::Data::OrHash],
+            meta: Straddle::PagedResponseMetadata::OrHash,
+            response_type:
+              Straddle::Embed::OrganizationPagedV1::ResponseType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          data:,
+          # Metadata about the API request, including an identifier, timestamp, and
+          # pagination details.
+          meta:,
+          # Indicates the structure of the returned content.
+          #
+          # - "object" means the `data` field contains a single JSON object.
+          # - "array" means the `data` field contains an array of objects.
+          # - "error" means the `data` field contains an error object with details of the
+          #   issue.
+          # - "none" means no data is returned.
+          response_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T::Array[Straddle::Embed::OrganizationPagedV1::Data],
+              meta: Straddle::PagedResponseMetadata,
+              response_type:
+                Straddle::Embed::OrganizationPagedV1::ResponseType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::Embed::OrganizationPagedV1::Data,
+                Straddle::Internal::AnyHash
+              )
+            end
+
+          # Straddle's unique identifier for the organization.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Timestamp of when the organization was created.
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # The name of the organization.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Timestamp of the most recent update to the organization.
+          sig { returns(Time) }
+          attr_accessor :updated_at
+
+          # Unique identifier for the organization in your database, used for
+          # cross-referencing between Straddle and your systems.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_id
+
+          # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+          # information about the organization in a structured format.
+          sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+          attr_accessor :metadata
+
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              name: String,
+              updated_at: Time,
+              external_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Straddle's unique identifier for the organization.
+            id:,
+            # Timestamp of when the organization was created.
+            created_at:,
+            # The name of the organization.
+            name:,
+            # Timestamp of the most recent update to the organization.
+            updated_at:,
+            # Unique identifier for the organization in your database, used for
+            # cross-referencing between Straddle and your systems.
+            external_id: nil,
+            # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+            # information about the organization in a structured format.
+            metadata: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                name: String,
+                updated_at: Time,
+                external_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Indicates the structure of the returned content.
+        #
+        # - "object" means the `data` field contains a single JSON object.
+        # - "array" means the `data` field contains an array of objects.
+        # - "error" means the `data` field contains an error object with details of the
+        #   issue.
+        # - "none" means no data is returned.
+        module ResponseType
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Embed::OrganizationPagedV1::ResponseType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          OBJECT =
+            T.let(
+              :object,
+              Straddle::Embed::OrganizationPagedV1::ResponseType::TaggedSymbol
+            )
+          ARRAY =
+            T.let(
+              :array,
+              Straddle::Embed::OrganizationPagedV1::ResponseType::TaggedSymbol
+            )
+          ERROR =
+            T.let(
+              :error,
+              Straddle::Embed::OrganizationPagedV1::ResponseType::TaggedSymbol
+            )
+          NONE =
+            T.let(
+              :none,
+              Straddle::Embed::OrganizationPagedV1::ResponseType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Embed::OrganizationPagedV1::ResponseType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/straddle/models/embed/organization_v1.rbi

@@ -0,0 +1,202 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Embed
+      class OrganizationV1 < Straddle::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Straddle::Embed::OrganizationV1, Straddle::Internal::AnyHash)
+          end
+
+        sig { returns(Straddle::Embed::OrganizationV1::Data) }
+        attr_reader :data
+
+        sig { params(data: Straddle::Embed::OrganizationV1::Data::OrHash).void }
+        attr_writer :data
+
+        # Metadata about the API request, including an identifier and timestamp.
+        sig { returns(Straddle::ResponseMetadata) }
+        attr_reader :meta
+
+        sig { params(meta: Straddle::ResponseMetadata::OrHash).void }
+        attr_writer :meta
+
+        # Indicates the structure of the returned content.
+        #
+        # - "object" means the `data` field contains a single JSON object.
+        # - "array" means the `data` field contains an array of objects.
+        # - "error" means the `data` field contains an error object with details of the
+        #   issue.
+        # - "none" means no data is returned.
+        sig do
+          returns(Straddle::Embed::OrganizationV1::ResponseType::TaggedSymbol)
+        end
+        attr_accessor :response_type
+
+        sig do
+          params(
+            data: Straddle::Embed::OrganizationV1::Data::OrHash,
+            meta: Straddle::ResponseMetadata::OrHash,
+            response_type:
+              Straddle::Embed::OrganizationV1::ResponseType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          data:,
+          # Metadata about the API request, including an identifier and timestamp.
+          meta:,
+          # Indicates the structure of the returned content.
+          #
+          # - "object" means the `data` field contains a single JSON object.
+          # - "array" means the `data` field contains an array of objects.
+          # - "error" means the `data` field contains an error object with details of the
+          #   issue.
+          # - "none" means no data is returned.
+          response_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: Straddle::Embed::OrganizationV1::Data,
+              meta: Straddle::ResponseMetadata,
+              response_type:
+                Straddle::Embed::OrganizationV1::ResponseType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::Embed::OrganizationV1::Data,
+                Straddle::Internal::AnyHash
+              )
+            end
+
+          # Straddle's unique identifier for the organization.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Timestamp of when the organization was created.
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # The name of the organization.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Timestamp of the most recent update to the organization.
+          sig { returns(Time) }
+          attr_accessor :updated_at
+
+          # Unique identifier for the organization in your database, used for
+          # cross-referencing between Straddle and your systems.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_id
+
+          # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+          # information about the organization in a structured format.
+          sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+          attr_accessor :metadata
+
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              name: String,
+              updated_at: Time,
+              external_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Straddle's unique identifier for the organization.
+            id:,
+            # Timestamp of when the organization was created.
+            created_at:,
+            # The name of the organization.
+            name:,
+            # Timestamp of the most recent update to the organization.
+            updated_at:,
+            # Unique identifier for the organization in your database, used for
+            # cross-referencing between Straddle and your systems.
+            external_id: nil,
+            # Up to 20 additional user-defined key-value pairs. Useful for storing additional
+            # information about the organization in a structured format.
+            metadata: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                name: String,
+                updated_at: Time,
+                external_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Indicates the structure of the returned content.
+        #
+        # - "object" means the `data` field contains a single JSON object.
+        # - "array" means the `data` field contains an array of objects.
+        # - "error" means the `data` field contains an error object with details of the
+        #   issue.
+        # - "none" means no data is returned.
+        module ResponseType
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Embed::OrganizationV1::ResponseType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          OBJECT =
+            T.let(
+              :object,
+              Straddle::Embed::OrganizationV1::ResponseType::TaggedSymbol
+            )
+          ARRAY =
+            T.let(
+              :array,
+              Straddle::Embed::OrganizationV1::ResponseType::TaggedSymbol
+            )
+          ERROR =
+            T.let(
+              :error,
+              Straddle::Embed::OrganizationV1::ResponseType::TaggedSymbol
+            )
+          NONE =
+            T.let(
+              :none,
+              Straddle::Embed::OrganizationV1::ResponseType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Embed::OrganizationV1::ResponseType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end