Class: TogaiClient::PricePlanDetailsConfig

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

Overview

Configuration for getting the usage rate card

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PricePlanDetailsConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 95

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Id of the account, this will be considered if mode is ACCOUNT



28
29
30
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 28

def 
  @account_id
end

#effective_on ⇒ Object

Will be used for getting the usage rate card, only used if mode is ACCOUNT or PRICE_PLAN



31
32
33
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 31

def effective_on
  @effective_on
end

#mode ⇒ Object

Mode to get the usage rate card - CUSTOM: Use the price plan details provided in the request - PRICE_PLAN: Use the usage rate cards of the given price plan - ACCOUNT: Use the usage rate cards of a associated price plan of the given account



20
21
22
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 20

def mode
  @mode
end

#price_plan_details ⇒ Object

Returns the value of attribute price_plan_details.



22
23
24
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 22

def price_plan_details
  @price_plan_details
end

#price_plan_id ⇒ Object

Id of the price plan, this will be considered if mode is PRICE_PLAN



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

def price_plan_id
  @price_plan_id
end

#pricing_cycle_ordinal ⇒ Object

nth cycle, will be used to calculate revenue for the particular cycle, only used if mode is CUSTOM or PRICE_PLAN



34
35
36
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 34

def pricing_cycle_ordinal
  @pricing_cycle_ordinal
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



257
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
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 257

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



71
72
73
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 59

def self.attribute_map
  {
    :'mode' => :'mode',
    :'price_plan_details' => :'pricePlanDetails',
    :'price_plan_id' => :'pricePlanId',
    :'account_id' => :'accountId',
    :'effective_on' => :'effectiveOn',
    :'pricing_cycle_ordinal' => :'pricingCycleOrdinal'
  }
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



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

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



88
89
90
91
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 76

def self.openapi_types
  {
    :'mode' => :'String',
    :'price_plan_details' => :'CreatePricePlanDetails',
    :'price_plan_id' => :'String',
    :'account_id' => :'String',
    :'effective_on' => :'Time',
    :'pricing_cycle_ordinal' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mode == o.mode &&
      price_plan_details == o.price_plan_details &&
      price_plan_id == o.price_plan_id &&
       == o. &&
      effective_on == o.effective_on &&
      pricing_cycle_ordinal == o.pricing_cycle_ordinal
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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 328

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


220
221
222
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 226

def hash
  [mode, price_plan_details, price_plan_id, , effective_on, pricing_cycle_ordinal].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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 137

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

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

  if !@account_id.nil? && @account_id.to_s.length < 1
    invalid_properties.push('invalid value for "account_id", 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



304
305
306
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 304

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 310

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



298
299
300
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 298

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



157
158
159
160
161
162
163
164
165
 
# File 'lib/togai_client/models/price_plan_details_config.rb', line 157

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @mode.nil?
  mode_validator = EnumAttributeValidator.new('String', ["CUSTOM", "PRICE_PLAN", "ACCOUNT"])
  return false unless mode_validator.valid?(@mode)
  return false if !@price_plan_id.nil? && @price_plan_id.to_s.length < 1
  return false if !@account_id.nil? && @account_id.to_s.length < 1
  true
end