Class: HubSpotSDK::Models::Cms::MediaPlayedEventRequest

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Cms::MediaPlayedEventRequest

Defined in:

lib/hubspot_sdk/models/cms/media_played_event_request.rb

Direct Known Subclasses

MediaBridgeCreateMediaPlayedEventParams

Defined Under Namespace

Modules: ExternalPlayContext, MediaType, State

Instance Attribute Summary

• #_hsenc ⇒ String^?
• #contact_id ⇒ Integer^?
• #contact_utk ⇒ String^?
• #external_id ⇒ String^?
• #external_play_context ⇒ Symbol, ...
• #iframe_url ⇒ String^?
• #media_bridge_id ⇒ Integer^?
• #media_name ⇒ String^?
• #media_type ⇒ Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::MediaType
• #media_url ⇒ String^?
• #occurred_timestamp ⇒ Integer
• #page_id ⇒ Integer^?
• #page_name ⇒ String^?
• #page_url ⇒ String^?
• #session_id ⇒ String
• #state ⇒ Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::State

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(media_type:, occurred_timestamp:, session_id:, state:, _hsenc: nil, contact_id: nil, contact_utk: nil, external_id: nil, external_play_context: nil, iframe_url: nil, media_bridge_id: nil, media_name: nil, media_url: nil, page_id: nil, page_name: nil, page_url: 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(media_type:, occurred_timestamp:, session_id:, state:, _hsenc: nil, contact_id: nil, contact_utk: nil, external_id: nil, external_play_context: nil, iframe_url: nil, media_bridge_id: nil, media_name: nil, media_url: nil, page_id: nil, page_name: nil, page_url: nil) ⇒ Object

Parameters:

• media_type (Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::MediaType)
• occurred_timestamp (Integer)
• session_id (String)
• state (Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::State)
• _hsenc (String) (defaults to: nil)
• contact_id (Integer) (defaults to: nil)
• contact_utk (String) (defaults to: nil)
• external_id (String) (defaults to: nil)
• external_play_context (Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::ExternalPlayContext) (defaults to: nil)
• iframe_url (String) (defaults to: nil)
• media_bridge_id (Integer) (defaults to: nil)
• media_name (String) (defaults to: nil)
• media_url (String) (defaults to: nil)
• page_id (Integer) (defaults to: nil)
• page_name (String) (defaults to: nil)
• page_url (String) (defaults to: nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 91

Instance Attribute Details

#_hsenc ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 32

optional :_hsenc, String

#contact_id ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 37

optional :contact_id, Integer, api_name: :contactId

#contact_utk ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 42

optional :contact_utk, String, api_name: :contactUtk

#external_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 47

optional :external_id, String, api_name: :externalId

#external_play_context ⇒ Symbol, ...

Returns:

• (Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::ExternalPlayContext, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 52

optional :external_play_context,
enum: -> { HubSpotSDK::Cms::MediaPlayedEventRequest::ExternalPlayContext },
api_name: :externalPlayContext

#iframe_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 59

optional :iframe_url, String, api_name: :iframeUrl

#media_bridge_id ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 64

optional :media_bridge_id, Integer, api_name: :mediaBridgeId

#media_name ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 69

optional :media_name, String, api_name: :mediaName

#media_type ⇒ Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::MediaType

Returns:

• (Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::MediaType)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 10

required :media_type,
enum: -> { HubSpotSDK::Cms::MediaPlayedEventRequest::MediaType },
api_name: :mediaType

#media_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 74

optional :media_url, String, api_name: :mediaUrl

#occurred_timestamp ⇒ Integer

Returns:

• (Integer)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 17

required :occurred_timestamp, Integer, api_name: :occurredTimestamp

#page_id ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 79

optional :page_id, Integer, api_name: :pageId

#page_name ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 84

optional :page_name, String, api_name: :pageName

#page_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 89

optional :page_url, String, api_name: :pageUrl

#session_id ⇒ String

Returns:

• (String)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 22

required :session_id, String, api_name: :sessionId

#state ⇒ Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::State

Returns:

• (Symbol, HubSpotSDK::Models::Cms::MediaPlayedEventRequest::State)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 27

required :state, enum: -> { HubSpotSDK::Cms::MediaPlayedEventRequest::State }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/hubspot_sdk/models/cms/media_played_event_request.rb', line 119