Class: PCPServerSDK::PositiveAmountOfMoney

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb

Overview

Object containing amount and ISO currency code attributes

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PositiveAmountOfMoney

Initializes the object



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 54

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

  if attributes.key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  else
    self.currency_code = nil
  end
end

Instance Attribute Details

#amount ⇒ Object

Amount in cents and always having 2 decimals



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 20

def amount
  @amount
end

#currency_code ⇒ Object

Three-letter ISO currency code representing the currency for the amount



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 23

def currency_code
  @currency_code
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 209

def self._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 = PCPServerSDK.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



34
35
36
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 34

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 26

def self.attribute_map
  {
    :'amount' => :'amount',
    :'currency_code' => :'currencyCode'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 185

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



47
48
49
50
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 47

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 39

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'currency_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



163
164
165
166
167
168
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      currency_code == o.currency_code
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 280

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


172
173
174
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 172

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



178
179
180
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 178

def hash
  [amount, currency_code].hash
end

#list_invalid_properties ⇒ Object

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



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
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 82

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @amount > 999999999999
    invalid_properties.push('invalid value for "amount", must be smaller than or equal to 999999999999.')
  end

  if @amount < 1
    invalid_properties.push('invalid value for "amount", must be greater than or equal to 1.')
  end

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



256
257
258
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 256

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 262

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



250
251
252
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 250

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/PCP-server-Ruby-SDK/models/positive_amount_of_money.rb', line 114

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @amount.nil?
  return false if @amount > 999999999999
  return false if @amount < 1
  return false if @currency_code.nil?
  return false if @currency_code.to_s.length > 3
  return false if @currency_code.to_s.length < 3
  true
end