class OpenapiClient::UsePaymentToken
Payment
token usage details.
Attributes
Card
verification value/number.
The ID of a same store (or) sibling store in a hierarchy for which the token was originally created.
Client-supplied payment token value.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/openapi_client/models/use_payment_token.rb, line 32 def self.attribute_map { :'value' => :'value', :'token_origin_store_id' => :'tokenOriginStoreId', :'function' => :'function', :'security_code' => :'securityCode', :'expiry_date' => :'expiryDate' } end
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/use_payment_token.rb, line 194 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/openapi_client/models/use_payment_token.rb, line 55 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsePaymentToken` 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::UsePaymentToken`. 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?(:'value') self.value = attributes[:'value'] end if attributes.key?(:'token_origin_store_id') self.token_origin_store_id = attributes[:'token_origin_store_id'] end if attributes.key?(:'function') self.function = attributes[:'function'] end if attributes.key?(:'security_code') self.security_code = attributes[:'security_code'] end if attributes.key?(:'expiry_date') self.expiry_date = attributes[:'expiry_date'] end end
Attribute type mapping.
# File lib/openapi_client/models/use_payment_token.rb, line 43 def self.openapi_types { :'value' => :'String', :'token_origin_store_id' => :'String', :'function' => :'CardFunction', :'security_code' => :'String', :'expiry_date' => :'Expiration' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/openapi_client/models/use_payment_token.rb, line 169 def ==(o) return true if self.equal?(o) self.class == o.class && value == o.value && token_origin_store_id == o.token_origin_store_id && function == o.function && security_code == o.security_code && expiry_date == o.expiry_date end
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/use_payment_token.rb, line 222 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
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/use_payment_token.rb, line 296 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
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/use_payment_token.rb, line 201 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
@see the `==` method @param [Object] Object to be compared
# File lib/openapi_client/models/use_payment_token.rb, line 181 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/openapi_client/models/use_payment_token.rb, line 187 def hash [value, token_origin_store_id, function, security_code, expiry_date].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/openapi_client/models/use_payment_token.rb, line 91 def list_invalid_properties invalid_properties = Array.new if @value.nil? invalid_properties.push('invalid value for "value", value cannot be nil.') end pattern = Regexp.new(/^(?!\s*$).+/) if @value !~ pattern invalid_properties.push("invalid value for \"value\", must conform to the pattern #{pattern}.") end if !@token_origin_store_id.nil? && @token_origin_store_id.to_s.length > 20 invalid_properties.push('invalid value for "token_origin_store_id", the character length must be smaller than or equal to 20.') end if !@security_code.nil? && @security_code.to_s.length > 4 invalid_properties.push('invalid value for "security_code", the character length must be smaller than or equal to 4.') end if !@security_code.nil? && @security_code.to_s.length < 3 invalid_properties.push('invalid value for "security_code", the character length must be great than or equal to 3.') end invalid_properties end
Custom attribute writer method with validation @param [Object] security_code
Value to be assigned
# File lib/openapi_client/models/use_payment_token.rb, line 155 def security_code=(security_code) if !security_code.nil? && security_code.to_s.length > 4 fail ArgumentError, 'invalid value for "security_code", the character length must be smaller than or equal to 4.' end if !security_code.nil? && security_code.to_s.length < 3 fail ArgumentError, 'invalid value for "security_code", the character length must be great than or equal to 3.' end @security_code = security_code end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/openapi_client/models/use_payment_token.rb, line 278 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/openapi_client/models/use_payment_token.rb, line 266 def to_s to_hash.to_s end
Custom attribute writer method with validation @param [Object] token_origin_store_id
Value to be assigned
# File lib/openapi_client/models/use_payment_token.rb, line 145 def token_origin_store_id=(token_origin_store_id) if !token_origin_store_id.nil? && token_origin_store_id.to_s.length > 20 fail ArgumentError, 'invalid value for "token_origin_store_id", the character length must be smaller than or equal to 20.' end @token_origin_store_id = token_origin_store_id end
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/use_payment_token.rb, line 119 def valid? return false if @value.nil? return false if @value !~ Regexp.new(/^(?!\s*$).+/) return false if !@token_origin_store_id.nil? && @token_origin_store_id.to_s.length > 20 return false if !@security_code.nil? && @security_code.to_s.length > 4 return false if !@security_code.nil? && @security_code.to_s.length < 3 true end
Custom attribute writer method with validation @param [Object] value Value to be assigned
# File lib/openapi_client/models/use_payment_token.rb, line 130 def value=(value) if value.nil? fail ArgumentError, 'value cannot be nil' end pattern = Regexp.new(/^(?!\s*$).+/) if value !~ pattern fail ArgumentError, "invalid value for \"value\", must conform to the pattern #{pattern}." end @value = value end