Class: UltracartClient::CustomerSoftwareEntitlement

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerSoftwareEntitlement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 83

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

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

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

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

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

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

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

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

Instance Attribute Details

#activation_code ⇒ Object

Activation Code Associated with the software



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

def activation_code
  @activation_code
end

#activation_dts ⇒ Object

Date/time when the activation code was created



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

def activation_dts
  @activation_dts
end

#customer_software_entitlement_oid ⇒ Object

Customer profile software entitlement object identifier



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

def customer_software_entitlement_oid
  @customer_software_entitlement_oid
end

#expiration_dts ⇒ Object

Date/time when the activation code will expire



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

def expiration_dts
  @expiration_dts
end

#purchased_via_item_description ⇒ Object

Item description used to purchase this software.



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

def purchased_via_item_description
  @purchased_via_item_description
end

#purchased_via_item_id ⇒ Object

Item ID used to purchase this software.



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

def purchased_via_item_id
  @purchased_via_item_id
end

#purchased_via_order_id ⇒ Object

Order ID used to purchase this software.



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

def purchased_via_order_id
  @purchased_via_order_id
end

#software_sku ⇒ Object

SKU of the software



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

def software_sku
  @software_sku
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'activation_code' => :'activation_code',
    :'activation_dts' => :'activation_dts',
    :'customer_software_entitlement_oid' => :'customer_software_entitlement_oid',
    :'expiration_dts' => :'expiration_dts',
    :'purchased_via_item_description' => :'purchased_via_item_description',
    :'purchased_via_item_id' => :'purchased_via_item_id',
    :'purchased_via_order_id' => :'purchased_via_order_id',
    :'software_sku' => :'software_sku'
  }
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



247
248
249
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 247

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 62

def self.openapi_types
  {
    :'activation_code' => :'String',
    :'activation_dts' => :'String',
    :'customer_software_entitlement_oid' => :'Integer',
    :'expiration_dts' => :'String',
    :'purchased_via_item_description' => :'String',
    :'purchased_via_item_id' => :'String',
    :'purchased_via_order_id' => :'String',
    :'software_sku' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activation_code == o.activation_code &&
      activation_dts == o.activation_dts &&
      customer_software_entitlement_oid == o.customer_software_entitlement_oid &&
      expiration_dts == o.expiration_dts &&
      purchased_via_item_description == o.purchased_via_item_description &&
      purchased_via_item_id == o.purchased_via_item_id &&
      purchased_via_order_id == o.purchased_via_order_id &&
      software_sku == o.software_sku
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



278
279
280
281
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
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 278

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 349

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 254

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


234
235
236
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 240

def hash
  [activation_code, activation_dts, customer_software_entitlement_oid, expiration_dts, purchased_via_item_description, purchased_via_item_id, purchased_via_order_id, software_sku].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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 131

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

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

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

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

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



325
326
327
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 331

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



319
320
321
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 319

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



158
159
160
161
162
163
164
165
 
# File 'lib/ultracart_api/models/customer_software_entitlement.rb', line 158

def valid?
  return false if !@activation_code.nil? && @activation_code.to_s.length > 50
  return false if !@purchased_via_item_description.nil? && @purchased_via_item_description.to_s.length > 512
  return false if !@purchased_via_item_id.nil? && @purchased_via_item_id.to_s.length > 20
  return false if !@purchased_via_order_id.nil? && @purchased_via_order_id.to_s.length > 30
  return false if !@software_sku.nil? && @software_sku.to_s.length > 30
  true
end