Class: Pipedrive::Activity

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Activity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 138

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

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

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

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

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

  if attributes.key?(:'duration')
    self.duration = attributes[:'duration']
  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?(:'participants')
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
  end

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

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

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

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

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

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

Instance Attribute Details

#attendees ⇒ Object

Attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: [Pipedrive::Activity."email_address":"mail@example"email_address":"[email protected]"] or ["email_address":"[email protected]"]



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

def attendees
  @attendees
end

#busy_flag ⇒ Object

Set the activity as ‘Busy’ or ‘Free’. If the flag is set to true, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with null. When the value of the flag is unset (null), the flag defaults to ‘Busy’ if it has a time set, and ‘Free’ if it is an all-day event without specified time.



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

def busy_flag
  @busy_flag
end

#deal_id ⇒ Object

ID of the deal this activity will be associated with



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

def deal_id
  @deal_id
end

#done ⇒ Object

Returns the value of attribute done.



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

def done
  @done
end

#due_date ⇒ Object

Due date of the activity. Format: YYYY-MM-DD



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

def due_date
  @due_date
end

#due_time ⇒ Object

Due time of the activity in UTC. Format: HH:MM



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

def due_time
  @due_time
end

#duration ⇒ Object

Duration of the activity. Format: HH:MM



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

def duration
  @duration
end

#location ⇒ Object

The address of the activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.



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

def location
  @location
end

#note ⇒ Object

Note of the activity (HTML format)



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

def note
  @note
end

#org_id ⇒ Object

ID of the organization this activity will be associated with



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

def org_id
  @org_id
end

#participants ⇒ Object

List of multiple persons (participants) this activity will be associated with. If omitted, single participant from person_id field is used. It requires a structure as follows: ["person_id":1,"primary_flag":true]



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

def participants
  @participants
end

#person_id ⇒ Object

ID of the person this activity will be associated with



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

def person_id
  @person_id
end

#public_description ⇒ Object

Additional details about the activity that will be synced to your external calendar. Unlike the note added to the activity, the description will be publicly visible to any guests added to the activity.



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

def public_description
  @public_description
end

#subject ⇒ Object

Subject of the activity



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

def subject
  @subject
end

#type ⇒ Object

Type of the activity. This is in correlation with the key_string parameter of ActivityTypes.



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

def type
  @type
end

#user_id ⇒ Object

ID of the user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'subject' => :'subject',
    :'done' => :'done',
    :'type' => :'type',
    :'due_date' => :'due_date',
    :'due_time' => :'due_time',
    :'duration' => :'duration',
    :'user_id' => :'user_id',
    :'deal_id' => :'deal_id',
    :'person_id' => :'person_id',
    :'participants' => :'participants',
    :'org_id' => :'org_id',
    :'note' => :'note',
    :'location' => :'location',
    :'public_description' => :'public_description',
    :'busy_flag' => :'busy_flag',
    :'attendees' => :'attendees'
  }
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



293
294
295
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 293

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 131

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

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 109

def self.openapi_types
  {
    :'subject' => :'String',
    :'done' => :'NumberBoolean',
    :'type' => :'String',
    :'due_date' => :'Date',
    :'due_time' => :'String',
    :'duration' => :'String',
    :'user_id' => :'Integer',
    :'deal_id' => :'Integer',
    :'person_id' => :'Integer',
    :'participants' => :'Array<Object>',
    :'org_id' => :'Integer',
    :'note' => :'String',
    :'location' => :'String',
    :'public_description' => :'String',
    :'busy_flag' => :'Boolean',
    :'attendees' => :'Array<Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subject == o.subject &&
      done == o.done &&
      type == o.type &&
      due_date == o.due_date &&
      due_time == o.due_time &&
      duration == o.duration &&
      user_id == o.user_id &&
      deal_id == o.deal_id &&
      person_id == o.person_id &&
      participants == o.participants &&
      org_id == o.org_id &&
      note == o.note &&
      location == o.location &&
      public_description == o.public_description &&
      busy_flag == o.busy_flag &&
      attendees == o.attendees
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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 321

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 390

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 300

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


280
281
282
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



286
287
288
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 286

def hash
  [subject, done, type, due_date, due_time, duration, user_id, deal_id, person_id, participants, org_id, note, location, public_description, busy_flag, attendees].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



222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 222

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

  if @type.nil?
    invalid_properties.push('invalid value for "type", 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



366
367
368
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 366

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 372

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



360
361
362
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 360

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



237
238
239
240
241
242
243
 
# File 'lib/pipedrive-openapi-client/models/activity.rb', line 237

def valid?
  return false if @subject.nil?
  return false if @type.nil?
  busy_flag_validator = EnumAttributeValidator.new('Boolean', ["true", "false"])
  return false unless busy_flag_validator.valid?(@busy_flag)
  true
end