-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplates.py
More file actions
323 lines (260 loc) · 11.6 KB
/
templates.py
File metadata and controls
323 lines (260 loc) · 11.6 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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing_extensions import Literal
import httpx
from ..types import template_list_params, template_retrieve_params
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from .._utils import path_template, maybe_transform, async_maybe_transform
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ..pagination import SyncCursorPage, AsyncCursorPage
from .._base_client import AsyncPaginator, make_request_options
from ..types.template_list_response import TemplateListResponse
from ..types.template_retrieve_response import TemplateRetrieveResponse
__all__ = ["TemplatesResource", "AsyncTemplatesResource"]
class TemplatesResource(SyncAPIResource):
"""Template management and retrieval."""
@cached_property
def with_raw_response(self) -> TemplatesResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers
"""
return TemplatesResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> TemplatesResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response
"""
return TemplatesResourceWithStreamingResponse(self)
def retrieve(
self,
id: str,
*,
project_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> TemplateRetrieveResponse:
"""
Get template by ID.
Args:
project_id: The project ID (required for PAT auth, auto-resolved for API key auth)
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
return self._get(
path_template("/v3/templates/{id}", id=id),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform({"project_id": project_id}, template_retrieve_params.TemplateRetrieveParams),
),
cast_to=TemplateRetrieveResponse,
)
def list(
self,
*,
cursor: str | Omit = omit,
display_mode: Literal["email", "web", "document"] | Omit = omit,
limit: int | Omit = omit,
name: str | Omit = omit,
project_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> SyncCursorPage[TemplateListResponse]:
"""List templates with cursor-based pagination.
Returns templates in descending
order by update time.
Args:
cursor: Pagination cursor from previous response
display_mode: Filter by template type
limit: Number of templates to return (1-100)
name: Filter by name (case-insensitive search)
project_id: The project ID to list templates for
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/v3/templates",
page=SyncCursorPage[TemplateListResponse],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"cursor": cursor,
"display_mode": display_mode,
"limit": limit,
"name": name,
"project_id": project_id,
},
template_list_params.TemplateListParams,
),
),
model=TemplateListResponse,
)
class AsyncTemplatesResource(AsyncAPIResource):
"""Template management and retrieval."""
@cached_property
def with_raw_response(self) -> AsyncTemplatesResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers
"""
return AsyncTemplatesResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncTemplatesResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response
"""
return AsyncTemplatesResourceWithStreamingResponse(self)
async def retrieve(
self,
id: str,
*,
project_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> TemplateRetrieveResponse:
"""
Get template by ID.
Args:
project_id: The project ID (required for PAT auth, auto-resolved for API key auth)
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not id:
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
return await self._get(
path_template("/v3/templates/{id}", id=id),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=await async_maybe_transform(
{"project_id": project_id}, template_retrieve_params.TemplateRetrieveParams
),
),
cast_to=TemplateRetrieveResponse,
)
def list(
self,
*,
cursor: str | Omit = omit,
display_mode: Literal["email", "web", "document"] | Omit = omit,
limit: int | Omit = omit,
name: str | Omit = omit,
project_id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AsyncPaginator[TemplateListResponse, AsyncCursorPage[TemplateListResponse]]:
"""List templates with cursor-based pagination.
Returns templates in descending
order by update time.
Args:
cursor: Pagination cursor from previous response
display_mode: Filter by template type
limit: Number of templates to return (1-100)
name: Filter by name (case-insensitive search)
project_id: The project ID to list templates for
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/v3/templates",
page=AsyncCursorPage[TemplateListResponse],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"cursor": cursor,
"display_mode": display_mode,
"limit": limit,
"name": name,
"project_id": project_id,
},
template_list_params.TemplateListParams,
),
),
model=TemplateListResponse,
)
class TemplatesResourceWithRawResponse:
def __init__(self, templates: TemplatesResource) -> None:
self._templates = templates
self.retrieve = to_raw_response_wrapper(
templates.retrieve,
)
self.list = to_raw_response_wrapper(
templates.list,
)
class AsyncTemplatesResourceWithRawResponse:
def __init__(self, templates: AsyncTemplatesResource) -> None:
self._templates = templates
self.retrieve = async_to_raw_response_wrapper(
templates.retrieve,
)
self.list = async_to_raw_response_wrapper(
templates.list,
)
class TemplatesResourceWithStreamingResponse:
def __init__(self, templates: TemplatesResource) -> None:
self._templates = templates
self.retrieve = to_streamed_response_wrapper(
templates.retrieve,
)
self.list = to_streamed_response_wrapper(
templates.list,
)
class AsyncTemplatesResourceWithStreamingResponse:
def __init__(self, templates: AsyncTemplatesResource) -> None:
self._templates = templates
self.retrieve = async_to_streamed_response_wrapper(
templates.retrieve,
)
self.list = async_to_streamed_response_wrapper(
templates.list,
)