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



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 92

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

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

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

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

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

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

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

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

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

  if attributes.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.



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

def click_wrap_agreement
  @click_wrap_agreement
end

#creation_dts ⇒ Object

File creation date



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

def creation_dts
  @creation_dts
end

#description ⇒ Object

Description of the digital item



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

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.



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

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.



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

def external_id
  @external_id
end

#file_size ⇒ Object

File size



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

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.



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

def import_from_url
  @import_from_url
end

#mime_type ⇒ Object

Mime type associated with the file



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

def mime_type
  @mime_type
end

#original_filename ⇒ Object

Original filename



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

def original_filename
  @original_filename
end

#pdf_meta ⇒ Object

Returns the value of attribute pdf_meta.



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

def pdf_meta
  @pdf_meta
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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/ultracart_api/models/item_digital_item.rb', line 251

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 69

def self.openapi_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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 221

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



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/ultracart_api/models/item_digital_item.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 = UltracartClient.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/ultracart_api/models/item_digital_item.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/ultracart_api/models/item_digital_item.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/ultracart_api/models/item_digital_item.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/ultracart_api/models/item_digital_item.rb', line 244

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 148

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



329
330
331
 
# File 'lib/ultracart_api/models/item_digital_item.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/ultracart_api/models/item_digital_item.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/ultracart_api/models/item_digital_item.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



171
172
173
174
175
176
177
 
# File 'lib/ultracart_api/models/item_digital_item.rb', line 171

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