Class: Pipedrive::BaseNote

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/models/base_note.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseNote

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_flag ⇒ Object

If Note is active or deleted



21
22
23
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 21

def active_flag
  @active_flag
end

#add_time ⇒ Object

The creation date and time of the Note



24
25
26
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 24

def add_time
  @add_time
end

#content ⇒ Object

Content of the Note in HTML format. Subject to sanitization on the back-end.



27
28
29
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 27

def content
  @content
end

#deal ⇒ Object

Returns the value of attribute deal.



29
30
31
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 29

def deal
  @deal
end

#deal_id ⇒ Object

The ID of the Deal the Note is attached to



32
33
34
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 32

def deal_id
  @deal_id
end

#id ⇒ Object

The ID of the Note



18
19
20
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 18

def id
  @id
end

#last_update_user_id ⇒ Object

The ID of the User who updated the Note last



35
36
37
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 35

def last_update_user_id
  @last_update_user_id
end

#org_id ⇒ Object

The ID of the Organization this Note is attached to



38
39
40
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 38

def org_id
  @org_id
end

#organization ⇒ Object

Returns the value of attribute organization.



40
41
42
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 40

def organization
  @organization
end

#person ⇒ Object

Returns the value of attribute person.



42
43
44
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 42

def person
  @person
end

#person_id ⇒ Object

The ID of the Person this Note is attached to



45
46
47
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 45

def person_id
  @person_id
end

#pinned_to_deal_flag ⇒ Object

If true, then the results are filtered by Note to Deal pinning state.



48
49
50
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 48

def pinned_to_deal_flag
  @pinned_to_deal_flag
end

#pinned_to_organization_flag ⇒ Object

If true, then the results are filtered by Note to Organization pinning state.



51
52
53
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 51

def pinned_to_organization_flag
  @pinned_to_organization_flag
end

#pinned_to_person_flag ⇒ Object

If true, then the results are filtered by Note to Person pinning state.



54
55
56
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 54

def pinned_to_person_flag
  @pinned_to_person_flag
end

#update_time ⇒ Object

The last updated date and time of the Note



57
58
59
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 57

def update_time
  @update_time
end

#user ⇒ Object

Returns the value of attribute user.



59
60
61
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 59

def user
  @user
end

#user_id ⇒ Object

The ID of the Note creator



62
63
64
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 62

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 65

def self.attribute_map
  {
    :'id' => :'id',
    :'active_flag' => :'active_flag',
    :'add_time' => :'add_time',
    :'content' => :'content',
    :'deal' => :'deal',
    :'deal_id' => :'deal_id',
    :'last_update_user_id' => :'last_update_user_id',
    :'org_id' => :'org_id',
    :'organization' => :'organization',
    :'person' => :'person',
    :'person_id' => :'person_id',
    :'pinned_to_deal_flag' => :'pinned_to_deal_flag',
    :'pinned_to_organization_flag' => :'pinned_to_organization_flag',
    :'pinned_to_person_flag' => :'pinned_to_person_flag',
    :'update_time' => :'update_time',
    :'user' => :'user',
    :'user_id' => :'user_id'
  }
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



252
253
254
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 88

def self.openapi_types
  {
    :'id' => :'Integer',
    :'active_flag' => :'Boolean',
    :'add_time' => :'String',
    :'content' => :'String',
    :'deal' => :'BaseNoteDealTitle',
    :'deal_id' => :'Integer',
    :'last_update_user_id' => :'Integer',
    :'org_id' => :'Integer',
    :'organization' => :'BaseNoteOrganization',
    :'person' => :'BaseNotePerson',
    :'person_id' => :'Integer',
    :'pinned_to_deal_flag' => :'Boolean',
    :'pinned_to_organization_flag' => :'Boolean',
    :'pinned_to_person_flag' => :'Boolean',
    :'update_time' => :'String',
    :'user' => :'NoteCreatorUser',
    :'user_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      active_flag == o.active_flag &&
      add_time == o.add_time &&
      content == o.content &&
      deal == o.deal &&
      deal_id == o.deal_id &&
      last_update_user_id == o.last_update_user_id &&
      org_id == o.org_id &&
      organization == o.organization &&
      person == o.person &&
      person_id == o.person_id &&
      pinned_to_deal_flag == o.pinned_to_deal_flag &&
      pinned_to_organization_flag == o.pinned_to_organization_flag &&
      pinned_to_person_flag == o.pinned_to_person_flag &&
      update_time == o.update_time &&
      user == o.user &&
      user_id == o.user_id
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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 280

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
    Pipedrive.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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 349

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 259

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


239
240
241
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 245

def hash
  [id, active_flag, add_time, content, deal, deal_id, last_update_user_id, org_id, organization, person, person_id, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, update_time, user, user_id].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



202
203
204
205
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 202

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



325
326
327
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 331

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



319
320
321
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 319

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



209
210
211
 
# File 'lib/pipedrive-openapi-client/models/base_note.rb', line 209

def valid?
  true
end