Repository navigation
Expand file tree
/
Copy pathclient.py
More file actions
290 lines (232 loc) · 8.45 KB
/
Copy pathclient.py
File metadata and controls
290 lines (232 loc) · 8.45 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
# This file was auto-generated by Fern from our API Definition.
from __future__ import annotations
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.annotation_ref import AnnotationRef
from ...types.doc_fonts_list200response import DocFontsList200Response
from ...types.doc_fonts_resolve200response import DocFontsResolve200Response
from ...types.font_resolve_run import FontResolveRun
from .raw_client import AsyncRawFontsClient, RawFontsClient
if typing.TYPE_CHECKING:
from .programs.client import AsyncProgramsClient, ProgramsClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class FontsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawFontsClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._programs: typing.Optional[ProgramsClient] = None
@property
def with_raw_response(self) -> RawFontsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawFontsClient
"""
return self._raw_client
def list(
self,
doc_id: str,
layer_name: str,
*,
document_password: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> DocFontsList200Response:
"""
Parameters
----------
doc_id : str
layer_name : str
document_password : typing.Optional[str]
Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DocFontsList200Response
OK
Examples
--------
from cloudpdf import CloudPDFClient
client = CloudPDFClient(
token="YOUR_TOKEN",
)
client.doc.fonts.list(
doc_id="docId",
layer_name="layerName",
)
"""
_response = self._raw_client.list(
doc_id, layer_name, document_password=document_password, request_options=request_options
)
return _response.data
def resolve(
self,
doc_id: str,
layer_name: str,
*,
runs: typing.Sequence[FontResolveRun],
document_password: typing.Optional[str] = None,
annotation: typing.Optional[AnnotationRef] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> DocFontsResolve200Response:
"""
Parameters
----------
doc_id : str
layer_name : str
runs : typing.Sequence[FontResolveRun]
document_password : typing.Optional[str]
Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
annotation : typing.Optional[AnnotationRef]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DocFontsResolve200Response
OK
Examples
--------
from cloudpdf import CloudPDFClient, FontResolveRun
client = CloudPDFClient(
token="YOUR_TOKEN",
)
client.doc.fonts.resolve(
doc_id="docId",
layer_name="layerName",
runs=[
FontResolveRun(
text="text",
)
],
)
"""
_response = self._raw_client.resolve(
doc_id,
layer_name,
runs=runs,
document_password=document_password,
annotation=annotation,
request_options=request_options,
)
return _response.data
@property
def programs(self):
if self._programs is None:
from .programs.client import ProgramsClient # noqa: E402
self._programs = ProgramsClient(client_wrapper=self._client_wrapper)
return self._programs
class AsyncFontsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawFontsClient(client_wrapper=client_wrapper)
self._client_wrapper = client_wrapper
self._programs: typing.Optional[AsyncProgramsClient] = None
@property
def with_raw_response(self) -> AsyncRawFontsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawFontsClient
"""
return self._raw_client
async def list(
self,
doc_id: str,
layer_name: str,
*,
document_password: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> DocFontsList200Response:
"""
Parameters
----------
doc_id : str
layer_name : str
document_password : typing.Optional[str]
Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DocFontsList200Response
OK
Examples
--------
import asyncio
from cloudpdf import AsyncCloudPDFClient
client = AsyncCloudPDFClient(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.doc.fonts.list(
doc_id="docId",
layer_name="layerName",
)
asyncio.run(main())
"""
_response = await self._raw_client.list(
doc_id, layer_name, document_password=document_password, request_options=request_options
)
return _response.data
async def resolve(
self,
doc_id: str,
layer_name: str,
*,
runs: typing.Sequence[FontResolveRun],
document_password: typing.Optional[str] = None,
annotation: typing.Optional[AnnotationRef] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> DocFontsResolve200Response:
"""
Parameters
----------
doc_id : str
layer_name : str
runs : typing.Sequence[FontResolveRun]
document_password : typing.Optional[str]
Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
annotation : typing.Optional[AnnotationRef]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DocFontsResolve200Response
OK
Examples
--------
import asyncio
from cloudpdf import AsyncCloudPDFClient, FontResolveRun
client = AsyncCloudPDFClient(
token="YOUR_TOKEN",
)
async def main() -> None:
await client.doc.fonts.resolve(
doc_id="docId",
layer_name="layerName",
runs=[
FontResolveRun(
text="text",
)
],
)
asyncio.run(main())
"""
_response = await self._raw_client.resolve(
doc_id,
layer_name,
runs=runs,
document_password=document_password,
annotation=annotation,
request_options=request_options,
)
return _response.data
@property
def programs(self):
if self._programs is None:
from .programs.client import AsyncProgramsClient # noqa: E402
self._programs = AsyncProgramsClient(client_wrapper=self._client_wrapper)
return self._programs