Repository navigation
Expand file tree
/
Copy pathblocks.py
More file actions
261 lines (204 loc) · 9.58 KB
/
Copy pathblocks.py
File metadata and controls
261 lines (204 loc) · 9.58 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
# 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 block_retrieve_params
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from .._utils import 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 .._base_client import make_request_options
from ..types.block_retrieve_response import BlockRetrieveResponse
__all__ = ["BlocksResource", "AsyncBlocksResource"]
class BlocksResource(SyncAPIResource):
"""
Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting.
"""
@cached_property
def with_raw_response(self) -> BlocksResourceWithRawResponse:
"""
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 BlocksResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> BlocksResourceWithStreamingResponse:
"""
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 BlocksResourceWithStreamingResponse(self)
def retrieve(
self,
*,
category: str | Omit = omit,
cursor: str | Omit = omit,
display_mode: Literal["email", "web", "popup", "document"] | Omit = omit,
include_data: bool | Omit = omit,
limit: int | Omit = omit,
project_id: str | Omit = omit,
scope: Literal["all", "shared", "user"] | Omit = omit,
user_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,
) -> BlockRetrieveResponse:
"""List blocks with cursor-based pagination.
Returns both shared project blocks and
blocks saved by end-users; each user-saved block carries the userId it was saved
under (null for shared blocks), so usage can be aggregated per end-user without
enumerating user IDs. Returns blocks in descending order by creation.
Args:
category: Filter by category (case-insensitive search)
cursor: Pagination cursor from previous response
display_mode: Filter by display mode
include_data: Include the block design JSON in each item. Pass false for lightweight sweeps
(e.g. usage reports).
limit: Number of blocks to return (1-100)
project_id: The project ID to list blocks for
scope: Filter by block ownership: shared project blocks, end-user saved blocks, or both
user_id: Only blocks saved by this end-user (exact match on the user id your app passes
to the editor)
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(
"/v3/blocks",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"category": category,
"cursor": cursor,
"display_mode": display_mode,
"include_data": include_data,
"limit": limit,
"project_id": project_id,
"scope": scope,
"user_id": user_id,
},
block_retrieve_params.BlockRetrieveParams,
),
),
cast_to=BlockRetrieveResponse,
)
class AsyncBlocksResource(AsyncAPIResource):
"""
Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting.
"""
@cached_property
def with_raw_response(self) -> AsyncBlocksResourceWithRawResponse:
"""
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 AsyncBlocksResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncBlocksResourceWithStreamingResponse:
"""
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 AsyncBlocksResourceWithStreamingResponse(self)
async def retrieve(
self,
*,
category: str | Omit = omit,
cursor: str | Omit = omit,
display_mode: Literal["email", "web", "popup", "document"] | Omit = omit,
include_data: bool | Omit = omit,
limit: int | Omit = omit,
project_id: str | Omit = omit,
scope: Literal["all", "shared", "user"] | Omit = omit,
user_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,
) -> BlockRetrieveResponse:
"""List blocks with cursor-based pagination.
Returns both shared project blocks and
blocks saved by end-users; each user-saved block carries the userId it was saved
under (null for shared blocks), so usage can be aggregated per end-user without
enumerating user IDs. Returns blocks in descending order by creation.
Args:
category: Filter by category (case-insensitive search)
cursor: Pagination cursor from previous response
display_mode: Filter by display mode
include_data: Include the block design JSON in each item. Pass false for lightweight sweeps
(e.g. usage reports).
limit: Number of blocks to return (1-100)
project_id: The project ID to list blocks for
scope: Filter by block ownership: shared project blocks, end-user saved blocks, or both
user_id: Only blocks saved by this end-user (exact match on the user id your app passes
to the editor)
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 await self._get(
"/v3/blocks",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=await async_maybe_transform(
{
"category": category,
"cursor": cursor,
"display_mode": display_mode,
"include_data": include_data,
"limit": limit,
"project_id": project_id,
"scope": scope,
"user_id": user_id,
},
block_retrieve_params.BlockRetrieveParams,
),
),
cast_to=BlockRetrieveResponse,
)
class BlocksResourceWithRawResponse:
def __init__(self, blocks: BlocksResource) -> None:
self._blocks = blocks
self.retrieve = to_raw_response_wrapper(
blocks.retrieve,
)
class AsyncBlocksResourceWithRawResponse:
def __init__(self, blocks: AsyncBlocksResource) -> None:
self._blocks = blocks
self.retrieve = async_to_raw_response_wrapper(
blocks.retrieve,
)
class BlocksResourceWithStreamingResponse:
def __init__(self, blocks: BlocksResource) -> None:
self._blocks = blocks
self.retrieve = to_streamed_response_wrapper(
blocks.retrieve,
)
class AsyncBlocksResourceWithStreamingResponse:
def __init__(self, blocks: AsyncBlocksResource) -> None:
self._blocks = blocks
self.retrieve = async_to_streamed_response_wrapper(
blocks.retrieve,
)