Class: HubSpotSDK::Models::Events::IndexedTimePoint

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Events::IndexedTimePoint

Defined in:

lib/hubspot_sdk/models/events/indexed_time_point.rb

Defined Under Namespace

Modules: IndexReference, TimeType, TimezoneSource

Instance Attribute Summary

• #index_reference ⇒ HubSpotSDK::Models::Events::NowReference, ...
• #offset ⇒ HubSpotSDK::Models::Events::IndexOffset^?
• #should_generate_refresh_time ⇒ Boolean^?
• #time_type ⇒ Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimeType
• #timezone_source ⇒ Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimezoneSource
• #zone_id ⇒ String

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(HubSpotSDK::Models::Events::NowReference, HubSpotSDK::Models::Events::TodayReference, HubSpotSDK::Models::Events::WeekReference, HubSpotSDK::Models::Events::MonthReference, HubSpotSDK::Models::Events::QuarterReference, HubSpotSDK::Models::Events::FiscalQuarter, HubSpotSDK::Models::Events::YearReference, HubSpotSDK::Models::Events::FiscalYear)

Instance Method Summary

• #initialize(index_reference:, time_type:, timezone_source:, zone_id:, offset: nil, should_generate_refresh_time: nil) ⇒ Object constructor

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(index_reference:, time_type:, timezone_source:, zone_id:, offset: nil, should_generate_refresh_time: nil) ⇒ Object

Parameters:

• index_reference (HubSpotSDK::Models::Events::NowReference, HubSpotSDK::Models::Events::TodayReference, HubSpotSDK::Models::Events::WeekReference, HubSpotSDK::Models::Events::MonthReference, HubSpotSDK::Models::Events::QuarterReference, HubSpotSDK::Models::Events::FiscalQuarter, HubSpotSDK::Models::Events::YearReference, HubSpotSDK::Models::Events::FiscalYear)
• time_type (Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimeType)
• timezone_source (Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimezoneSource)
• zone_id (String)
• offset (HubSpotSDK::Models::Events::IndexOffset) (defaults to: nil)
• should_generate_refresh_time (Boolean) (defaults to: nil)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 43

Instance Attribute Details

#index_reference ⇒ HubSpotSDK::Models::Events::NowReference, ...

Returns:

• (HubSpotSDK::Models::Events::NowReference, HubSpotSDK::Models::Events::TodayReference, HubSpotSDK::Models::Events::WeekReference, HubSpotSDK::Models::Events::MonthReference, HubSpotSDK::Models::Events::QuarterReference, HubSpotSDK::Models::Events::FiscalQuarter, HubSpotSDK::Models::Events::YearReference, HubSpotSDK::Models::Events::FiscalYear)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 10

required :index_reference,
union: -> { HubSpotSDK::Events::IndexedTimePoint::IndexReference },
api_name: :indexReference

#offset ⇒ HubSpotSDK::Models::Events::IndexOffset^?

Returns:

• (HubSpotSDK::Models::Events::IndexOffset, nil)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 34

optional :offset, -> { HubSpotSDK::Events::IndexOffset }

#should_generate_refresh_time ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 39

optional :should_generate_refresh_time,
HubSpotSDK::Internal::Type::Boolean,
api_name: :shouldGenerateRefreshTime

#time_type ⇒ Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimeType

Returns:

• (Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimeType)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 17

required :time_type, enum: -> { HubSpotSDK::Events::IndexedTimePoint::TimeType }, api_name: :timeType

#timezone_source ⇒ Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimezoneSource

Returns:

• (Symbol, HubSpotSDK::Models::Events::IndexedTimePoint::TimezoneSource)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 22

required :timezone_source,
enum: -> { HubSpotSDK::Events::IndexedTimePoint::TimezoneSource },
api_name: :timezoneSource

#zone_id ⇒ String

Returns:

• (String)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 29

required :zone_id, String, api_name: :zoneId

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 81

.variants ⇒ Array(HubSpotSDK::Models::Events::NowReference, HubSpotSDK::Models::Events::TodayReference, HubSpotSDK::Models::Events::WeekReference, HubSpotSDK::Models::Events::MonthReference, HubSpotSDK::Models::Events::QuarterReference, HubSpotSDK::Models::Events::FiscalQuarter, HubSpotSDK::Models::Events::YearReference, HubSpotSDK::Models::Events::FiscalYear)

Returns:

• (Array(HubSpotSDK::Models::Events::NowReference, HubSpotSDK::Models::Events::TodayReference, HubSpotSDK::Models::Events::WeekReference, HubSpotSDK::Models::Events::MonthReference, HubSpotSDK::Models::Events::QuarterReference, HubSpotSDK::Models::Events::FiscalQuarter, HubSpotSDK::Models::Events::YearReference, HubSpotSDK::Models::Events::FiscalYear))

# File 'lib/hubspot_sdk/models/events/indexed_time_point.rb', line 71