forked from PaystackOSS/paystack-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplan_.py
More file actions
133 lines (106 loc) · 4.48 KB
/
Copy pathplan_.py
File metadata and controls
133 lines (106 loc) · 4.48 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
# 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 Plan(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, name, amount, interval, **kwargs): # noqa: E501
"""Create Plan # noqa: E501
:param name: Name of plan (required)
:type name: str
:param amount: Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR (required)
:type amount: int
:param interval: Interval in words. Valid intervals are daily, weekly, monthly,biannually, annually (required)
:type interval: str
:param description: A description for this plan
:type description: bool
:param send_invoices: Set to false if you don't want invoices to be sent to your customers
:type send_invoices: bool
:param send_sms: Set to false if you don't want text messages to be sent to your customers
:type send_sms: bool
:param currency: Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD
:type currency: str
:param invoice_limit: Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing.
:type invoice_limit: int
: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 Plan # 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 Plans # noqa: E501
:param per_page: Number of records to fetch per page
:type per_page: int
:param page: The section to retrieve
:type page: int
:param interval: Specify interval of the plan
:type interval: str
:param amount: The amount on the plans to retrieve
:type amount: int
:param _from: The start date
:type _from: datetime
:param to: The end date
:type to: datetime
: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 Plan # noqa: E501
:param code: (required)
:type code: str
:param name: Name of plan
:type name: str
:param amount: Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
:type amount: int
:param interval: Interval in words. Valid intervals are daily, weekly, monthly,biannually, annually
:type interval: str
:param description: A description for this plan
:type description: bool
:param send_invoices: Set to false if you don't want invoices to be sent to your customers
:type send_invoices: bool
:param send_sms: Set to false if you don't want text messages to be sent to your customers
:type send_sms: bool
:param currency: Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD
:type currency: str
:param invoice_limit: Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing.
:type invoice_limit: int
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass