Class: TogaiClient::CreatePurchaseRequest

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

Overview

Create a purchase for an account

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePurchaseRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
169
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 111

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

Instance Attribute Details

#association_override ⇒ Object

Returns the value of attribute association_override.



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

def association_override
  @association_override
end

#effective_from ⇒ Object

Returns the value of attribute effective_from.



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

def effective_from
  @effective_from
end

#effective_until ⇒ Object

Returns the value of attribute effective_until.



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

def effective_until
  @effective_until
end

#expiry_date ⇒ Object

Returns the value of attribute expiry_date.



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

def expiry_date
  @expiry_date
end

#idempotency_key ⇒ Object

Returns the value of attribute idempotency_key.



26
27
28
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 26

def idempotency_key
  @idempotency_key
end

#price_plan_id ⇒ Object

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



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

def price_plan_id
  @price_plan_id
end

#purchase_plan_override ⇒ Object

Returns the value of attribute purchase_plan_override.



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

def purchase_plan_override
  @purchase_plan_override
end

#quantity ⇒ Object

Returns the value of attribute quantity.



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

def quantity
  @quantity
end

#rate_card_quantities ⇒ Object

Returns the value of attribute rate_card_quantities.



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

def rate_card_quantities
  @rate_card_quantities
end

#type ⇒ Object

Returns the value of attribute type.



40
41
42
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 40

def type
  @type
end

#wallet_topup_details ⇒ Object

Returns the value of attribute wallet_topup_details.



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

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



243
244
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
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 243

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



82
83
84
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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'
  }
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



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

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



104
105
106
107
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 87

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 188

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
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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 314

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


206
207
208
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 212

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].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



173
174
175
176
177
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 173

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



290
291
292
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 296

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



284
285
286
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 284

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



181
182
183
184
 
# File 'lib/togai_client/models/create_purchase_request.rb', line 181

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end