class VoucherifySdk::RedemptionsRedeemRequestBody
Response body schema for POST ‘v1/redemptions`.
Attributes
A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format.
Is correspondent to Customer’s source_id
Public Class Methods
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 183 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 = VoucherifySdk.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Returns all the JSON keys this model knows about
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 49 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 36 def self.attribute_map { :'options' => :'options', :'redeemables' => :'redeemables', :'order' => :'order', :'customer' => :'customer', :'session' => :'session', :'tracking_id' => :'tracking_id', :'metadata' => :'metadata' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 159 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 78 def initialize(attributes = {}) # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.key?(:'options') self.options = attributes[:'options'] end if attributes.key?(:'redeemables') if (value = attributes[:'redeemables']).is_a?(Array) self.redeemables = value end end if attributes.key?(:'order') self.order = attributes[:'order'] end if attributes.key?(:'customer') self.customer = attributes[:'customer'] end if attributes.key?(:'session') self.session = attributes[:'session'] end if attributes.key?(:'tracking_id') self.tracking_id = attributes[:'tracking_id'] end if attributes.key?(:'metadata') self.metadata = attributes[:'metadata'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 67 def self.openapi_nullable Set.new([ :'options', :'redeemables', :'tracking_id', :'metadata' ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 54 def self.openapi_types { :'options' => :'RedemptionsRedeemRequestBodyOptions', :'redeemables' => :'Array<RedemptionsRedeemRequestBodyRedeemablesItem>', :'order' => :'Order', :'customer' => :'Customer', :'session' => :'Session', :'tracking_id' => :'String', :'metadata' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 132 def ==(o) return true if self.equal?(o) self.class == o.class && options == o.options && redeemables == o.redeemables && order == o.order && customer == o.customer && session == o.session && tracking_id == o.tracking_id && metadata == o.metadata 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/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 254 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 146 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 152 def hash [options, redeemables, order, customer, session, tracking_id, metadata].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 117 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 236 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 224 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/VoucherifySdk/models/redemptions_redeem_request_body.rb, line 125 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end