Class: UltracartClient::ItemDigitalItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemDigitalItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 56

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

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

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

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

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

Instance Attribute Details

#creation_dts ⇒ Object

File creation date



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

def creation_dts
  @creation_dts
end

#description ⇒ Object

Description of the digital item



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

def description
  @description
end

#file_size ⇒ Object

File size



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

def file_size
  @file_size
end

#mime_type ⇒ Object

Mime type associated with the file



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

def mime_type
  @mime_type
end

#original_filename ⇒ Object

Original filename



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

def original_filename
  @original_filename
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 33

def self.attribute_map
  {
    :'creation_dts' => :'creation_dts',
    :'description' => :'description',
    :'file_size' => :'file_size',
    :'mime_type' => :'mime_type',
    :'original_filename' => :'original_filename'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 44

def self.swagger_types
  {
    :'creation_dts' => :'String',
    :'description' => :'String',
    :'file_size' => :'Integer',
    :'mime_type' => :'String',
    :'original_filename' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      creation_dts == o.creation_dts &&
      description == o.description &&
      file_size == o.file_size &&
      mime_type == o.mime_type &&
      original_filename == o.original_filename
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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 255

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 168

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


155
156
157
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 161

def hash
  [creation_dts, description, file_size, mime_type, original_filename].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



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

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

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

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



235
236
237
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 235

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



241
242
243
244
245
246
247
248
249
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 241

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



229
230
231
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 229

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



104
105
106
107
108
109
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 104

def valid?
  return false if !@description.nil? && @description.to_s.length > 200
  return false if !@mime_type.nil? && @mime_type.to_s.length > 100
  return false if !@original_filename.nil? && @original_filename.to_s.length > 250
  true
end