Class: TogaiClient::PricingCycleConfigStartOffset

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

Overview

Represents the start of pricing cycle in terms of - dayOffset - number of days from beginning of week / month and - monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn’t exist for a month, closest previous day is considered Examples: WEEKLY - - 1, monthOffset: NIL - First day of every week (Monday) - 3, monthOffset: NIL - 3rd day of every week (Wednesday) - LAST, monthOffset: NIL - Last day of every week (Sunday) MONTHLY - - 1, monthOffset: NIL - First day of every month - 12, monthOffset: NIL - 12th of every month - 28, monthOffset: NIL - 28th of every month. i.e, 28th of Jan, 28th of Feb, … - 30, monthOffset: NIL - 30th of every month. i.e, 28th of Jan, 28th of Feb, … - LAST, monthOffset: NIL - Last day of every month. i.e, 31st of Jan, 28th of Feb, … QUARTERLY - 15, monthOffset: FIRST - 15th Jan, 15th Apr, 15th Jul and 15th Oct - 15, monthOffset: 2 - 15th Feb, 15th May, 15th Aug and 15th Nov - 15, monthOffset: LAST - 15th Mar, 15th Jun, 15th Sep and 15th Dec - LAST, monthOffset: FIRST - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY - 15, monthOffset: FIRST - 15th Jan and 15th Jul - 15, monthOffset: 4 - 15th Apr and 15th Oct - 15, monthOffset: LAST - 15th Jun and 15th Dec ANNUALLY - 15, monthOffset: FIRST - 15th Jan - 15, monthOffset: 1 - 15th Jan - LAST, monthOffset: 2 - 29th Feb on Leap year, 28th otherwise - 15, monthOffset: 8 - 15th Aug - 15, monthOffset: LAST - 15th Dec

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PricingCycleConfigStartOffset

Initializes the object

Parameters:

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

    Model attributes in the form of hash



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 54

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

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

Instance Attribute Details

#day_offset ⇒ Object

If interval is WEEKLY, min: "1" and max: "7" as strings. Spl. string allowed: LAST Otherwise, min: "1" and max: "31" as strings. Spl. string allowed: LAST



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

def day_offset
  @day_offset
end

#month_offset ⇒ Object

min: "1" and max: "12". Spl. string allowed: FIRST / LAST. For QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn’t be passed for MONTHLY.



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

def month_offset
  @month_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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 153

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 26

def self.attribute_map
  {
    :'day_offset' => :'dayOffset',
    :'month_offset' => :'monthOffset'
  }
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 129

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



47
48
49
50
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 47

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 39

def self.openapi_types
  {
    :'day_offset' => :'String',
    :'month_offset' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      day_offset == o.day_offset &&
      month_offset == o.month_offset
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



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 224

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


116
117
118
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 116

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



122
123
124
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 122

def hash
  [day_offset, month_offset].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



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

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

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



200
201
202
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 200

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 206

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



194
195
196
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 194

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



98
99
100
101
102
103
 
# File 'lib/togai_client/models/pricing_cycle_config_start_offset.rb', line 98

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