Class: Hubspot::Files::Files::HubspotFile

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/files/files/models/hubspot_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 = {}) ⇒ HubspotFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 158

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access ⇒ Object

File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE.



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

def access
  @access
end

#archived ⇒ Object

If the file is deleted.



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

def archived
  @archived
end

#archived_at ⇒ Object

Deletion time of the file object.



28
29
30
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 28

def archived_at
  @archived_at
end

#created_at ⇒ Object

Creation time of the file object.



25
26
27
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 25

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.



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

def default_hosting_url
  @default_hosting_url
end

#encoding ⇒ Object

Encoding of the file.



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

def encoding
  @encoding
end

#extension ⇒ Object

Extension of the file. For example png.



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

def extension
  @extension
end

#height ⇒ Object

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



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

def height
  @height
end

#id ⇒ Object

File ID.



22
23
24
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 22

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.



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

def is_usable_in_content
  @is_usable_in_content
end

#name ⇒ Object

Name of the file.



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

def name
  @name
end

#parent_folder_id ⇒ Object

Id of the folder the file is in.



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

def parent_folder_id
  @parent_folder_id
end

#path ⇒ Object

Path of the file in the file manager.



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

def path
  @path
end

#size ⇒ Object

Size in bytes of the file.



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

def size
  @size
end

#type ⇒ Object

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



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

def type
  @type
end

#updated_at ⇒ Object

Timestamp of the latest update to the file.



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

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.



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

def url
  @url
end

#width ⇒ Object

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



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

def width
  @width
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



122
123
124
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 122

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

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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



151
152
153
154
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 151

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 296

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



365
366
367
368
369
370
371
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
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 365

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::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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 436

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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 341

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


321
322
323
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 321

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



327
328
329
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 327

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 246

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

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

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

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

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



412
413
414
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 418

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



406
407
408
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 406

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



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/hubspot/codegen/files/files/models/hubspot_file.rb', line 273

def valid?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @archived.nil?
  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)
  true
end