Class: TogaiClient::CreditGrantRateCard

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

Overview

Credit grant rate card

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditGrantRateCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'rate_details')
    self.rate_details = attributes[:'rate_details']
  else
    self.rate_details = nil
  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?(:'recurrence_config')
    self.recurrence_config = attributes[:'recurrence_config']
  end
end

Instance Attribute Details

#display_name ⇒ Object

Returns the value of attribute display_name.



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

def display_name
  @display_name
end

#grant_details ⇒ Object

Returns the value of attribute grant_details.



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

def grant_details
  @grant_details
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_timing ⇒ Object

Returns the value of attribute invoice_timing.



33
34
35
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 33

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.



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

def name
  @name
end

#rate_details ⇒ Object

Returns the value of attribute rate_details.



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

def rate_details
  @rate_details
end

#recurrence_config ⇒ Object

Returns the value of attribute recurrence_config.



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

def recurrence_config
  @recurrence_config
end

#tag ⇒ Object

A tag string to group creditGrantRateCard



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

def tag
  @tag
end

#type ⇒ Object

Returns the value of attribute type.



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

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



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
274
275
276
277
278
279
280
281
282
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 245

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



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

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
73
74
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 62

def self.attribute_map
  {
    :'id' => :'id',
    :'display_name' => :'displayName',
    :'name' => :'name',
    :'tag' => :'tag',
    :'grant_details' => :'grantDetails',
    :'rate_details' => :'rateDetails',
    :'invoice_timing' => :'invoiceTiming',
    :'type' => :'type',
    :'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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 221

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



97
98
99
100
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'display_name' => :'String',
    :'name' => :'String',
    :'tag' => :'String',
    :'grant_details' => :'GrantDetails',
    :'rate_details' => :'CreditRateDetails',
    :'invoice_timing' => :'InvoiceTiming',
    :'type' => :'CreditGrantType',
    :'recurrence_config' => :'RecurrenceConfig'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 192

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 &&
      grant_details == o.grant_details &&
      rate_details == o.rate_details &&
      invoice_timing == o.invoice_timing &&
      type == o.type &&
      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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 316

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


208
209
210
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 214

def hash
  [id, display_name, name, tag, grant_details, rate_details, invoice_timing, type, 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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 162

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 @grant_details.nil?
    invalid_properties.push('invalid value for "grant_details", grant_details cannot be nil.')
  end

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



292
293
294
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 292

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 298

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



286
287
288
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 286

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



182
183
184
185
186
187
188
 
# File 'lib/togai_client/models/credit_grant_rate_card.rb', line 182

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