Class: Tpaga::DaviPlataApi

Inherits:
Object show all
Defined in:
lib/tpaga/api/davi_plata_api.rb

Class Method Summary collapse

Class Method Details

.add_davi_plata(customer_id, body, opts = {}) ⇒ DaviPlata

Adds a new DaviPlata payment method to the Customer Creates a new ‘DaviPLata` and associates it to the `Customer`

Parameters:

  • customer_id —

    Identification of ‘Customer` to associate the new `DaviPlata`

  • body —

    The ‘DaviPlata` object to be added to the `Customer`n- id its the id of the `DaviPlata` thats going to be generated after creation.n- number its the `DaviPlata` number.n- lastFour it the last four digits of the `DaviPlata` numbern- customer its the id of the `Customer` associated to the `DaviPlata`n- document its the document number of the `Customer`n- documentType its the type of document supplied, it can be CC, CE or TIn- maxAmount its the maximum amount that can be charged to the associated `DaviPlata`

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

    the optional parameters

Returns:



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/tpaga/api/davi_plata_api.rb', line 174

def self.add_davi_plata(customer_id, body, opts = {})

  # verify the required parameter 'customer_id' is set
  raise "Missing the required parameter 'customer_id' when calling add_davi_plata" if customer_id.nil?

  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling add_davi_plata" if body.nil?


  # resource path
  path = "/customer/{customer_id}/daviplata".sub('{format}', 'json').sub('{' + 'customer_id' + '}', customer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(body)


  auth_names = ['api_key']
  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = DaviPlata.new() and obj.build_from_hash(response)
end

.add_davi_plata_charge(body, opts = {}) ⇒ DaviPlataCharge

Adds a new DaviPlataCharge to Customer's DaviPlata Creates a new ‘DaviPlataCharge` and associates it to a `DaviPlata`.

Parameters:

  • body —

    The ‘DaviPlataCharge` object to be generated to a `DaviPlata`. It has the following fieldsn- id its the id of the `DaviPlataCharge` thats going to be generated after creation.n- daviPlata which is the identificator of the `DaviPlata` to be chargedn- customer which is the id of the `Customer` associated with the `DaviPlata`n- amount which is the full amount of the chargen- currency its the 3-letter ISO code for the currency.n- taxAmount the amount that accounts as taxes.n- paid its the status of the charge. true if its paid, false if its not.n- description which is the desciption of the charge being made.n- orderId commerce order identificator

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

    the optional parameters

Returns:



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/tpaga/api/davi_plata_api.rb', line 13

def self.add_davi_plata_charge(body, opts = {})

  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling add_davi_plata_charge" if body.nil?


  # resource path
  path = "/charge/daviplata".sub('{format}', 'json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(body)


  auth_names = ['api_key']
  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = DaviPlataCharge.new() and obj.build_from_hash(response)
end

.add_davi_plata_chargeback(body, opts = {}) ⇒ DaviPlataChargeback

Adds a new DaviPlataChargeback to Customer's DaviPlata Creates a new ‘DaviPlataChargeback` and associates it to a `DaviPlata`.

Parameters:

  • body —

    The ‘DaviPlataChargeback` to be applied to a `DaviPlata`. It has the following fieldsn- id its the id of the `DaviPlataChargeback` thats going to be generated after creation.n- daviPlata its the id of the `DaviPlata` to be reinbursed.n- daviPlataCharge its the id of the `DaviPlataCharge` to apply the Chargeback.n- reimbursed its the status of the chargeback, true if its been reinbursed or false if its still pending.

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

    the optional parameters

Returns:



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
 
# File 'lib/tpaga/api/davi_plata_api.rb', line 93

def self.add_davi_plata_chargeback(body, opts = {})

  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling add_davi_plata_chargeback" if body.nil?


  # resource path
  path = "/chargeback/daviplata".sub('{format}', 'json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(body)


  auth_names = ['api_key']
  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = DaviPlataChargeback.new() and obj.build_from_hash(response)
end

.delete_davi_plata_by_id(customer_id, daviplata_id, opts = {}) ⇒ nil

Deletes a DaviPlata by ID Deletes a ‘DaviPlata` when its `id` matches the parameter. Only available when `DaviPlata` does not have associated Charges.

Parameters:

  • customer_id —

    Identification of ‘Customer` associated with a `DaviPlata`

  • daviplata_id —

    Identification of ‘DaviPlata` to be deleted

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

    the optional parameters

Returns:

  • (nil) 


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
290
291
292
293
294
295
296
297
298
 
# File 'lib/tpaga/api/davi_plata_api.rb', line 262

def self.delete_davi_plata_by_id(customer_id, daviplata_id, opts = {})

  # verify the required parameter 'customer_id' is set
  raise "Missing the required parameter 'customer_id' when calling delete_davi_plata_by_id" if customer_id.nil?

  # verify the required parameter 'daviplata_id' is set
  raise "Missing the required parameter 'daviplata_id' when calling delete_davi_plata_by_id" if daviplata_id.nil?


  # resource path
  path = "/customer/{customer_id}/daviplata/{daviplata_id}".sub('{format}', 'json').sub('{' + 'customer_id' + '}', customer_id.to_s).sub('{' + 'daviplata_id' + '}', daviplata_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  Swagger::Request.new(:DELETE, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make
  nil
end

.get_davi_plata_by_id(customer_id, daviplata_id, opts = {}) ⇒ DaviPlata

Retrieve a DaviPlata by ID Get the details of an existing ‘DaviPlata`. This method only requires an unique `DaviPlata` identifier `id` that was returned upon `DaviPlata` creation.

Parameters:

  • customer_id —

    Identification of ‘Customer` associated with a `DaviPlata`

  • daviplata_id —

    Identification of ‘DaviPlata` that needs to be retrieved

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

    the optional parameters

Returns:



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
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/tpaga/api/davi_plata_api.rb', line 218

def self.get_davi_plata_by_id(customer_id, daviplata_id, opts = {})

  # verify the required parameter 'customer_id' is set
  raise "Missing the required parameter 'customer_id' when calling get_davi_plata_by_id" if customer_id.nil?

  # verify the required parameter 'daviplata_id' is set
  raise "Missing the required parameter 'daviplata_id' when calling get_davi_plata_by_id" if daviplata_id.nil?


  # resource path
  path = "/customer/{customer_id}/daviplata/{daviplata_id}".sub('{format}', 'json').sub('{' + 'customer_id' + '}', customer_id.to_s).sub('{' + 'daviplata_id' + '}', daviplata_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = DaviPlata.new() and obj.build_from_hash(response)
end

.get_davi_plata_charge_by_id(id, opts = {}) ⇒ DaviPlataCharge

Retrieve a DaviPlataCharge by ID Get the details of an existing ‘DaviPlataCharge`. This method only requires an unique `DaviPlataCharge` identifier `id` that was returned upon `DaviPlataCharge` creation.

Parameters:

  • id —

    Identification of ‘DaviPlataCharge` that needs to be retrieved

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

    the optional parameters

Returns:



53
54
55
56
57
58
59
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
 
# File 'lib/tpaga/api/davi_plata_api.rb', line 53

def self.get_davi_plata_charge_by_id(id, opts = {})

  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling get_davi_plata_charge_by_id" if id.nil?


  # resource path
  path = "/charge/daviplata/{id}".sub('{format}', 'json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = DaviPlataCharge.new() and obj.build_from_hash(response)
end

.get_davi_plata_chargeback_by_id(id, opts = {}) ⇒ DaviPlataChargeback

Retrieve a DaviPlataChargeback by ID Get the details of an existing ‘DaviPlataChargeback`. This method only requires an unique `DaviPlataChargeback` identifier `id` that was returned upon `DaviPlataChargeback` creation.

Parameters:

  • id —

    Identification of ‘DaviPlataChargeback` to be retrieved

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

    the optional parameters

Returns:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/tpaga/api/davi_plata_api.rb', line 133

def self.get_davi_plata_chargeback_by_id(id, opts = {})

  # verify the required parameter 'id' is set
  raise "Missing the required parameter 'id' when calling get_davi_plata_chargeback_by_id" if id.nil?


  # resource path
  path = "/chargeback/daviplata/{id}".sub('{format}', 'json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil


  auth_names = ['api_key']
  response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = DaviPlataChargeback.new() and obj.build_from_hash(response)
end

.verify_davi_plata(body, opts = {}) ⇒ DaviPlata

Verifies the ownership of the associated DaviPlata This method requires two parameters. One is the unique ‘DaviPlata` identifier `id` that was returned upon `DaviPlata` creation. the second parameter is a six digit pin code `pinNumber` obtained through a SMS from the service provider of `DaviPlata`. Its used to validate the ownership of the associated `DaviPlata`

Parameters:

  • body —

    it has two fieldsn- daviPlata which is the Identification of the ‘DaviPlata` to verifyn- pinNumber which is a Six digit pin code used to validate `DaviPlata` as a payment method.

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

    the optional parameters

Returns:



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/tpaga/api/davi_plata_api.rb', line 305

def self.verify_davi_plata(body, opts = {})

  # verify the required parameter 'body' is set
  raise "Missing the required parameter 'body' when calling verify_davi_plata" if body.nil?


  # resource path
  path = "/daviplata/verify".sub('{format}', 'json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = Swagger::Request.object_to_http_body(body)


  auth_names = ['api_key']
  response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => auth_names}).make.body
  obj = DaviPlata.new() and obj.build_from_hash(response)
end