forked from PaystackOSS/paystack-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpage_.py
More file actions
151 lines (116 loc) · 4.32 KB
/
page_.py
File metadata and controls
151 lines (116 loc) · 4.32 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
# 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 Page(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 add_products(cls, id, product, **kwargs): # noqa: E501
"""Add Products # noqa: E501
:param id: (required)
:type id: str
:param product: IDs of all products to add to a page (required)
:type product: list[str]
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def check_slug_availability(cls, slug, **kwargs): # noqa: E501
"""Check Slug Availability # noqa: E501
:param slug: (required)
:type slug: str
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def create(cls, name, **kwargs): # noqa: E501
"""Create Page # noqa: E501
:param name: Name of page (required)
:type name: str
:param description: The description of the page
:type description: 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 slug: URL slug you would like to be associated with this page. Page will be accessible at https://paystack.com/pay/[slug]
:type slug: str
:param metadata: Stringified JSON object of custom data
:type metadata: str
:param redirect_url: If you would like Paystack to redirect to a URL upon successful payment, specify the URL here.
:type redirect_url: str
:param custom_fields: If you would like to accept custom fields, specify them here.
:type custom_fields: list[object]
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass
@classmethod
def fetch(cls, id, **kwargs): # noqa: E501
"""Fetch Page # noqa: E501
:param id: (required)
:type id: 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 Pages # 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 _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, id, **kwargs): # noqa: E501
"""Update Page # noqa: E501
:param id: (required)
:type id: str
:param name: Name of page
:type name: str
:param description: The description of the page
:type description: 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 active: Set to false to deactivate page url
:type active: bool
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: Response
"""
pass