Class: TogaiClient::PricingRule

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/pricing_rule.rb

Overview

Represents pricing rules of a price plan. i.e, price plan bound by time.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PricingRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/togai_client/models/pricing_rule.rb', line 100

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



35
36
37
 
# File 'lib/togai_client/models/pricing_rule.rb', line 35

def action
  @action
end

#computation ⇒ Object

JSON logic to be computed



33
34
35
 
# File 'lib/togai_client/models/pricing_rule.rb', line 33

def computation
  @computation
end

#condition ⇒ Object

JSON logic condition deciding whether to compute this pricing rule or not



30
31
32
 
# File 'lib/togai_client/models/pricing_rule.rb', line 30

def condition
  @condition
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/togai_client/models/pricing_rule.rb', line 19

def id
  @id
end

#invoice_timing ⇒ Object

Returns the value of attribute invoice_timing.



25
26
27
 
# File 'lib/togai_client/models/pricing_rule.rb', line 25

def invoice_timing
  @invoice_timing
end

#name ⇒ Object

Returns the value of attribute name.



21
22
23
 
# File 'lib/togai_client/models/pricing_rule.rb', line 21

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.



27
28
29
 
# File 'lib/togai_client/models/pricing_rule.rb', line 27

def order
  @order
end

#version ⇒ Object

Returns the value of attribute version.



23
24
25
 
# File 'lib/togai_client/models/pricing_rule.rb', line 23

def version
  @version
end

Class Method Details

._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



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
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/togai_client/models/pricing_rule.rb', line 295

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



74
75
76
 
# File 'lib/togai_client/models/pricing_rule.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/togai_client/models/pricing_rule.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'version' => :'version',
    :'invoice_timing' => :'invoiceTiming',
    :'order' => :'order',
    :'condition' => :'condition',
    :'computation' => :'computation',
    :'action' => :'action'
  }
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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/togai_client/models/pricing_rule.rb', line 271

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



93
94
95
96
 
# File 'lib/togai_client/models/pricing_rule.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/togai_client/models/pricing_rule.rb', line 79

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'version' => :'Integer',
    :'invoice_timing' => :'PricingRuleTiming',
    :'order' => :'Integer',
    :'condition' => :'String',
    :'computation' => :'String',
    :'action' => :'PricingRuleAction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/togai_client/models/pricing_rule.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      version == o.version &&
      invoice_timing == o.invoice_timing &&
      order == o.order &&
      condition == o.condition &&
      computation == o.computation &&
      action == o.action
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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/togai_client/models/pricing_rule.rb', line 366

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


258
259
260
 
# File 'lib/togai_client/models/pricing_rule.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



264
265
266
 
# File 'lib/togai_client/models/pricing_rule.rb', line 264

def hash
  [id, name, version, invoice_timing, order, condition, computation, action].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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/togai_client/models/pricing_rule.rb', line 160

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

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

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

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

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

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

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

  if @action.nil?
    invalid_properties.push('invalid value for "action", action cannot be nil.')
  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



342
343
344
 
# File 'lib/togai_client/models/pricing_rule.rb', line 342

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/togai_client/models/pricing_rule.rb', line 348

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



336
337
338
 
# File 'lib/togai_client/models/pricing_rule.rb', line 336

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



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/togai_client/models/pricing_rule.rb', line 200

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  return false if @version.nil?
  return false if @version < 1
  return false if @order.nil?
  return false if @order < 1
  return false if @computation.nil?
  return false if @action.nil?
  true
end