Class: BudgeaClient::PaymentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/models/payment_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
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
 
# File 'lib/budgea_client/models/payment_request.rb', line 60

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

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

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

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

  if attributes.has_key?(:'instructions')
    if (value = attributes[:'instructions']).is_a?(Array)
      self.instructions = value
    end
  end

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

Instance Attribute Details

#beneficiary ⇒ Object

Returns the value of attribute beneficiary.



26
27
28
 
# File 'lib/budgea_client/models/payment_request.rb', line 26

def beneficiary
  @beneficiary
end

#client_redirect_uri ⇒ Object

The redirect URL to use when building the validation URL. The provided URL must not contain any query parameter, rely on the client_state parameter for state management.



21
22
23
 
# File 'lib/budgea_client/models/payment_request.rb', line 21

def client_redirect_uri
  @client_redirect_uri
end

#client_state ⇒ Object

Optional value that will be added as a state query parameter to the redirect URL after validation.



24
25
26
 
# File 'lib/budgea_client/models/payment_request.rb', line 24

def client_state
  @client_state
end

#id_connector ⇒ Object

ID of the bank connector to use to initiate the payment. The bank connector must be eligible to payments creation. The id_connector can be submitted later on if validated is false when you initiate the payment request.



18
19
20
 
# File 'lib/budgea_client/models/payment_request.rb', line 18

def id_connector
  @id_connector
end

#instructions ⇒ Object

The payment information.



29
30
31
 
# File 'lib/budgea_client/models/payment_request.rb', line 29

def instructions
  @instructions
end

#validated ⇒ Object

Provide true to acknowledge payment validation at once. Otherwise, validation is deferred.



32
33
34
 
# File 'lib/budgea_client/models/payment_request.rb', line 32

def validated
  @validated
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/budgea_client/models/payment_request.rb', line 35

def self.attribute_map
  {
    :'id_connector' => :'id_connector',
    :'client_redirect_uri' => :'client_redirect_uri',
    :'client_state' => :'client_state',
    :'beneficiary' => :'beneficiary',
    :'instructions' => :'instructions',
    :'validated' => :'validated'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/budgea_client/models/payment_request.rb', line 47

def self.swagger_types
  {
    :'id_connector' => :'Integer',
    :'client_redirect_uri' => :'String',
    :'client_state' => :'String',
    :'beneficiary' => :'PaymentBeneficiaryRequest',
    :'instructions' => :'Array<PaymentInstructionRequest>',
    :'validated' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/budgea_client/models/payment_request.rb', line 118

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id_connector == o.id_connector &&
      client_redirect_uri == o.client_redirect_uri &&
      client_state == o.client_state &&
      beneficiary == o.beneficiary &&
      instructions == o.instructions &&
      validated == o.validated
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/budgea_client/models/payment_request.rb', line 165

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 = BudgeaClient.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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/budgea_client/models/payment_request.rb', line 231

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/budgea_client/models/payment_request.rb', line 144

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


131
132
133
 
# File 'lib/budgea_client/models/payment_request.rb', line 131

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/budgea_client/models/payment_request.rb', line 137

def hash
  [id_connector, client_redirect_uri, client_state, beneficiary, instructions, validated].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



95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/budgea_client/models/payment_request.rb', line 95

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

  if @instructions.nil?
    invalid_properties.push('invalid value for "instructions", instructions cannot be nil.')
  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



211
212
213
 
# File 'lib/budgea_client/models/payment_request.rb', line 211

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



217
218
219
220
221
222
223
224
225
 
# File 'lib/budgea_client/models/payment_request.rb', line 217

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



205
206
207
 
# File 'lib/budgea_client/models/payment_request.rb', line 205

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



110
111
112
113
114
 
# File 'lib/budgea_client/models/payment_request.rb', line 110

def valid?
  return false if @client_redirect_uri.nil?
  return false if @instructions.nil?
  true
end