You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
API changes:
- Update API client
- Update API client
- Update API client
- Update API client
- Update API client
- ... and 6 more API files
Model changes:
- Add create_version_request model
- Add set_default_version_request model
- Add update_version_request model
- Add version_item model
- Add versions_list_response model
- ... and 25 more model files
Generated from OpenAPI spec v1.8.0
job_id: Annotated[StrictStr, Field(description="Async job ID (UUID returned by the create-async endpoint)")],
337
338
_request_timeout: Union[
338
339
None,
339
340
Annotated[StrictFloat, Field(gt=0)],
@@ -351,7 +352,7 @@ def get_pdf_job(
351
352
352
353
Get the current status of an async PDF generation job. **Authentication:** API Key required (`x-api-key` header) ## Status Values | Status | Description | |--------|-------------| | `pending` | Job is queued, waiting to be processed | | `processing` | Job is being processed | | `completed` | PDF generated successfully | | `failed` | Job failed (check error_message) | ## Polling Recommendations - Poll every 1-2 seconds for small documents - Poll every 5-10 seconds for large documents - Consider using webhooks instead of polling
353
354
354
-
:param job_id: (required)
355
+
:param job_id: Async job ID (UUID returned by the create-async endpoint) (required)
355
356
:type job_id: str
356
357
:param _request_timeout: timeout setting for this request. If one
357
358
number provided, it will be total request
@@ -402,7 +403,7 @@ def get_pdf_job(
402
403
@validate_call
403
404
defget_pdf_job_with_http_info(
404
405
self,
405
-
job_id: StrictStr,
406
+
job_id: Annotated[StrictStr, Field(description="Async job ID (UUID returned by the create-async endpoint)")],
Get the current status of an async PDF generation job. **Authentication:** API Key required (`x-api-key` header) ## Status Values | Status | Description | |--------|-------------| | `pending` | Job is queued, waiting to be processed | | `processing` | Job is being processed | | `completed` | PDF generated successfully | | `failed` | Job failed (check error_message) | ## Polling Recommendations - Poll every 1-2 seconds for small documents - Poll every 5-10 seconds for large documents - Consider using webhooks instead of polling
422
423
423
-
:param job_id: (required)
424
+
:param job_id: Async job ID (UUID returned by the create-async endpoint) (required)
424
425
:type job_id: str
425
426
:param _request_timeout: timeout setting for this request. If one
Get the current status of an async PDF generation job. **Authentication:** API Key required (`x-api-key` header) ## Status Values | Status | Description | |--------|-------------| | `pending` | Job is queued, waiting to be processed | | `processing` | Job is being processed | | `completed` | PDF generated successfully | | `failed` | Job failed (check error_message) | ## Polling Recommendations - Poll every 1-2 seconds for small documents - Poll every 5-10 seconds for large documents - Consider using webhooks instead of polling
491
492
492
-
:param job_id: (required)
493
+
:param job_id: Async job ID (UUID returned by the create-async endpoint) (required)
493
494
:type job_id: str
494
495
:param _request_timeout: timeout setting for this request. If one
495
496
number provided, it will be total request
@@ -600,9 +601,9 @@ def _get_pdf_job_serialize(
600
601
@validate_call
601
602
deflist_pdf_jobs(
602
603
self,
603
-
limit: Optional[StrictInt] =None,
604
-
offset: Optional[StrictInt] =None,
605
-
status: Optional[Any] =None,
604
+
limit: Annotated[Optional[StrictInt], Field(description="Maximum number of results to return")] =None,
605
+
offset: Annotated[Optional[StrictInt], Field(description="Number of results to skip (for pagination)")] =None,
606
+
status: Annotated[Optional[Any], Field(description="Filter jobs by status")] =None,
606
607
_request_timeout: Union[
607
608
None,
608
609
Annotated[StrictFloat, Field(gt=0)],
@@ -620,11 +621,11 @@ def list_pdf_jobs(
620
621
621
622
List async PDF generation jobs for your team. **Authentication:** API Key required (`x-api-key` header) Supports pagination and filtering by status.
622
623
623
-
:param limit:
624
+
:param limit: Maximum number of results to return
624
625
:type limit: int
625
-
:param offset:
626
+
:param offset: Number of results to skip (for pagination)
626
627
:type offset: int
627
-
:param status:
628
+
:param status: Filter jobs by status
628
629
:type status: JobStatus
629
630
:param _request_timeout: timeout setting for this request. If one
630
631
number provided, it will be total request
@@ -676,9 +677,9 @@ def list_pdf_jobs(
676
677
@validate_call
677
678
deflist_pdf_jobs_with_http_info(
678
679
self,
679
-
limit: Optional[StrictInt] =None,
680
-
offset: Optional[StrictInt] =None,
681
-
status: Optional[Any] =None,
680
+
limit: Annotated[Optional[StrictInt], Field(description="Maximum number of results to return")] =None,
681
+
offset: Annotated[Optional[StrictInt], Field(description="Number of results to skip (for pagination)")] =None,
682
+
status: Annotated[Optional[Any], Field(description="Filter jobs by status")] =None,
0 commit comments