forked from square/square-python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcustomer_groups_api.py
More file actions
249 lines (210 loc) · 9.64 KB
/
customer_groups_api.py
File metadata and controls
249 lines (210 loc) · 9.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
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
# -*- 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 CustomerGroupsApi(BaseApi):
"""A Controller to access Endpoints in the square API."""
def __init__(self, config):
super(CustomerGroupsApi, self).__init__(config)
def list_customer_groups(self,
cursor=None,
limit=None):
"""Does a GET request to /v2/customers/groups.
Retrieves the list of customer groups of a business.
Args:
cursor (str, optional): A pagination cursor returned by a previous
call to this endpoint. Provide this cursor to retrieve the
next set of results for your original query. For more
information, see
[Pagination](https://developer.squareup.com/docs/build-basics/c
ommon-api-patterns/pagination).
limit (int, optional): The maximum number of results to return in
a single page. This limit is advisory. The response might
contain more or fewer results. If the limit is less than 1 or
greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400
VALUE_TOO_HIGH` error. The default value is 50. For more
information, see
[Pagination](https://developer.squareup.com/docs/build-basics/c
ommon-api-patterns/pagination).
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/customers/groups')
.http_method(HttpMethodEnum.GET)
.query_param(Parameter()
.key('cursor')
.value(cursor))
.query_param(Parameter()
.key('limit')
.value(limit))
.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_customer_group(self,
body):
"""Does a POST request to /v2/customers/groups.
Creates a new customer group for a business.
The request must include the `name` value of the group.
Args:
body (CreateCustomerGroupRequest): 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/customers/groups')
.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 delete_customer_group(self,
group_id):
"""Does a DELETE request to /v2/customers/groups/{group_id}.
Deletes a customer group as identified by the `group_id` value.
Args:
group_id (str): The ID of the customer group to delete.
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/customers/groups/{group_id}')
.http_method(HttpMethodEnum.DELETE)
.template_param(Parameter()
.key('group_id')
.value(group_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 retrieve_customer_group(self,
group_id):
"""Does a GET request to /v2/customers/groups/{group_id}.
Retrieves a specific customer group as identified by the `group_id`
value.
Args:
group_id (str): The ID of the customer group to retrieve.
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/customers/groups/{group_id}')
.http_method(HttpMethodEnum.GET)
.template_param(Parameter()
.key('group_id')
.value(group_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 update_customer_group(self,
group_id,
body):
"""Does a PUT request to /v2/customers/groups/{group_id}.
Updates a customer group as identified by the `group_id` value.
Args:
group_id (str): The ID of the customer group to update.
body (UpdateCustomerGroupRequest): 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/customers/groups/{group_id}')
.http_method(HttpMethodEnum.PUT)
.template_param(Parameter()
.key('group_id')
.value(group_id)
.should_encode(True))
.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()