Class: Pipedrive::FileData

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

Overview

The File data

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FileData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 168

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_flag ⇒ Object

Whether the User is active or not. false = Not activated, true = Activated



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

def active_flag
  @active_flag
end

#activity_id ⇒ Object

The ID of the Activity to associate the File with



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

def activity_id
  @activity_id
end

#add_time ⇒ Object

The date and time when the File was added/created. Format: YYYY-MM-DD HH:MM:SS



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

def add_time
  @add_time
end

#cid ⇒ Object

The ID of the inline attachment



64
65
66
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 64

def cid
  @cid
end

#deal_id ⇒ Object

The ID of the Deal to associate the File with



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

def deal_id
  @deal_id
end

#deal_name ⇒ Object

The name of the Deal associated with the File



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

def deal_name
  @deal_name
end

#description ⇒ Object

The description of the File



94
95
96
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 94

def description
  @description
end

#file_name ⇒ Object

The original name of the File



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

def file_name
  @file_name
end

#file_size ⇒ Object

The size of the File



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

def file_size
  @file_size
end

#id ⇒ Object

The ID of the File



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

def id
  @id
end

#inline_flag ⇒ Object

Whether the File was uploaded as inline or not



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

def inline_flag
  @inline_flag
end

#mail_message_id ⇒ Object

The ID of the mail message to associate the File with



70
71
72
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 70

def mail_message_id
  @mail_message_id
end

#mail_template_id ⇒ Object

The ID of the mail template to associate the File with



73
74
75
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 73

def mail_template_id
  @mail_template_id
end

#name ⇒ Object

The visible name of the File



91
92
93
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 91

def name
  @name
end

#org_id ⇒ Object

The ID of the Organization to associate the File with



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

def org_id
  @org_id
end

#org_name ⇒ Object

The name of the Organization associated with the File



82
83
84
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 82

def org_name
  @org_name
end

#person_id ⇒ Object

The ID of the Person to associate the File with



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

def person_id
  @person_id
end

#person_name ⇒ Object

The name of the Person associated with the File



79
80
81
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 79

def person_name
  @person_name
end

#product_id ⇒ Object

The ID of the Product to associate the File with



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

def product_id
  @product_id
end

#product_name ⇒ Object

The name of the Product associated with the File



85
86
87
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 85

def product_name
  @product_name
end

#remote_id ⇒ Object

The ID of the remote item



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

def remote_id
  @remote_id
end

#remote_location ⇒ Object

The location type to send the File to. Only googledrive is supported at the moment.



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

def remote_location
  @remote_location
end

#s3_bucket ⇒ Object

The location of the cloud storage



67
68
69
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 67

def s3_bucket
  @s3_bucket
end

#update_time ⇒ Object

The last updated date and time of the File. Format: YYYY-MM-DD HH:MM:SS



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

def update_time
  @update_time
end

#url ⇒ Object

The URL of the download File



88
89
90
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 88

def url
  @url
end

#user_id ⇒ Object

The ID of the User to associate the File with



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'user_id',
    :'deal_id' => :'deal_id',
    :'person_id' => :'person_id',
    :'org_id' => :'org_id',
    :'product_id' => :'product_id',
    :'activity_id' => :'activity_id',
    :'add_time' => :'add_time',
    :'update_time' => :'update_time',
    :'file_name' => :'file_name',
    :'file_size' => :'file_size',
    :'active_flag' => :'active_flag',
    :'inline_flag' => :'inline_flag',
    :'remote_location' => :'remote_location',
    :'remote_id' => :'remote_id',
    :'cid' => :'cid',
    :'s3_bucket' => :'s3_bucket',
    :'mail_message_id' => :'mail_message_id',
    :'mail_template_id' => :'mail_template_id',
    :'deal_name' => :'deal_name',
    :'person_name' => :'person_name',
    :'org_name' => :'org_name',
    :'product_name' => :'product_name',
    :'url' => :'url',
    :'name' => :'name',
    :'description' => :'description'
  }
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



347
348
349
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 347

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



161
162
163
164
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 161

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'user_id' => :'Integer',
    :'deal_id' => :'Integer',
    :'person_id' => :'Integer',
    :'org_id' => :'Integer',
    :'product_id' => :'Integer',
    :'activity_id' => :'Integer',
    :'add_time' => :'String',
    :'update_time' => :'String',
    :'file_name' => :'String',
    :'file_size' => :'String',
    :'active_flag' => :'Boolean',
    :'inline_flag' => :'Boolean',
    :'remote_location' => :'String',
    :'remote_id' => :'String',
    :'cid' => :'String',
    :'s3_bucket' => :'String',
    :'mail_message_id' => :'String',
    :'mail_template_id' => :'String',
    :'deal_name' => :'String',
    :'person_name' => :'String',
    :'org_name' => :'String',
    :'product_name' => :'String',
    :'url' => :'String',
    :'name' => :'String',
    :'description' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 301

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      deal_id == o.deal_id &&
      person_id == o.person_id &&
      org_id == o.org_id &&
      product_id == o.product_id &&
      activity_id == o.activity_id &&
      add_time == o.add_time &&
      update_time == o.update_time &&
      file_name == o.file_name &&
      file_size == o.file_size &&
      active_flag == o.active_flag &&
      inline_flag == o.inline_flag &&
      remote_location == o.remote_location &&
      remote_id == o.remote_id &&
      cid == o.cid &&
      s3_bucket == o.s3_bucket &&
      mail_message_id == o.mail_message_id &&
      mail_template_id == o.mail_template_id &&
      deal_name == o.deal_name &&
      person_name == o.person_name &&
      org_name == o.org_name &&
      product_name == o.product_name &&
      url == o.url &&
      name == o.name &&
      description == o.description
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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 375

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 444

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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 354

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


334
335
336
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



340
341
342
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 340

def hash
  [id, user_id, deal_id, person_id, org_id, product_id, activity_id, add_time, update_time, file_name, file_size, active_flag, inline_flag, remote_location, remote_id, cid, s3_bucket, mail_message_id, mail_template_id, deal_name, person_name, org_name, product_name, url, name, description].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



288
289
290
291
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 288

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



420
421
422
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 420

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 426

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



414
415
416
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 414

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



295
296
297
 
# File 'lib/pipedrive-openapi-client/models/file_data.rb', line 295

def valid?
  true
end