class OpenapiClient::ChinaDomestic

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

Attributes

bank_id[RW]

Use this to indicate the CUP bank ID if known.

customer_id[RW]

Use this to indicate the CUP customer ID if known.

limit_card_function_to_debit[RW]

Use this to limit card functions to debit cards.

open_id[RW]

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

product_code[RW]

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

product_description[RW]

The product description.

product_price[RW]

Rate amount in 3 decimal 12 bytes total digit.

product_quantity[RW]

The quantity.

redirect_url[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/openapi_client/models/china_domestic.rb, line 350
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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
bank_id=(bank_id) click to toggle source

Custom attribute writer method with validation @param [Object] bank_id Value to be assigned

# File lib/openapi_client/models/china_domestic.rb, line 301
def bank_id=(bank_id)
  if !bank_id.nil? && bank_id.to_s.length > 8
    fail ArgumentError, 'invalid value for "bank_id", the character length must be smaller than or equal to 8.'
  end

  @bank_id = bank_id
end
build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
customer_id=(customer_id) click to toggle source

Custom attribute writer method with validation @param [Object] customer_id Value to be assigned

# File lib/openapi_client/models/china_domestic.rb, line 291
def customer_id=(customer_id)
  if !customer_id.nil? && customer_id.to_s.length > 32
    fail ArgumentError, 'invalid value for "customer_id", the character length must be smaller than or equal to 32.'
  end

  @customer_id = customer_id
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/openapi_client/models/china_domestic.rb, line 337
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
open_id=(open_id) click to toggle source

Custom attribute writer method with validation @param [Object] open_id Value to be assigned

# File lib/openapi_client/models/china_domestic.rb, line 311
def open_id=(open_id)
  if !open_id.nil? && open_id.to_s.length > 128
    fail ArgumentError, 'invalid value for "open_id", the character length must be smaller than or equal to 128.'
  end

  @open_id = open_id
end
product_code=(product_code) click to toggle source

Custom attribute writer method with validation @param [Object] product_code Value to be assigned

# File lib/openapi_client/models/china_domestic.rb, line 220
def product_code=(product_code)
  if product_code.nil?
    fail ArgumentError, 'product_code cannot be nil'
  end

  if product_code.to_s.length > 32
    fail ArgumentError, '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
    fail ArgumentError, "invalid value for \"product_code\", must conform to the pattern #{pattern}."
  end

  @product_code = product_code
end
product_description=(product_description) click to toggle source

Custom attribute writer method with validation @param [Object] product_description Value to be assigned

# File lib/openapi_client/models/china_domestic.rb, line 253
def product_description=(product_description)
  if product_description.nil?
    fail ArgumentError, 'product_description cannot be nil'
  end

  if product_description.to_s.length > 100
    fail ArgumentError, '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
    fail ArgumentError, "invalid value for \"product_description\", must conform to the pattern #{pattern}."
  end

  @product_description = product_description
end
product_quantity=(product_quantity) click to toggle source

Custom attribute writer method with validation @param [Object] product_quantity Value to be assigned

# File lib/openapi_client/models/china_domestic.rb, line 239
def product_quantity=(product_quantity)
  if product_quantity.nil?
    fail ArgumentError, 'product_quantity cannot be nil'
  end

  if product_quantity < 1
    fail ArgumentError, 'invalid value for "product_quantity", must be greater than or equal to 1.'
  end

  @product_quantity = product_quantity
end
redirect_url=(redirect_url) click to toggle source

Custom attribute writer method with validation @param [Object] redirect_url Value to be assigned

# File lib/openapi_client/models/china_domestic.rb, line 272
def redirect_url=(redirect_url)
  if redirect_url.nil?
    fail ArgumentError, 'redirect_url cannot be nil'
  end

  if redirect_url.to_s.length > 1024
    fail ArgumentError, '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
    fail ArgumentError, "invalid value for \"redirect_url\", must conform to the pattern #{pattern}."
  end

  @redirect_url = redirect_url
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# 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([])) click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/openapi_client/models/china_domestic.rb, line 422
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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