Class: SquareConnect::V1Refund

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1Refund

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/square_connect/models/v1_refund.rb', line 91

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?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'reason')
    self.reason = attributes[:'reason']
  end

  if attributes.has_key?(:'refunded_money')
    self.refunded_money = attributes[:'refunded_money']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'processed_at')
    self.processed_at = attributes[:'processed_at']
  end

  if attributes.has_key?(:'payment_id')
    self.payment_id = attributes[:'payment_id']
  end

  if attributes.has_key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.has_key?(:'is_exchange')
    self.is_exchange = attributes[:'is_exchange']
  end

end

Instance Attribute Details

#created_at ⇒ Object

The time when the merchant initiated the refund for Square to process, in ISO 8601 format.



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

def created_at
  @created_at
end

#is_exchange ⇒ Object

Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.



37
38
39
 
# File 'lib/square_connect/models/v1_refund.rb', line 37

def is_exchange
  @is_exchange
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



34
35
36
 
# File 'lib/square_connect/models/v1_refund.rb', line 34

def merchant_id
  @merchant_id
end

#payment_id ⇒ Object

A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.



31
32
33
 
# File 'lib/square_connect/models/v1_refund.rb', line 31

def payment_id
  @payment_id
end

#processed_at ⇒ Object

The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.



28
29
30
 
# File 'lib/square_connect/models/v1_refund.rb', line 28

def processed_at
  @processed_at
end

#reason ⇒ Object

The merchant-specified reason for the refund.



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

def reason
  @reason
end

#refunded_money ⇒ Object

The amount of money refunded. This amount is always negative.



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

def refunded_money
  @refunded_money
end

#type ⇒ Object

The type of refund



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/square_connect/models/v1_refund.rb', line 62

def self.attribute_map
  {
    :'type' => :'type',
    :'reason' => :'reason',
    :'refunded_money' => :'refunded_money',
    :'created_at' => :'created_at',
    :'processed_at' => :'processed_at',
    :'payment_id' => :'payment_id',
    :'merchant_id' => :'merchant_id',
    :'is_exchange' => :'is_exchange'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/square_connect/models/v1_refund.rb', line 76

def self.swagger_types
  {
    :'type' => :'String',
    :'reason' => :'String',
    :'refunded_money' => :'V1Money',
    :'created_at' => :'String',
    :'processed_at' => :'String',
    :'payment_id' => :'String',
    :'merchant_id' => :'String',
    :'is_exchange' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/square_connect/models/v1_refund.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      reason == o.reason &&
      refunded_money == o.refunded_money &&
      created_at == o.created_at &&
      processed_at == o.processed_at &&
      payment_id == o.payment_id &&
      merchant_id == o.merchant_id &&
      is_exchange == o.is_exchange
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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/square_connect/models/v1_refund.rb', line 207

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/square_connect/models/v1_refund.rb', line 273

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/square_connect/models/v1_refund.rb', line 186

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


173
174
175
 
# File 'lib/square_connect/models/v1_refund.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/square_connect/models/v1_refund.rb', line 179

def hash
  [type, reason, refunded_money, created_at, processed_at, payment_id, merchant_id, is_exchange].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



133
134
135
136
 
# File 'lib/square_connect/models/v1_refund.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  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



253
254
255
 
# File 'lib/square_connect/models/v1_refund.rb', line 253

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



259
260
261
262
263
264
265
266
267
 
# File 'lib/square_connect/models/v1_refund.rb', line 259

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



247
248
249
 
# File 'lib/square_connect/models/v1_refund.rb', line 247

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



140
141
142
143
144
 
# File 'lib/square_connect/models/v1_refund.rb', line 140

def valid?
  type_validator = EnumAttributeValidator.new('String', ["FULL", "PARTIAL"])
  return false unless type_validator.valid?(@type)
  return true
end