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



64
65
66
67
68
69
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
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 64

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.



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

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.



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

def header_template
  @header_template
end

#name ⇒ Object

The template name.



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

def name
  @name
end

#object_type ⇒ Object

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



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

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.



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

def tokens
  @tokens
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 46

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



130
131
132
133
134
135
136
137
138
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 130

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



183
184
185
186
187
188
189
190
191
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
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 183

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    Hubspot::Crm::Timeline.const_get(type).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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 252

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 162

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


142
143
144
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 102

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



228
229
230
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 228

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 234

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



222
223
224
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 222

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



121
122
123
124
125
126
 
# File 'lib/hubspot/codegen/crm/timeline/models/timeline_event_template_create_request.rb', line 121

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