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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 80

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

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

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

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

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

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

Instance Attribute Details

#click_wrap_agreement ⇒ Object

Click wrap agreement is presented to the customer before they can purchase your product.



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

def click_wrap_agreement
  @click_wrap_agreement
end

#creation_dts ⇒ Object

File creation date



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

def creation_dts
  @creation_dts
end

#description ⇒ Object

Description of the digital item



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

def description
  @description
end

#digital_item_oid ⇒ Object

The Digital item oid is a primary key used internally by UltraCart. You should not set or change this value. Doing so will have no effect.



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

def digital_item_oid
  @digital_item_oid
end

#external_id ⇒ Object

External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs.



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

def external_id
  @external_id
end

#file_size ⇒ Object

File size



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

def file_size
  @file_size
end

#import_from_url ⇒ Object

This url is sourced to create or update a digital file in your digital library. It is only considered during an insert or update operation.



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

def import_from_url
  @import_from_url
end

#mime_type ⇒ Object

Mime type associated with the file



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

def mime_type
  @mime_type
end

#original_filename ⇒ Object

Original filename



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

def original_filename
  @original_filename
end

#pdf_meta ⇒ Object

Returns the value of attribute pdf_meta.



44
45
46
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 44

def pdf_meta
  @pdf_meta
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 47

def self.attribute_map
  {
    :'click_wrap_agreement' => :'click_wrap_agreement',
    :'creation_dts' => :'creation_dts',
    :'description' => :'description',
    :'digital_item_oid' => :'digital_item_oid',
    :'external_id' => :'external_id',
    :'file_size' => :'file_size',
    :'import_from_url' => :'import_from_url',
    :'mime_type' => :'mime_type',
    :'original_filename' => :'original_filename',
    :'pdf_meta' => :'pdf_meta'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 63

def self.swagger_types
  {
    :'click_wrap_agreement' => :'String',
    :'creation_dts' => :'String',
    :'description' => :'String',
    :'digital_item_oid' => :'Integer',
    :'external_id' => :'String',
    :'file_size' => :'Integer',
    :'import_from_url' => :'String',
    :'mime_type' => :'String',
    :'original_filename' => :'String',
    :'pdf_meta' => :'ItemDigitalItemPdfMeta'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 253

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 319

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 232

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


219
220
221
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



225
226
227
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 225

def hash
  [click_wrap_agreement, creation_dts, description, digital_item_oid, external_id, file_size, import_from_url, mime_type, original_filename, pdf_meta].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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 129

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



299
300
301
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 299

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



305
306
307
308
309
310
311
312
313
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 305

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



293
294
295
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 293

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



152
153
154
155
156
157
158
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 152

def valid?
  return false if !@description.nil? && @description.to_s.length > 200
  return false if !@external_id.nil? && @external_id.to_s.length > 100
  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