Repository navigation
Expand file tree
/
Copy pathworkspaces.py
More file actions
226 lines (184 loc) · 8.28 KB
/
Copy pathworkspaces.py
File metadata and controls
226 lines (184 loc) · 8.28 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
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
import httpx
from .._types import Body, Query, Headers, NotGiven, not_given
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.workspace_list_response import WorkspaceListResponse
from ..types.workspace_retrieve_response import WorkspaceRetrieveResponse
__all__ = ["WorkspacesResource", "AsyncWorkspacesResource"]
class WorkspacesResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> WorkspacesResourceWithRawResponse:
"""
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 WorkspacesResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> WorkspacesResourceWithStreamingResponse:
"""
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 WorkspacesResourceWithStreamingResponse(self)
def retrieve(
self,
workspace_id: str,
*,
# 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,
) -> WorkspaceRetrieveResponse:
"""Get a specific workspace by ID with its projects.
Requires a Personal Access
Token (PAT).
Args:
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 workspace_id:
raise ValueError(f"Expected a non-empty value for `workspace_id` but received {workspace_id!r}")
return self._get(
f"/v3/workspaces/{workspace_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=WorkspaceRetrieveResponse,
)
def list(
self,
*,
# 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,
) -> WorkspaceListResponse:
"""Get all workspaces accessible by the current token.
Requires a Personal Access
Token (PAT).
"""
return self._get(
"/v3/workspaces",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=WorkspaceListResponse,
)
class AsyncWorkspacesResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncWorkspacesResourceWithRawResponse:
"""
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 AsyncWorkspacesResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncWorkspacesResourceWithStreamingResponse:
"""
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 AsyncWorkspacesResourceWithStreamingResponse(self)
async def retrieve(
self,
workspace_id: str,
*,
# 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,
) -> WorkspaceRetrieveResponse:
"""Get a specific workspace by ID with its projects.
Requires a Personal Access
Token (PAT).
Args:
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 workspace_id:
raise ValueError(f"Expected a non-empty value for `workspace_id` but received {workspace_id!r}")
return await self._get(
f"/v3/workspaces/{workspace_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=WorkspaceRetrieveResponse,
)
async def list(
self,
*,
# 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,
) -> WorkspaceListResponse:
"""Get all workspaces accessible by the current token.
Requires a Personal Access
Token (PAT).
"""
return await self._get(
"/v3/workspaces",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=WorkspaceListResponse,
)
class WorkspacesResourceWithRawResponse:
def __init__(self, workspaces: WorkspacesResource) -> None:
self._workspaces = workspaces
self.retrieve = to_raw_response_wrapper(
workspaces.retrieve,
)
self.list = to_raw_response_wrapper(
workspaces.list,
)
class AsyncWorkspacesResourceWithRawResponse:
def __init__(self, workspaces: AsyncWorkspacesResource) -> None:
self._workspaces = workspaces
self.retrieve = async_to_raw_response_wrapper(
workspaces.retrieve,
)
self.list = async_to_raw_response_wrapper(
workspaces.list,
)
class WorkspacesResourceWithStreamingResponse:
def __init__(self, workspaces: WorkspacesResource) -> None:
self._workspaces = workspaces
self.retrieve = to_streamed_response_wrapper(
workspaces.retrieve,
)
self.list = to_streamed_response_wrapper(
workspaces.list,
)
class AsyncWorkspacesResourceWithStreamingResponse:
def __init__(self, workspaces: AsyncWorkspacesResource) -> None:
self._workspaces = workspaces
self.retrieve = async_to_streamed_response_wrapper(
workspaces.retrieve,
)
self.list = async_to_streamed_response_wrapper(
workspaces.list,
)