Class: Hubspot::Crm::Timeline::TimelineEventTemplateCreateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimelineEventTemplateCreateRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 70

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Timeline::TimelineEventTemplateCreateRequest` 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::TimelineEventTemplateCreateRequest`. 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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'header_template')
    self.header_template = attributes[:'header_template']
  end

  if attributes.key?(:'detail_template')
    self.detail_template = attributes[:'detail_template']
  end

  if attributes.key?(:'tokens')
    if (value = attributes[:'tokens']).is_a?(Array)
      self.tokens = value
    end
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  end
end

Instance Attribute Details

#detail_template ⇒ Object

This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details.



27
28
29
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 27

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.



24
25
26
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 24

def header_template
  @header_template
end

#name ⇒ Object

The template name.



21
22
23
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 21

def name
  @name
end

#object_type ⇒ Object

The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported.



33
34
35
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 33

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_create_request.rb', line 30

def tokens
  @tokens
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 47

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



36
37
38
39
40
41
42
43
44
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 36

def self.attribute_map
  {
    :'name' => :'name',
    :'header_template' => :'headerTemplate',
    :'detail_template' => :'detailTemplate',
    :'tokens' => :'tokens',
    :'object_type' => :'objectType'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



161
162
163
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 161

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



63
64
65
66
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 63

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 52

def self.openapi_types
  {
    :'name' => :'String',
    :'header_template' => :'String',
    :'detail_template' => :'String',
    :'tokens' => :'Array<TimelineEventTemplateToken>',
    :'object_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      header_template == o.header_template &&
      detail_template == o.detail_template &&
      tokens == o.tokens &&
      object_type == o.object_type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 192

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 263

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 168

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


148
149
150
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 148

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



154
155
156
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 154

def hash
  [name, header_template, detail_template, tokens, object_type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 108

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 @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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 239

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 245

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

Returns:

  • (String) —

    String presentation of the object



233
234
235
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 233

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



127
128
129
130
131
132
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 127

def valid?
  return false if @name.nil?
  return false if @tokens.nil?
  return false if @object_type.nil?
  true
end