Class: Hubspot::Files::ImportFromUrlInput

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportFromUrlInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
159
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 111

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access ⇒ Object

PUBLIC_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines can index the file. PUBLIC_NOT_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines *can’t* index the file. PRIVATE: File is NOT publicly accessible. Requires a signed URL to see content. Search engines *can’t* index the file.



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

def access
  @access
end

#duplicate_validation_scope ⇒ Object

ENTIRE_PORTAL: Look for a duplicate file in the entire account. EXACT_FOLDER: Look for a duplicate file in the provided folder.



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

def duplicate_validation_scope
  @duplicate_validation_scope
end

#duplicate_validation_strategy ⇒ Object

NONE: Do not run any duplicate validation. REJECT: Reject the upload if a duplicate is found. RETURN_EXISTING: If a duplicate file is found, do not upload a new file and return the found duplicate instead.



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

def duplicate_validation_strategy
  @duplicate_validation_strategy
end

#folder_id ⇒ Object

One of folderId or folderPath is required. Destination folderId for the uploaded file.



44
45
46
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 44

def folder_id
  @folder_id
end

#folder_path ⇒ Object

One of folderPath or folderId is required. Destination folder path for the uploaded file. If the folder path does not exist, there will be an attempt to create the folder path.



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

def folder_path
  @folder_path
end

#name ⇒ Object

Name to give the resulting file in the file manager.



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

def name
  @name
end

#overwrite ⇒ Object

If true, will overwrite existing file if one with the same name and extension exists in the given folder. The overwritten file will be deleted and the uploaded file will take its place with a new ID. If unset or set as false, the new file’s name will be updated to prevent colliding with existing file if one exists with the same path, name, and extension



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

def overwrite
  @overwrite
end

#ttl ⇒ Object

Time to live. If specified the file will be deleted after the given time frame. If left unset, the file will exist indefinitely



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

def ttl
  @ttl
end

#url ⇒ Object

URL to download the new file from.



41
42
43
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 41

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 69

def self.attribute_map
  {
    :'folder_path' => :'folderPath',
    :'access' => :'access',
    :'duplicate_validation_scope' => :'duplicateValidationScope',
    :'name' => :'name',
    :'duplicate_validation_strategy' => :'duplicateValidationStrategy',
    :'ttl' => :'ttl',
    :'overwrite' => :'overwrite',
    :'url' => :'url',
    :'folder_id' => :'folderId'
  }
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



251
252
253
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 251

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 89

def self.openapi_types
  {
    :'folder_path' => :'String',
    :'access' => :'String',
    :'duplicate_validation_scope' => :'String',
    :'name' => :'String',
    :'duplicate_validation_strategy' => :'String',
    :'ttl' => :'String',
    :'overwrite' => :'Boolean',
    :'url' => :'String',
    :'folder_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      folder_path == o.folder_path &&
      access == o.access &&
      duplicate_validation_scope == o.duplicate_validation_scope &&
      name == o.name &&
      duplicate_validation_strategy == o.duplicate_validation_strategy &&
      ttl == o.ttl &&
      overwrite == o.overwrite &&
      url == o.url &&
      folder_id == o.folder_id
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 282

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 353

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 258

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


238
239
240
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 244

def hash
  [folder_path, access, duplicate_validation_scope, name, duplicate_validation_strategy, ttl, overwrite, url, folder_id].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



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 163

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

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



329
330
331
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 335

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



323
324
325
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 323

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



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/hubspot/codegen/files/models/import_from_url_input.rb', line 178

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)
  duplicate_validation_scope_validator = EnumAttributeValidator.new('String', ["ENTIRE_PORTAL", "EXACT_FOLDER"])
  return false unless duplicate_validation_scope_validator.valid?(@duplicate_validation_scope)
  duplicate_validation_strategy_validator = EnumAttributeValidator.new('String', ["NONE", "REJECT", "RETURN_EXISTING"])
  return false unless duplicate_validation_strategy_validator.valid?(@duplicate_validation_strategy)
  return false if @url.nil?
  true
end