Class: OpenapiClient::ChinaDomestic

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/china_domestic.rb

Overview

The payment object for China-domestic transactions. Use this to populate all china domestic payment method details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChinaDomestic

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/openapi_client/models/china_domestic.rb', line 77

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_id ⇒ Object

Use this to indicate the CUP bank ID if known.



40
41
42
 
# File 'lib/openapi_client/models/china_domestic.rb', line 40

def bank_id
  @bank_id
end

#customer_id ⇒ Object

Use this to indicate the CUP customer ID if known.



37
38
39
 
# File 'lib/openapi_client/models/china_domestic.rb', line 37

def customer_id
  @customer_id
end

#limit_card_function_to_debit ⇒ Object

Use this to limit card functions to debit cards.



34
35
36
 
# File 'lib/openapi_client/models/china_domestic.rb', line 34

def limit_card_function_to_debit
  @limit_card_function_to_debit
end

#open_id ⇒ Object

Use this as unique identifier of WeChat user which is corresponded to the appid of merchant. The field is only applicable for ChinaDomesticPaymentMethod - brand = WECHAT_DOMESTIC



43
44
45
 
# File 'lib/openapi_client/models/china_domestic.rb', line 43

def open_id
  @open_id
end

#product_code ⇒ Object

Use this to indicate the product code according to the product category list.



19
20
21
 
# File 'lib/openapi_client/models/china_domestic.rb', line 19

def product_code
  @product_code
end

#product_description ⇒ Object

The product description.



28
29
30
 
# File 'lib/openapi_client/models/china_domestic.rb', line 28

def product_description
  @product_description
end

#product_price ⇒ Object

Rate amount in 3 decimal 12 bytes total digit.



25
26
27
 
# File 'lib/openapi_client/models/china_domestic.rb', line 25

def product_price
  @product_price
end

#product_quantity ⇒ Object

The quantity.



22
23
24
 
# File 'lib/openapi_client/models/china_domestic.rb', line 22

def product_quantity
  @product_quantity
end

#redirect_url ⇒ Object

Use this to indicate the product code according to the product category list.



31
32
33
 
# File 'lib/openapi_client/models/china_domestic.rb', line 31

def redirect_url
  @redirect_url
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/openapi_client/models/china_domestic.rb', line 46

def self.attribute_map
  {
    :'product_code' => :'productCode',
    :'product_quantity' => :'productQuantity',
    :'product_price' => :'productPrice',
    :'product_description' => :'productDescription',
    :'redirect_url' => :'redirectURL',
    :'limit_card_function_to_debit' => :'limitCardFunctionToDebit',
    :'customer_id' => :'customerId',
    :'bank_id' => :'bankId',
    :'open_id' => :'openId'
  }
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



350
351
352
 
# File 'lib/openapi_client/models/china_domestic.rb', line 350

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/openapi_client/models/china_domestic.rb', line 61

def self.openapi_types
  {
    :'product_code' => :'String',
    :'product_quantity' => :'Integer',
    :'product_price' => :'Float',
    :'product_description' => :'String',
    :'redirect_url' => :'String',
    :'limit_card_function_to_debit' => :'Boolean',
    :'customer_id' => :'String',
    :'bank_id' => :'String',
    :'open_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/openapi_client/models/china_domestic.rb', line 321

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_code == o.product_code &&
      product_quantity == o.product_quantity &&
      product_price == o.product_price &&
      product_description == o.product_description &&
      redirect_url == o.redirect_url &&
      limit_card_function_to_debit == o.limit_card_function_to_debit &&
      customer_id == o.customer_id &&
      bank_id == o.bank_id &&
      open_id == o.open_id
end

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



378
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/openapi_client/models/china_domestic.rb', line 378

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.build_from_hash(value)
  end
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



452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/openapi_client/models/china_domestic.rb', line 452

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

#build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/openapi_client/models/china_domestic.rb', line 357

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_types.each_pair do |key, type|
    if 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)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


337
338
339
 
# File 'lib/openapi_client/models/china_domestic.rb', line 337

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



343
344
345
 
# File 'lib/openapi_client/models/china_domestic.rb', line 343

def hash
  [product_code, product_quantity, product_price, product_description, redirect_url, limit_card_function_to_debit, customer_id, bank_id, open_id].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



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
188
189
190
191
192
193
194
195
 
# File 'lib/openapi_client/models/china_domestic.rb', line 129

def list_invalid_properties
  invalid_properties = Array.new
  if @product_code.nil?
    invalid_properties.push('invalid value for "product_code", product_code cannot be nil.')
  end

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @product_code !~ pattern
    invalid_properties.push("invalid value for \"product_code\", must conform to the pattern #{pattern}.")
  end

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

  if @product_quantity < 1
    invalid_properties.push('invalid value for "product_quantity", must be greater than or equal to 1.')
  end

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

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

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @product_description !~ pattern
    invalid_properties.push("invalid value for \"product_description\", must conform to the pattern #{pattern}.")
  end

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

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @redirect_url !~ pattern
    invalid_properties.push("invalid value for \"redirect_url\", must conform to the pattern #{pattern}.")
  end

  if !@customer_id.nil? && @customer_id.to_s.length > 32
    invalid_properties.push('invalid value for "customer_id", the character length must be smaller than or equal to 32.')
  end

  if !@bank_id.nil? && @bank_id.to_s.length > 8
    invalid_properties.push('invalid value for "bank_id", the character length must be smaller than or equal to 8.')
  end

  if !@open_id.nil? && @open_id.to_s.length > 128
    invalid_properties.push('invalid value for "open_id", the character length must be smaller than or equal to 128.')
  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



428
429
430
 
# File 'lib/openapi_client/models/china_domestic.rb', line 428

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/openapi_client/models/china_domestic.rb', line 434

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = 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



422
423
424
 
# File 'lib/openapi_client/models/china_domestic.rb', line 422

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/openapi_client/models/china_domestic.rb', line 199

def valid?
  return false if @product_code.nil?
  return false if @product_code.to_s.length > 32
  return false if @product_code !~ Regexp.new(/^(?!\s*$).+/)
  return false if @product_quantity.nil?
  return false if @product_quantity < 1
  return false if @product_price.nil?
  return false if @product_description.nil?
  return false if @product_description.to_s.length > 100
  return false if @product_description !~ Regexp.new(/^(?!\s*$).+/)
  return false if @redirect_url.nil?
  return false if @redirect_url.to_s.length > 1024
  return false if @redirect_url !~ Regexp.new(/^(?!\s*$).+/)
  return false if !@customer_id.nil? && @customer_id.to_s.length > 32
  return false if !@bank_id.nil? && @bank_id.to_s.length > 8
  return false if !@open_id.nil? && @open_id.to_s.length > 128
  true
end