Class: Trycourier::Models::InboundTrackEventParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/trycourier/models/inbound_track_event_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Trycourier::Internal::Type::BaseModel

Instance Attribute Details

#event ⇒ String

A descriptive name of the event. This name will appear as a trigger in the Courier Automation Trigger node.

Returns:

  • (String) 


15
 
# File 'lib/trycourier/models/inbound_track_event_params.rb', line 15

required :event, String

#message_id ⇒ String

A required unique identifier that will be used to de-duplicate requests. If not unique, will respond with 409 Conflict status

Returns:

  • (String) 


22
 
# File 'lib/trycourier/models/inbound_track_event_params.rb', line 22

required :message_id, String, api_name: :messageId

#properties ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


27
 
# File 'lib/trycourier/models/inbound_track_event_params.rb', line 27

required :properties, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]

#type ⇒ Symbol, Trycourier::Models::InboundTrackEventParams::Type

Returns:



32
 
# File 'lib/trycourier/models/inbound_track_event_params.rb', line 32

required :type, enum: -> { Trycourier::InboundTrackEventParams::Type }

#user_id ⇒ String?

The user id associatiated with the track

Returns:

  • (String, nil) 


38
 
# File 'lib/trycourier/models/inbound_track_event_params.rb', line 38

optional :user_id, String, api_name: :userId, nil?: true