Class: Pipedrive::Note

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Note

Initializes the object



82
83
84
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
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 82

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

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

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

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

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

  if attributes.key?(:'add_time')
    self.add_time = attributes[:'add_time']
  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
end

Instance Attribute Details

#add_time ⇒ Object

Optional creation date & time of the Note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS



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

def add_time
  @add_time
end

#content ⇒ Object

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



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

def content
  @content
end

#deal_id ⇒ Object

ID of the deal the note will be attached to.



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

def deal_id
  @deal_id
end

#org_id ⇒ Object

ID of the organization this note will be attached to.



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

def org_id
  @org_id
end

#person_id ⇒ Object

ID of the person this note will be attached to.



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

def person_id
  @person_id
end

#pinned_to_deal_flag ⇒ Object

If set, then results are filtered by note to deal pinning state (deal_id is also required).



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

def pinned_to_deal_flag
  @pinned_to_deal_flag
end

#pinned_to_organization_flag ⇒ Object

If set, then results are filtered by note to organization pinning state (org_id is also required).



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

def pinned_to_organization_flag
  @pinned_to_organization_flag
end

#pinned_to_person_flag ⇒ Object

If set, then results are filtered by note to person pinning state (person_id is also required).



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

def pinned_to_person_flag
  @pinned_to_person_flag
end

#user_id ⇒ Object

ID of the user who will be marked as the author of this note. Only an admin can change the author.



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

def user_id
  @user_id
end

Class Method Details

.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
57
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 45

def self.attribute_map
  {
    :'content' => :'content',
    :'user_id' => :'user_id',
    :'deal_id' => :'deal_id',
    :'person_id' => :'person_id',
    :'org_id' => :'org_id',
    :'add_time' => :'add_time',
    :'pinned_to_deal_flag' => :'pinned_to_deal_flag',
    :'pinned_to_organization_flag' => :'pinned_to_organization_flag',
    :'pinned_to_person_flag' => :'pinned_to_person_flag'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



181
182
183
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 181

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 60

def self.openapi_types
  {
    :'content' => :'String',
    :'user_id' => :'Integer',
    :'deal_id' => :'Integer',
    :'person_id' => :'Integer',
    :'org_id' => :'Integer',
    :'add_time' => :'String',
    :'pinned_to_deal_flag' => :'NumberBoolean',
    :'pinned_to_organization_flag' => :'NumberBoolean',
    :'pinned_to_person_flag' => :'NumberBoolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      user_id == o.user_id &&
      deal_id == o.deal_id &&
      person_id == o.person_id &&
      org_id == o.org_id &&
      add_time == o.add_time &&
      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
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 209

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 278

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 188

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

See Also:

  • `==` method


168
169
170
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



174
175
176
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 174

def hash
  [content, user_id, deal_id, person_id, org_id, add_time, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag].hash
end

#list_invalid_properties ⇒ Object

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



134
135
136
137
138
139
140
141
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 134

def list_invalid_properties
  invalid_properties = Array.new
  if @content.nil?
    invalid_properties.push('invalid value for "content", content cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



254
255
256
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 254

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



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

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



248
249
250
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 248

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



145
146
147
148
 
# File 'lib/pipedrive-openapi-client/models/note.rb', line 145

def valid?
  return false if @content.nil?
  true
end