straddle 0.1.0.pre.alpha.1

data/lib/straddle/models/funding_event_summary_paged_v1.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class FundingEventSummaryPagedV1 < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Straddle::Models::FundingEventSummaryPagedV1::Data>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::FundingEventSummaryPagedV1::Data] }
+
+      # @!attribute meta
+      #
+      #   @return [Straddle::Models::FundingEventSummaryPagedV1::Meta]
+      required :meta, -> { Straddle::FundingEventSummaryPagedV1::Meta }
+
+      # @!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::FundingEventSummaryPagedV1::ResponseType]
+      required :response_type, enum: -> { Straddle::FundingEventSummaryPagedV1::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::FundingEventSummaryPagedV1} for more details.
+      #
+      #   @param data [Array<Straddle::Models::FundingEventSummaryPagedV1::Data>]
+      #
+      #   @param meta [Straddle::Models::FundingEventSummaryPagedV1::Meta]
+      #
+      #   @param response_type [Symbol, Straddle::Models::FundingEventSummaryPagedV1::ResponseType] Indicates the structure of the returned content.
+
+      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::FundingEventSummaryPagedV1::Data::Direction]
+        required :direction, enum: -> { Straddle::FundingEventSummaryPagedV1::Data::Direction }
+
+        # @!attribute event_type
+        #   The funding event types describes the direction and reason for the funding
+        #   event.
+        #
+        #   @return [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Data::EventType]
+        required :event_type, enum: -> { Straddle::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::Data::Direction] Describes the direction of the funding event from the perspective of the `linked
+        #
+        #   @param event_type [Symbol, Straddle::Models::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::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
+
+      # @see Straddle::Models::FundingEventSummaryPagedV1#meta
+      class Meta < Straddle::Internal::Type::BaseModel
+        # @!attribute api_request_id
+        #   Unique identifier for this API request, useful for troubleshooting.
+        #
+        #   @return [String]
+        required :api_request_id, String
+
+        # @!attribute api_request_timestamp
+        #   Timestamp for this API request, useful for troubleshooting.
+        #
+        #   @return [Time]
+        required :api_request_timestamp, Time
+
+        # @!attribute max_page_size
+        #   Maximum allowed page size for this endpoint.
+        #
+        #   @return [Integer]
+        required :max_page_size, Integer
+
+        # @!attribute page_number
+        #   Page number for paginated results.
+        #
+        #   @return [Integer]
+        required :page_number, Integer
+
+        # @!attribute page_size
+        #   Number of items per page in this response.
+        #
+        #   @return [Integer]
+        required :page_size, Integer
+
+        # @!attribute sort_by
+        #   The field that the results were sorted by.
+        #
+        #   @return [String]
+        required :sort_by, String
+
+        # @!attribute sort_order
+        #
+        #   @return [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Meta::SortOrder]
+        required :sort_order, enum: -> { Straddle::FundingEventSummaryPagedV1::Meta::SortOrder }
+
+        # @!attribute total_items
+        #
+        #   @return [Integer]
+        required :total_items, Integer
+
+        # @!attribute total_pages
+        #   The number of pages available.
+        #
+        #   @return [Integer]
+        required :total_pages, Integer
+
+        # @!method initialize(api_request_id:, api_request_timestamp:, max_page_size:, page_number:, page_size:, sort_by:, sort_order:, total_items:, total_pages:)
+        #   @param api_request_id [String] Unique identifier for this API request, useful for troubleshooting.
+        #
+        #   @param api_request_timestamp [Time] Timestamp for this API request, useful for troubleshooting.
+        #
+        #   @param max_page_size [Integer] Maximum allowed page size for this endpoint.
+        #
+        #   @param page_number [Integer] Page number for paginated results.
+        #
+        #   @param page_size [Integer] Number of items per page in this response.
+        #
+        #   @param sort_by [String] The field that the results were sorted by.
+        #
+        #   @param sort_order [Symbol, Straddle::Models::FundingEventSummaryPagedV1::Meta::SortOrder]
+        #
+        #   @param total_items [Integer]
+        #
+        #   @param total_pages [Integer] The number of pages available.
+
+        # @see Straddle::Models::FundingEventSummaryPagedV1::Meta#sort_order
+        module SortOrder
+          extend Straddle::Internal::Type::Enum
+
+          ASC = :asc
+          DESC = :desc
+
+          # @!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::FundingEventSummaryPagedV1#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

data/lib/straddle/models/paged_response_metadata.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PagedResponseMetadata < Straddle::Internal::Type::BaseModel
+      # @!attribute api_request_id
+      #   Unique identifier for this API request, useful for troubleshooting.
+      #
+      #   @return [String]
+      required :api_request_id, String
+
+      # @!attribute api_request_timestamp
+      #   Timestamp for this API request, useful for troubleshooting.
+      #
+      #   @return [Time]
+      required :api_request_timestamp, Time
+
+      # @!attribute max_page_size
+      #   Maximum allowed page size for this endpoint.
+      #
+      #   @return [Integer]
+      required :max_page_size, Integer
+
+      # @!attribute page_number
+      #   Page number for paginated results.
+      #
+      #   @return [Integer]
+      required :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of items per page in this response.
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute sort_by
+      #   The field that the results were sorted by.
+      #
+      #   @return [String]
+      required :sort_by, String
+
+      # @!attribute sort_order
+      #
+      #   @return [Symbol, Straddle::Models::PagedResponseMetadata::SortOrder]
+      required :sort_order, enum: -> { Straddle::PagedResponseMetadata::SortOrder }
+
+      # @!attribute total_items
+      #   Total number of items returned in this response.
+      #
+      #   @return [Integer]
+      required :total_items, Integer
+
+      # @!attribute total_pages
+      #   The number of pages available.
+      #
+      #   @return [Integer]
+      required :total_pages, Integer
+
+      # @!method initialize(api_request_id:, api_request_timestamp:, max_page_size:, page_number:, page_size:, sort_by:, sort_order:, total_items:, total_pages:)
+      #   Metadata about the API request, including an identifier, timestamp, and
+      #   pagination details.
+      #
+      #   @param api_request_id [String] Unique identifier for this API request, useful for troubleshooting.
+      #
+      #   @param api_request_timestamp [Time] Timestamp for this API request, useful for troubleshooting.
+      #
+      #   @param max_page_size [Integer] Maximum allowed page size for this endpoint.
+      #
+      #   @param page_number [Integer] Page number for paginated results.
+      #
+      #   @param page_size [Integer] Number of items per page in this response.
+      #
+      #   @param sort_by [String] The field that the results were sorted by.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::PagedResponseMetadata::SortOrder]
+      #
+      #   @param total_items [Integer] Total number of items returned in this response.
+      #
+      #   @param total_pages [Integer] The number of pages available.
+
+      # @see Straddle::Models::PagedResponseMetadata#sort_order
+      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/paykey_cancel_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#cancel
+    class PaykeyCancelParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute reason
+      #
+      #   @return [String, nil]
+      optional :reason, 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(reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param reason [String, nil]
+      #   @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/paykey_details_v1.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaykeyDetailsV1 < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the paykey.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the paykey.
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute label
+      #   Human-readable label that combines the bank name and masked account number to
+      #   help easility represent this paykey in a UI
+      #
+      #   @return [String]
+      required :label, String
+
+      # @!attribute balance
+      #   The most recent balance of the bank account associated with the paykey in
+      #   dollars.
+      #
+      #   @return [Integer, nil]
+      optional :balance, Integer, nil?: true
+
+      # @!method initialize(id:, customer_id:, label:, balance: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::PaykeyDetailsV1} for more details.
+      #
+      #   @param id [String] Unique identifier for the paykey.
+      #
+      #   @param customer_id [String] Unique identifier for the customer associated with the paykey.
+      #
+      #   @param label [String] Human-readable label that combines the bank name and masked account number to he
+      #
+      #   @param balance [Integer, nil] The most recent balance of the bank account associated with the paykey in dollar
+    end
+  end
+end

data/lib/straddle/models/paykey_get_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#get
+    class PaykeyGetParams < 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/paykey_list_params.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#list
+    class PaykeyListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute customer_id
+      #   Filter paykeys by related customer ID.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String
+
+      # @!attribute page_number
+      #   Page number for paginated results. Starts at 1.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of results per page. Maximum: 1000.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort_by
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyListParams::SortBy, nil]
+      optional :sort_by, enum: -> { Straddle::PaykeyListParams::SortBy }
+
+      # @!attribute sort_order
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyListParams::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::PaykeyListParams::SortOrder }
+
+      # @!attribute source
+      #   Filter paykeys by their source.
+      #
+      #   @return [Array<Symbol, Straddle::Models::PaykeyListParams::Source>, nil]
+      optional :source, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyListParams::Source] }
+
+      # @!attribute status
+      #   Filter paykeys by their current status.
+      #
+      #   @return [Array<Symbol, Straddle::Models::PaykeyListParams::Status>, nil]
+      optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyListParams::Status] }
+
+      # @!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(customer_id: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param customer_id [String] Filter paykeys by related customer ID.
+      #
+      #   @param page_number [Integer] Page number for paginated results. Starts at 1.
+      #
+      #   @param page_size [Integer] Number of results per page. Maximum: 1000.
+      #
+      #   @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy]
+      #
+      #   @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder]
+      #
+      #   @param source [Array<Symbol, Straddle::Models::PaykeyListParams::Source>] Filter paykeys by their source.
+      #
+      #   @param status [Array<Symbol, Straddle::Models::PaykeyListParams::Status>] Filter paykeys by their current status.
+      #
+      #   @param correlation_id [String]
+      #
+      #   @param request_id [String]
+      #
+      #   @param straddle_account_id [String]
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      module SortBy
+        extend Straddle::Internal::Type::Enum
+
+        INSTITUTION_NAME = :institution_name
+        EXPIRES_AT = :expires_at
+        CREATED_AT = :created_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Source
+        extend Straddle::Internal::Type::Enum
+
+        BANK_ACCOUNT = :bank_account
+        STRADDLE = :straddle
+        MX = :mx
+        PLAID = :plaid
+        TAN = :tan
+        QUILTT = :quiltt
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        PENDING = :pending
+        ACTIVE = :active
+        INACTIVE = :inactive
+        REJECTED = :rejected
+        REVIEW = :review
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/paykey_reveal_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Paykeys#reveal
+    class PaykeyRevealParams < 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