Class: Shortcut::UnusableEntitlementError

Inherits:
Object
  • Object
show all
Defined in:
lib/shortcut_client_ruby/models/unusable_entitlement_error.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnusableEntitlementError

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
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 80

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

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

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

Instance Attribute Details

#entitlement_tag ⇒ Object

Short tag describing the unusable entitlement action taken by the user.



22
23
24
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 22

def entitlement_tag
  @entitlement_tag
end

#message ⇒ Object

Message displayed to the user on why their action failed.



25
26
27
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 25

def message
  @message
end

#reason_tag ⇒ Object

The tag for violating an entitlement action.



19
20
21
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 19

def reason_tag
  @reason_tag
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 50

def self.attribute_map
  {
    :'reason_tag' => :'reason_tag',
    :'entitlement_tag' => :'entitlement_tag',
    :'message' => :'message'
  }
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



227
228
229
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 227

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 73

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 64

def self.openapi_types
  {
    :'reason_tag' => :'String',
    :'entitlement_tag' => :'String',
    :'message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reason_tag == o.reason_tag &&
      entitlement_tag == o.entitlement_tag &&
      message == o.message
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



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
290
291
292
293
294
295
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 258

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 = Shortcut.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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 329

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 234

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


214
215
216
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 220

def hash
  [reason_tag, entitlement_tag, message].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



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
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  if @reason_tag.nil?
    invalid_properties.push('invalid value for "reason_tag", reason_tag cannot be nil.')
  end

  if @entitlement_tag.nil?
    invalid_properties.push('invalid value for "entitlement_tag", entitlement_tag cannot be nil.')
  end

  if @entitlement_tag.to_s.length > 63
    invalid_properties.push('invalid value for "entitlement_tag", the character length must be smaller than or equal to 63.')
  end

  if @entitlement_tag.to_s.length < 1
    invalid_properties.push('invalid value for "entitlement_tag", the character length must be great than or equal to 1.')
  end

  if @message.nil?
    invalid_properties.push('invalid value for "message", message cannot be nil.')
  end

  if @message.to_s.length > 256
    invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 256.')
  end

  if @message.to_s.length < 1
    invalid_properties.push('invalid value for "message", the character length must be great than or equal to 1.')
  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



305
306
307
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 305

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 311

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



299
300
301
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 299

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



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/shortcut_client_ruby/models/unusable_entitlement_error.rb', line 143

def valid?
  return false if @reason_tag.nil?
  reason_tag_validator = EnumAttributeValidator.new('String', ["entitlement-violation"])
  return false unless reason_tag_validator.valid?(@reason_tag)
  return false if @entitlement_tag.nil?
  return false if @entitlement_tag.to_s.length > 63
  return false if @entitlement_tag.to_s.length < 1
  return false if @message.nil?
  return false if @message.to_s.length > 256
  return false if @message.to_s.length < 1
  true
end