forked from square/square-python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsnippets_api.py
More file actions
175 lines (150 loc) · 7.03 KB
/
snippets_api.py
File metadata and controls
175 lines (150 loc) · 7.03 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
# -*- 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 SnippetsApi(BaseApi):
"""A Controller to access Endpoints in the square API."""
def __init__(self, config):
super(SnippetsApi, self).__init__(config)
def delete_snippet(self,
site_id):
"""Does a DELETE request to /v2/sites/{site_id}/snippet.
Removes your snippet from a Square Online site.
You can call [ListSites]($e/Sites/ListSites) to get the IDs of the
sites that belong to a seller.
__Note:__ Square Online APIs are publicly available as part of an
early access program. For more information, see [Early access program
for Square Online
APIs](https://developer.squareup.com/docs/online-api#early-access-progr
am-for-square-online-apis).
Args:
site_id (str): The ID of the site that contains the snippet.
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/sites/{site_id}/snippet')
.http_method(HttpMethodEnum.DELETE)
.template_param(Parameter()
.key('site_id')
.value(site_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_snippet(self,
site_id):
"""Does a GET request to /v2/sites/{site_id}/snippet.
Retrieves your snippet from a Square Online site. A site can contain
snippets from multiple snippet applications, but you can retrieve only
the snippet that was added by your application.
You can call [ListSites]($e/Sites/ListSites) to get the IDs of the
sites that belong to a seller.
__Note:__ Square Online APIs are publicly available as part of an
early access program. For more information, see [Early access program
for Square Online
APIs](https://developer.squareup.com/docs/online-api#early-access-progr
am-for-square-online-apis).
Args:
site_id (str): The ID of the site that contains the snippet.
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/sites/{site_id}/snippet')
.http_method(HttpMethodEnum.GET)
.template_param(Parameter()
.key('site_id')
.value(site_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 upsert_snippet(self,
site_id,
body):
"""Does a POST request to /v2/sites/{site_id}/snippet.
Adds a snippet to a Square Online site or updates the existing snippet
on the site.
The snippet code is appended to the end of the `head` element on every
page of the site, except checkout pages. A snippet application can add
one snippet to a given site.
You can call [ListSites]($e/Sites/ListSites) to get the IDs of the
sites that belong to a seller.
__Note:__ Square Online APIs are publicly available as part of an
early access program. For more information, see [Early access program
for Square Online
APIs](https://developer.squareup.com/docs/online-api#early-access-progr
am-for-square-online-apis).
Args:
site_id (str): The ID of the site where you want to add or update
the snippet.
body (UpsertSnippetRequest): 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/sites/{site_id}/snippet')
.http_method(HttpMethodEnum.POST)
.template_param(Parameter()
.key('site_id')
.value(site_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()