Class: CityPayApiClient::RefundRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/refund_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RefundRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
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
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 67

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::RefundRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::RefundRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  else
    self.amount = nil
  end

  if attributes.key?(:'identifier')
    self.identifier = attributes[:'identifier']
  else
    self.identifier = nil
  end

  if attributes.key?(:'merchantid')
    self.merchantid = attributes[:'merchantid']
  else
    self.merchantid = nil
  end

  if attributes.key?(:'refund_ref')
    self.refund_ref = attributes[:'refund_ref']
  else
    self.refund_ref = nil
  end

  if attributes.key?(:'trans_info')
    self.trans_info = attributes[:'trans_info']
  end
end

Instance Attribute Details

#amount ⇒ Object

The amount to refund in the lowest unit of currency with a variable length to a maximum of 12 digits. The amount should be the total amount required to refund for the transaction up to the original processed amount. No decimal points are to be included and no divisional characters such as 1,024. For example with GBP £1,021.95 the amount value is 102195.



18
19
20
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 18

def amount
  @amount
end

#identifier ⇒ Object

The identifier of the refund to process. The value should be a valid reference and may be used to perform post processing actions and to aid in reconciliation of transactions. The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127. The identifier is recommended to be distinct for each transaction such as a [random unique identifier](en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable. When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.



21
22
23
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 21

def identifier
  @identifier
end

#merchantid ⇒ Object

Identifies the merchant account to perform the refund for.



24
25
26
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 24

def merchantid
  @merchantid
end

#refund_ref ⇒ Object

A reference to the original transaction number that is wanting to be refunded. The original transaction must be on the same merchant id, previously authorised.



27
28
29
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 27

def refund_ref
  @refund_ref
end

#trans_info ⇒ Object

Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id.



30
31
32
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 30

def trans_info
  @trans_info
end

Class Method Details

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 252

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 = CityPayApiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



44
45
46
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 44

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 33

def self.attribute_map
  {
    :'amount' => :'amount',
    :'identifier' => :'identifier',
    :'merchantid' => :'merchantid',
    :'refund_ref' => :'refund_ref',
    :'trans_info' => :'trans_info'
  }
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 228

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
63
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 60

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 49

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'identifier' => :'String',
    :'merchantid' => :'Integer',
    :'refund_ref' => :'Integer',
    :'trans_info' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      identifier == o.identifier &&
      merchantid == o.merchantid &&
      refund_ref == o.refund_ref &&
      trans_info == o.trans_info
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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 323

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


215
216
217
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 221

def hash
  [amount, identifier, merchantid, refund_ref, trans_info].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



111
112
113
114
115
116
117
118
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
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 111

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @identifier.nil?
    invalid_properties.push('invalid value for "identifier", identifier cannot be nil.')
  end

  if @identifier.to_s.length > 50
    invalid_properties.push('invalid value for "identifier", the character length must be smaller than or equal to 50.')
  end

  if @identifier.to_s.length < 4
    invalid_properties.push('invalid value for "identifier", the character length must be great than or equal to 4.')
  end

  if @merchantid.nil?
    invalid_properties.push('invalid value for "merchantid", merchantid cannot be nil.')
  end

  if @refund_ref.nil?
    invalid_properties.push('invalid value for "refund_ref", refund_ref cannot be nil.')
  end

  if !@trans_info.nil? && @trans_info.to_s.length > 50
    invalid_properties.push('invalid value for "trans_info", the character length must be smaller than or equal to 50.')
  end

  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



299
300
301
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 299

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 305

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



293
294
295
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 293

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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/citypay_api_client/models/refund_request.rb', line 147

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @amount.nil?
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 50
  return false if @identifier.to_s.length < 4
  return false if @merchantid.nil?
  return false if @refund_ref.nil?
  return false if !@trans_info.nil? && @trans_info.to_s.length > 50
  true
end