pagespool 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (220) hide show
  1. pagespool/__init__.py +8 -0
  2. pagespool/api/__init__.py +1 -0
  3. pagespool/api/account/__init__.py +1 -0
  4. pagespool/api/account/get_me.py +176 -0
  5. pagespool/api/docling/__init__.py +1 -0
  6. pagespool/api/docling/docling_convert_file.py +255 -0
  7. pagespool/api/docling/docling_convert_file_async.py +232 -0
  8. pagespool/api/docling/docling_convert_source.py +253 -0
  9. pagespool/api/docling/docling_convert_source_async.py +234 -0
  10. pagespool/api/docling/docling_result.py +196 -0
  11. pagespool/api/docling/docling_status_poll.py +184 -0
  12. pagespool/api/epub_check/__init__.py +1 -0
  13. pagespool/api/epub_check/epubcheck_check.py +260 -0
  14. pagespool/api/gotenberg/__init__.py +1 -0
  15. pagespool/api/gotenberg/gotenberg_chromium_convert_html.py +233 -0
  16. pagespool/api/gotenberg/gotenberg_chromium_convert_markdown.py +233 -0
  17. pagespool/api/gotenberg/gotenberg_chromium_convert_url.py +233 -0
  18. pagespool/api/gotenberg/gotenberg_chromium_screenshot_html.py +227 -0
  19. pagespool/api/gotenberg/gotenberg_chromium_screenshot_markdown.py +227 -0
  20. pagespool/api/gotenberg/gotenberg_chromium_screenshot_url.py +227 -0
  21. pagespool/api/gotenberg/gotenberg_health.py +148 -0
  22. pagespool/api/gotenberg/gotenberg_libreoffice_convert.py +233 -0
  23. pagespool/api/gotenberg/gotenberg_pdf_attach.py +229 -0
  24. pagespool/api/gotenberg/gotenberg_pdf_attachments.py +237 -0
  25. pagespool/api/gotenberg/gotenberg_pdf_autotag.py +229 -0
  26. pagespool/api/gotenberg/gotenberg_pdf_bookmarks.py +233 -0
  27. pagespool/api/gotenberg/gotenberg_pdf_compose.py +229 -0
  28. pagespool/api/gotenberg/gotenberg_pdf_convert_colors.py +233 -0
  29. pagespool/api/gotenberg/gotenberg_pdf_decrypt.py +229 -0
  30. pagespool/api/gotenberg/gotenberg_pdf_delete.py +229 -0
  31. pagespool/api/gotenberg/gotenberg_pdf_detach.py +229 -0
  32. pagespool/api/gotenberg/gotenberg_pdf_encrypt.py +229 -0
  33. pagespool/api/gotenberg/gotenberg_pdf_extract_attachments.py +233 -0
  34. pagespool/api/gotenberg/gotenberg_pdf_extract_text.py +231 -0
  35. pagespool/api/gotenberg/gotenberg_pdf_flatten_form.py +233 -0
  36. pagespool/api/gotenberg/gotenberg_pdf_flatten_transparency.py +233 -0
  37. pagespool/api/gotenberg/gotenberg_pdf_form.py +233 -0
  38. pagespool/api/gotenberg/gotenberg_pdf_info.py +233 -0
  39. pagespool/api/gotenberg/gotenberg_pdf_insert.py +229 -0
  40. pagespool/api/gotenberg/gotenberg_pdf_merge.py +229 -0
  41. pagespool/api/gotenberg/gotenberg_pdf_metadata.py +233 -0
  42. pagespool/api/gotenberg/gotenberg_pdf_optimize.py +229 -0
  43. pagespool/api/gotenberg/gotenberg_pdf_pipe.py +229 -0
  44. pagespool/api/gotenberg/gotenberg_pdf_redact.py +229 -0
  45. pagespool/api/gotenberg/gotenberg_pdf_remediate.py +229 -0
  46. pagespool/api/gotenberg/gotenberg_pdf_render.py +223 -0
  47. pagespool/api/gotenberg/gotenberg_pdf_rotate.py +229 -0
  48. pagespool/api/gotenberg/gotenberg_pdf_select.py +229 -0
  49. pagespool/api/gotenberg/gotenberg_pdf_set_bookmarks.py +233 -0
  50. pagespool/api/gotenberg/gotenberg_pdf_set_form.py +229 -0
  51. pagespool/api/gotenberg/gotenberg_pdf_set_metadata.py +233 -0
  52. pagespool/api/gotenberg/gotenberg_pdf_sign.py +229 -0
  53. pagespool/api/gotenberg/gotenberg_pdf_split.py +229 -0
  54. pagespool/api/gotenberg/gotenberg_pdf_stamp_image.py +233 -0
  55. pagespool/api/gotenberg/gotenberg_pdf_stamp_pdf.py +229 -0
  56. pagespool/api/gotenberg/gotenberg_pdf_stamp_text.py +229 -0
  57. pagespool/api/gotenberg/gotenberg_pdf_timestamp.py +229 -0
  58. pagespool/api/gotenberg/gotenberg_pdf_validate.py +233 -0
  59. pagespool/api/gotenberg/gotenberg_version.py +138 -0
  60. pagespool/api/jobs/__init__.py +1 -0
  61. pagespool/api/jobs/get_job.py +189 -0
  62. pagespool/api/jobs/list_jobs.py +211 -0
  63. pagespool/api/mark_it_down/__init__.py +1 -0
  64. pagespool/api/mark_it_down/markitdown_convert.py +242 -0
  65. pagespool/api/oc_rmy_pdf/__init__.py +1 -0
  66. pagespool/api/oc_rmy_pdf/ocrmypdf_get_result.py +211 -0
  67. pagespool/api/oc_rmy_pdf/ocrmypdf_submit.py +259 -0
  68. pagespool/api/vera_pdf/__init__.py +1 -0
  69. pagespool/api/vera_pdf/verapdf_get_profile.py +194 -0
  70. pagespool/api/vera_pdf/verapdf_info.py +157 -0
  71. pagespool/api/vera_pdf/verapdf_list_profiles.py +153 -0
  72. pagespool/api/vera_pdf/verapdf_validate_1a.py +231 -0
  73. pagespool/api/vera_pdf/verapdf_validate_1b.py +231 -0
  74. pagespool/api/vera_pdf/verapdf_validate_2a.py +231 -0
  75. pagespool/api/vera_pdf/verapdf_validate_2b.py +231 -0
  76. pagespool/api/vera_pdf/verapdf_validate_2u.py +231 -0
  77. pagespool/api/vera_pdf/verapdf_validate_3a.py +231 -0
  78. pagespool/api/vera_pdf/verapdf_validate_3b.py +231 -0
  79. pagespool/api/vera_pdf/verapdf_validate_3u.py +231 -0
  80. pagespool/api/vera_pdf/verapdf_validate_4.py +231 -0
  81. pagespool/api/vera_pdf/verapdf_validate_4e.py +231 -0
  82. pagespool/api/vera_pdf/verapdf_validate_4f.py +231 -0
  83. pagespool/api/vera_pdf/verapdf_validate_auto.py +231 -0
  84. pagespool/api/vera_pdf/verapdf_validate_ua1.py +231 -0
  85. pagespool/api/vera_pdf/verapdf_validate_ua2.py +231 -0
  86. pagespool/api/vera_pdf/verapdf_validate_wt1a.py +231 -0
  87. pagespool/api/vera_pdf/verapdf_validate_wt1r.py +231 -0
  88. pagespool/api/weasy_print/__init__.py +1 -0
  89. pagespool/api/weasy_print/weasyprint_render.py +277 -0
  90. pagespool/client.py +268 -0
  91. pagespool/errors.py +16 -0
  92. pagespool/models/__init__.py +251 -0
  93. pagespool/models/body_docling_convert_file.py +618 -0
  94. pagespool/models/body_docling_convert_file_async.py +618 -0
  95. pagespool/models/body_epubcheck_check.py +75 -0
  96. pagespool/models/body_markitdown_convert.py +75 -0
  97. pagespool/models/body_ocrmypdf_submit.py +162 -0
  98. pagespool/models/body_ocrmypdf_submit_language.py +11 -0
  99. pagespool/models/body_ocrmypdf_submit_mode.py +10 -0
  100. pagespool/models/body_ocrmypdf_submit_output_type.py +9 -0
  101. pagespool/models/body_verapdf_validate_1a.py +75 -0
  102. pagespool/models/body_verapdf_validate_1b.py +75 -0
  103. pagespool/models/body_verapdf_validate_2a.py +75 -0
  104. pagespool/models/body_verapdf_validate_2b.py +75 -0
  105. pagespool/models/body_verapdf_validate_2u.py +75 -0
  106. pagespool/models/body_verapdf_validate_3a.py +75 -0
  107. pagespool/models/body_verapdf_validate_3b.py +75 -0
  108. pagespool/models/body_verapdf_validate_3u.py +75 -0
  109. pagespool/models/body_verapdf_validate_4.py +75 -0
  110. pagespool/models/body_verapdf_validate_4e.py +75 -0
  111. pagespool/models/body_verapdf_validate_4f.py +75 -0
  112. pagespool/models/body_verapdf_validate_auto.py +75 -0
  113. pagespool/models/body_verapdf_validate_ua_1.py +75 -0
  114. pagespool/models/body_verapdf_validate_ua_2.py +75 -0
  115. pagespool/models/body_verapdf_validate_wt_1a.py +75 -0
  116. pagespool/models/body_verapdf_validate_wt_1r.py +75 -0
  117. pagespool/models/check_report.py +156 -0
  118. pagespool/models/check_report_checker.py +47 -0
  119. pagespool/models/check_report_items_item.py +45 -0
  120. pagespool/models/check_report_messages_item.py +45 -0
  121. pagespool/models/check_report_publication.py +47 -0
  122. pagespool/models/convert_document_response.py +161 -0
  123. pagespool/models/convert_document_response_confidence_type_0.py +45 -0
  124. pagespool/models/convert_document_response_errors_item.py +45 -0
  125. pagespool/models/convert_document_response_timings.py +45 -0
  126. pagespool/models/convert_options.py +422 -0
  127. pagespool/models/convert_source_request.py +167 -0
  128. pagespool/models/convert_source_request_target_type_0.py +45 -0
  129. pagespool/models/credits_info.py +95 -0
  130. pagespool/models/export_document.py +202 -0
  131. pagespool/models/export_document_json_content_type_0.py +45 -0
  132. pagespool/models/file_source.py +80 -0
  133. pagespool/models/gotenberg_chromium_convert_html_body.py +89 -0
  134. pagespool/models/gotenberg_chromium_convert_markdown_body.py +89 -0
  135. pagespool/models/gotenberg_chromium_convert_url_body.py +89 -0
  136. pagespool/models/gotenberg_chromium_screenshot_html_body.py +89 -0
  137. pagespool/models/gotenberg_chromium_screenshot_markdown_body.py +89 -0
  138. pagespool/models/gotenberg_chromium_screenshot_url_body.py +89 -0
  139. pagespool/models/gotenberg_libreoffice_convert_body.py +89 -0
  140. pagespool/models/gotenberg_pdf_attach_body.py +89 -0
  141. pagespool/models/gotenberg_pdf_attachments_body.py +89 -0
  142. pagespool/models/gotenberg_pdf_attachments_response_200.py +45 -0
  143. pagespool/models/gotenberg_pdf_autotag_body.py +89 -0
  144. pagespool/models/gotenberg_pdf_bookmarks_body.py +89 -0
  145. pagespool/models/gotenberg_pdf_bookmarks_response_200.py +45 -0
  146. pagespool/models/gotenberg_pdf_compose_body.py +89 -0
  147. pagespool/models/gotenberg_pdf_convert_colors_body.py +89 -0
  148. pagespool/models/gotenberg_pdf_decrypt_body.py +89 -0
  149. pagespool/models/gotenberg_pdf_delete_body.py +89 -0
  150. pagespool/models/gotenberg_pdf_detach_body.py +89 -0
  151. pagespool/models/gotenberg_pdf_encrypt_body.py +89 -0
  152. pagespool/models/gotenberg_pdf_extract_attachments_body.py +89 -0
  153. pagespool/models/gotenberg_pdf_extract_text_body.py +89 -0
  154. pagespool/models/gotenberg_pdf_flatten_form_body.py +89 -0
  155. pagespool/models/gotenberg_pdf_flatten_transparency_body.py +89 -0
  156. pagespool/models/gotenberg_pdf_form_body.py +89 -0
  157. pagespool/models/gotenberg_pdf_form_response_200.py +45 -0
  158. pagespool/models/gotenberg_pdf_info_body.py +89 -0
  159. pagespool/models/gotenberg_pdf_info_response_200.py +45 -0
  160. pagespool/models/gotenberg_pdf_insert_body.py +89 -0
  161. pagespool/models/gotenberg_pdf_merge_body.py +89 -0
  162. pagespool/models/gotenberg_pdf_metadata_body.py +89 -0
  163. pagespool/models/gotenberg_pdf_metadata_response_200.py +45 -0
  164. pagespool/models/gotenberg_pdf_optimize_body.py +89 -0
  165. pagespool/models/gotenberg_pdf_pipe_body.py +89 -0
  166. pagespool/models/gotenberg_pdf_redact_body.py +89 -0
  167. pagespool/models/gotenberg_pdf_remediate_body.py +89 -0
  168. pagespool/models/gotenberg_pdf_render_body.py +89 -0
  169. pagespool/models/gotenberg_pdf_rotate_body.py +89 -0
  170. pagespool/models/gotenberg_pdf_select_body.py +89 -0
  171. pagespool/models/gotenberg_pdf_set_bookmarks_body.py +89 -0
  172. pagespool/models/gotenberg_pdf_set_form_body.py +89 -0
  173. pagespool/models/gotenberg_pdf_set_metadata_body.py +89 -0
  174. pagespool/models/gotenberg_pdf_sign_body.py +89 -0
  175. pagespool/models/gotenberg_pdf_split_body.py +89 -0
  176. pagespool/models/gotenberg_pdf_stamp_image_body.py +89 -0
  177. pagespool/models/gotenberg_pdf_stamp_pdf_body.py +89 -0
  178. pagespool/models/gotenberg_pdf_stamp_text_body.py +89 -0
  179. pagespool/models/gotenberg_pdf_timestamp_body.py +89 -0
  180. pagespool/models/gotenberg_pdf_validate_body.py +89 -0
  181. pagespool/models/gotenberg_pdf_validate_response_200.py +45 -0
  182. pagespool/models/http_source.py +96 -0
  183. pagespool/models/http_source_headers.py +47 -0
  184. pagespool/models/job_response.py +230 -0
  185. pagespool/models/job_response_page.py +97 -0
  186. pagespool/models/job_response_result_type_0.py +45 -0
  187. pagespool/models/mark_it_down_convert_response.py +87 -0
  188. pagespool/models/mark_it_down_convert_response_meta.py +47 -0
  189. pagespool/models/me_response.py +135 -0
  190. pagespool/models/ocr_job_response.py +102 -0
  191. pagespool/models/problem.py +190 -0
  192. pagespool/models/problem_errors_type_0_item.py +45 -0
  193. pagespool/models/rate_limit_info.py +118 -0
  194. pagespool/models/summary.py +86 -0
  195. pagespool/models/task_status.py +163 -0
  196. pagespool/models/task_status_task_meta_type_0.py +45 -0
  197. pagespool/models/task_status_task_status.py +11 -0
  198. pagespool/models/verapdf_validate_1a_response_200.py +45 -0
  199. pagespool/models/verapdf_validate_1b_response_200.py +45 -0
  200. pagespool/models/verapdf_validate_2a_response_200.py +45 -0
  201. pagespool/models/verapdf_validate_2b_response_200.py +45 -0
  202. pagespool/models/verapdf_validate_2u_response_200.py +45 -0
  203. pagespool/models/verapdf_validate_3a_response_200.py +45 -0
  204. pagespool/models/verapdf_validate_3b_response_200.py +45 -0
  205. pagespool/models/verapdf_validate_3u_response_200.py +45 -0
  206. pagespool/models/verapdf_validate_4_response_200.py +45 -0
  207. pagespool/models/verapdf_validate_4e_response_200.py +45 -0
  208. pagespool/models/verapdf_validate_4f_response_200.py +45 -0
  209. pagespool/models/verapdf_validate_auto_response_200.py +45 -0
  210. pagespool/models/verapdf_validate_ua_1_response_200.py +45 -0
  211. pagespool/models/verapdf_validate_ua_2_response_200.py +45 -0
  212. pagespool/models/verapdf_validate_wt_1a_response_200.py +45 -0
  213. pagespool/models/verapdf_validate_wt_1r_response_200.py +45 -0
  214. pagespool/models/weasy_print_render_request.py +108 -0
  215. pagespool/models/weasy_print_render_request_pdf_variant_type_0.py +9 -0
  216. pagespool/py.typed +1 -0
  217. pagespool/types.py +54 -0
  218. pagespool-1.0.0.dist-info/METADATA +126 -0
  219. pagespool-1.0.0.dist-info/RECORD +220 -0
  220. pagespool-1.0.0.dist-info/WHEEL +4 -0
pagespool/__init__.py ADDED
@@ -0,0 +1,8 @@
1
+ """A client library for accessing pagespool"""
2
+
3
+ from .client import AuthenticatedClient, Client
4
+
5
+ __all__ = (
6
+ "AuthenticatedClient",
7
+ "Client",
8
+ )
@@ -0,0 +1 @@
1
+ """Contains methods for accessing the API"""
@@ -0,0 +1 @@
1
+ """Contains endpoint functions for accessing the API"""
@@ -0,0 +1,176 @@
1
+ from http import HTTPStatus
2
+ from typing import Any
3
+
4
+ import httpx2
5
+
6
+ from ... import errors
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...models.me_response import MeResponse
9
+ from ...types import Response
10
+
11
+
12
+ def _get_kwargs() -> dict[str, Any]:
13
+
14
+ _kwargs: dict[str, Any] = {
15
+ "method": "get",
16
+ "url": "/v1/me",
17
+ }
18
+
19
+ return _kwargs
20
+
21
+
22
+ def _parse_response(*, client: AuthenticatedClient | Client, response: httpx2.Response) -> MeResponse | None:
23
+ if response.status_code == 200:
24
+ response_200 = MeResponse.from_dict(response.json())
25
+
26
+ return response_200
27
+
28
+ if client.raise_on_unexpected_status:
29
+ raise errors.UnexpectedStatus(response.status_code, response.content)
30
+ else:
31
+ return None
32
+
33
+
34
+ def _build_response(*, client: AuthenticatedClient | Client, response: httpx2.Response) -> Response[MeResponse]:
35
+ return Response(
36
+ status_code=HTTPStatus(response.status_code),
37
+ content=response.content,
38
+ headers=response.headers,
39
+ parsed=_parse_response(client=client, response=response),
40
+ )
41
+
42
+
43
+ def sync_detailed(
44
+ *,
45
+ client: AuthenticatedClient,
46
+ ) -> Response[MeResponse]:
47
+ """Your plan, remaining requests, and remaining credits
48
+
49
+ Check where you stand before a call fails.
50
+
51
+ Returns the plan this request runs on and whether your key was recognized.
52
+ Without an `X-API-Key`, the call runs anonymously at the rate limit for
53
+ calls without a key. It also returns the requests left in the current window
54
+ and the features your plan includes. On plans priced in credits, it returns
55
+ the credits left in the current billing period.
56
+
57
+ This call does not count against your rate limit, so the numbers it reports
58
+ are the numbers you have.
59
+
60
+ **Credits:** free. This endpoint is not metered.
61
+
62
+ Raises:
63
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
64
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
65
+
66
+ Returns:
67
+ Response[MeResponse]
68
+ """
69
+
70
+ kwargs = _get_kwargs()
71
+
72
+ response = client.get_httpx_client().request(
73
+ **kwargs,
74
+ )
75
+
76
+ return _build_response(client=client, response=response)
77
+
78
+
79
+ def sync(
80
+ *,
81
+ client: AuthenticatedClient,
82
+ ) -> MeResponse | None:
83
+ """Your plan, remaining requests, and remaining credits
84
+
85
+ Check where you stand before a call fails.
86
+
87
+ Returns the plan this request runs on and whether your key was recognized.
88
+ Without an `X-API-Key`, the call runs anonymously at the rate limit for
89
+ calls without a key. It also returns the requests left in the current window
90
+ and the features your plan includes. On plans priced in credits, it returns
91
+ the credits left in the current billing period.
92
+
93
+ This call does not count against your rate limit, so the numbers it reports
94
+ are the numbers you have.
95
+
96
+ **Credits:** free. This endpoint is not metered.
97
+
98
+ Raises:
99
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
100
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
101
+
102
+ Returns:
103
+ MeResponse
104
+ """
105
+
106
+ return sync_detailed(
107
+ client=client,
108
+ ).parsed
109
+
110
+
111
+ async def asyncio_detailed(
112
+ *,
113
+ client: AuthenticatedClient,
114
+ ) -> Response[MeResponse]:
115
+ """Your plan, remaining requests, and remaining credits
116
+
117
+ Check where you stand before a call fails.
118
+
119
+ Returns the plan this request runs on and whether your key was recognized.
120
+ Without an `X-API-Key`, the call runs anonymously at the rate limit for
121
+ calls without a key. It also returns the requests left in the current window
122
+ and the features your plan includes. On plans priced in credits, it returns
123
+ the credits left in the current billing period.
124
+
125
+ This call does not count against your rate limit, so the numbers it reports
126
+ are the numbers you have.
127
+
128
+ **Credits:** free. This endpoint is not metered.
129
+
130
+ Raises:
131
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
132
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
133
+
134
+ Returns:
135
+ Response[MeResponse]
136
+ """
137
+
138
+ kwargs = _get_kwargs()
139
+
140
+ response = await client.get_async_httpx_client().request(**kwargs)
141
+
142
+ return _build_response(client=client, response=response)
143
+
144
+
145
+ async def asyncio(
146
+ *,
147
+ client: AuthenticatedClient,
148
+ ) -> MeResponse | None:
149
+ """Your plan, remaining requests, and remaining credits
150
+
151
+ Check where you stand before a call fails.
152
+
153
+ Returns the plan this request runs on and whether your key was recognized.
154
+ Without an `X-API-Key`, the call runs anonymously at the rate limit for
155
+ calls without a key. It also returns the requests left in the current window
156
+ and the features your plan includes. On plans priced in credits, it returns
157
+ the credits left in the current billing period.
158
+
159
+ This call does not count against your rate limit, so the numbers it reports
160
+ are the numbers you have.
161
+
162
+ **Credits:** free. This endpoint is not metered.
163
+
164
+ Raises:
165
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
166
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
167
+
168
+ Returns:
169
+ MeResponse
170
+ """
171
+
172
+ return (
173
+ await asyncio_detailed(
174
+ client=client,
175
+ )
176
+ ).parsed
@@ -0,0 +1 @@
1
+ """Contains endpoint functions for accessing the API"""
@@ -0,0 +1,255 @@
1
+ from http import HTTPStatus
2
+ from typing import Any
3
+
4
+ import httpx2
5
+
6
+ from ... import errors
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...models.body_docling_convert_file import BodyDoclingConvertFile
9
+ from ...models.convert_document_response import ConvertDocumentResponse
10
+ from ...models.problem import Problem
11
+ from ...types import Response
12
+
13
+
14
+ def _get_kwargs(
15
+ *,
16
+ body: BodyDoclingConvertFile,
17
+ ) -> dict[str, Any]:
18
+ headers: dict[str, Any] = {}
19
+
20
+ _kwargs: dict[str, Any] = {
21
+ "method": "post",
22
+ "url": "/v1/docling/v1/convert/file",
23
+ }
24
+
25
+ _kwargs["files"] = body.to_multipart()
26
+
27
+ _kwargs["headers"] = headers
28
+ return _kwargs
29
+
30
+
31
+ def _parse_response(
32
+ *, client: AuthenticatedClient | Client, response: httpx2.Response
33
+ ) -> ConvertDocumentResponse | Problem | None:
34
+ if response.status_code == 200:
35
+ response_200 = ConvertDocumentResponse.from_dict(response.json())
36
+
37
+ return response_200
38
+
39
+ if response.status_code == 400:
40
+ response_400 = Problem.from_dict(response.json())
41
+
42
+ return response_400
43
+
44
+ if response.status_code == 401:
45
+ response_401 = Problem.from_dict(response.json())
46
+
47
+ return response_401
48
+
49
+ if response.status_code == 402:
50
+ response_402 = Problem.from_dict(response.json())
51
+
52
+ return response_402
53
+
54
+ if response.status_code == 413:
55
+ response_413 = Problem.from_dict(response.json())
56
+
57
+ return response_413
58
+
59
+ if response.status_code == 422:
60
+ response_422 = Problem.from_dict(response.json())
61
+
62
+ return response_422
63
+
64
+ if response.status_code == 429:
65
+ response_429 = Problem.from_dict(response.json())
66
+
67
+ return response_429
68
+
69
+ if response.status_code == 503:
70
+ response_503 = Problem.from_dict(response.json())
71
+
72
+ return response_503
73
+
74
+ if response.status_code == 504:
75
+ response_504 = Problem.from_dict(response.json())
76
+
77
+ return response_504
78
+
79
+ if client.raise_on_unexpected_status:
80
+ raise errors.UnexpectedStatus(response.status_code, response.content)
81
+ else:
82
+ return None
83
+
84
+
85
+ def _build_response(
86
+ *, client: AuthenticatedClient | Client, response: httpx2.Response
87
+ ) -> Response[ConvertDocumentResponse | Problem]:
88
+ return Response(
89
+ status_code=HTTPStatus(response.status_code),
90
+ content=response.content,
91
+ headers=response.headers,
92
+ parsed=_parse_response(client=client, response=response),
93
+ )
94
+
95
+
96
+ def sync_detailed(
97
+ *,
98
+ client: AuthenticatedClient,
99
+ body: BodyDoclingConvertFile,
100
+ ) -> Response[ConvertDocumentResponse | Problem]:
101
+ """Convert an uploaded document, waiting up to 50 s (1 credit per PDF page, 10 per other file)
102
+
103
+ docling-serve's `POST /v1/convert/file`: converts one uploaded document
104
+ and returns docling-serve's response, waiting up to 50 seconds.
105
+
106
+ Send the file as the multipart field `files`, and options as form fields
107
+ of docling-serve's names. A conversion that takes longer answers 504
108
+ `use_async` with its `task_id`: it goes on, and `GET /v1/status/poll/{task_id}`
109
+ reports when `GET /v1/result/{task_id}` has the document.
110
+
111
+ Costs 1 credit per PDF page converted (2 with `force_ocr`) and 10 per other
112
+ file, charged at submission and refunded if the conversion fails. Up to
113
+ 25 MB and 200 pages.
114
+
115
+ **Credits:** 1 per call.
116
+
117
+ Args:
118
+ body (BodyDoclingConvertFile):
119
+
120
+ Raises:
121
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
122
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
123
+
124
+ Returns:
125
+ Response[ConvertDocumentResponse | Problem]
126
+ """
127
+
128
+ kwargs = _get_kwargs(
129
+ body=body,
130
+ )
131
+
132
+ response = client.get_httpx_client().request(
133
+ **kwargs,
134
+ )
135
+
136
+ return _build_response(client=client, response=response)
137
+
138
+
139
+ def sync(
140
+ *,
141
+ client: AuthenticatedClient,
142
+ body: BodyDoclingConvertFile,
143
+ ) -> ConvertDocumentResponse | Problem | None:
144
+ """Convert an uploaded document, waiting up to 50 s (1 credit per PDF page, 10 per other file)
145
+
146
+ docling-serve's `POST /v1/convert/file`: converts one uploaded document
147
+ and returns docling-serve's response, waiting up to 50 seconds.
148
+
149
+ Send the file as the multipart field `files`, and options as form fields
150
+ of docling-serve's names. A conversion that takes longer answers 504
151
+ `use_async` with its `task_id`: it goes on, and `GET /v1/status/poll/{task_id}`
152
+ reports when `GET /v1/result/{task_id}` has the document.
153
+
154
+ Costs 1 credit per PDF page converted (2 with `force_ocr`) and 10 per other
155
+ file, charged at submission and refunded if the conversion fails. Up to
156
+ 25 MB and 200 pages.
157
+
158
+ **Credits:** 1 per call.
159
+
160
+ Args:
161
+ body (BodyDoclingConvertFile):
162
+
163
+ Raises:
164
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
165
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
166
+
167
+ Returns:
168
+ ConvertDocumentResponse | Problem
169
+ """
170
+
171
+ return sync_detailed(
172
+ client=client,
173
+ body=body,
174
+ ).parsed
175
+
176
+
177
+ async def asyncio_detailed(
178
+ *,
179
+ client: AuthenticatedClient,
180
+ body: BodyDoclingConvertFile,
181
+ ) -> Response[ConvertDocumentResponse | Problem]:
182
+ """Convert an uploaded document, waiting up to 50 s (1 credit per PDF page, 10 per other file)
183
+
184
+ docling-serve's `POST /v1/convert/file`: converts one uploaded document
185
+ and returns docling-serve's response, waiting up to 50 seconds.
186
+
187
+ Send the file as the multipart field `files`, and options as form fields
188
+ of docling-serve's names. A conversion that takes longer answers 504
189
+ `use_async` with its `task_id`: it goes on, and `GET /v1/status/poll/{task_id}`
190
+ reports when `GET /v1/result/{task_id}` has the document.
191
+
192
+ Costs 1 credit per PDF page converted (2 with `force_ocr`) and 10 per other
193
+ file, charged at submission and refunded if the conversion fails. Up to
194
+ 25 MB and 200 pages.
195
+
196
+ **Credits:** 1 per call.
197
+
198
+ Args:
199
+ body (BodyDoclingConvertFile):
200
+
201
+ Raises:
202
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
203
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
204
+
205
+ Returns:
206
+ Response[ConvertDocumentResponse | Problem]
207
+ """
208
+
209
+ kwargs = _get_kwargs(
210
+ body=body,
211
+ )
212
+
213
+ response = await client.get_async_httpx_client().request(**kwargs)
214
+
215
+ return _build_response(client=client, response=response)
216
+
217
+
218
+ async def asyncio(
219
+ *,
220
+ client: AuthenticatedClient,
221
+ body: BodyDoclingConvertFile,
222
+ ) -> ConvertDocumentResponse | Problem | None:
223
+ """Convert an uploaded document, waiting up to 50 s (1 credit per PDF page, 10 per other file)
224
+
225
+ docling-serve's `POST /v1/convert/file`: converts one uploaded document
226
+ and returns docling-serve's response, waiting up to 50 seconds.
227
+
228
+ Send the file as the multipart field `files`, and options as form fields
229
+ of docling-serve's names. A conversion that takes longer answers 504
230
+ `use_async` with its `task_id`: it goes on, and `GET /v1/status/poll/{task_id}`
231
+ reports when `GET /v1/result/{task_id}` has the document.
232
+
233
+ Costs 1 credit per PDF page converted (2 with `force_ocr`) and 10 per other
234
+ file, charged at submission and refunded if the conversion fails. Up to
235
+ 25 MB and 200 pages.
236
+
237
+ **Credits:** 1 per call.
238
+
239
+ Args:
240
+ body (BodyDoclingConvertFile):
241
+
242
+ Raises:
243
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
244
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
245
+
246
+ Returns:
247
+ ConvertDocumentResponse | Problem
248
+ """
249
+
250
+ return (
251
+ await asyncio_detailed(
252
+ client=client,
253
+ body=body,
254
+ )
255
+ ).parsed
@@ -0,0 +1,232 @@
1
+ from http import HTTPStatus
2
+ from typing import Any
3
+
4
+ import httpx2
5
+
6
+ from ... import errors
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...models.body_docling_convert_file_async import BodyDoclingConvertFileAsync
9
+ from ...models.problem import Problem
10
+ from ...models.task_status import TaskStatus
11
+ from ...types import Response
12
+
13
+
14
+ def _get_kwargs(
15
+ *,
16
+ body: BodyDoclingConvertFileAsync,
17
+ ) -> dict[str, Any]:
18
+ headers: dict[str, Any] = {}
19
+
20
+ _kwargs: dict[str, Any] = {
21
+ "method": "post",
22
+ "url": "/v1/docling/v1/convert/file/async",
23
+ }
24
+
25
+ _kwargs["files"] = body.to_multipart()
26
+
27
+ _kwargs["headers"] = headers
28
+ return _kwargs
29
+
30
+
31
+ def _parse_response(*, client: AuthenticatedClient | Client, response: httpx2.Response) -> Problem | TaskStatus | None:
32
+ if response.status_code == 200:
33
+ response_200 = TaskStatus.from_dict(response.json())
34
+
35
+ return response_200
36
+
37
+ if response.status_code == 400:
38
+ response_400 = Problem.from_dict(response.json())
39
+
40
+ return response_400
41
+
42
+ if response.status_code == 401:
43
+ response_401 = Problem.from_dict(response.json())
44
+
45
+ return response_401
46
+
47
+ if response.status_code == 402:
48
+ response_402 = Problem.from_dict(response.json())
49
+
50
+ return response_402
51
+
52
+ if response.status_code == 413:
53
+ response_413 = Problem.from_dict(response.json())
54
+
55
+ return response_413
56
+
57
+ if response.status_code == 422:
58
+ response_422 = Problem.from_dict(response.json())
59
+
60
+ return response_422
61
+
62
+ if response.status_code == 429:
63
+ response_429 = Problem.from_dict(response.json())
64
+
65
+ return response_429
66
+
67
+ if response.status_code == 503:
68
+ response_503 = Problem.from_dict(response.json())
69
+
70
+ return response_503
71
+
72
+ if client.raise_on_unexpected_status:
73
+ raise errors.UnexpectedStatus(response.status_code, response.content)
74
+ else:
75
+ return None
76
+
77
+
78
+ def _build_response(
79
+ *, client: AuthenticatedClient | Client, response: httpx2.Response
80
+ ) -> Response[Problem | TaskStatus]:
81
+ return Response(
82
+ status_code=HTTPStatus(response.status_code),
83
+ content=response.content,
84
+ headers=response.headers,
85
+ parsed=_parse_response(client=client, response=response),
86
+ )
87
+
88
+
89
+ def sync_detailed(
90
+ *,
91
+ client: AuthenticatedClient,
92
+ body: BodyDoclingConvertFileAsync,
93
+ ) -> Response[Problem | TaskStatus]:
94
+ """Queue an uploaded document for conversion (1 credit per PDF page, 10 per other file)
95
+
96
+ docling-serve's `POST /v1/convert/file/async`: queues one uploaded
97
+ document and returns its task at once.
98
+
99
+ Poll `GET /v1/status/poll/{task_id}` (free) until `task_status` is `success`
100
+ or `failure`, then fetch `GET /v1/result/{task_id}` (free). Costs 1 credit
101
+ per PDF page converted (2 with `force_ocr`) and 10 per other file, charged
102
+ now and refunded if the conversion fails. Results are kept for 7 days.
103
+
104
+ **Credits:** 1 per call.
105
+
106
+ Args:
107
+ body (BodyDoclingConvertFileAsync):
108
+
109
+ Raises:
110
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
111
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
112
+
113
+ Returns:
114
+ Response[Problem | TaskStatus]
115
+ """
116
+
117
+ kwargs = _get_kwargs(
118
+ body=body,
119
+ )
120
+
121
+ response = client.get_httpx_client().request(
122
+ **kwargs,
123
+ )
124
+
125
+ return _build_response(client=client, response=response)
126
+
127
+
128
+ def sync(
129
+ *,
130
+ client: AuthenticatedClient,
131
+ body: BodyDoclingConvertFileAsync,
132
+ ) -> Problem | TaskStatus | None:
133
+ """Queue an uploaded document for conversion (1 credit per PDF page, 10 per other file)
134
+
135
+ docling-serve's `POST /v1/convert/file/async`: queues one uploaded
136
+ document and returns its task at once.
137
+
138
+ Poll `GET /v1/status/poll/{task_id}` (free) until `task_status` is `success`
139
+ or `failure`, then fetch `GET /v1/result/{task_id}` (free). Costs 1 credit
140
+ per PDF page converted (2 with `force_ocr`) and 10 per other file, charged
141
+ now and refunded if the conversion fails. Results are kept for 7 days.
142
+
143
+ **Credits:** 1 per call.
144
+
145
+ Args:
146
+ body (BodyDoclingConvertFileAsync):
147
+
148
+ Raises:
149
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
150
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
151
+
152
+ Returns:
153
+ Problem | TaskStatus
154
+ """
155
+
156
+ return sync_detailed(
157
+ client=client,
158
+ body=body,
159
+ ).parsed
160
+
161
+
162
+ async def asyncio_detailed(
163
+ *,
164
+ client: AuthenticatedClient,
165
+ body: BodyDoclingConvertFileAsync,
166
+ ) -> Response[Problem | TaskStatus]:
167
+ """Queue an uploaded document for conversion (1 credit per PDF page, 10 per other file)
168
+
169
+ docling-serve's `POST /v1/convert/file/async`: queues one uploaded
170
+ document and returns its task at once.
171
+
172
+ Poll `GET /v1/status/poll/{task_id}` (free) until `task_status` is `success`
173
+ or `failure`, then fetch `GET /v1/result/{task_id}` (free). Costs 1 credit
174
+ per PDF page converted (2 with `force_ocr`) and 10 per other file, charged
175
+ now and refunded if the conversion fails. Results are kept for 7 days.
176
+
177
+ **Credits:** 1 per call.
178
+
179
+ Args:
180
+ body (BodyDoclingConvertFileAsync):
181
+
182
+ Raises:
183
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
184
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
185
+
186
+ Returns:
187
+ Response[Problem | TaskStatus]
188
+ """
189
+
190
+ kwargs = _get_kwargs(
191
+ body=body,
192
+ )
193
+
194
+ response = await client.get_async_httpx_client().request(**kwargs)
195
+
196
+ return _build_response(client=client, response=response)
197
+
198
+
199
+ async def asyncio(
200
+ *,
201
+ client: AuthenticatedClient,
202
+ body: BodyDoclingConvertFileAsync,
203
+ ) -> Problem | TaskStatus | None:
204
+ """Queue an uploaded document for conversion (1 credit per PDF page, 10 per other file)
205
+
206
+ docling-serve's `POST /v1/convert/file/async`: queues one uploaded
207
+ document and returns its task at once.
208
+
209
+ Poll `GET /v1/status/poll/{task_id}` (free) until `task_status` is `success`
210
+ or `failure`, then fetch `GET /v1/result/{task_id}` (free). Costs 1 credit
211
+ per PDF page converted (2 with `force_ocr`) and 10 per other file, charged
212
+ now and refunded if the conversion fails. Results are kept for 7 days.
213
+
214
+ **Credits:** 1 per call.
215
+
216
+ Args:
217
+ body (BodyDoclingConvertFileAsync):
218
+
219
+ Raises:
220
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
221
+ httpx2.TimeoutException: If the request takes longer than Client.timeout.
222
+
223
+ Returns:
224
+ Problem | TaskStatus
225
+ """
226
+
227
+ return (
228
+ await asyncio_detailed(
229
+ client=client,
230
+ body=body,
231
+ )
232
+ ).parsed