Class: MergeCRMClient::Note

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_crm_client/models/note.rb

Overview

# The Note Object ### Description The ‘Note` object is used to represent a note in the remote system. ### Usage Example TODO

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Note

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/merge_crm_client/models/note.rb', line 101

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



31
32
33
 
# File 'lib/merge_crm_client/models/note.rb', line 31

def 
  @account
end

#contact ⇒ Object

Returns the value of attribute contact.



29
30
31
 
# File 'lib/merge_crm_client/models/note.rb', line 29

def contact
  @contact
end

#content ⇒ Object

The note’s content.



27
28
29
 
# File 'lib/merge_crm_client/models/note.rb', line 27

def content
  @content
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_crm_client/models/note.rb', line 19

def id
  @id
end

#opportunity ⇒ Object

Returns the value of attribute opportunity.



33
34
35
 
# File 'lib/merge_crm_client/models/note.rb', line 33

def opportunity
  @opportunity
end

#owner ⇒ Object

Returns the value of attribute owner.



24
25
26
 
# File 'lib/merge_crm_client/models/note.rb', line 24

def owner
  @owner
end

#remote_created_at ⇒ Object

When the third party’s lead was created.



39
40
41
 
# File 'lib/merge_crm_client/models/note.rb', line 39

def remote_created_at
  @remote_created_at
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



41
42
43
 
# File 'lib/merge_crm_client/models/note.rb', line 41

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_crm_client/models/note.rb', line 22

def remote_id
  @remote_id
end

#remote_updated_at ⇒ Object

When the third party’s lead was updated.



36
37
38
 
# File 'lib/merge_crm_client/models/note.rb', line 36

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Object

Returns the value of attribute remote_was_deleted.



43
44
45
 
# File 'lib/merge_crm_client/models/note.rb', line 43

def remote_was_deleted
  @remote_was_deleted
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/merge_crm_client/models/note.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/merge_crm_client/models/note.rb', line 46

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'owner' => :'owner',
    :'content' => :'content',
    :'contact' => :'contact',
    :'account' => :'account',
    :'opportunity' => :'opportunity',
    :'remote_updated_at' => :'remote_updated_at',
    :'remote_created_at' => :'remote_created_at',
    :'remote_data' => :'remote_data',
    :'remote_was_deleted' => :'remote_was_deleted'
  }
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



207
208
209
 
# File 'lib/merge_crm_client/models/note.rb', line 207

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/merge_crm_client/models/note.rb', line 85

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'owner',
    :'content',
    :'contact',
    :'account',
    :'opportunity',
    :'remote_updated_at',
    :'remote_created_at',
    :'remote_data',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/merge_crm_client/models/note.rb', line 68

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'owner' => :'String',
    :'content' => :'String',
    :'contact' => :'String',
    :'account' => :'String',
    :'opportunity' => :'String',
    :'remote_updated_at' => :'Time',
    :'remote_created_at' => :'Time',
    :'remote_data' => :'Array<RemoteData>',
    :'remote_was_deleted' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/merge_crm_client/models/note.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      owner == o.owner &&
      content == o.content &&
      contact == o.contact &&
       == o. &&
      opportunity == o.opportunity &&
      remote_updated_at == o.remote_updated_at &&
      remote_created_at == o.remote_created_at &&
      remote_data == o.remote_data &&
      remote_was_deleted == o.remote_was_deleted
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



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
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/merge_crm_client/models/note.rb', line 237

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeCRMClient.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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/merge_crm_client/models/note.rb', line 308

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/merge_crm_client/models/note.rb', line 214

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


194
195
196
 
# File 'lib/merge_crm_client/models/note.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/merge_crm_client/models/note.rb', line 200

def hash
  [id, remote_id, owner, content, contact, , opportunity, remote_updated_at, remote_created_at, remote_data, remote_was_deleted].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



163
164
165
166
 
# File 'lib/merge_crm_client/models/note.rb', line 163

def list_invalid_properties
  invalid_properties = Array.new
  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



284
285
286
 
# File 'lib/merge_crm_client/models/note.rb', line 284

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/merge_crm_client/models/note.rb', line 290

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



278
279
280
 
# File 'lib/merge_crm_client/models/note.rb', line 278

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



170
171
172
 
# File 'lib/merge_crm_client/models/note.rb', line 170

def valid?
  true
end