straddle 0.1.0.pre.alpha.1

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      class BusinessProfileV1 < Straddle::Internal::Type::BaseModel
+        # @!attribute name
+        #   The operating or trade name of the business.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute website
+        #   URL of the business's primary marketing website.
+        #
+        #   @return [String]
+        required :website, String
+
+        # @!attribute address
+        #   The address object is optional. If provided, it must be a valid address.
+        #
+        #   @return [Straddle::Models::Embed::AddressV1, nil]
+        optional :address, -> { Straddle::Embed::AddressV1 }, nil?: true
+
+        # @!attribute description
+        #   A brief description of the business and its products or services.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute industry
+        #
+        #   @return [Straddle::Models::Embed::IndustryV1, nil]
+        optional :industry, -> { Straddle::Embed::IndustryV1 }
+
+        # @!attribute legal_name
+        #   The official registered name of the business.
+        #
+        #   @return [String, nil]
+        optional :legal_name, String, nil?: true
+
+        # @!attribute phone
+        #   The primary contact phone number for the business.
+        #
+        #   @return [String, nil]
+        optional :phone, String, nil?: true
+
+        # @!attribute support_channels
+        #
+        #   @return [Straddle::Models::Embed::SupportChannelsV1, nil]
+        optional :support_channels, -> { Straddle::Embed::SupportChannelsV1 }
+
+        # @!attribute tax_id
+        #   The business's tax identification number (e.g., EIN in the US).
+        #
+        #   @return [String, nil]
+        optional :tax_id, String, nil?: true
+
+        # @!attribute use_case
+        #   A description of how the business intends to use Straddle's services.
+        #
+        #   @return [String, nil]
+        optional :use_case, String, nil?: true
+
+        # @!method initialize(name:, website:, address: nil, description: nil, industry: nil, legal_name: nil, phone: nil, support_channels: nil, tax_id: nil, use_case: nil)
+        #   @param name [String] The operating or trade name of the business.
+        #
+        #   @param website [String] URL of the business's primary marketing website.
+        #
+        #   @param address [Straddle::Models::Embed::AddressV1, nil] The address object is optional. If provided, it must be a valid address.
+        #
+        #   @param description [String, nil] A brief description of the business and its products or services.
+        #
+        #   @param industry [Straddle::Models::Embed::IndustryV1]
+        #
+        #   @param legal_name [String, nil] The official registered name of the business.
+        #
+        #   @param phone [String, nil] The primary contact phone number for the business.
+        #
+        #   @param support_channels [Straddle::Models::Embed::SupportChannelsV1]
+        #
+        #   @param tax_id [String, nil] The business's tax identification number (e.g., EIN in the US).
+        #
+        #   @param use_case [String, nil] A description of how the business intends to use Straddle's services.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      class CapabilityV1 < Straddle::Internal::Type::BaseModel
+        # @!attribute capability_status
+        #
+        #   @return [Symbol, Straddle::Models::Embed::CapabilityV1::CapabilityStatus]
+        required :capability_status, enum: -> { Straddle::Embed::CapabilityV1::CapabilityStatus }
+
+        # @!method initialize(capability_status:)
+        #   @param capability_status [Symbol, Straddle::Models::Embed::CapabilityV1::CapabilityStatus]
+
+        # @see Straddle::Models::Embed::CapabilityV1#capability_status
+        module CapabilityStatus
+          extend Straddle::Internal::Type::Enum
+
+          ACTIVE = :active
+          INACTIVE = :inactive
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      class IndustryV1 < Straddle::Internal::Type::BaseModel
+        # @!attribute category
+        #   The general category of the industry. Required if not providing MCC.
+        #
+        #   @return [String, nil]
+        optional :category, String, nil?: true
+
+        # @!attribute mcc
+        #   The Merchant Category Code (MCC) that best describes the business. Optional.
+        #
+        #   @return [String, nil]
+        optional :mcc, String, nil?: true
+
+        # @!attribute sector
+        #   The specific sector within the industry category. Required if not providing MCC.
+        #
+        #   @return [String, nil]
+        optional :sector, String, nil?: true
+
+        # @!method initialize(category: nil, mcc: nil, sector: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Embed::IndustryV1} for more details.
+        #
+        #   @param category [String, nil] The general category of the industry. Required if not providing MCC.
+        #
+        #   @param mcc [String, nil] The Merchant Category Code (MCC) that best describes the business. Optional.
+        #
+        #   @param sector [String, nil] The specific sector within the industry category. Required if not providing MCC.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::LinkedBankAccounts#create
+      class LinkedBankAccountCreateParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute account_id
+        #   The unique identifier of the Straddle account to associate this bank account
+        #   with.
+        #
+        #   @return [String]
+        required :account_id, String
+
+        # @!attribute bank_account
+        #
+        #   @return [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount]
+        required :bank_account, -> { Straddle::Embed::LinkedBankAccountCreateParams::BankAccount }
+
+        # @!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 correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(account_id:, bank_account:, metadata: nil, correlation_id: nil, request_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Embed::LinkedBankAccountCreateParams} for more details.
+        #
+        #   @param account_id [String] The unique identifier of the Straddle account to associate this bank account wit
+        #
+        #   @param bank_account [Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount]
+        #
+        #   @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 request_id [String]
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+        class BankAccount < Straddle::Internal::Type::BaseModel
+          # @!attribute account_holder
+          #   The name of the account holder as it appears on the bank account. Typically,
+          #   this is the legal name of the business associated with the account.
+          #
+          #   @return [String]
+          required :account_holder, String
+
+          # @!attribute account_number
+          #   The bank account number.
+          #
+          #   @return [String]
+          required :account_number, String
+
+          # @!attribute routing_number
+          #   The routing number of the bank account.
+          #
+          #   @return [String]
+          required :routing_number, String
+
+          # @!method initialize(account_holder:, account_number:, routing_number:)
+          #   Some parameter documentations has been truncated, see
+          #   {Straddle::Models::Embed::LinkedBankAccountCreateParams::BankAccount} for more
+          #   details.
+          #
+          #   @param account_holder [String] The name of the account holder as it appears on the bank account. Typically, thi
+          #
+          #   @param account_number [String] The bank account number.
+          #
+          #   @param routing_number [String] The routing number of the bank account.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::LinkedBankAccounts#get
+      class LinkedBankAccountGetParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(correlation_id: nil, request_id: nil, request_options: {})
+        #   @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/linked_bank_account_list_params.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::LinkedBankAccounts#list
+      class LinkedBankAccountListParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute account_id
+        #   The unique identifier of the related account.
+        #
+        #   @return [String, nil]
+        optional :account_id, String
+
+        # @!attribute level
+        #
+        #   @return [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level, nil]
+        optional :level, enum: -> { Straddle::Embed::LinkedBankAccountListParams::Level }
+
+        # @!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::LinkedBankAccountListParams::SortOrder, nil]
+        optional :sort_order, enum: -> { Straddle::Embed::LinkedBankAccountListParams::SortOrder }
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(account_id: nil, level: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
+        #   @param account_id [String] The unique identifier of the related account.
+        #
+        #   @param level [Symbol, Straddle::Models::Embed::LinkedBankAccountListParams::Level]
+        #
+        #   @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::LinkedBankAccountListParams::SortOrder] Sort Order.
+        #
+        #   @param correlation_id [String]
+        #
+        #   @param request_id [String]
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+        module Level
+          extend Straddle::Internal::Type::Enum
+
+          ACCOUNT = :account
+          PLATFORM = :platform
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # 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/linked_bank_account_paged_v1.rb

@@ -0,0 +1,271 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      class LinkedBankAccountPagedV1 < Straddle::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Straddle::Models::Embed::LinkedBankAccountPagedV1::Data>]
+        required :data,
+                 -> {
+                   Straddle::Internal::Type::ArrayOf[Straddle::Embed::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1::ResponseType]
+        required :response_type, enum: -> { Straddle::Embed::LinkedBankAccountPagedV1::ResponseType }
+
+        # @!method initialize(data:, meta:, response_type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Embed::LinkedBankAccountPagedV1} for more details.
+        #
+        #   @param data [Array<Straddle::Models::Embed::LinkedBankAccountPagedV1::Data>]
+        #
+        #   @param meta [Straddle::Models::PagedResponseMetadata] Metadata about the API request, including an identifier, timestamp, and paginati
+        #
+        #   @param response_type [Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::ResponseType] Indicates the structure of the returned content.
+
+        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::LinkedBankAccountPagedV1::Data::BankAccount]
+          required :bank_account, -> { Straddle::Embed::LinkedBankAccountPagedV1::Data::BankAccount }
+
+          # @!attribute created_at
+          #   Timestamp of when the bank account object was created.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute status
+          #   The current status of the linked bank account.
+          #
+          #   @return [Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::Status]
+          required :status, enum: -> { Straddle::Embed::LinkedBankAccountPagedV1::Data::Status }
+
+          # @!attribute status_detail
+          #
+          #   @return [Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::StatusDetail]
+          required :status_detail, -> { Straddle::Embed::LinkedBankAccountPagedV1::Data::StatusDetail }
+
+          # @!attribute updated_at
+          #   Timestamp of the most recent update to the linked bank account.
+          #
+          #   @return [Time]
+          required :updated_at, Time
+
+          # @!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:, status:, status_detail:, updated_at:, metadata: nil, platform_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Straddle::Models::Embed::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1::Data::BankAccount]
+          #
+          #   @param created_at [Time] Timestamp of when the bank account object was created.
+          #
+          #   @param status [Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::Status] The current status of the linked bank account.
+          #
+          #   @param status_detail [Straddle::Models::Embed::LinkedBankAccountPagedV1::Data::StatusDetail]
+          #
+          #   @param updated_at [Time] Timestamp of the most recent update to the linked 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::LinkedBankAccountPagedV1::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
+
+          # The current status of the linked bank account.
+          #
+          # @see Straddle::Models::Embed::LinkedBankAccountPagedV1::Data#status
+          module Status
+            extend Straddle::Internal::Type::Enum
+
+            CREATED = :created
+            ONBOARDING = :onboarding
+            ACTIVE = :active
+            REJECTED = :rejected
+            INACTIVE = :inactive
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Straddle::Models::Embed::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1::Data::StatusDetail::Reason]
+            required :reason,
+                     enum: -> {
+                       Straddle::Embed::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1::Data::StatusDetail::Source]
+            required :source,
+                     enum: -> {
+                       Straddle::Embed::LinkedBankAccountPagedV1::Data::StatusDetail::Source
+                     }
+
+            # @!method initialize(code:, message:, reason:, source:)
+            #   Some parameter documentations has been truncated, see
+            #   {Straddle::Models::Embed::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1::Data::StatusDetail::Reason] A machine-readable identifier for the specific status, useful for programmatic h
+            #
+            #   @param source [Symbol, Straddle::Models::Embed::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1::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::LinkedBankAccountPagedV1#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/linked_bank_account_unmask_params.rb

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