Class: TogaiClient::UpdatePricingScheduleRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdatePricingScheduleRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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



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

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



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

def effective_until
  @effective_until
end

#mode ⇒ Object

Mode of request to create dis/association



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

def mode
  @mode
end

#price_plan_details_override ⇒ Object

Returns the value of attribute price_plan_details_override.



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

def price_plan_details_override
  @price_plan_details_override
end

#price_plan_id ⇒ Object

Id of the price plan if association request



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

def price_plan_id
  @price_plan_id
end

#pricing_rules_override ⇒ Object

Returns the value of attribute pricing_rules_override.



32
33
34
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 32

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



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

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 236

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



73
74
75
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 73

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

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'
  }
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 212

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



91
92
93
94
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 185

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 307

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


199
200
201
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 205

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



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 148

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



283
284
285
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 283

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 289

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



277
278
279
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 277

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



164
165
166
167
168
169
170
171
 
# File 'lib/togai_client/models/update_pricing_schedule_request.rb', line 164

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