Class: TogaiClient::PricingCycleConfig

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

Overview

Represents configurations related to pricing cycle

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PricingCycleConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 84

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

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

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

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

Instance Attribute Details

#anniversary_cycle ⇒ Object

Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY - - 23/10/2023 (Monday) - 1, monthOffset: NIL - 25/10/2023 (Wednesday) - 3, monthOffset: NIL - 29/10/2023 (Sunday) - 7, monthOffset: NIL MONTHLY - - 1st Oct - 1, monthOffset: NIL - 12th Oct - 12, monthOffset: NIL - 28th Oct - 28, monthOffset: NIL - 30th Oct - 30, monthOffset: NIL - 31th Oct - LAST, monthOffset: NIL QUARTERLY - 15th Jan, 15th Apr, 15th Jul and 15th Oct - 15, monthOffset: 1 - 15th Feb, 15th May, 15th Aug and 15th Nov - 15, monthOffset: 2 - 15th Mar, 15th Jun, 15th Sep and 15th Dec - 15, monthOffset: 3 HALF_YEARLY - 15th Jan and 15th Jul - 15, monthOffset: 1 - 15th Apr and 15th Oct - 15, monthOffset: 4 - 15th Jun and 15th Dec - 15, monthOffset: 6 ANNUALLY - 15th Jan - 15, monthOffset: 1 - 29th Feb on Leap year - LAST, monthOffset: 2 - 28th Feb - LAST, monthOffset: 2 - 15th Aug - 15, monthOffset: 8 - 15th Dec - 15, monthOffset: 12



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

def anniversary_cycle
  @anniversary_cycle
end

#grace_period ⇒ Object

Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. For example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period.



24
25
26
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 24

def grace_period
  @grace_period
end

#interval ⇒ Object

Returns the value of attribute interval.



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

def interval
  @interval
end

#start_offset ⇒ Object

Returns the value of attribute start_offset.



21
22
23
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 21

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 193

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



62
63
64
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 52

def self.attribute_map
  {
    :'interval' => :'interval',
    :'start_offset' => :'startOffset',
    :'grace_period' => :'gracePeriod',
    :'anniversary_cycle' => :'anniversaryCycle'
  }
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 169

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 67

def self.openapi_types
  {
    :'interval' => :'PricingCycleInterval',
    :'start_offset' => :'PricingCycleConfigStartOffset',
    :'grace_period' => :'Integer',
    :'anniversary_cycle' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      interval == o.interval &&
      start_offset == o.start_offset &&
      grace_period == o.grace_period &&
      anniversary_cycle == o.anniversary_cycle
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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 264

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


156
157
158
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 162

def hash
  [interval, start_offset, grace_period, anniversary_cycle].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



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 120

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

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



240
241
242
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 240

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 246

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



234
235
236
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 234

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



136
137
138
139
140
141
 
# File 'lib/togai_client/models/pricing_cycle_config.rb', line 136

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @interval.nil?
  return false if @grace_period.nil?
  true
end