Class: Hubspot::Files::File

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

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



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

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

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



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

def access
  @access
end

#archived ⇒ Object

If the file is deleted.



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

def archived
  @archived
end

#archived_at ⇒ Object

Deletion time of the file object.



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

def archived_at
  @archived_at
end

#created_at ⇒ Object

Creation time of the file object.



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

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.



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

def default_hosting_url
  @default_hosting_url
end

#encoding ⇒ Object

Encoding of the file.



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

def encoding
  @encoding
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



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

def expires_at
  @expires_at
end

#extension ⇒ Object

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



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

def extension
  @extension
end

#height ⇒ Object

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



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

def height
  @height
end

#id ⇒ Object

File ID.



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

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.



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

def is_usable_in_content
  @is_usable_in_content
end

#name ⇒ Object

Name of the file.



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

def name
  @name
end

#parent_folder_id ⇒ Object

ID of the folder the file is in.



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

def parent_folder_id
  @parent_folder_id
end

#path ⇒ Object

Path of the file in the file manager.



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

def path
  @path
end

#size ⇒ Object

Size of the file in bytes.



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

def size
  @size
end

#type ⇒ Object

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



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

def type
  @type
end

#updated_at ⇒ Object

Timestamp of the latest update to the file.



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

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.



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

def url
  @url
end

#width ⇒ Object

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



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

def width
  @width
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



123
124
125
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 98

def self.attribute_map
  {
    :'extension' => :'extension',
    :'access' => :'access',
    :'parent_folder_id' => :'parentFolderId',
    :'encoding' => :'encoding',
    :'type' => :'type',
    :'is_usable_in_content' => :'isUsableInContent',
    :'url' => :'url',
    :'expires_at' => :'expiresAt',
    :'created_at' => :'createdAt',
    :'archived_at' => :'archivedAt',
    :'archived' => :'archived',
    :'path' => :'path',
    :'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



341
342
343
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 341

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 153

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

.openapi_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 128

def self.openapi_types
  {
    :'extension' => :'String',
    :'access' => :'String',
    :'parent_folder_id' => :'String',
    :'encoding' => :'String',
    :'type' => :'String',
    :'is_usable_in_content' => :'Boolean',
    :'url' => :'String',
    :'expires_at' => :'Integer',
    :'created_at' => :'Time',
    :'archived_at' => :'Time',
    :'archived' => :'Boolean',
    :'path' => :'String',
    :'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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 302

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 &&
      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 &&
      archived == o.archived &&
      path == o.path &&
      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



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

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



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

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 348

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


328
329
330
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 328

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



334
335
336
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 334

def hash
  [extension, access, parent_folder_id, encoding, type, is_usable_in_content, url, expires_at, created_at, archived_at, archived, path, 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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 252

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



419
420
421
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 419

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



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 425

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



413
414
415
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 413

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



279
280
281
282
283
284
285
286
287
288
 
# File 'lib/hubspot/codegen/files/models/file.rb', line 279

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"])
  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