forked from PaystackOSS/paystack-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcustomer_.py
More file actions
585 lines (476 loc) · 21.3 KB
/
customer_.py
File metadata and controls
585 lines (476 loc) · 21.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
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
47
48
49
50
51
52
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
87
88
89
90
91
92
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
127
128
129
130
131
132
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
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
# coding: utf-8
"""
Paystack
The OpenAPI specification of the Paystack API that merchants and developers can harness to build financial solutions in Africa. # noqa: E501
The version of the OpenAPI document: 1.0.0
Contact: [email protected]
"""
from __future__ import absolute_import
import re # noqa: F401
import six
from paystack.api_client import ApiClient
from paystack.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
class Customer(object):
"""NOTE: This class is auto generated. Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
@classmethod
def create(cls, email, **kwargs): # noqa: E501
"""Create Customer # noqa: E501
:param email: Customer's email address (required)
:type email: str
:param first_name: Customer's first name
:type first_name: str
:param last_name: Customer's last name
:type last_name: str
:param phone: Customer's phone number
:type phone: str
:param metadata: Stringified JSON object of custom data
:type metadata: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
local_var_params = locals()
all_params = [
'email',
'first_name',
'last_name',
'phone',
'metadata'
]
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method create" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'email' is set
if cls().api_client.client_side_validation and ('email' not in local_var_params or # noqa: E501
local_var_params['email'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `email` when calling `create`") # noqa: E501
path_params = {}
query_params = []
form_params = []
local_var_files = {}
body_params = {}
if 'email' in local_var_params:
body_params['email'] = local_var_params['email']
if 'first_name' in local_var_params:
body_params['first_name'] = local_var_params['first_name']
if 'last_name' in local_var_params:
body_params['last_name'] = local_var_params['last_name']
if 'phone' in local_var_params:
body_params['phone'] = local_var_params['phone']
if 'metadata' in local_var_params:
body_params['metadata'] = local_var_params['metadata']
response_types_map = {
200: "Response",
401: "Error",
}
return cls().api_client.call_api(
'/customer', 'POST',
path_params,
query_params,
body=body_params,
post_params=form_params,
response_types_map=response_types_map)
@classmethod
def deactivate_authorization(cls, authorization_code, **kwargs): # noqa: E501
"""Deactivate Authorization # noqa: E501
Deactivate a customer's card # noqa: E501
:param authorization_code: Authorization code to be deactivated (required)
:type authorization_code: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
local_var_params = locals()
all_params = [
'authorization_code'
]
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method deactivate_authorization" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'authorization_code' is set
if cls().api_client.client_side_validation and ('authorization_code' not in local_var_params or # noqa: E501
local_var_params['authorization_code'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `authorization_code` when calling `deactivate_authorization`") # noqa: E501
path_params = {}
query_params = []
form_params = []
local_var_files = {}
body_params = {}
if 'authorization_code' in local_var_params:
body_params['authorization_code'] = local_var_params['authorization_code']
response_types_map = {
200: "Response",
401: "Error",
}
return cls().api_client.call_api(
'/customer/deactivate_authorization', 'POST',
path_params,
query_params,
body=body_params,
post_params=form_params,
response_types_map=response_types_map)
@classmethod
def fetch(cls, code, **kwargs): # noqa: E501
"""Fetch Customer # noqa: E501
:param code: (required)
:type code: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
local_var_params = locals()
all_params = [
'code'
]
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method fetch" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'code' is set
if cls().api_client.client_side_validation and ('code' not in local_var_params or # noqa: E501
local_var_params['code'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `code` when calling `fetch`") # noqa: E501
path_params = {}
if 'code' in local_var_params:
path_params['code'] = local_var_params['code'] # noqa: E501
query_params = []
form_params = []
local_var_files = {}
body_params = {}
response_types_map = {
200: "Response",
401: "Error",
404: "Error",
}
return cls().api_client.call_api(
'/customer/{code}', 'GET',
path_params,
query_params,
body=body_params,
post_params=form_params,
response_types_map=response_types_map)
@classmethod
def list(cls, **kwargs): # noqa: E501
"""List Customers # noqa: E501
List customers on your integration # noqa: E501
:param use_cursor:
:type use_cursor: bool
:param next:
:type next: str
:param previous:
:type previous: str
:param _from:
:type _from: str
:param to:
:type to: str
:param per_page:
:type per_page: str
:param page:
:type page: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
local_var_params = locals()
all_params = [
'use_cursor',
'next',
'previous',
'_from',
'to',
'per_page',
'page'
]
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method list" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
path_params = {}
query_params = []
if 'use_cursor' in local_var_params and local_var_params['use_cursor'] is not None: # noqa: E501
query_params.append(('use_cursor', local_var_params['use_cursor'])) # noqa: E501
if 'next' in local_var_params and local_var_params['next'] is not None: # noqa: E501
query_params.append(('next', local_var_params['next'])) # noqa: E501
if 'previous' in local_var_params and local_var_params['previous'] is not None: # noqa: E501
query_params.append(('previous', local_var_params['previous'])) # noqa: E501
if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
query_params.append(('from', local_var_params['_from'])) # noqa: E501
if 'to' in local_var_params and local_var_params['to'] is not None: # noqa: E501
query_params.append(('to', local_var_params['to'])) # noqa: E501
if 'per_page' in local_var_params and local_var_params['per_page'] is not None: # noqa: E501
query_params.append(('perPage', local_var_params['per_page'])) # noqa: E501
if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501
query_params.append(('page', local_var_params['page'])) # noqa: E501
form_params = []
local_var_files = {}
body_params = {}
response_types_map = {
200: "Response",
401: "Error",
404: "Error",
}
return cls().api_client.call_api(
'/customer', 'GET',
path_params,
query_params,
body=body_params,
post_params=form_params,
response_types_map=response_types_map)
@classmethod
def risk_action(cls, customer, **kwargs): # noqa: E501
"""White/blacklist Customer # noqa: E501
Set customer's risk action by whitelisting or blacklisting the customer # noqa: E501
:param customer: Customer's code, or email address (required)
:type customer: str
:param risk_action: One of the possible risk actions [ default, allow, deny ]. allow to whitelist. deny to blacklist. Customers start with a default risk action.
:type risk_action: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
local_var_params = locals()
all_params = [
'customer',
'risk_action'
]
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method risk_action" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'customer' is set
if cls().api_client.client_side_validation and ('customer' not in local_var_params or # noqa: E501
local_var_params['customer'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `customer` when calling `risk_action`") # noqa: E501
path_params = {}
query_params = []
form_params = []
local_var_files = {}
body_params = {}
if 'customer' in local_var_params:
body_params['customer'] = local_var_params['customer']
if 'risk_action' in local_var_params:
body_params['risk_action'] = local_var_params['risk_action']
response_types_map = {
200: "Response",
401: "Error",
}
return cls().api_client.call_api(
'/customer/set_risk_action', 'POST',
path_params,
query_params,
body=body_params,
post_params=form_params,
response_types_map=response_types_map)
@classmethod
def update(cls, code, **kwargs): # noqa: E501
"""Update Customer # noqa: E501
:param code: (required)
:type code: str
:param first_name: Customer's first name
:type first_name: str
:param last_name: Customer's last name
:type last_name: str
:param phone: Customer's phone number
:type phone: str
:param metadata: Stringified JSON object of custom data
:type metadata: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
local_var_params = locals()
all_params = [
'code',
'first_name',
'last_name',
'phone',
'metadata'
]
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method update" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'code' is set
if cls().api_client.client_side_validation and ('code' not in local_var_params or # noqa: E501
local_var_params['code'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `code` when calling `update`") # noqa: E501
path_params = {}
if 'code' in local_var_params:
path_params['code'] = local_var_params['code'] # noqa: E501
query_params = []
form_params = []
local_var_files = {}
body_params = {}
if 'first_name' in local_var_params:
body_params['first_name'] = local_var_params['first_name']
if 'last_name' in local_var_params:
body_params['last_name'] = local_var_params['last_name']
if 'phone' in local_var_params:
body_params['phone'] = local_var_params['phone']
if 'metadata' in local_var_params:
body_params['metadata'] = local_var_params['metadata']
response_types_map = {
200: "Response",
401: "Error",
404: "Error",
}
return cls().api_client.call_api(
'/customer/{code}', 'PUT',
path_params,
query_params,
body=body_params,
post_params=form_params,
response_types_map=response_types_map)
@classmethod
def validate(cls, code, first_name, last_name, type, country, bvn, bank_code, account_number, **kwargs): # noqa: E501
"""Validate Customer # noqa: E501
Validate a customer's identity # noqa: E501
:param code: (required)
:type code: str
:param first_name: Customer's first name (required)
:type first_name: str
:param last_name: Customer's last name (required)
:type last_name: str
:param type: Predefined types of identification. (required)
:type type: str
:param country: Two-letter country code of identification issuer (required)
:type country: str
:param bvn: Customer's Bank Verification Number (required)
:type bvn: str
:param bank_code: You can get the list of bank codes by calling the List Banks endpoint (https://api.paystack.co/bank). (required)
:type bank_code: str
:param account_number: Customer's bank account number. (required)
:type account_number: str
:param value: Customer's identification number. Required if type is bvn
:type value: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Accepted
"""
local_var_params = locals()
all_params = [
'code',
'first_name',
'last_name',
'type',
'country',
'bvn',
'bank_code',
'account_number',
'value'
]
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method validate" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'code' is set
if cls().api_client.client_side_validation and ('code' not in local_var_params or # noqa: E501
local_var_params['code'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `code` when calling `validate`") # noqa: E501
# verify the required parameter 'first_name' is set
if cls().api_client.client_side_validation and ('first_name' not in local_var_params or # noqa: E501
local_var_params['first_name'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `first_name` when calling `validate`") # noqa: E501
# verify the required parameter 'last_name' is set
if cls().api_client.client_side_validation and ('last_name' not in local_var_params or # noqa: E501
local_var_params['last_name'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `last_name` when calling `validate`") # noqa: E501
# verify the required parameter 'type' is set
if cls().api_client.client_side_validation and ('type' not in local_var_params or # noqa: E501
local_var_params['type'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `type` when calling `validate`") # noqa: E501
# verify the required parameter 'country' is set
if cls().api_client.client_side_validation and ('country' not in local_var_params or # noqa: E501
local_var_params['country'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `country` when calling `validate`") # noqa: E501
# verify the required parameter 'bvn' is set
if cls().api_client.client_side_validation and ('bvn' not in local_var_params or # noqa: E501
local_var_params['bvn'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `bvn` when calling `validate`") # noqa: E501
# verify the required parameter 'bank_code' is set
if cls().api_client.client_side_validation and ('bank_code' not in local_var_params or # noqa: E501
local_var_params['bank_code'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `bank_code` when calling `validate`") # noqa: E501
# verify the required parameter 'account_number' is set
if cls().api_client.client_side_validation and ('account_number' not in local_var_params or # noqa: E501
local_var_params['account_number'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `account_number` when calling `validate`") # noqa: E501
path_params = {}
if 'code' in local_var_params:
path_params['code'] = local_var_params['code'] # noqa: E501
query_params = []
form_params = []
local_var_files = {}
body_params = {}
if 'first_name' in local_var_params:
body_params['first_name'] = local_var_params['first_name']
if 'last_name' in local_var_params:
body_params['last_name'] = local_var_params['last_name']
if 'type' in local_var_params:
body_params['type'] = local_var_params['type']
if 'country' in local_var_params:
body_params['country'] = local_var_params['country']
if 'bvn' in local_var_params:
body_params['bvn'] = local_var_params['bvn']
if 'bank_code' in local_var_params:
body_params['bank_code'] = local_var_params['bank_code']
if 'account_number' in local_var_params:
body_params['account_number'] = local_var_params['account_number']
if 'value' in local_var_params:
body_params['value'] = local_var_params['value']
response_types_map = {
202: "Accepted",
401: "Error",
}
return cls().api_client.call_api(
'/customer/{code}/identification', 'POST',
path_params,
query_params,
body=body_params,
post_params=form_params,
response_types_map=response_types_map)