Class: Straddle::Models::FundingEventSummaryList

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/straddle/models/funding_event_summary_list.rb,
sig/straddle/models/funding_event_summary_list.rbs

Overview

See Also:

  • Straddle::Resources::FundingEvents#list

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(data:, meta:, response_type:) ⇒ Object

Some parameter documentations has been truncated, see Straddle::Models::FundingEventSummaryList for more details.

Parameters:




# File 'lib/straddle/models/funding_event_summary_list.rb', line 30

Instance Attribute Details

#data ⇒ Array<Straddle::Models::FundingEventSummary>

Funding events returned for this page.

Parameters:

Returns:



11
 
# File 'lib/straddle/models/funding_event_summary_list.rb', line 11

required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::FundingEventSummary] }

#meta ⇒ Straddle::Models::PageMetadata

Metadata for an API request and a page of results.

Parameters:

Returns:



17
 
# File 'lib/straddle/models/funding_event_summary_list.rb', line 17

required :meta, -> { Straddle::PageMetadata }

#response_type ⇒ Symbol, Straddle::Models::ResponseType

Shape of the response envelope.

  • object means data contains one JSON object.
  • array means data contains an array of JSON objects.
  • error means error contains the error details.
  • none means the response contains no data.

Parameters:

  • value (Straddle::Models::response_type)

Returns:



28
 
# File 'lib/straddle/models/funding_event_summary_list.rb', line 28

required :response_type, enum: -> { Straddle::ResponseType }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


23
 
# File 'sig/straddle/models/funding_event_summary_list.rbs', line 23

def to_hash: -> {