Class: UltracartClient::ItemContentMultimedia

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/item_content_multimedia.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemContentMultimedia

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 128

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'cloud_url')
    self.cloud_url = attributes[:'cloud_url']
  end

  if attributes.has_key?(:'cloud_url_expiration')
    self.cloud_url_expiration = attributes[:'cloud_url_expiration']
  end

  if attributes.has_key?(:'code')
    self.code = attributes[:'code']
  end

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

  if attributes.has_key?(:'exclude_from_gallery')
    self.exclude_from_gallery = attributes[:'exclude_from_gallery']
  end

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

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

  if attributes.has_key?(:'merchant_item_multimedia_oid')
    self.merchant_item_multimedia_oid = attributes[:'merchant_item_multimedia_oid']
  end

  if attributes.has_key?(:'orphan')
    self.orphan = attributes[:'orphan']
  end

  if attributes.has_key?(:'placeholder')
    self.placeholder = attributes[:'placeholder']
  end

  if attributes.has_key?(:'temp_multimedia_oid')
    self.temp_multimedia_oid = attributes[:'temp_multimedia_oid']
  end

  if attributes.has_key?(:'thumbnails')
    if (value = attributes[:'thumbnails']).is_a?(Array)
      self.thumbnails = value
    end
  end

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

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

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

Instance Attribute Details

#cloud_url ⇒ Object

URL where the image can be downloaded from the cloud



18
19
20
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 18

def cloud_url
  @cloud_url
end

#cloud_url_expiration ⇒ Object

Expiration date of the cloud URL



21
22
23
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 21

def cloud_url_expiration
  @cloud_url_expiration
end

#code ⇒ Object

Code assigned to the file



24
25
26
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 24

def code
  @code
end

#description ⇒ Object

Description



27
28
29
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 27

def description
  @description
end

#exclude_from_gallery ⇒ Object

True to exclude from multimedia gallery



30
31
32
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 30

def exclude_from_gallery
  @exclude_from_gallery
end

#file_name ⇒ Object

File name



33
34
35
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 33

def file_name
  @file_name
end

#height ⇒ Object

Height of the image



36
37
38
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 36

def height
  @height
end

#merchant_item_multimedia_oid ⇒ Object

Item multimedia object identifier



39
40
41
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 39

def merchant_item_multimedia_oid
  @merchant_item_multimedia_oid
end

#orphan ⇒ Object

True if the multimedia is an orphan of the active StoreFront themes



42
43
44
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 42

def orphan
  @orphan
end

#placeholder ⇒ Object

True if the object is a place holder that can be populated



45
46
47
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 45

def placeholder
  @placeholder
end

#temp_multimedia_oid ⇒ Object

Temporary multimedia object identifier assigned if uploading new multimedia



48
49
50
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 48

def temp_multimedia_oid
  @temp_multimedia_oid
end

#thumbnails ⇒ Object

Thumbnails of this image



51
52
53
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 51

def thumbnails
  @thumbnails
end

#type ⇒ Object

Type of file



54
55
56
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 54

def type
  @type
end

#url ⇒ Object

URL to download file (on new multimedia record this can be a URL for UltraCart to fetch)



57
58
59
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 57

def url
  @url
end

#width ⇒ Object

Width of the image



60
61
62
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 60

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 85

def self.attribute_map
  {
    :'cloud_url' => :'cloud_url',
    :'cloud_url_expiration' => :'cloud_url_expiration',
    :'code' => :'code',
    :'description' => :'description',
    :'exclude_from_gallery' => :'exclude_from_gallery',
    :'file_name' => :'file_name',
    :'height' => :'height',
    :'merchant_item_multimedia_oid' => :'merchant_item_multimedia_oid',
    :'orphan' => :'orphan',
    :'placeholder' => :'placeholder',
    :'temp_multimedia_oid' => :'temp_multimedia_oid',
    :'thumbnails' => :'thumbnails',
    :'type' => :'type',
    :'url' => :'url',
    :'width' => :'width'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 106

def self.swagger_types
  {
    :'cloud_url' => :'String',
    :'cloud_url_expiration' => :'String',
    :'code' => :'String',
    :'description' => :'String',
    :'exclude_from_gallery' => :'BOOLEAN',
    :'file_name' => :'String',
    :'height' => :'Integer',
    :'merchant_item_multimedia_oid' => :'Integer',
    :'orphan' => :'BOOLEAN',
    :'placeholder' => :'BOOLEAN',
    :'temp_multimedia_oid' => :'Integer',
    :'thumbnails' => :'Array<ItemContentMultimediaThumbnail>',
    :'type' => :'String',
    :'url' => :'String',
    :'width' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cloud_url == o.cloud_url &&
      cloud_url_expiration == o.cloud_url_expiration &&
      code == o.code &&
      description == o.description &&
      exclude_from_gallery == o.exclude_from_gallery &&
      file_name == o.file_name &&
      height == o.height &&
      merchant_item_multimedia_oid == o.merchant_item_multimedia_oid &&
      orphan == o.orphan &&
      placeholder == o.placeholder &&
      temp_multimedia_oid == o.temp_multimedia_oid &&
      thumbnails == o.thumbnails &&
      type == o.type &&
      url == o.url &&
      width == o.width
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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 325

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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 391

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 304

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


291
292
293
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



297
298
299
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 297

def hash
  [cloud_url, cloud_url_expiration, code, description, exclude_from_gallery, file_name, height, merchant_item_multimedia_oid, orphan, placeholder, temp_multimedia_oid, thumbnails, type, url, width].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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 199

def list_invalid_properties
  invalid_properties = Array.new
  if !@code.nil? && @code.to_s.length > 20
    invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 20.')
  end

  if !@description.nil? && @description.to_s.length > 50000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 50000.')
  end

  if !@file_name.nil? && @file_name.to_s.length > 75
    invalid_properties.push('invalid value for "file_name", the character length must be smaller than or equal to 75.')
  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



371
372
373
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 371

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



377
378
379
380
381
382
383
384
385
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 377

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



365
366
367
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 365

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



218
219
220
221
222
223
224
225
 
# File 'lib/ultracart_api/models/item_content_multimedia.rb', line 218

def valid?
  return false if !@code.nil? && @code.to_s.length > 20
  return false if !@description.nil? && @description.to_s.length > 50000
  return false if !@file_name.nil? && @file_name.to_s.length > 75
  type_validator = EnumAttributeValidator.new('String', ['Image', 'PDF', 'Text', 'Unknown', 'Video'])
  return false unless type_validator.valid?(@type)
  true
end