Class: TogaiClient::CreatePricePlanV2Request

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

Overview

Request to create a price plan

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePricePlanV2Request

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 99

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

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

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

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

  if attributes.key?(:'supported_currencies')
    if (value = attributes[:'supported_currencies']).is_a?(Array)
      self.supported_currencies = value
    end
  else
    self.supported_currencies = nil
  end

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

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

Instance Attribute Details

#allow_ongoing_cycle_updates ⇒ Object

Allow changes to price plan from the beginning of the ongoing cycle.



36
37
38
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 36

def allow_ongoing_cycle_updates
  @allow_ongoing_cycle_updates
end

#deferred_revenue ⇒ Object

This option can be enabled while creating a price plan to opt for deferred revenue finalization. i.e, Togai will assume that the price plan may change any time during the pricing cycle and thereby does not compute the revenue in near-real time. This gives the flexibility of editing rate cards in price plan from beginning of the pricing cycle. Enabling this mode comes with the following limitations. 1. Following rate cards are not supported under a ‘deferredRevenue` plan * creditGrantRateCards, * billingEntitlementRateCards, * entitlementOverageRateCards, * IN_ADVANCE fixedFeeRateCards, * IN_ADVANCE licenseRateCards 2. Metrics API return revenue metrics only after the grace period of the account’s pricing cycle (i.e, only once the invoice becomes DUE)



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

def deferred_revenue
  @deferred_revenue
end

#description ⇒ Object

Description of price plan



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

def description
  @description
end

#name ⇒ Object

Name of the price plan



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

def name
  @name
end

#pricing_cycle_config ⇒ Object

Returns the value of attribute pricing_cycle_config.



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

def pricing_cycle_config
  @pricing_cycle_config
end

#supported_currencies ⇒ Object

List of currencies supported by the price plan



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

def supported_currencies
  @supported_currencies
end

#type ⇒ Object

Returns the value of attribute type.



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

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



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
316
317
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 280

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/create_price_plan_v2_request.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'pricing_cycle_config' => :'pricingCycleConfig',
    :'supported_currencies' => :'supportedCurrencies',
    :'deferred_revenue' => :'deferredRevenue',
    :'allow_ongoing_cycle_updates' => :'allowOngoingCycleUpdates'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 256

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



92
93
94
95
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'PricePlanType',
    :'pricing_cycle_config' => :'PricingCycleConfig',
    :'supported_currencies' => :'Array<String>',
    :'deferred_revenue' => :'Boolean',
    :'allow_ongoing_cycle_updates' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      pricing_cycle_config == o.pricing_cycle_config &&
      supported_currencies == o.supported_currencies &&
      deferred_revenue == o.deferred_revenue &&
      allow_ongoing_cycle_updates == o.allow_ongoing_cycle_updates
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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 351

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


243
244
245
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 249

def hash
  [name, description, type, pricing_cycle_config, supported_currencies, deferred_revenue, allow_ongoing_cycle_updates].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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 151

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

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

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

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

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



327
328
329
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 333

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



321
322
323
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 321

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



179
180
181
182
183
184
185
186
187
 
# File 'lib/togai_client/models/create_price_plan_v2_request.rb', line 179

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if !@description.nil? && @description.to_s.length > 255
  return false if @type.nil?
  return false if @supported_currencies.nil?
  true
end