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
188 lines (149 loc) · 5.64 KB
/
customer_.py
File metadata and controls
188 lines (149 loc) · 5.64 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
# 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: techsupport@paystack.com
"""
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
"""
pass
@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
"""
pass
@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
"""
pass
@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
"""
pass
@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
"""
pass
@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
"""
pass
@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
"""
pass