Class: TogaiClient::FixedFeeRateCard

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FixedFeeRateCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 105

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#display_name ⇒ Object

Name of the attached AddOn



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

def display_name
  @display_name
end

#enable_proration ⇒ Object

Returns the value of attribute enable_proration.



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

def enable_proration
  @enable_proration
end

#id ⇒ Object

Unique Identifier of the attached AddOn



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

def id
  @id
end

#invoice_timing ⇒ Object

Returns the value of attribute invoice_timing.



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

def invoice_timing
  @invoice_timing
end

#name ⇒ Object

Unique identifier for the rate card in a price plan. If left null it is auto-generated.



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

def name
  @name
end

#rate_values ⇒ Object

Returns the value of attribute rate_values.



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

def rate_values
  @rate_values
end

#recurrence_config ⇒ Object

Returns the value of attribute recurrence_config.



38
39
40
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 38

def recurrence_config
  @recurrence_config
end

#tag ⇒ Object

A tag string to group fixedFeeRateCards



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

def tag
  @tag
end

#type ⇒ Object

Returns the value of attribute type.



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

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



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
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 267

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/fixed_fee_rate_card.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'display_name' => :'displayName',
    :'name' => :'name',
    :'tag' => :'tag',
    :'invoice_timing' => :'invoiceTiming',
    :'type' => :'type',
    :'rate_values' => :'rateValues',
    :'enable_proration' => :'enableProration',
    :'recurrence_config' => :'recurrenceConfig'
  }
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 243

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



98
99
100
101
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 98

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
95
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 83

def self.openapi_types
  {
    :'id' => :'String',
    :'display_name' => :'String',
    :'name' => :'String',
    :'tag' => :'String',
    :'invoice_timing' => :'InvoiceTiming',
    :'type' => :'FixedFeeType',
    :'rate_values' => :'Array<CurrencyRateValue>',
    :'enable_proration' => :'Boolean',
    :'recurrence_config' => :'RecurrenceConfig'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      display_name == o.display_name &&
      name == o.name &&
      tag == o.tag &&
      invoice_timing == o.invoice_timing &&
      type == o.type &&
      rate_values == o.rate_values &&
      enable_proration == o.enable_proration &&
      recurrence_config == o.recurrence_config
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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 338

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


230
231
232
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 236

def hash
  [id, display_name, name, tag, invoice_timing, type, rate_values, enable_proration, recurrence_config].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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 165

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

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

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

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



314
315
316
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 314

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 320

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



308
309
310
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 308

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



189
190
191
192
193
194
195
196
 
# File 'lib/togai_client/models/fixed_fee_rate_card.rb', line 189

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @id.to_s.length > 50
  return false if @rate_values.nil?
  return false if @enable_proration.nil?
  true
end