Class: TogaiClient::PricePlanMigrationConfig

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

Overview

Migrate all account associations of a price plan to another price plan

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PricePlanMigrationConfig

Initializes the object



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

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

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

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

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

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

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

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

Instance Attribute Details

#is_price_plan_v2_migration ⇒ Object

If this flag is true, the migration will be done for price plan v2. Default value is false



37
38
39
 
# File 'lib/togai_client/models/price_plan_migration_config.rb', line 37

def is_price_plan_v2_migration
  @is_price_plan_v2_migration
end

#migration_mode ⇒ Object

Returns the value of attribute migration_mode.



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

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



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

def retain_start_offsets
  @retain_start_offsets
end

#source_id ⇒ Object

Id of source price plan



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

def source_id
  @source_id
end

#source_version ⇒ Object

Version of the source price plan



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

def source_version
  @source_version
end

#target_id ⇒ Object

Id of target price plan



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

def target_id
  @target_id
end

#target_version ⇒ Object

Version of the target price plan



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

def target_version
  @target_version
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
318
 
# File 'lib/togai_client/models/price_plan_migration_config.rb', line 281

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



75
76
77
 
# File 'lib/togai_client/models/price_plan_migration_config.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'source_id' => :'sourceId',
    :'source_version' => :'sourceVersion',
    :'target_id' => :'targetId',
    :'target_version' => :'targetVersion',
    :'migration_mode' => :'migrationMode',
    :'retain_start_offsets' => :'retainStartOffsets',
    :'is_price_plan_v2_migration' => :'isPricePlanV2Migration'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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/price_plan_migration_config.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'source_id' => :'String',
    :'source_version' => :'Integer',
    :'target_id' => :'String',
    :'target_version' => :'Integer',
    :'migration_mode' => :'String',
    :'retain_start_offsets' => :'Boolean',
    :'is_price_plan_v2_migration' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source_id == o.source_id &&
      source_version == o.source_version &&
      target_id == o.target_id &&
      target_version == o.target_version &&
      migration_mode == o.migration_mode &&
      retain_start_offsets == o.retain_start_offsets &&
      is_price_plan_v2_migration == o.is_price_plan_v2_migration
end

#_to_hash(value) ⇒ Hash

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



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

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


244
245
246
 
# File 'lib/togai_client/models/price_plan_migration_config.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



250
251
252
 
# File 'lib/togai_client/models/price_plan_migration_config.rb', line 250

def hash
  [source_id, source_version, target_id, target_version, migration_mode, retain_start_offsets, is_price_plan_v2_migration].hash
end

#list_invalid_properties ⇒ Object

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



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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



328
329
330
 
# File 'lib/togai_client/models/price_plan_migration_config.rb', line 328

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



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

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



322
323
324
 
# File 'lib/togai_client/models/price_plan_migration_config.rb', line 322

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @source_id.nil?
  return false if @source_id.to_s.length > 255
  return false if @source_version.nil?
  return false if !@target_id.nil? && @target_id.to_s.length > 255
  return false if @migration_mode.nil?
  migration_mode_validator = EnumAttributeValidator.new('String', ["IMMEDIATE", "IMMEDIATE_IGNORE_OVERRIDE", "NEXT_CYCLE", "NEXT_CYCLE_IGNORE_OVERRIDE", "START_OF_CURRENT_CYCLE"])
  return false unless migration_mode_validator.valid?(@migration_mode)
  true
end