Class: BudgeaClient::Payment

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Payment

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
102
103
104
105
106
107
108
# File 'lib/budgea_client/models/payment.rb', line 69

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

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

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

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

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

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

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

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

Instance Attribute Details

#client_redirect_uriObject

The validate_uri callback URL that was provided when configuring the transfer request.



34
35
36
# File 'lib/budgea_client/models/payment.rb', line 34

def client_redirect_uri
  @client_redirect_uri
end

#error_codeObject

Returns the value of attribute error_code.



22
23
24
# File 'lib/budgea_client/models/payment.rb', line 22

def error_code
  @error_code
end

#error_descriptionObject

Error message in case of an error.



25
26
27
# File 'lib/budgea_client/models/payment.rb', line 25

def error_description
  @error_description
end

#idObject

The ID of the created payment request.



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

def id
  @id
end

#id_connectorObject

ID of the bank connector to use to initiate the payment.



28
29
30
# File 'lib/budgea_client/models/payment.rb', line 28

def id_connector
  @id_connector
end

#instructionsObject

The list of payment instructions.



37
38
39
# File 'lib/budgea_client/models/payment.rb', line 37

def instructions
  @instructions
end

#stateObject

Returns the value of attribute state.



20
21
22
# File 'lib/budgea_client/models/payment.rb', line 20

def state
  @state
end

#validate_uriObject

The URL that must be presented to the PSU to validate the payment request. The URL is only available after the transfer has been validated.



31
32
33
# File 'lib/budgea_client/models/payment.rb', line 31

def validate_uri
  @validate_uri
end

Class Method Details

.attribute_mapObject

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



40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/budgea_client/models/payment.rb', line 40

def self.attribute_map
  {
    :'id' => :'id',
    :'state' => :'state',
    :'error_code' => :'error_code',
    :'error_description' => :'error_description',
    :'id_connector' => :'id_connector',
    :'validate_uri' => :'validate_uri',
    :'client_redirect_uri' => :'client_redirect_uri',
    :'instructions' => :'instructions'
  }
end

.swagger_typesObject

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/budgea_client/models/payment.rb', line 54

def self.swagger_types
  {
    :'id' => :'Integer',
    :'state' => :'String',
    :'error_code' => :'String',
    :'error_description' => :'String',
    :'id_connector' => :'Integer',
    :'validate_uri' => :'String',
    :'client_redirect_uri' => :'String',
    :'instructions' => :'Array<PaymentInstruction>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/budgea_client/models/payment.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      error_code == o.error_code &&
      error_description == o.error_description &&
      id_connector == o.id_connector &&
      validate_uri == o.validate_uri &&
      client_redirect_uri == o.client_redirect_uri &&
      instructions == o.instructions
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



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
202
203
204
205
206
207
208
209
210
# File 'lib/budgea_client/models/payment.rb', line 174

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



240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/budgea_client/models/payment.rb', line 240

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/budgea_client/models/payment.rb', line 153

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


140
141
142
# File 'lib/budgea_client/models/payment.rb', line 140

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



146
147
148
# File 'lib/budgea_client/models/payment.rb', line 146

def hash
  [id, state, error_code, error_description, id_connector, validate_uri, client_redirect_uri, instructions].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



112
113
114
115
# File 'lib/budgea_client/models/payment.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



220
221
222
# File 'lib/budgea_client/models/payment.rb', line 220

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
# File 'lib/budgea_client/models/payment.rb', line 226

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



214
215
216
# File 'lib/budgea_client/models/payment.rb', line 214

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



119
120
121
# File 'lib/budgea_client/models/payment.rb', line 119

def valid?
  true
end