Class: Komoju::ResponsePaymentDetailsKonbini

Inherits:
ApiModelBase show all
Defined in:
lib/komoju-sdk/models/response_payment_details_konbini.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponsePaymentDetailsKonbini

Initializes the object

Parameters:

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

    Model attributes in the form of hash



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 172

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Komoju::ResponsePaymentDetailsKonbini` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Komoju::ResponsePaymentDetailsKonbini`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_address_city ⇒ Object

Billing address city.



67
68
69
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 67

def billing_address_city
  @billing_address_city
end

#billing_address_country ⇒ Object

Billing address country.



76
77
78
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 76

def billing_address_country
  @billing_address_country
end

#billing_address_line1 ⇒ Object

Billing address line 1.



61
62
63
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 61

def billing_address_line1
  @billing_address_line1
end

#billing_address_line2 ⇒ Object

Billing address line 2.



64
65
66
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 64

def billing_address_line2
  @billing_address_line2
end

#billing_address_name ⇒ Object

Billing address name. This is the paying customer's name.



58
59
60
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 58

def billing_address_name
  @billing_address_name
end

#billing_address_state ⇒ Object

Billing address state.



70
71
72
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 70

def billing_address_state
  @billing_address_state
end

#billing_address_zip ⇒ Object

Billing address ZIP code.



73
74
75
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 73

def billing_address_zip
  @billing_address_zip
end

#confirmation_code ⇒ Object

Confirmation code for the konbini payment slip.



28
29
30
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 28

def confirmation_code
  @confirmation_code
end

#email ⇒ Object

Customer's email address. Will be used for fraud prevention, payment instruction, and payment receipt.



25
26
27
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 25

def email
  @email
end

#instructions_url ⇒ Object

URL with payment instructions for the customer.



34
35
36
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 34

def instructions_url
  @instructions_url
end

#receipt ⇒ Object

Receipt number for the konbini payment.



31
32
33
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 31

def receipt
  @receipt
end

#shipping_address_city ⇒ Object

Shipping address city.



46
47
48
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 46

def shipping_address_city
  @shipping_address_city
end

#shipping_address_country ⇒ Object

Shipping address country.



55
56
57
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 55

def shipping_address_country
  @shipping_address_country
end

#shipping_address_line1 ⇒ Object

Shipping address line 1.



40
41
42
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 40

def shipping_address_line1
  @shipping_address_line1
end

#shipping_address_line2 ⇒ Object

Shipping address line 2.



43
44
45
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 43

def shipping_address_line2
  @shipping_address_line2
end

#shipping_address_name ⇒ Object

Shipping address name. This is the recipient's name.



37
38
39
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 37

def shipping_address_name
  @shipping_address_name
end

#shipping_address_state ⇒ Object

Shipping address state.



49
50
51
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 49

def shipping_address_state
  @shipping_address_state
end

#shipping_address_zip ⇒ Object

Shipping address ZIP code.



52
53
54
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 52

def shipping_address_zip
  @shipping_address_zip
end

#store ⇒ Object

Returns the value of attribute store.



22
23
24
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 22

def store
  @store
end

#type ⇒ Object

Payment method type.



20
21
22
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 20

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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 409

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value) rescue value
  when :Date
    Date.parse(value) rescue 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 = Komoju.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



127
128
129
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 127

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



132
133
134
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 132

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 101

def self.attribute_map
  {
    :'type' => :'type',
    :'store' => :'store',
    :'email' => :'email',
    :'confirmation_code' => :'confirmation_code',
    :'receipt' => :'receipt',
    :'instructions_url' => :'instructions_url',
    :'shipping_address_name' => :'shipping_address_name',
    :'shipping_address_line1' => :'shipping_address_line1',
    :'shipping_address_line2' => :'shipping_address_line2',
    :'shipping_address_city' => :'shipping_address_city',
    :'shipping_address_state' => :'shipping_address_state',
    :'shipping_address_zip' => :'shipping_address_zip',
    :'shipping_address_country' => :'shipping_address_country',
    :'billing_address_name' => :'billing_address_name',
    :'billing_address_line1' => :'billing_address_line1',
    :'billing_address_line2' => :'billing_address_line2',
    :'billing_address_city' => :'billing_address_city',
    :'billing_address_state' => :'billing_address_state',
    :'billing_address_zip' => :'billing_address_zip',
    :'billing_address_country' => :'billing_address_country'
  }
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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 379

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
  begin
    new(transformed_hash)
  rescue ArgumentError => e
    obj = allocate
    transformed_hash.each { |k, v| obj.instance_variable_set(:"@#{k}", v) }
    obj
  end
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



163
164
165
166
167
168
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 163

def self.openapi_nullable
  Set.new([
    :'confirmation_code',
    :'receipt',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 137

def self.openapi_types
  {
    :'type' => :'String',
    :'store' => :'String',
    :'email' => :'String',
    :'confirmation_code' => :'String',
    :'receipt' => :'String',
    :'instructions_url' => :'String',
    :'shipping_address_name' => :'String',
    :'shipping_address_line1' => :'String',
    :'shipping_address_line2' => :'String',
    :'shipping_address_city' => :'String',
    :'shipping_address_state' => :'String',
    :'shipping_address_zip' => :'String',
    :'shipping_address_country' => :'String',
    :'billing_address_name' => :'String',
    :'billing_address_line1' => :'String',
    :'billing_address_line2' => :'String',
    :'billing_address_city' => :'String',
    :'billing_address_state' => :'String',
    :'billing_address_zip' => :'String',
    :'billing_address_country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 339

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      store == o.store &&
      email == o.email &&
      confirmation_code == o.confirmation_code &&
      receipt == o.receipt &&
      instructions_url == o.instructions_url &&
      shipping_address_name == o.shipping_address_name &&
      shipping_address_line1 == o.shipping_address_line1 &&
      shipping_address_line2 == o.shipping_address_line2 &&
      shipping_address_city == o.shipping_address_city &&
      shipping_address_state == o.shipping_address_state &&
      shipping_address_zip == o.shipping_address_zip &&
      shipping_address_country == o.shipping_address_country &&
      billing_address_name == o.billing_address_name &&
      billing_address_line1 == o.billing_address_line1 &&
      billing_address_line2 == o.billing_address_line2 &&
      billing_address_city == o.billing_address_city &&
      billing_address_state == o.billing_address_state &&
      billing_address_zip == o.billing_address_zip &&
      billing_address_country == o.billing_address_country
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



480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 480

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


366
367
368
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 366

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



372
373
374
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 372

def hash
  [type, store, email, confirmation_code, receipt, instructions_url, shipping_address_name, shipping_address_line1, shipping_address_line2, shipping_address_city, shipping_address_state, shipping_address_zip, shipping_address_country, billing_address_name, billing_address_line1, billing_address_line2, billing_address_city, billing_address_state, billing_address_zip, billing_address_country].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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 275

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

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



456
457
458
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 456

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



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 462

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



450
451
452
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 450

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



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/komoju-sdk/models/response_payment_details_konbini.rb', line 295

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["konbini"])
  return false unless type_validator.valid?(@type)
  return false if @store.nil?
  store_validator = EnumAttributeValidator.new('String', ["seven-eleven", "lawson", "family-mart", "ministop", "daily-yamazaki", "seicomart"])
  return false unless store_validator.valid?(@store)
  return false if @email.nil?
  true
end