class SquareConnect::CreateRefundRequest
Defines the body parameters that can be included in a request to the CreateRefund endpoint.
Attributes
The amount of money to refund. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](workingwithmonetaryamounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`.
A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](/basics/api101/idempotency) for more information.
A description of the reason for the refund. Default value: `Refund via API`
The ID of the tender to refund. A [`Transaction`](type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/create_refund_request.rb, line 29 def self.attribute_map { :'idempotency_key' => :'idempotency_key', :'tender_id' => :'tender_id', :'reason' => :'reason', :'amount_money' => :'amount_money' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/create_refund_request.rb, line 50 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'idempotency_key') self.idempotency_key = attributes[:'idempotency_key'] end if attributes.has_key?(:'tender_id') self.tender_id = attributes[:'tender_id'] end if attributes.has_key?(:'reason') self.reason = attributes[:'reason'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end end
Attribute type mapping.
# File lib/square_connect/models/create_refund_request.rb, line 39 def self.swagger_types { :'idempotency_key' => :'String', :'tender_id' => :'String', :'reason' => :'String', :'amount_money' => :'Money' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/create_refund_request.rb, line 176 def ==(o) return true if self.equal?(o) self.class == o.class && idempotency_key == o.idempotency_key && tender_id == o.tender_id && reason == o.reason && amount_money == o.amount_money 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/square_connect/models/create_refund_request.rb, line 221 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 temp_model = SquareConnect.const_get(type).new temp_model.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/square_connect/models/create_refund_request.rb, line 287 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/square_connect/models/create_refund_request.rb, line 200 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.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/square_connect/models/create_refund_request.rb, line 187 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/create_refund_request.rb, line 193 def hash [idempotency_key, tender_id, reason, amount_money].hash end
Custom attribute writer method with validation @param [Object] idempotency_key
Value to be assigned
# File lib/square_connect/models/create_refund_request.rb, line 129 def idempotency_key=(idempotency_key) if idempotency_key.nil? fail ArgumentError, "idempotency_key cannot be nil" end if idempotency_key.to_s.length > 192 fail ArgumentError, "invalid value for 'idempotency_key', the character length must be smaller than or equal to 192." end if idempotency_key.to_s.length < 1 fail ArgumentError, "invalid value for 'idempotency_key', the character length must be great than or equal to 1." end @idempotency_key = idempotency_key end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/square_connect/models/create_refund_request.rb, line 76 def list_invalid_properties invalid_properties = Array.new if @idempotency_key.nil? invalid_properties.push("invalid value for 'idempotency_key', idempotency_key cannot be nil.") end if @idempotency_key.to_s.length > 192 invalid_properties.push("invalid value for 'idempotency_key', the character length must be smaller than or equal to 192.") end if @idempotency_key.to_s.length < 1 invalid_properties.push("invalid value for 'idempotency_key', the character length must be great than or equal to 1.") end if @tender_id.nil? invalid_properties.push("invalid value for 'tender_id', tender_id cannot be nil.") end if @tender_id.to_s.length > 192 invalid_properties.push("invalid value for 'tender_id', the character length must be smaller than or equal to 192.") end if @tender_id.to_s.length < 1 invalid_properties.push("invalid value for 'tender_id', the character length must be great than or equal to 1.") end if !@reason.nil? && @reason.to_s.length > 192 invalid_properties.push("invalid value for 'reason', the character length must be smaller than or equal to 192.") end if @amount_money.nil? invalid_properties.push("invalid value for 'amount_money', amount_money cannot be nil.") end return invalid_properties end
Custom attribute writer method with validation @param [Object] reason Value to be assigned
# File lib/square_connect/models/create_refund_request.rb, line 165 def reason=(reason) if !reason.nil? && reason.to_s.length > 192 fail ArgumentError, "invalid value for 'reason', the character length must be smaller than or equal to 192." end @reason = reason end
Custom attribute writer method with validation @param [Object] tender_id
Value to be assigned
# File lib/square_connect/models/create_refund_request.rb, line 147 def tender_id=(tender_id) if tender_id.nil? fail ArgumentError, "tender_id cannot be nil" end if tender_id.to_s.length > 192 fail ArgumentError, "invalid value for 'tender_id', the character length must be smaller than or equal to 192." end if tender_id.to_s.length < 1 fail ArgumentError, "invalid value for 'tender_id', the character length must be great than or equal to 1." end @tender_id = tender_id end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/create_refund_request.rb, line 273 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/create_refund_request.rb, line 261 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/square_connect/models/create_refund_request.rb, line 115 def valid? return false if @idempotency_key.nil? return false if @idempotency_key.to_s.length > 192 return false if @idempotency_key.to_s.length < 1 return false if @tender_id.nil? return false if @tender_id.to_s.length > 192 return false if @tender_id.to_s.length < 1 return false if !@reason.nil? && @reason.to_s.length > 192 return false if @amount_money.nil? return true end