Class: Plaid::PaymentInitiationPaymentReverseRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/payment_initiation_payment_reverse_request.rb

Overview

PaymentInitiationPaymentReverseRequest defines the request schema for ‘/payment_initiation/payment/reverse`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentInitiationPaymentReverseRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PaymentInitiationPaymentReverseRequest` 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 `Plaid::PaymentInitiationPaymentReverseRequest`. 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?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

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

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

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

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

Instance Attribute Details

#client_id ⇒ Object

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.



20
21
22
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 20

def client_id
  @client_id
end

#idempotency_key ⇒ Object

A random key provided by the client, per unique wallet transaction. Maximum of 128 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a wallet transaction fails due to a network connection error, then after a minimum delay of one minute, you can retry the request with the same idempotency key to guarantee that only a single wallet transaction is created. If the request was successfully processed, it will prevent any transaction that uses the same idempotency key, and was received within 24 hours of the first request, from being processed.



29
30
31
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 29

def idempotency_key
  @idempotency_key
end

#payment_id ⇒ Object

The ID of the payment to reverse



26
27
28
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 26

def payment_id
  @payment_id
end

#reference ⇒ Object

A reference for the refund. This must be an alphanumeric string with at most 18 characters and must not contain any special characters or spaces.



32
33
34
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 32

def reference
  @reference
end

#secret ⇒ Object

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.



23
24
25
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 23

def secret
  @secret
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 46

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 35

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'payment_id' => :'payment_id',
    :'idempotency_key' => :'idempotency_key',
    :'reference' => :'reference'
  }
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



239
240
241
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 239

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 51

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'payment_id' => :'String',
    :'idempotency_key' => :'String',
    :'reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      payment_id == o.payment_id &&
      idempotency_key == o.idempotency_key &&
      reference == o.reference
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 269

def _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 = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 340

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 246

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 232

def hash
  [client_id, secret, payment_id, idempotency_key, reference].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



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 105

def list_invalid_properties
  invalid_properties = Array.new
  if @payment_id.nil?
    invalid_properties.push('invalid value for "payment_id", payment_id cannot be nil.')
  end

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


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

  if @idempotency_key.to_s.length > 128
    invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 128.')
  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 @reference.nil?
    invalid_properties.push('invalid value for "reference", reference cannot be nil.')
  end

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

  if @reference.to_s.length < 1
    invalid_properties.push('invalid value for "reference", the character length must be great than or equal to 1.')
  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



316
317
318
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 316

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 322

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



310
311
312
 
# File 'lib/plaid/models/payment_initiation_payment_reverse_request.rb', line 310

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/plaid/models/payment_initiation_payment_reverse_request.rb', line 147

def valid?
  return false if @payment_id.nil?
  return false if @payment_id.to_s.length < 1
  return false if @idempotency_key.nil?
  return false if @idempotency_key.to_s.length > 128
  return false if @idempotency_key.to_s.length < 1
  return false if @reference.nil?
  return false if @reference.to_s.length > 18
  return false if @reference.to_s.length < 1
  true
end