Class: TogaiClient::CreateProposalRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateProposalRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'rate_card_quantities')
    if (value = attributes[:'rate_card_quantities']).is_a?(Hash)
      self.rate_card_quantities = value
    end
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#association_override ⇒ Object

Returns the value of attribute association_override.



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

def association_override
  @association_override
end

#effective_from ⇒ Object

Returns the value of attribute effective_from.



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

def effective_from
  @effective_from
end

#effective_until ⇒ Object

Returns the value of attribute effective_until.



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

def effective_until
  @effective_until
end

#expiry_date ⇒ Object

Returns the value of attribute expiry_date.



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

def expiry_date
  @expiry_date
end

#idempotency_key ⇒ Object

Returns the value of attribute idempotency_key.



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

def idempotency_key
  @idempotency_key
end

#payment_mode ⇒ Object

Returns the value of attribute payment_mode.



41
42
43
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 41

def payment_mode
  @payment_mode
end

#price_plan_id ⇒ Object

Id of the price plan, Required for ENTITLEMENT_GRANT, ASSOCIATION purchase



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

def price_plan_id
  @price_plan_id
end

#purchase_plan_override ⇒ Object

Returns the value of attribute purchase_plan_override.



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

def purchase_plan_override
  @purchase_plan_override
end

#quantity ⇒ Object

Returns the value of attribute quantity.



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

def quantity
  @quantity
end

#rate_card_quantities ⇒ Object

Returns the value of attribute rate_card_quantities.



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

def rate_card_quantities
  @rate_card_quantities
end

#type ⇒ Object

Returns the value of attribute type.



39
40
41
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 39

def type
  @type
end

#wallet_topup_details ⇒ Object

Returns the value of attribute wallet_topup_details.



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

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 284

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



84
85
86
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 66

def self.attribute_map
  {
    :'price_plan_id' => :'pricePlanId',
    :'quantity' => :'quantity',
    :'rate_card_quantities' => :'rateCardQuantities',
    :'idempotency_key' => :'idempotencyKey',
    :'purchase_plan_override' => :'purchasePlanOverride',
    :'association_override' => :'associationOverride',
    :'wallet_topup_details' => :'walletTopupDetails',
    :'effective_from' => :'effectiveFrom',
    :'effective_until' => :'effectiveUntil',
    :'expiry_date' => :'expiryDate',
    :'type' => :'type',
    :'payment_mode' => :'paymentMode'
  }
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 260

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



113
114
115
116
117
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 113

def self.openapi_all_of
  [
  :'CreatePurchaseRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 89

def self.openapi_types
  {
    :'price_plan_id' => :'String',
    :'quantity' => :'Integer',
    :'rate_card_quantities' => :'Hash<String, Float>',
    :'idempotency_key' => :'String',
    :'purchase_plan_override' => :'PurchasePlanOverride',
    :'association_override' => :'CreatePricePlanDetailsOverride',
    :'wallet_topup_details' => :'WalletTopupDetails',
    :'effective_from' => :'Date',
    :'effective_until' => :'Date',
    :'expiry_date' => :'Time',
    :'type' => :'PurchaseType',
    :'payment_mode' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      price_plan_id == o.price_plan_id &&
      quantity == o.quantity &&
      rate_card_quantities == o.rate_card_quantities &&
      idempotency_key == o.idempotency_key &&
      purchase_plan_override == o.purchase_plan_override &&
      association_override == o.association_override &&
      wallet_topup_details == o.wallet_topup_details &&
      effective_from == o.effective_from &&
      effective_until == o.effective_until &&
      expiry_date == o.expiry_date &&
      type == o.type &&
      payment_mode == o.payment_mode
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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 355

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


247
248
249
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 253

def hash
  [price_plan_id, quantity, rate_card_quantities, idempotency_key, purchase_plan_override, association_override, wallet_topup_details, effective_from, effective_until, expiry_date, type, payment_mode].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



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

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

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



331
332
333
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 331

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



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

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



325
326
327
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 325

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



207
208
209
210
211
212
213
214
 
# File 'lib/togai_client/models/create_proposal_request.rb', line 207

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @payment_mode.nil?
  payment_mode_validator = EnumAttributeValidator.new('String', ["PREPAID", "POSTPAID"])
  return false unless payment_mode_validator.valid?(@payment_mode)
  true
end