forked from square/square-python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcards_api.py
More file actions
213 lines (181 loc) · 8.1 KB
/
cards_api.py
File metadata and controls
213 lines (181 loc) · 8.1 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
# -*- coding: utf-8 -*-
from square.api_helper import APIHelper
from square.http.api_response import ApiResponse
from square.api.base_api import BaseApi
from apimatic_core.request_builder import RequestBuilder
from apimatic_core.response_handler import ResponseHandler
from apimatic_core.types.parameter import Parameter
from square.http.http_method_enum import HttpMethodEnum
from apimatic_core.authentication.multiple.single_auth import Single
class CardsApi(BaseApi):
"""A Controller to access Endpoints in the square API."""
def __init__(self, config):
super(CardsApi, self).__init__(config)
def list_cards(self,
cursor=None,
customer_id=None,
include_disabled=False,
reference_id=None,
sort_order=None):
"""Does a GET request to /v2/cards.
Retrieves a list of cards owned by the account making the request.
A max of 25 cards will be returned.
Args:
cursor (str, optional): A pagination cursor returned by a previous
call to this endpoint. Provide this to retrieve the next set
of results for your original query. See
[Pagination](https://developer.squareup.com/docs/build-basics/c
ommon-api-patterns/pagination) for more information.
customer_id (str, optional): Limit results to cards associated
with the customer supplied. By default, all cards owned by the
merchant are returned.
include_disabled (bool, optional): Includes disabled cards. By
default, all enabled cards owned by the merchant are
returned.
reference_id (str, optional): Limit results to cards associated
with the reference_id supplied.
sort_order (SortOrder, optional): Sorts the returned list by when
the card was created with the specified order. This field
defaults to ASC.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/cards')
.http_method(HttpMethodEnum.GET)
.query_param(Parameter()
.key('cursor')
.value(cursor))
.query_param(Parameter()
.key('customer_id')
.value(customer_id))
.query_param(Parameter()
.key('include_disabled')
.value(include_disabled))
.query_param(Parameter()
.key('reference_id')
.value(reference_id))
.query_param(Parameter()
.key('sort_order')
.value(sort_order))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def create_card(self,
body):
"""Does a POST request to /v2/cards.
Adds a card on file to an existing merchant.
Args:
body (CreateCardRequest): An object containing the fields to POST
for the request. See the corresponding object definition for
field details.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/cards')
.http_method(HttpMethodEnum.POST)
.header_param(Parameter()
.key('Content-Type')
.value('application/json'))
.body_param(Parameter()
.value(body))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.body_serializer(APIHelper.json_serialize)
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def retrieve_card(self,
card_id):
"""Does a GET request to /v2/cards/{card_id}.
Retrieves details for a specific Card.
Args:
card_id (str): Unique ID for the desired Card.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/cards/{card_id}')
.http_method(HttpMethodEnum.GET)
.template_param(Parameter()
.key('card_id')
.value(card_id)
.should_encode(True))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()
def disable_card(self,
card_id):
"""Does a POST request to /v2/cards/{card_id}/disable.
Disables the card, preventing any further updates or charges.
Disabling an already disabled card is allowed but has no effect.
Args:
card_id (str): Unique ID for the desired Card.
Returns:
ApiResponse: An object with the response value as well as other
useful information such as status codes and headers. Success
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
return super().new_api_call_builder.request(
RequestBuilder().server('default')
.path('/v2/cards/{card_id}/disable')
.http_method(HttpMethodEnum.POST)
.template_param(Parameter()
.key('card_id')
.value(card_id)
.should_encode(True))
.header_param(Parameter()
.key('accept')
.value('application/json'))
.auth(Single('global'))
).response(
ResponseHandler()
.deserializer(APIHelper.json_deserialize)
.is_api_response(True)
.convertor(ApiResponse.create)
).execute()