Repository navigation
Expand file tree
/
Copy pathclient.py
More file actions
173 lines (137 loc) · 5.55 KB
/
Copy pathclient.py
File metadata and controls
173 lines (137 loc) · 5.55 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
# This file was auto-generated by Fern from our API Definition.
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.annotation_ref import AnnotationRef
from ...types.doc_redactions_apply200response import DocRedactionsApply200Response
from ...types.page_ref import PageRef
from .raw_client import AsyncRawRedactionsClient, RawRedactionsClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class RedactionsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawRedactionsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawRedactionsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawRedactionsClient
"""
return self._raw_client
def apply(
self,
doc_id: str,
layer_name: str,
*,
document_password: typing.Optional[str] = None,
idempotency_key: typing.Optional[str] = None,
pages: typing.Optional[typing.Sequence[PageRef]] = OMIT,
annotations: typing.Optional[typing.Sequence[AnnotationRef]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> DocRedactionsApply200Response:
"""
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.
idempotency_key : typing.Optional[str]
Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
pages : typing.Optional[typing.Sequence[PageRef]]
annotations : typing.Optional[typing.Sequence[AnnotationRef]]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DocRedactionsApply200Response
OK
Examples
--------
from cloudpdf import CloudPDFClient
client = CloudPDFClient(
token="YOUR_TOKEN",
base_url="https://yourhost.com/path/to/api",
)
client.doc.redactions.apply(
doc_id="docId",
layer_name="layerName",
)
"""
_response = self._raw_client.apply(
doc_id,
layer_name,
document_password=document_password,
idempotency_key=idempotency_key,
pages=pages,
annotations=annotations,
request_options=request_options,
)
return _response.data
class AsyncRedactionsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawRedactionsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawRedactionsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawRedactionsClient
"""
return self._raw_client
async def apply(
self,
doc_id: str,
layer_name: str,
*,
document_password: typing.Optional[str] = None,
idempotency_key: typing.Optional[str] = None,
pages: typing.Optional[typing.Sequence[PageRef]] = OMIT,
annotations: typing.Optional[typing.Sequence[AnnotationRef]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> DocRedactionsApply200Response:
"""
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.
idempotency_key : typing.Optional[str]
Names the change: 1 to 255 printable ASCII characters. A retry under the same key on the same layer answers with what the first request committed, and changes nothing.
pages : typing.Optional[typing.Sequence[PageRef]]
annotations : typing.Optional[typing.Sequence[AnnotationRef]]
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DocRedactionsApply200Response
OK
Examples
--------
import asyncio
from cloudpdf import AsyncCloudPDFClient
client = AsyncCloudPDFClient(
token="YOUR_TOKEN",
base_url="https://yourhost.com/path/to/api",
)
async def main() -> None:
await client.doc.redactions.apply(
doc_id="docId",
layer_name="layerName",
)
asyncio.run(main())
"""
_response = await self._raw_client.apply(
doc_id,
layer_name,
document_password=document_password,
idempotency_key=idempotency_key,
pages=pages,
annotations=annotations,
request_options=request_options,
)
return _response.data