Class: SquareConnect::CreateRefundRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/create_refund_request.rb

Overview

Defines the body parameters that can be included inna request to the CreateRefund endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRefundRequest

Returns a new instance of CreateRefundRequest.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/square_connect/models/create_refund_request.rb', line 54

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'idempotency_key']
    self.idempotency_key = attributes[:'idempotency_key']
  end
  
  if attributes[:'tender_id']
    self.tender_id = attributes[:'tender_id']
  end
  
  if attributes[:'reason']
    self.reason = attributes[:'reason']
  end
  
  if attributes[:'amount_money']
    self.amount_money = attributes[:'amount_money']
  end
  
end

Instance Attribute Details

#amount_money ⇒ Object

The amount of money to refund.



26
27
28
 
# File 'lib/square_connect/models/create_refund_request.rb', line 26

def amount_money
  @amount_money
end

#idempotency_key ⇒ Object

A value you specify that uniquely identifies thisnrefund among refunds you’ve created for the tender.nnIf you’re unsure whether a particular refund succeeded,nyou can reattempt it with the same idempotency key withoutnworrying about duplicating the refund.



17
18
19
 
# File 'lib/square_connect/models/create_refund_request.rb', line 17

def idempotency_key
  @idempotency_key
end

#reason ⇒ Object

A description of the reason for the refund.



23
24
25
 
# File 'lib/square_connect/models/create_refund_request.rb', line 23

def reason
  @reason
end

#tender_id ⇒ Object

The ID of the tender to refund.



20
21
22
 
# File 'lib/square_connect/models/create_refund_request.rb', line 20

def tender_id
  @tender_id
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/square_connect/models/create_refund_request.rb', line 44

def self.swagger_types
  {
    :'idempotency_key' => :'String',
    :'tender_id' => :'String',
    :'reason' => :'String',
    :'amount_money' => :'Money'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



80
81
82
83
84
85
86
87
 
# File 'lib/square_connect/models/create_refund_request.rb', line 80

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

#_deserialize(type, value) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/square_connect/models/create_refund_request.rb', line 119

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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
    _model = SquareConnect.const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/square_connect/models/create_refund_request.rb', line 176

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) ⇒ Object

build the object from hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/square_connect/models/create_refund_request.rb', line 100

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


90
91
92
 
# File 'lib/square_connect/models/create_refund_request.rb', line 90

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



95
96
97
 
# File 'lib/square_connect/models/create_refund_request.rb', line 95

def hash
  [idempotency_key, tender_id, reason, amount_money].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



159
160
161
 
# File 'lib/square_connect/models/create_refund_request.rb', line 159

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



164
165
166
167
168
169
170
171
172
 
# File 'lib/square_connect/models/create_refund_request.rb', line 164

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

#to_s ⇒ Object 



154
155
156
 
# File 'lib/square_connect/models/create_refund_request.rb', line 154

def to_s
  to_hash.to_s
end