Class: Hubspot::Crm::Timeline::TimelineEventTemplate
- Inherits:
-
Object
- Object
- Hubspot::Crm::Timeline::TimelineEventTemplate
- Defined in:
- lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb
Instance Attribute Summary collapse
-
#created_at ⇒ Object
The date and time that the Event Template was created, as an ISO 8601 timestamp.
-
#detail_template ⇒ Object
This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details.
-
#header_template ⇒ Object
This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
-
#id ⇒ Object
The template ID.
-
#name ⇒ Object
The template name.
-
#object_type ⇒ Object
The type of CRM object this template is for.
-
#tokens ⇒ Object
A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects.
-
#updated_at ⇒ Object
The date and time that the Event Template was last updated, as an ISO 8601 timestamp.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TimelineEventTemplate
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ TimelineEventTemplate
Initializes the object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 85 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Timeline::TimelineEventTemplate` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Timeline::TimelineEventTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'detail_template') self.detail_template = attributes[:'detail_template'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'tokens') if (value = attributes[:'tokens']).is_a?(Array) self.tokens = value end end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'header_template') self.header_template = attributes[:'header_template'] end if attributes.key?(:'object_type') self.object_type = attributes[:'object_type'] end if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end end |
Instance Attribute Details
#created_at ⇒ Object
The date and time that the Event Template was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
21 22 23 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 21 def created_at @created_at end |
#detail_template ⇒ Object
This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details.
24 25 26 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 24 def detail_template @detail_template end |
#header_template ⇒ Object
This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
36 37 38 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 36 def header_template @header_template end |
#id ⇒ Object
The template ID.
33 34 35 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 33 def id @id end |
#name ⇒ Object
The template name.
27 28 29 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 27 def name @name end |
#object_type ⇒ Object
The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported.
39 40 41 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 39 def object_type @object_type end |
#tokens ⇒ Object
A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects.
30 31 32 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 30 def tokens @tokens end |
#updated_at ⇒ Object
The date and time that the Event Template was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020.
42 43 44 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 42 def updated_at @updated_at end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
59 60 61 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 59 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 45 def self.attribute_map { :'created_at' => :'createdAt', :'detail_template' => :'detailTemplate', :'name' => :'name', :'tokens' => :'tokens', :'id' => :'id', :'header_template' => :'headerTemplate', :'object_type' => :'objectType', :'updated_at' => :'updatedAt' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
196 197 198 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 196 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
78 79 80 81 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 78 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 64 def self.openapi_types { :'created_at' => :'Time', :'detail_template' => :'String', :'name' => :'String', :'tokens' => :'Array<TimelineEventTemplateToken>', :'id' => :'String', :'header_template' => :'String', :'object_type' => :'String', :'updated_at' => :'Time' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 168 def ==(o) return true if self.equal?(o) self.class == o.class && created_at == o.created_at && detail_template == o.detail_template && name == o.name && tokens == o.tokens && id == o.id && header_template == o.header_template && object_type == o.object_type && updated_at == o.updated_at end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 227 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Hubspot::Crm::Timeline.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 298 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 203 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end |
#eql?(o) ⇒ Boolean
183 184 185 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 183 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
189 190 191 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 189 def hash [created_at, detail_template, name, tokens, id, header_template, object_type, updated_at].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 135 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @tokens.nil? invalid_properties.push('invalid value for "tokens", tokens cannot be nil.') end if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @object_type.nil? invalid_properties.push('invalid value for "object_type", object_type cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
274 275 276 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 274 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 280 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
268 269 270 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 268 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
158 159 160 161 162 163 164 |
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template.rb', line 158 def valid? return false if @name.nil? return false if @tokens.nil? return false if @id.nil? return false if @object_type.nil? true end |