Class: UltracartClient::ItemDigitalDelivery

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemDigitalDelivery

Initializes the object



73
74
75
76
77
78
79
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
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 73

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

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

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

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

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

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

Instance Attribute Details

#activation_code_description ⇒ Object

Description of the activation code



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

def activation_code_description
  @activation_code_description
end

#activation_code_low_warning ⇒ Object

The number of activation codes whcih should generate a warning email



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

def activation_code_low_warning
  @activation_code_low_warning
end

#activation_code_realtime_url ⇒ Object

The URL to retrieve activation codes from in real-time



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

def activation_code_realtime_url
  @activation_code_realtime_url
end

#activation_code_shared_secret ⇒ Object

Shared secret used when communicating with the real-time URL



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

def activation_code_shared_secret
  @activation_code_shared_secret
end

#activation_code_type ⇒ Object

Type of activation code



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

def activation_code_type
  @activation_code_type
end

#digital_items ⇒ Object

Digital items that customer can download when this item is purchased



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

def digital_items
  @digital_items
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 37

def self.attribute_map
  {
    :'activation_code_description' => :'activation_code_description',
    :'activation_code_low_warning' => :'activation_code_low_warning',
    :'activation_code_realtime_url' => :'activation_code_realtime_url',
    :'activation_code_shared_secret' => :'activation_code_shared_secret',
    :'activation_code_type' => :'activation_code_type',
    :'digital_items' => :'digital_items'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



199
200
201
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 199

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 54

def self.openapi_types
  {
    :'activation_code_description' => :'String',
    :'activation_code_low_warning' => :'Integer',
    :'activation_code_realtime_url' => :'String',
    :'activation_code_shared_secret' => :'String',
    :'activation_code_type' => :'String',
    :'digital_items' => :'Array<ItemDigitalItem>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activation_code_description == o.activation_code_description &&
      activation_code_low_warning == o.activation_code_low_warning &&
      activation_code_realtime_url == o.activation_code_realtime_url &&
      activation_code_shared_secret == o.activation_code_shared_secret &&
      activation_code_type == o.activation_code_type &&
      digital_items == o.digital_items
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 230

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 301

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 206

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

See Also:

  • `==` method


186
187
188
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 186

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



192
193
194
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 192

def hash
  [activation_code_description, activation_code_low_warning, activation_code_realtime_url, activation_code_shared_secret, activation_code_type, digital_items].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 115

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



277
278
279
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 277

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 283

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



271
272
273
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 271

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



134
135
136
137
138
139
 
# File 'lib/ultracart_api/models/item_digital_delivery.rb', line 134

def valid?
  return false if !@activation_code_description.nil? && @activation_code_description.to_s.length > 50
  return false if !@activation_code_realtime_url.nil? && @activation_code_realtime_url.to_s.length > 350
  return false if !@activation_code_shared_secret.nil? && @activation_code_shared_secret.to_s.length > 20
  true
end