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 in a request to the CreateRefund endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRefundRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# 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

Instance Attribute Details

#amount_money ⇒ Object

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`.



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

def amount_money
  @amount_money
end

#idempotency_key ⇒ Object

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.



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

def idempotency_key
  @idempotency_key
end

#reason ⇒ Object

A description of the reason for the refund. Default value: ‘Refund via API`



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

def reason
  @reason
end

#tender_id ⇒ Object

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.



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

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
 
# 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.



39
40
41
42
43
44
45
46
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
 
# 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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# 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

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# 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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


187
188
189
 
# File 'lib/square_connect/models/create_refund_request.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



193
194
195
 
# File 'lib/square_connect/models/create_refund_request.rb', line 193

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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



267
268
269
 
# File 'lib/square_connect/models/create_refund_request.rb', line 267

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



261
262
263
 
# File 'lib/square_connect/models/create_refund_request.rb', line 261

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



115
116
117
118
119
120
121
122
123
124
125
 
# 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