straddle 0.1.0.pre.alpha.1

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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      # @see Straddle::Resources::Embed::Representatives#update
+      class RepresentativeUpdateParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        # @!attribute dob
+        #   The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
+        #
+        #   @return [Date]
+        required :dob, Date
+
+        # @!attribute email
+        #   The email address of the representative.
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute first_name
+        #   The first name of the representative.
+        #
+        #   @return [String]
+        required :first_name, String
+
+        # @!attribute last_name
+        #   The last name of the representative.
+        #
+        #   @return [String]
+        required :last_name, String
+
+        # @!attribute mobile_number
+        #   The mobile phone number of the representative.
+        #
+        #   @return [String]
+        required :mobile_number, String
+
+        # @!attribute relationship
+        #
+        #   @return [Straddle::Models::Embed::RepresentativeUpdateParams::Relationship]
+        required :relationship, -> { Straddle::Embed::RepresentativeUpdateParams::Relationship }
+
+        # @!attribute ssn_last4
+        #   The last 4 digits of the representative's Social Security Number.
+        #
+        #   @return [String]
+        required :ssn_last4, String
+
+        # @!attribute external_id
+        #   Unique identifier for the representative in your database, used for
+        #   cross-referencing between Straddle and your systems.
+        #
+        #   @return [String, nil]
+        optional :external_id, String, nil?: true
+
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!attribute request_id
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!method initialize(dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, correlation_id: nil, request_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Embed::RepresentativeUpdateParams} for more details.
+        #
+        #   @param dob [Date] The date of birth of the representative, in ISO 8601 format (YYYY-MM-DD).
+        #
+        #   @param email [String] The email address of the representative.
+        #
+        #   @param first_name [String] The first name of the representative.
+        #
+        #   @param last_name [String] The last name of the representative.
+        #
+        #   @param mobile_number [String] The mobile phone number of the representative.
+        #
+        #   @param relationship [Straddle::Models::Embed::RepresentativeUpdateParams::Relationship]
+        #
+        #   @param ssn_last4 [String] The last 4 digits of the representative's Social Security Number.
+        #
+        #   @param external_id [String, nil] Unique identifier for the representative in your database, used for cross-refere
+        #
+        #   @param correlation_id [String]
+        #
+        #   @param request_id [String]
+        #
+        #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+        class Relationship < Straddle::Internal::Type::BaseModel
+          # @!attribute control
+          #   Whether the representative has significant responsibility to control, manage, or
+          #   direct the organization. One representative must be identified under the control
+          #   prong for each legal entity.
+          #
+          #   @return [Boolean]
+          required :control, Straddle::Internal::Type::Boolean
+
+          # @!attribute owner
+          #   Whether the representative owns any percentage of of the equity interests of the
+          #   legal entity.
+          #
+          #   @return [Boolean]
+          required :owner, Straddle::Internal::Type::Boolean
+
+          # @!attribute primary
+          #   Whether the person is authorized as the primary representative of the account.
+          #   This is the person chosen by the business to provide information about
+          #   themselves, general information about the account, and who consented to the
+          #   services agreement.
+          #
+          #   There can be only one primary representative for an account at a time.
+          #
+          #   @return [Boolean]
+          required :primary, Straddle::Internal::Type::Boolean
+
+          # @!attribute percent_ownership
+          #   The percentage of ownership the representative has. Required if 'Owner' is true.
+          #
+          #   @return [Float, nil]
+          optional :percent_ownership, Float, nil?: true
+
+          # @!attribute title
+          #   The job title of the representative.
+          #
+          #   @return [String, nil]
+          optional :title, String, nil?: true
+
+          # @!method initialize(control:, owner:, primary:, percent_ownership: nil, title: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Straddle::Models::Embed::RepresentativeUpdateParams::Relationship} for more
+          #   details.
+          #
+          #   @param control [Boolean] Whether the representative has significant responsibility to control, manage, or
+          #
+          #   @param owner [Boolean] Whether the representative owns any percentage of of the equity interests of the
+          #
+          #   @param primary [Boolean] Whether the person is authorized as the primary representative of the account. T
+          #
+          #   @param percent_ownership [Float, nil] The percentage of ownership the representative has. Required if 'Owner' is true.
+          #
+          #   @param title [String, nil] The job title of the representative.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      class SupportChannelsV1 < Straddle::Internal::Type::BaseModel
+        # @!attribute email
+        #   The email address for customer support inquiries.
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!attribute phone
+        #   The phone number for customer support.
+        #
+        #   @return [String, nil]
+        optional :phone, String, nil?: true
+
+        # @!attribute url
+        #   The URL of the business's customer support page or contact form.
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(email: nil, phone: nil, url: nil)
+        #   @param email [String, nil] The email address for customer support inquiries.
+        #
+        #   @param phone [String, nil] The phone number for customer support.
+        #
+        #   @param url [String, nil] The URL of the business's customer support page or contact form.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module Embed
+      class TermsOfServiceV1 < Straddle::Internal::Type::BaseModel
+        # @!attribute accepted_date
+        #   The datetime of when the terms of service were accepted, in ISO 8601 format.
+        #
+        #   @return [Time]
+        required :accepted_date, Time
+
+        # @!attribute agreement_type
+        #   The type or version of the agreement accepted. Use `embedded` unless your
+        #   platform was specifically enabled for `direct` agreements.
+        #
+        #   @return [Symbol, Straddle::Models::Embed::TermsOfServiceV1::AgreementType]
+        required :agreement_type, enum: -> { Straddle::Embed::TermsOfServiceV1::AgreementType }
+
+        # @!attribute agreement_url
+        #   The URL where the full text of the accepted agreement can be found.
+        #
+        #   @return [String, nil]
+        required :agreement_url, String, nil?: true
+
+        # @!attribute accepted_ip
+        #   The IP address from which the terms of service were accepted.
+        #
+        #   @return [String, nil]
+        optional :accepted_ip, String, nil?: true
+
+        # @!attribute accepted_user_agent
+        #   The user agent string of the browser or application used to accept the terms.
+        #
+        #   @return [String, nil]
+        optional :accepted_user_agent, String, nil?: true
+
+        # @!method initialize(accepted_date:, agreement_type:, agreement_url:, accepted_ip: nil, accepted_user_agent: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::Embed::TermsOfServiceV1} for more details.
+        #
+        #   @param accepted_date [Time] The datetime of when the terms of service were accepted, in ISO 8601 format.
+        #
+        #   @param agreement_type [Symbol, Straddle::Models::Embed::TermsOfServiceV1::AgreementType] The type or version of the agreement accepted. Use `embedded` unless your platfo
+        #
+        #   @param agreement_url [String, nil] The URL where the full text of the accepted agreement can be found.
+        #
+        #   @param accepted_ip [String, nil] The IP address from which the terms of service were accepted.
+        #
+        #   @param accepted_user_agent [String, nil] The user agent string of the browser or application used to accept the terms.
+
+        # The type or version of the agreement accepted. Use `embedded` unless your
+        # platform was specifically enabled for `direct` agreements.
+        #
+        # @see Straddle::Models::Embed::TermsOfServiceV1#agreement_type
+        module AgreementType
+          extend Straddle::Internal::Type::Enum
+
+          EMBEDDED = :embedded
+          DIRECT = :direct
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/straddle/models/funding_event_get_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#get
+    class FundingEventGetParams < 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
+
+      # @!attribute straddle_account_id
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param correlation_id [String]
+      #   @param request_id [String]
+      #   @param straddle_account_id [String]
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/funding_event_list_params.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#list
+    class FundingEventListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute created_from
+      #   The start date of the range to filter by using the `YYYY-MM-DD` format.
+      #
+      #   @return [Date, nil]
+      optional :created_from, Date, nil?: true
+
+      # @!attribute created_to
+      #   The end date of the range to filter by using the `YYYY-MM-DD` format.
+      #
+      #   @return [Date, nil]
+      optional :created_to, Date, nil?: true
+
+      # @!attribute direction
+      #   Describes the direction of the funding event from the perspective of the
+      #   `linked_bank_account`.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventListParams::Direction, nil]
+      optional :direction, enum: -> { Straddle::FundingEventListParams::Direction }
+
+      # @!attribute event_type
+      #   The funding event types describes the direction and reason for the funding
+      #   event.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventListParams::EventType, nil]
+      optional :event_type, enum: -> { Straddle::FundingEventListParams::EventType }
+
+      # @!attribute page_number
+      #   Results page number. Starts at page 1.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Results page size. Max value: 1000
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort_by
+      #   The field to sort the results by.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventListParams::SortBy, nil]
+      optional :sort_by, enum: -> { Straddle::FundingEventListParams::SortBy }
+
+      # @!attribute sort_order
+      #   The order in which to sort the results.
+      #
+      #   @return [Symbol, Straddle::Models::FundingEventListParams::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::FundingEventListParams::SortOrder }
+
+      # @!attribute trace_number
+      #   Trace number.
+      #
+      #   @return [String, nil]
+      optional :trace_number, String, nil?: true
+
+      # @!attribute correlation_id
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute request_id
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute straddle_account_id
+      #
+      #   @return [String, nil]
+      optional :straddle_account_id, String
+
+      # @!method initialize(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventListParams} for more details.
+      #
+      #   @param created_from [Date, nil] The start date of the range to filter by using the `YYYY-MM-DD` format.
+      #
+      #   @param created_to [Date, nil] The end date of the range to filter by using the `YYYY-MM-DD` format.
+      #
+      #   @param direction [Symbol, Straddle::Models::FundingEventListParams::Direction] Describes the direction of the funding event from the perspective of the `linked
+      #
+      #   @param event_type [Symbol, Straddle::Models::FundingEventListParams::EventType] The funding event types describes the direction and reason for the funding event
+      #
+      #   @param page_number [Integer] Results page number. Starts at page 1.
+      #
+      #   @param page_size [Integer] Results page size. Max value: 1000
+      #
+      #   @param sort_by [Symbol, Straddle::Models::FundingEventListParams::SortBy] The field to sort the results by.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::FundingEventListParams::SortOrder] The order in which to sort the results.
+      #
+      #   @param trace_number [String, nil] Trace number.
+      #
+      #   @param correlation_id [String]
+      #
+      #   @param request_id [String]
+      #
+      #   @param straddle_account_id [String]
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      # Describes the direction of the funding event from the perspective of the
+      # `linked_bank_account`.
+      module Direction
+        extend Straddle::Internal::Type::Enum
+
+        DEPOSIT = :deposit
+        WITHDRAWAL = :withdrawal
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The funding event types describes the direction and reason for the funding
+      # event.
+      module EventType
+        extend Straddle::Internal::Type::Enum
+
+        CHARGE_DEPOSIT = :charge_deposit
+        CHARGE_REVERSAL = :charge_reversal
+        PAYOUT_RETURN = :payout_return
+        PAYOUT_WITHDRAWAL = :payout_withdrawal
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The field to sort the results by.
+      module SortBy
+        extend Straddle::Internal::Type::Enum
+
+        TRANSFER_DATE = :transfer_date
+        ID = :id
+        AMOUNT = :amount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The order in which to sort the results.
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/funding_event_summary_item_v1.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::FundingEvents#get
+    class FundingEventSummaryItemV1 < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::FundingEventSummaryItemV1::Data]
+      required :data, -> { Straddle::FundingEventSummaryItemV1::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::FundingEventSummaryItemV1::ResponseType]
+      required :response_type, enum: -> { Straddle::FundingEventSummaryItemV1::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventSummaryItemV1} for more details.
+      #
+      #   @param data [Straddle::Models::FundingEventSummaryItemV1::Data]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata about the API request, including an identifier and timestamp.
+      #
+      #   @param response_type [Symbol, Straddle::Models::FundingEventSummaryItemV1::ResponseType] Indicates the structure of the returned content.
+
+      # @see Straddle::Models::FundingEventSummaryItemV1#data
+      class Data < Straddle::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the funding event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #   The amount of the funding event in cents.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute direction
+        #   Describes the direction of the funding event from the perspective of the
+        #   `linked_bank_account`.
+        #
+        #   @return [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::Direction]
+        required :direction, enum: -> { Straddle::FundingEventSummaryItemV1::Data::Direction }
+
+        # @!attribute event_type
+        #   The funding event types describes the direction and reason for the funding
+        #   event.
+        #
+        #   @return [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::EventType]
+        required :event_type, enum: -> { Straddle::FundingEventSummaryItemV1::Data::EventType }
+
+        # @!attribute payment_count
+        #   The number of payments associated with the funding event.
+        #
+        #   @return [Integer]
+        required :payment_count, Integer
+
+        # @!attribute trace_numbers
+        #   Trace number.
+        #
+        #   @return [Array<String>]
+        required :trace_numbers, Straddle::Internal::Type::ArrayOf[String]
+
+        # @!attribute transfer_date
+        #   The date on which the funding event occurred. For `deposits` and `returns`, this
+        #   is the date the funds were credited to your bank account. For `withdrawals` and
+        #   `reversals`, this is the date the funds were debited from your bank account.
+        #
+        #   @return [Date]
+        required :transfer_date, Date
+
+        # @!attribute trace_number
+        #   The trace number of the funding event.
+        #
+        #   @return [String, nil]
+        optional :trace_number, String, nil?: true
+
+        # @!method initialize(id:, amount:, direction:, event_type:, payment_count:, trace_numbers:, transfer_date:, trace_number: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::FundingEventSummaryItemV1::Data} for more details.
+        #
+        #   @param id [String] Unique identifier for the funding event.
+        #
+        #   @param amount [Integer] The amount of the funding event in cents.
+        #
+        #   @param direction [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::Direction] Describes the direction of the funding event from the perspective of the `linked
+        #
+        #   @param event_type [Symbol, Straddle::Models::FundingEventSummaryItemV1::Data::EventType] The funding event types describes the direction and reason for the funding event
+        #
+        #   @param payment_count [Integer] The number of payments associated with the funding event.
+        #
+        #   @param trace_numbers [Array<String>] Trace number.
+        #
+        #   @param transfer_date [Date] The date on which the funding event occurred. For `deposits` and `returns`, this
+        #
+        #   @param trace_number [String, nil] The trace number of the funding event.
+
+        # Describes the direction of the funding event from the perspective of the
+        # `linked_bank_account`.
+        #
+        # @see Straddle::Models::FundingEventSummaryItemV1::Data#direction
+        module Direction
+          extend Straddle::Internal::Type::Enum
+
+          DEPOSIT = :deposit
+          WITHDRAWAL = :withdrawal
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The funding event types describes the direction and reason for the funding
+        # event.
+        #
+        # @see Straddle::Models::FundingEventSummaryItemV1::Data#event_type
+        module EventType
+          extend Straddle::Internal::Type::Enum
+
+          CHARGE_DEPOSIT = :charge_deposit
+          CHARGE_REVERSAL = :charge_reversal
+          PAYOUT_RETURN = :payout_return
+          PAYOUT_WITHDRAWAL = :payout_withdrawal
+
+          # @!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::FundingEventSummaryItemV1#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