straddle 0.4.0 → 1.0.0

data/lib/straddle/models/embed/linked_bank_account_v1.rb

@@ -1,292 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    module Embed
-      # @see Straddle::Resources::Embed::LinkedBankAccounts#create
-      class LinkedBankAccountV1 < Straddle::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Straddle::Models::Embed::LinkedBankAccountV1::Data]
-        required :data, -> { Straddle::Embed::LinkedBankAccountV1::Data }
-
-        # @!attribute meta
-        #   Metadata about the API request, including an identifier and timestamp.
-        #
-        #   @return [Straddle::Models::ResponseMetadata]
-        required :meta, -> { Straddle::ResponseMetadata }
-
-        # @!attribute response_type
-        #   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.
-        #
-        #   @return [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::ResponseType]
-        required :response_type, enum: -> { Straddle::Embed::LinkedBankAccountV1::ResponseType }
-
-        # @!method initialize(data:, meta:, response_type:)
-        #   Some parameter documentations has been truncated, see
-        #   {Straddle::Models::Embed::LinkedBankAccountV1} for more details.
-        #
-        #   @param data [Straddle::Models::Embed::LinkedBankAccountV1::Data]
-        #
-        #   @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
-        #
-        #   @param response_type [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::ResponseType] Indicates the structure of the returned content.
-
-        # @see Straddle::Models::Embed::LinkedBankAccountV1#data
-        class Data < Straddle::Internal::Type::BaseModel
-          # @!attribute id
-          #   Unique identifier for the linked bank account.
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute account_id
-          #   The unique identifier of the Straddle account related to this bank account.
-          #
-          #   @return [String, nil]
-          required :account_id, String, nil?: true
-
-          # @!attribute bank_account
-          #
-          #   @return [Straddle::Models::Embed::LinkedBankAccountV1::Data::BankAccount]
-          required :bank_account, -> { Straddle::Embed::LinkedBankAccountV1::Data::BankAccount }
-
-          # @!attribute created_at
-          #   Timestamp of when the bank account object was created.
-          #
-          #   @return [Time]
-          required :created_at, Time
-
-          # @!attribute purposes
-          #   The purposes for the linked bank account.
-          #
-          #   @return [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::Purpose>]
-          required :purposes,
-                   -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::Embed::LinkedBankAccountV1::Data::Purpose] }
-
-          # @!attribute status
-          #   The current status of the linked bank account.
-          #
-          #   @return [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::Status]
-          required :status, enum: -> { Straddle::Embed::LinkedBankAccountV1::Data::Status }
-
-          # @!attribute status_detail
-          #
-          #   @return [Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail]
-          required :status_detail, -> { Straddle::Embed::LinkedBankAccountV1::Data::StatusDetail }
-
-          # @!attribute updated_at
-          #   Timestamp of the most recent update to the linked bank account.
-          #
-          #   @return [Time]
-          required :updated_at, Time
-
-          # @!attribute description
-          #   Optional description for the bank account.
-          #
-          #   @return [String, nil]
-          optional :description, String, nil?: true
-
-          # @!attribute metadata
-          #   Up to 20 additional user-defined key-value pairs. Useful for storing additional
-          #   information about the linked bank account in a structured format.
-          #
-          #   @return [Hash{Symbol=>String, nil}, nil]
-          optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
-
-          # @!attribute platform_id
-          #   The unique identifier of the Straddle Platform relatd to this bank account.
-          #
-          #   @return [String, nil]
-          optional :platform_id, String, nil?: true
-
-          # @!method initialize(id:, account_id:, bank_account:, created_at:, purposes:, status:, status_detail:, updated_at:, description: nil, metadata: nil, platform_id: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Straddle::Models::Embed::LinkedBankAccountV1::Data} for more details.
-          #
-          #   @param id [String] Unique identifier for the linked bank account.
-          #
-          #   @param account_id [String, nil] The unique identifier of the Straddle account related to this bank account.
-          #
-          #   @param bank_account [Straddle::Models::Embed::LinkedBankAccountV1::Data::BankAccount]
-          #
-          #   @param created_at [Time] Timestamp of when the bank account object was created.
-          #
-          #   @param purposes [Array<Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::Purpose>] The purposes for the linked bank account.
-          #
-          #   @param status [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::Status] The current status of the linked bank account.
-          #
-          #   @param status_detail [Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail]
-          #
-          #   @param updated_at [Time] Timestamp of the most recent update to the linked bank account.
-          #
-          #   @param description [String, nil] Optional description for the bank account.
-          #
-          #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
-          #
-          #   @param platform_id [String, nil] The unique identifier of the Straddle Platform relatd to this bank account.
-
-          # @see Straddle::Models::Embed::LinkedBankAccountV1::Data#bank_account
-          class BankAccount < Straddle::Internal::Type::BaseModel
-            # @!attribute account_holder
-            #
-            #   @return [String]
-            required :account_holder, String
-
-            # @!attribute account_mask
-            #
-            #   @return [String]
-            required :account_mask, String
-
-            # @!attribute institution_name
-            #
-            #   @return [String]
-            required :institution_name, String
-
-            # @!attribute routing_number
-            #
-            #   @return [String]
-            required :routing_number, String
-
-            # @!method initialize(account_holder:, account_mask:, institution_name:, routing_number:)
-            #   @param account_holder [String]
-            #   @param account_mask [String]
-            #   @param institution_name [String]
-            #   @param routing_number [String]
-          end
-
-          module Purpose
-            extend Straddle::Internal::Type::Enum
-
-            CHARGES = :charges
-            PAYOUTS = :payouts
-            BILLING = :billing
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          # The current status of the linked bank account.
-          #
-          # @see Straddle::Models::Embed::LinkedBankAccountV1::Data#status
-          module Status
-            extend Straddle::Internal::Type::Enum
-
-            CREATED = :created
-            ONBOARDING = :onboarding
-            ACTIVE = :active
-            REJECTED = :rejected
-            INACTIVE = :inactive
-            CANCELED = :canceled
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          # @see Straddle::Models::Embed::LinkedBankAccountV1::Data#status_detail
-          class StatusDetail < Straddle::Internal::Type::BaseModel
-            # @!attribute code
-            #   A machine-readable code for the specific status, useful for programmatic
-            #   handling.
-            #
-            #   @return [String]
-            required :code, String
-
-            # @!attribute message
-            #   A human-readable message describing the current status.
-            #
-            #   @return [String]
-            required :message, String
-
-            # @!attribute reason
-            #   A machine-readable identifier for the specific status, useful for programmatic
-            #   handling.
-            #
-            #   @return [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail::Reason]
-            required :reason, enum: -> { Straddle::Embed::LinkedBankAccountV1::Data::StatusDetail::Reason }
-
-            # @!attribute source
-            #   Identifies the origin of the status change (e.g., `watchtower`). This helps in
-            #   tracking the cause of status updates.
-            #
-            #   @return [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail::Source]
-            required :source, enum: -> { Straddle::Embed::LinkedBankAccountV1::Data::StatusDetail::Source }
-
-            # @!method initialize(code:, message:, reason:, source:)
-            #   Some parameter documentations has been truncated, see
-            #   {Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail} for more
-            #   details.
-            #
-            #   @param code [String] A machine-readable code for the specific status, useful for programmatic handlin
-            #
-            #   @param message [String] A human-readable message describing the current status.
-            #
-            #   @param reason [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail::Reason] A machine-readable identifier for the specific status, useful for programmatic h
-            #
-            #   @param source [Symbol, Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail::Source] Identifies the origin of the status change (e.g., `watchtower`). This helps in t
-
-            # A machine-readable identifier for the specific status, useful for programmatic
-            # handling.
-            #
-            # @see Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail#reason
-            module Reason
-              extend Straddle::Internal::Type::Enum
-
-              UNVERIFIED = :unverified
-              IN_REVIEW = :in_review
-              PENDING = :pending
-              STUCK = :stuck
-              VERIFIED = :verified
-              FAILED_VERIFICATION = :failed_verification
-              DISABLED = :disabled
-              NEW = :new
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-
-            # Identifies the origin of the status change (e.g., `watchtower`). This helps in
-            # tracking the cause of status updates.
-            #
-            # @see Straddle::Models::Embed::LinkedBankAccountV1::Data::StatusDetail#source
-            module Source
-              extend Straddle::Internal::Type::Enum
-
-              WATCHTOWER = :watchtower
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          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.
-        #
-        # @see Straddle::Models::Embed::LinkedBankAccountV1#response_type
-        module ResponseType
-          extend Straddle::Internal::Type::Enum
-
-          OBJECT = :object
-          ARRAY = :array
-          ERROR = :error
-          NONE = :none
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/straddle/models/embed/organization_create_params.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    module Embed
-      # @see Straddle::Resources::Embed::Organizations#create
-      class OrganizationCreateParams < Straddle::Internal::Type::BaseModel
-        extend Straddle::Internal::Type::RequestParameters::Converter
-        include Straddle::Internal::Type::RequestParameters
-
-        # @!attribute name
-        #   The name of the organization.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute external_id
-        #   Unique identifier for the organization in your database, used for
-        #   cross-referencing between Straddle and your systems.
-        #
-        #   @return [String, nil]
-        optional :external_id, String, nil?: true
-
-        # @!attribute metadata
-        #   Up to 20 additional user-defined key-value pairs. Useful for storing additional
-        #   information about the organization in a structured format.
-        #
-        #   @return [Hash{Symbol=>String, nil}, nil]
-        optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
-
-        # @!attribute correlation_id
-        #
-        #   @return [String, nil]
-        optional :correlation_id, String
-
-        # @!attribute idempotency_key
-        #
-        #   @return [String, nil]
-        optional :idempotency_key, String
-
-        # @!attribute request_id
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!method initialize(name:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {Straddle::Models::Embed::OrganizationCreateParams} for more details.
-        #
-        #   @param name [String] The name of the organization.
-        #
-        #   @param external_id [String, nil] Unique identifier for the organization in your database, used for cross-referenc
-        #
-        #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
-        #
-        #   @param correlation_id [String]
-        #
-        #   @param idempotency_key [String]
-        #
-        #   @param request_id [String]
-        #
-        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/straddle/models/embed/organization_get_params.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    module Embed
-      # @see Straddle::Resources::Embed::Organizations#get
-      class OrganizationGetParams < Straddle::Internal::Type::BaseModel
-        extend Straddle::Internal::Type::RequestParameters::Converter
-        include Straddle::Internal::Type::RequestParameters
-
-        # @!attribute organization_id
-        #
-        #   @return [String]
-        required :organization_id, String
-
-        # @!attribute correlation_id
-        #
-        #   @return [String, nil]
-        optional :correlation_id, String
-
-        # @!attribute request_id
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!method initialize(organization_id:, correlation_id: nil, request_id: nil, request_options: {})
-        #   @param organization_id [String]
-        #   @param correlation_id [String]
-        #   @param request_id [String]
-        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/straddle/models/embed/organization_list_params.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    module Embed
-      # @see Straddle::Resources::Embed::Organizations#list
-      class OrganizationListParams < Straddle::Internal::Type::BaseModel
-        extend Straddle::Internal::Type::RequestParameters::Converter
-        include Straddle::Internal::Type::RequestParameters
-
-        # @!attribute external_id
-        #   List organizations by their external ID.
-        #
-        #   @return [String, nil]
-        optional :external_id, String
-
-        # @!attribute name
-        #   List organizations by name (partial match supported).
-        #
-        #   @return [String, nil]
-        optional :name, String
-
-        # @!attribute page_number
-        #   Results page number. Starts at page 1.
-        #
-        #   @return [Integer, nil]
-        optional :page_number, Integer
-
-        # @!attribute page_size
-        #   Page size. Max value: 1000
-        #
-        #   @return [Integer, nil]
-        optional :page_size, Integer
-
-        # @!attribute sort_by
-        #   Sort By.
-        #
-        #   @return [String, nil]
-        optional :sort_by, String
-
-        # @!attribute sort_order
-        #   Sort Order.
-        #
-        #   @return [Symbol, Straddle::Models::Embed::OrganizationListParams::SortOrder, nil]
-        optional :sort_order, enum: -> { Straddle::Embed::OrganizationListParams::SortOrder }
-
-        # @!attribute correlation_id
-        #
-        #   @return [String, nil]
-        optional :correlation_id, String
-
-        # @!attribute request_id
-        #
-        #   @return [String, nil]
-        optional :request_id, String
-
-        # @!method initialize(external_id: nil, name: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
-        #   @param external_id [String] List organizations by their external ID.
-        #
-        #   @param name [String] List organizations by name (partial match supported).
-        #
-        #   @param page_number [Integer] Results page number. Starts at page 1.
-        #
-        #   @param page_size [Integer] Page size. Max value: 1000
-        #
-        #   @param sort_by [String] Sort By.
-        #
-        #   @param sort_order [Symbol, Straddle::Models::Embed::OrganizationListParams::SortOrder] Sort Order.
-        #
-        #   @param correlation_id [String]
-        #
-        #   @param request_id [String]
-        #
-        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
-
-        # Sort Order.
-        module SortOrder
-          extend Straddle::Internal::Type::Enum
-
-          ASC = :asc
-          DESC = :desc
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/straddle/models/embed/organization_paged_v1.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Models
-    module Embed
-      class OrganizationPagedV1 < Straddle::Internal::Type::BaseModel
-        # @!attribute data
-        #
-        #   @return [Array<Straddle::Models::Embed::OrganizationPagedV1::Data>]
-        required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::Embed::OrganizationPagedV1::Data] }
-
-        # @!attribute meta
-        #   Metadata about the API request, including an identifier, timestamp, and
-        #   pagination details.
-        #
-        #   @return [Straddle::Models::PagedResponseMetadata]
-        required :meta, -> { Straddle::PagedResponseMetadata }
-
-        # @!attribute response_type
-        #   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.
-        #
-        #   @return [Symbol, Straddle::Models::Embed::OrganizationPagedV1::ResponseType]
-        required :response_type, enum: -> { Straddle::Embed::OrganizationPagedV1::ResponseType }
-
-        # @!method initialize(data:, meta:, response_type:)
-        #   Some parameter documentations has been truncated, see
-        #   {Straddle::Models::Embed::OrganizationPagedV1} for more details.
-        #
-        #   @param data [Array<Straddle::Models::Embed::OrganizationPagedV1::Data>]
-        #
-        #   @param meta [Straddle::Models::PagedResponseMetadata] Metadata about the API request, including an identifier, timestamp, and paginati
-        #
-        #   @param response_type [Symbol, Straddle::Models::Embed::OrganizationPagedV1::ResponseType] Indicates the structure of the returned content.
-
-        class Data < Straddle::Internal::Type::BaseModel
-          # @!attribute id
-          #   Straddle's unique identifier for the organization.
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute created_at
-          #   Timestamp of when the organization was created.
-          #
-          #   @return [Time]
-          required :created_at, Time
-
-          # @!attribute name
-          #   The name of the organization.
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute updated_at
-          #   Timestamp of the most recent update to the organization.
-          #
-          #   @return [Time]
-          required :updated_at, Time
-
-          # @!attribute external_id
-          #   Unique identifier for the organization in your database, used for
-          #   cross-referencing between Straddle and your systems.
-          #
-          #   @return [String, nil]
-          optional :external_id, String, nil?: true
-
-          # @!attribute metadata
-          #   Up to 20 additional user-defined key-value pairs. Useful for storing additional
-          #   information about the organization in a structured format.
-          #
-          #   @return [Hash{Symbol=>String, nil}, nil]
-          optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
-
-          # @!method initialize(id:, created_at:, name:, updated_at:, external_id: nil, metadata: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Straddle::Models::Embed::OrganizationPagedV1::Data} for more details.
-          #
-          #   @param id [String] Straddle's unique identifier for the organization.
-          #
-          #   @param created_at [Time] Timestamp of when the organization was created.
-          #
-          #   @param name [String] The name of the organization.
-          #
-          #   @param updated_at [Time] Timestamp of the most recent update to the organization.
-          #
-          #   @param external_id [String, nil] Unique identifier for the organization in your database, used for cross-referenc
-          #
-          #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
-        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.
-        #
-        # @see Straddle::Models::Embed::OrganizationPagedV1#response_type
-        module ResponseType
-          extend Straddle::Internal::Type::Enum
-
-          OBJECT = :object
-          ARRAY = :array
-          ERROR = :error
-          NONE = :none
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end