straddle 0.1.0.pre.alpha.1

data/lib/straddle/models/embed/accounts/capability_request_create_params.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      module Accounts
+        # @see Straddle::Resources::Embed::Accounts::CapabilityRequests#create
+        class CapabilityRequestCreateParams < Straddle::Internal::Type::BaseModel
+          extend Straddle::Internal::Type::RequestParameters::Converter
+          include Straddle::Internal::Type::RequestParameters
+
+          # @!attribute businesses
+          #   Allows the account to accept payments from businesses.
+          #
+          #   @return [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Businesses, nil]
+          optional :businesses, -> { Straddle::Embed::Accounts::CapabilityRequestCreateParams::Businesses }
+
+          # @!attribute charges
+          #   The charges capability settings for the account.
+          #
+          #   @return [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Charges, nil]
+          optional :charges, -> { Straddle::Embed::Accounts::CapabilityRequestCreateParams::Charges }
+
+          # @!attribute individuals
+          #   Allows the account to accept payments from individuals.
+          #
+          #   @return [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Individuals, nil]
+          optional :individuals, -> { Straddle::Embed::Accounts::CapabilityRequestCreateParams::Individuals }
+
+          # @!attribute internet
+          #   Allows the account to accept payments authorized via the internet or mobile
+          #   applications.
+          #
+          #   @return [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Internet, nil]
+          optional :internet, -> { Straddle::Embed::Accounts::CapabilityRequestCreateParams::Internet }
+
+          # @!attribute payouts
+          #   The payouts capability settings for the account.
+          #
+          #   @return [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Payouts, nil]
+          optional :payouts, -> { Straddle::Embed::Accounts::CapabilityRequestCreateParams::Payouts }
+
+          # @!attribute signed_agreement
+          #   Allows the account to accept payments authorized by signed agreements or
+          #   contracts.
+          #
+          #   @return [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement, nil]
+          optional :signed_agreement,
+                   -> { Straddle::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement }
+
+          # @!attribute correlation_id
+          #
+          #   @return [String, nil]
+          optional :correlation_id, String
+
+          # @!attribute request_id
+          #
+          #   @return [String, nil]
+          optional :request_id, String
+
+          # @!method initialize(businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, request_id: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams} for more
+          #   details.
+          #
+          #   @param businesses [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Businesses] Allows the account to accept payments from businesses.
+          #
+          #   @param charges [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Charges] The charges capability settings for the account.
+          #
+          #   @param individuals [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Individuals] Allows the account to accept payments from individuals.
+          #
+          #   @param internet [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Internet] Allows the account to accept payments authorized via the internet or mobile appl
+          #
+          #   @param payouts [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::Payouts] The payouts capability settings for the account.
+          #
+          #   @param signed_agreement [Straddle::Models::Embed::Accounts::CapabilityRequestCreateParams::SignedAgreement] Allows the account to accept payments authorized by signed agreements or contrac
+          #
+          #   @param correlation_id [String]
+          #
+          #   @param request_id [String]
+          #
+          #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+          class Businesses < Straddle::Internal::Type::BaseModel
+            # @!attribute enable
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
+            # @!method initialize(enable:)
+            #   Allows the account to accept payments from businesses.
+            #
+            #   @param enable [Boolean]
+          end
+
+          class Charges < Straddle::Internal::Type::BaseModel
+            # @!attribute daily_amount
+            #   The maximum dollar amount of charges in a calendar day.
+            #
+            #   @return [Float]
+            required :daily_amount, Float
+
+            # @!attribute enable
+            #   Determines whether `charges` are enabled for the account.
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
+            # @!attribute max_amount
+            #   The maximum amount of a single charge.
+            #
+            #   @return [Float]
+            required :max_amount, Float
+
+            # @!attribute monthly_amount
+            #   The maximum dollar amount of charges in a calendar month.
+            #
+            #   @return [Float]
+            required :monthly_amount, Float
+
+            # @!attribute monthly_count
+            #   The maximum number of charges in a calendar month.
+            #
+            #   @return [Integer]
+            required :monthly_count, Integer
+
+            # @!method initialize(daily_amount:, enable:, max_amount:, monthly_amount:, monthly_count:)
+            #   The charges capability settings for the account.
+            #
+            #   @param daily_amount [Float] The maximum dollar amount of charges in a calendar day.
+            #
+            #   @param enable [Boolean] Determines whether `charges` are enabled for the account.
+            #
+            #   @param max_amount [Float] The maximum amount of a single charge.
+            #
+            #   @param monthly_amount [Float] The maximum dollar amount of charges in a calendar month.
+            #
+            #   @param monthly_count [Integer] The maximum number of charges in a calendar month.
+          end
+
+          class Individuals < Straddle::Internal::Type::BaseModel
+            # @!attribute enable
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
+            # @!method initialize(enable:)
+            #   Allows the account to accept payments from individuals.
+            #
+            #   @param enable [Boolean]
+          end
+
+          class Internet < Straddle::Internal::Type::BaseModel
+            # @!attribute enable
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
+            # @!method initialize(enable:)
+            #   Allows the account to accept payments authorized via the internet or mobile
+            #   applications.
+            #
+            #   @param enable [Boolean]
+          end
+
+          class Payouts < Straddle::Internal::Type::BaseModel
+            # @!attribute daily_amount
+            #   The maximum dollar amount of payouts in a day.
+            #
+            #   @return [Float]
+            required :daily_amount, Float
+
+            # @!attribute enable
+            #   Determines whether `payouts` are enabled for the account.
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
+            # @!attribute max_amount
+            #   The maximum amount of a single payout.
+            #
+            #   @return [Float]
+            required :max_amount, Float
+
+            # @!attribute monthly_amount
+            #   The maximum dollar amount of payouts in a month.
+            #
+            #   @return [Float]
+            required :monthly_amount, Float
+
+            # @!attribute monthly_count
+            #   The maximum number of payouts in a month.
+            #
+            #   @return [Integer]
+            required :monthly_count, Integer
+
+            # @!method initialize(daily_amount:, enable:, max_amount:, monthly_amount:, monthly_count:)
+            #   The payouts capability settings for the account.
+            #
+            #   @param daily_amount [Float] The maximum dollar amount of payouts in a day.
+            #
+            #   @param enable [Boolean] Determines whether `payouts` are enabled for the account.
+            #
+            #   @param max_amount [Float] The maximum amount of a single payout.
+            #
+            #   @param monthly_amount [Float] The maximum dollar amount of payouts in a month.
+            #
+            #   @param monthly_count [Integer] The maximum number of payouts in a month.
+          end
+
+          class SignedAgreement < Straddle::Internal::Type::BaseModel
+            # @!attribute enable
+            #
+            #   @return [Boolean]
+            required :enable, Straddle::Internal::Type::Boolean
+
+            # @!method initialize(enable:)
+            #   Allows the account to accept payments authorized by signed agreements or
+            #   contracts.
+            #
+            #   @param enable [Boolean]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/straddle/models/embed/accounts/capability_request_list_params.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      module Accounts
+        # @see Straddle::Resources::Embed::Accounts::CapabilityRequests#list
+        class CapabilityRequestListParams < Straddle::Internal::Type::BaseModel
+          extend Straddle::Internal::Type::RequestParameters::Converter
+          include Straddle::Internal::Type::RequestParameters
+
+          # @!attribute category
+          #   Filter capability requests by category.
+          #
+          #   @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Category, nil]
+          optional :category, enum: -> { Straddle::Embed::Accounts::CapabilityRequestListParams::Category }
+
+          # @!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::Accounts::CapabilityRequestListParams::SortOrder, nil]
+          optional :sort_order, enum: -> { Straddle::Embed::Accounts::CapabilityRequestListParams::SortOrder }
+
+          # @!attribute status
+          #   Filter capability requests by their current status.
+          #
+          #   @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Status, nil]
+          optional :status, enum: -> { Straddle::Embed::Accounts::CapabilityRequestListParams::Status }
+
+          # @!attribute type
+          #   Filter capability requests by the specific type of capability.
+          #
+          #   @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Type, nil]
+          optional :type, enum: -> { Straddle::Embed::Accounts::CapabilityRequestListParams::Type }
+
+          # @!attribute correlation_id
+          #
+          #   @return [String, nil]
+          optional :correlation_id, String
+
+          # @!attribute request_id
+          #
+          #   @return [String, nil]
+          optional :request_id, String
+
+          # @!method initialize(category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+          #   @param category [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Category] Filter capability requests by category.
+          #
+          #   @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::Accounts::CapabilityRequestListParams::SortOrder] Sort Order.
+          #
+          #   @param status [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Status] Filter capability requests by their current status.
+          #
+          #   @param type [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestListParams::Type] Filter capability requests by the specific type of capability.
+          #
+          #   @param correlation_id [String]
+          #
+          #   @param request_id [String]
+          #
+          #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+          # Filter capability requests by category.
+          module Category
+            extend Straddle::Internal::Type::Enum
+
+            PAYMENT_TYPE = :payment_type
+            CUSTOMER_TYPE = :customer_type
+            CONSENT_TYPE = :consent_type
+
+            # @!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
+
+          # Filter capability requests by their current status.
+          module Status
+            extend Straddle::Internal::Type::Enum
+
+            ACTIVE = :active
+            INACTIVE = :inactive
+            IN_REVIEW = :in_review
+            REJECTED = :rejected
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Filter capability requests by the specific type of capability.
+          module Type
+            extend Straddle::Internal::Type::Enum
+
+            CHARGES = :charges
+            PAYOUTS = :payouts
+            INDIVIDUALS = :individuals
+            BUSINESSES = :businesses
+            SIGNED_AGREEMENT = :signed_agreement
+            INTERNET = :internet
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/straddle/models/embed/accounts/capability_request_paged_v1.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      module Accounts
+        # @see Straddle::Resources::Embed::Accounts::CapabilityRequests#create
+        class CapabilityRequestPagedV1 < Straddle::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data>]
+          required :data,
+                   -> {
+                     Straddle::Internal::Type::ArrayOf[Straddle::Embed::Accounts::CapabilityRequestPagedV1::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::Accounts::CapabilityRequestPagedV1::ResponseType]
+          required :response_type,
+                   enum: -> {
+                     Straddle::Embed::Accounts::CapabilityRequestPagedV1::ResponseType
+                   }
+
+          # @!method initialize(data:, meta:, response_type:)
+          #   Some parameter documentations has been truncated, see
+          #   {Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1} for more details.
+          #
+          #   @param data [Array<Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data>]
+          #
+          #   @param meta [Straddle::Models::PagedResponseMetadata] Metadata about the API request, including an identifier, timestamp, and paginati
+          #
+          #   @param response_type [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::ResponseType] Indicates the structure of the returned content.
+
+          class Data < Straddle::Internal::Type::BaseModel
+            # @!attribute id
+            #   Unique identifier for the capability request.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute account_id
+            #   The unique identifier of the account associated with this capability request.
+            #
+            #   @return [String]
+            required :account_id, String
+
+            # @!attribute category
+            #   The category of the requested capability. Use `payment_type` for charges and
+            #   payouts, `customer_type` to define `individuals` or `businesses`, and
+            #   `consent_type` for `signed_agreement` or `internet` payment authorization.
+            #
+            #   @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Category]
+            required :category,
+                     enum: -> {
+                       Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data::Category
+                     }
+
+            # @!attribute created_at
+            #   Timestamp of when the capability request was created.
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute status
+            #   The current status of the capability request.
+            #
+            #   @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Status]
+            required :status, enum: -> { Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data::Status }
+
+            # @!attribute type
+            #   The specific type of capability being requested within the category.
+            #
+            #   @return [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Type]
+            required :type, enum: -> { Straddle::Embed::Accounts::CapabilityRequestPagedV1::Data::Type }
+
+            # @!attribute updated_at
+            #   Timestamp of the most recent update to the capability request.
+            #
+            #   @return [Time]
+            required :updated_at, Time
+
+            # @!attribute settings
+            #   Any specific settings or configurations related to the requested capability.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :settings,
+                     Straddle::Internal::Type::HashOf[Straddle::Internal::Type::Unknown],
+                     nil?: true
+
+            # @!method initialize(id:, account_id:, category:, created_at:, status:, type:, updated_at:, settings: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data} for more
+            #   details.
+            #
+            #   @param id [String] Unique identifier for the capability request.
+            #
+            #   @param account_id [String] The unique identifier of the account associated with this capability request.
+            #
+            #   @param category [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Category] The category of the requested capability. Use `payment_type` for charges and pay
+            #
+            #   @param created_at [Time] Timestamp of when the capability request was created.
+            #
+            #   @param status [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Status] The current status of the capability request.
+            #
+            #   @param type [Symbol, Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data::Type] The specific type of capability being requested within the category.
+            #
+            #   @param updated_at [Time] Timestamp of the most recent update to the capability request.
+            #
+            #   @param settings [Hash{Symbol=>Object}, nil] Any specific settings or configurations related to the requested capability.
+
+            # The category of the requested capability. Use `payment_type` for charges and
+            # payouts, `customer_type` to define `individuals` or `businesses`, and
+            # `consent_type` for `signed_agreement` or `internet` payment authorization.
+            #
+            # @see Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data#category
+            module Category
+              extend Straddle::Internal::Type::Enum
+
+              PAYMENT_TYPE = :payment_type
+              CUSTOMER_TYPE = :customer_type
+              CONSENT_TYPE = :consent_type
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The current status of the capability request.
+            #
+            # @see Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data#status
+            module Status
+              extend Straddle::Internal::Type::Enum
+
+              ACTIVE = :active
+              INACTIVE = :inactive
+              IN_REVIEW = :in_review
+              REJECTED = :rejected
+              APPROVED = :approved
+              REVIEWING = :reviewing
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The specific type of capability being requested within the category.
+            #
+            # @see Straddle::Models::Embed::Accounts::CapabilityRequestPagedV1::Data#type
+            module Type
+              extend Straddle::Internal::Type::Enum
+
+              CHARGES = :charges
+              PAYOUTS = :payouts
+              INDIVIDUALS = :individuals
+              BUSINESSES = :businesses
+              SIGNED_AGREEMENT = :signed_agreement
+              INTERNET = :internet
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            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::Accounts::CapabilityRequestPagedV1#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
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      class AddressV1 < Straddle::Internal::Type::BaseModel
+        # @!attribute address1
+        #   Primary address line (e.g., street, PO Box).
+        #
+        #   @return [String]
+        required :address1, String
+
+        # @!attribute city
+        #   City, district, suburb, town, or village.
+        #
+        #   @return [String, nil]
+        required :city, String, nil?: true
+
+        # @!attribute state
+        #   Two-letter state code.
+        #
+        #   @return [String, nil]
+        required :state, String, nil?: true
+
+        # @!attribute zip
+        #   Zip or postal code.
+        #
+        #   @return [String]
+        required :zip, String
+
+        # @!attribute address2
+        #   Secondary address line (e.g., apartment, suite, unit, or building).
+        #
+        #   @return [String, nil]
+        optional :address2, String, nil?: true
+
+        # @!attribute country
+        #   The country of the address, in ISO 3166-1 alpha-2 format.
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute line1
+        #   Primary address line (e.g., street, PO Box).
+        #
+        #   @return [String, nil]
+        optional :line1, String, nil?: true
+
+        # @!attribute line2
+        #   Secondary address line (e.g., apartment, suite, unit, or building).
+        #
+        #   @return [String, nil]
+        optional :line2, String, nil?: true
+
+        # @!attribute postal_code
+        #   Postal or ZIP code.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!method initialize(address1:, city:, state:, zip:, address2: nil, country: nil, line1: nil, line2: nil, postal_code: nil)
+        #   The address object is optional. If provided, it must be a valid address.
+        #
+        #   @param address1 [String] Primary address line (e.g., street, PO Box).
+        #
+        #   @param city [String, nil] City, district, suburb, town, or village.
+        #
+        #   @param state [String, nil] Two-letter state code.
+        #
+        #   @param zip [String] Zip or postal code.
+        #
+        #   @param address2 [String, nil] Secondary address line (e.g., apartment, suite, unit, or building).
+        #
+        #   @param country [String, nil] The country of the address, in ISO 3166-1 alpha-2 format.
+        #
+        #   @param line1 [String, nil] Primary address line (e.g., street, PO Box).
+        #
+        #   @param line2 [String, nil] Secondary address line (e.g., apartment, suite, unit, or building).
+        #
+        #   @param postal_code [String, nil] Postal or ZIP code.
+      end
+    end
+  end
+end