Class: TogaiClient::UpdatePricingScheduleRequestWithActions

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

Overview

Request to associate or disassociate a price plan to an account with actions

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdatePricingScheduleRequestWithActions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
159
160
161
162
163
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 111

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

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

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

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

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

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

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

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

Instance Attribute Details

#effective_from ⇒ Object

Date of effectiveness of the association. The date is expected in YYYY-MM-DD format - Editing of a BILLING plan with deferredRevenue can be achieved with effectiveFrom as start date of current cycle or using ‘retainStartOffset` option.



26
27
28
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 26

def effective_from
  @effective_from
end

#effective_until ⇒ Object

Date until which the association must be effective. The date is expected in YYYY-MM-DD format



29
30
31
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 29

def effective_until
  @effective_until
end

#mode ⇒ Object

Mode of request to create dis/association



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

def mode
  @mode
end

#pre_actions ⇒ Object

Pre actions to be performed before association or disassociation



39
40
41
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 39

def pre_actions
  @pre_actions
end

#price_plan_details_override ⇒ Object

Returns the value of attribute price_plan_details_override.



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

def price_plan_details_override
  @price_plan_details_override
end

#price_plan_id ⇒ Object

Id of the price plan if association request



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

def price_plan_id
  @price_plan_id
end

#pricing_rules_override ⇒ Object

Returns the value of attribute pricing_rules_override.



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

def pricing_rules_override
  @pricing_rules_override
end

#retain_start_offsets ⇒ Object

If this flag is true, current pricing cycle of the account on the date of association will continue rather than the configurations of the newly associated price plan. Pricing cycle overrides specified using ‘pricePlanDetailsOverride` will take precedence over the pricing cycle configurations of the new price plan that the account needs to migrate to. PricingCycleInterval of the existing plan and the new plan must be same for this to work. We’ll return a ‘400 BadRequest` otherwise. Examples: - Ongoing plan (1st Oct to 30th Oct) - 1, monthOffset: NIL New association (15th Oct to 15th Nov) of different price plan with retainStartOffsets option true will use the same pricing cycle configuration 1, monthOffset: NIL rather than using the pricing cycle configuration of the new price plan that the account needs to migrate to. - Ongoing plan (1st Oct to 30th Oct) - 1, monthOffset: NIL New association (1st Nov to 30th Nov) of different price plan with retainStartOffsets option true will throw a `400 BadRequest` as no existing price plan configuration found on date of association



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

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



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

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



78
79
80
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 64

def self.attribute_map
  {
    :'mode' => :'mode',
    :'price_plan_id' => :'pricePlanId',
    :'effective_from' => :'effectiveFrom',
    :'effective_until' => :'effectiveUntil',
    :'price_plan_details_override' => :'pricePlanDetailsOverride',
    :'pricing_rules_override' => :'pricingRulesOverride',
    :'retain_start_offsets' => :'retainStartOffsets',
    :'pre_actions' => :'preActions'
  }
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



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

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



103
104
105
106
107
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 103

def self.openapi_all_of
  [
  :'UpdatePricingScheduleRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 83

def self.openapi_types
  {
    :'mode' => :'String',
    :'price_plan_id' => :'String',
    :'effective_from' => :'Date',
    :'effective_until' => :'Date',
    :'price_plan_details_override' => :'CreatePricePlanDetailsOverride',
    :'pricing_rules_override' => :'Array<CreatePricingRule>',
    :'retain_start_offsets' => :'Boolean',
    :'pre_actions' => :'Array<PreAction>'
  }
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
211
212
213
214
215
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mode == o.mode &&
      price_plan_id == o.price_plan_id &&
      effective_from == o.effective_from &&
      effective_until == o.effective_until &&
      price_plan_details_override == o.price_plan_details_override &&
      pricing_rules_override == o.pricing_rules_override &&
      retain_start_offsets == o.retain_start_offsets &&
      pre_actions == o.pre_actions
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



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

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


219
220
221
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 225

def hash
  [mode, price_plan_id, effective_from, effective_until, price_plan_details_override, pricing_rules_override, retain_start_offsets, pre_actions].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



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 167

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

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



303
304
305
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 303

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



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

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



297
298
299
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 297

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



183
184
185
186
187
188
189
190
 
# File 'lib/togai_client/models/update_pricing_schedule_request_with_actions.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  mode_validator = EnumAttributeValidator.new('String', ["ASSOCIATE", "DISASSOCIATE"])
  return false unless mode_validator.valid?(@mode)
  return false if @effective_from.nil?
  return false if @effective_until.nil?
  true
end