Class: Hubspot::Files::File

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/files/models/file.rb

Overview

File

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ File

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 169

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access ⇒ Object

File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE.



24
25
26
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 24

def access
  @access
end

#archived ⇒ Object

If the file is deleted.



57
58
59
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 57

def archived
  @archived
end

#archived_at ⇒ Object

Deletion time of the file object.



51
52
53
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 51

def archived_at
  @archived_at
end

#created_at ⇒ Object

Creation time of the file object.



48
49
50
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 48

def created_at
  @created_at
end

#default_hosting_url ⇒ Object

Default hosting URL of the file. This will use one of HubSpot’s provided URLs to serve the file.



72
73
74
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 72

def default_hosting_url
  @default_hosting_url
end

#encoding ⇒ Object

Encoding of the file.



34
35
36
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 34

def encoding
  @encoding
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



45
46
47
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 45

def expires_at
  @expires_at
end

#extension ⇒ Object

Extension of the file. ex: .jpg, .png, .gif, .pdf, etc.



21
22
23
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 21

def extension
  @extension
end

#file_md5 ⇒ Object

Returns the value of attribute file_md5.



31
32
33
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 31

def file_md5
  @file_md5
end

#height ⇒ Object

For image and video files, the height of the content.



78
79
80
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 78

def height
  @height
end

#id ⇒ Object

File ID.



69
70
71
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 69

def id
  @id
end

#is_usable_in_content ⇒ Object

Previously "archied". Indicates if the file should be used when creating new content like web pages.



40
41
42
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 40

def is_usable_in_content
  @is_usable_in_content
end

#name ⇒ Object

Name of the file.



63
64
65
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 63

def name
  @name
end

#parent_folder_id ⇒ Object

ID of the folder the file is in.



27
28
29
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 27

def parent_folder_id
  @parent_folder_id
end

#path ⇒ Object

Path of the file in the file manager.



54
55
56
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 54

def path
  @path
end

#size ⇒ Object

Size of the file in bytes.



60
61
62
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 60

def size
  @size
end

#source_group ⇒ Object

Returns the value of attribute source_group.



29
30
31
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 29

def source_group
  @source_group
end

#type ⇒ Object

Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER.



37
38
39
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 37

def type
  @type
end

#updated_at ⇒ Object

Timestamp of the latest update to the file.



75
76
77
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 75

def updated_at
  @updated_at
end

#url ⇒ Object

URL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain.



43
44
45
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 43

def url
  @url
end

#width ⇒ Object

For image and video files, the width of the content.



66
67
68
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 66

def width
  @width
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



130
131
132
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 130

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 103

def self.attribute_map
  {
    :'extension' => :'extension',
    :'access' => :'access',
    :'parent_folder_id' => :'parentFolderId',
    :'source_group' => :'sourceGroup',
    :'file_md5' => :'fileMd5',
    :'encoding' => :'encoding',
    :'type' => :'type',
    :'is_usable_in_content' => :'isUsableInContent',
    :'url' => :'url',
    :'expires_at' => :'expiresAt',
    :'created_at' => :'createdAt',
    :'archived_at' => :'archivedAt',
    :'path' => :'path',
    :'archived' => :'archived',
    :'size' => :'size',
    :'name' => :'name',
    :'width' => :'width',
    :'id' => :'id',
    :'default_hosting_url' => :'defaultHostingUrl',
    :'updated_at' => :'updatedAt',
    :'height' => :'height'
  }
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



360
361
362
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 360

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



162
163
164
165
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 162

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

.openapi_types ⇒ Object

Attribute type mapping.



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/hubspot/codegen/files/models/file.rb', line 135

def self.openapi_types
  {
    :'extension' => :'String',
    :'access' => :'String',
    :'parent_folder_id' => :'String',
    :'source_group' => :'String',
    :'file_md5' => :'String',
    :'encoding' => :'String',
    :'type' => :'String',
    :'is_usable_in_content' => :'Boolean',
    :'url' => :'String',
    :'expires_at' => :'Integer',
    :'created_at' => :'Time',
    :'archived_at' => :'Time',
    :'path' => :'String',
    :'archived' => :'Boolean',
    :'size' => :'Integer',
    :'name' => :'String',
    :'width' => :'Integer',
    :'id' => :'String',
    :'default_hosting_url' => :'String',
    :'updated_at' => :'Time',
    :'height' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 319

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      extension == o.extension &&
      access == o.access &&
      parent_folder_id == o.parent_folder_id &&
      source_group == o.source_group &&
      file_md5 == o.file_md5 &&
      encoding == o.encoding &&
      type == o.type &&
      is_usable_in_content == o.is_usable_in_content &&
      url == o.url &&
      expires_at == o.expires_at &&
      created_at == o.created_at &&
      archived_at == o.archived_at &&
      path == o.path &&
      archived == o.archived &&
      size == o.size &&
      name == o.name &&
      width == o.width &&
      id == o.id &&
      default_hosting_url == o.default_hosting_url &&
      updated_at == o.updated_at &&
      height == o.height
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



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 391

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Hubspot::Files.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



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 462

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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 367

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


347
348
349
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



353
354
355
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 353

def hash
  [extension, access, parent_folder_id, source_group, file_md5, encoding, type, is_usable_in_content, url, expires_at, created_at, archived_at, path, archived, size, name, width, id, default_hosting_url, updated_at, height].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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 269

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

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @archived.nil?
    invalid_properties.push('invalid value for "archived", archived cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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



438
439
440
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 438

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 444

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



432
433
434
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 432

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



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 296

def valid?
  return false if @access.nil?
  access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE", "HIDDEN_SENSITIVE", "SENSITIVE"])
  return false unless access_validator.valid?(@access)
  return false if @created_at.nil?
  return false if @archived.nil?
  return false if @id.nil?
  return false if @updated_at.nil?
  true
end