|
1 | 1 | # epilot-document |
2 | 2 |
|
3 | | -<!-- Start SDK Installation --> |
| 3 | +<!-- Start SDK Installation [installation] --> |
4 | 4 | ## SDK Installation |
5 | 5 |
|
6 | 6 | ```bash |
7 | 7 | pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=document |
8 | 8 | ``` |
9 | | -<!-- End SDK Installation --> |
| 9 | +<!-- End SDK Installation [installation] --> |
10 | 10 |
|
| 11 | +<!-- Start SDK Example Usage [usage] --> |
11 | 12 | ## SDK Example Usage |
12 | | -<!-- Start SDK Example Usage --> |
| 13 | + |
| 14 | +### Example |
| 15 | + |
| 16 | +```python |
| 17 | +import epilot |
| 18 | +from epilot.models import components |
| 19 | + |
| 20 | +s = epilot.Epilot( |
| 21 | + epilot_auth="<YOUR_BEARER_TOKEN_HERE>", |
| 22 | +) |
| 23 | + |
| 24 | +req = components.ConvertDocumentRequest( |
| 25 | + input_document=components.InputDocument( |
| 26 | + s3ref=components.S3Reference( |
| 27 | + bucket='document-api-prod', |
| 28 | + key='uploads/my-template.pdf', |
| 29 | + ), |
| 30 | + ), |
| 31 | + output_format=components.OutputFormat.PDF, |
| 32 | + output_filename='converted.pdf', |
| 33 | +) |
| 34 | + |
| 35 | +res = s.documents.convert_document(req) |
| 36 | + |
| 37 | +if res.convert_document_response is not None: |
| 38 | + # handle response |
| 39 | + pass |
| 40 | + |
| 41 | +``` |
| 42 | +<!-- End SDK Example Usage [usage] --> |
| 43 | + |
| 44 | +<!-- Start Available Resources and Operations [operations] --> |
| 45 | +## Available Resources and Operations |
| 46 | + |
| 47 | +### [documents](docs/sdks/documents/README.md) |
| 48 | + |
| 49 | +* [convert_document](docs/sdks/documents/README.md#convert_document) - convertDocument |
| 50 | +* [generate_document_v2](docs/sdks/documents/README.md#generate_document_v2) - generateDocumentV2 |
| 51 | +<!-- End Available Resources and Operations [operations] --> |
| 52 | + |
| 53 | +<!-- Start Error Handling [errors] --> |
| 54 | +## Error Handling |
| 55 | + |
| 56 | +Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type. |
| 57 | + |
| 58 | +| Error Object | Status Code | Content Type | |
| 59 | +| --------------- | --------------- | --------------- | |
| 60 | +| errors.SDKError | 4xx-5xx | */* | |
| 61 | + |
| 62 | +### Example |
| 63 | + |
| 64 | +```python |
| 65 | +import epilot |
| 66 | +from epilot.models import components, errors |
| 67 | + |
| 68 | +s = epilot.Epilot( |
| 69 | + epilot_auth="<YOUR_BEARER_TOKEN_HERE>", |
| 70 | +) |
| 71 | + |
| 72 | +req = components.ConvertDocumentRequest( |
| 73 | + input_document=components.InputDocument( |
| 74 | + s3ref=components.S3Reference( |
| 75 | + bucket='document-api-prod', |
| 76 | + key='uploads/my-template.pdf', |
| 77 | + ), |
| 78 | + ), |
| 79 | + output_format=components.OutputFormat.PDF, |
| 80 | + output_filename='converted.pdf', |
| 81 | +) |
| 82 | + |
| 83 | +res = None |
| 84 | +try: |
| 85 | + res = s.documents.convert_document(req) |
| 86 | +except errors.SDKError as e: |
| 87 | + # handle exception |
| 88 | + raise(e) |
| 89 | + |
| 90 | +if res.convert_document_response is not None: |
| 91 | + # handle response |
| 92 | + pass |
| 93 | + |
| 94 | +``` |
| 95 | +<!-- End Error Handling [errors] --> |
| 96 | + |
| 97 | +<!-- Start Server Selection [server] --> |
| 98 | +## Server Selection |
| 99 | + |
| 100 | +### Select Server by Index |
| 101 | + |
| 102 | +You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers: |
| 103 | + |
| 104 | +| # | Server | Variables | |
| 105 | +| - | ------ | --------- | |
| 106 | +| 0 | `https://document.sls.epilot.io` | None | |
| 107 | + |
| 108 | +#### Example |
| 109 | + |
13 | 110 | ```python |
14 | 111 | import epilot |
15 | | -from epilot.models import operations, shared |
| 112 | +from epilot.models import components |
16 | 113 |
|
17 | 114 | s = epilot.Epilot( |
18 | | - security=shared.Security( |
19 | | - epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE", |
| 115 | + server_idx=0, |
| 116 | + epilot_auth="<YOUR_BEARER_TOKEN_HERE>", |
| 117 | +) |
| 118 | + |
| 119 | +req = components.ConvertDocumentRequest( |
| 120 | + input_document=components.InputDocument( |
| 121 | + s3ref=components.S3Reference( |
| 122 | + bucket='document-api-prod', |
| 123 | + key='uploads/my-template.pdf', |
| 124 | + ), |
20 | 125 | ), |
| 126 | + output_format=components.OutputFormat.PDF, |
| 127 | + output_filename='converted.pdf', |
21 | 128 | ) |
22 | 129 |
|
| 130 | +res = s.documents.convert_document(req) |
| 131 | + |
| 132 | +if res.convert_document_response is not None: |
| 133 | + # handle response |
| 134 | + pass |
| 135 | + |
| 136 | +``` |
| 137 | + |
| 138 | + |
| 139 | +### Override Server URL Per-Client |
| 140 | + |
| 141 | +The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: |
| 142 | +```python |
| 143 | +import epilot |
| 144 | +from epilot.models import components |
| 145 | + |
| 146 | +s = epilot.Epilot( |
| 147 | + server_url="https://document.sls.epilot.io", |
| 148 | + epilot_auth="<YOUR_BEARER_TOKEN_HERE>", |
| 149 | +) |
23 | 150 |
|
24 | | -req = operations.GenerateDocumentRequestBody( |
25 | | - context_entity_id="bcd0aab9-b544-42b0-8bfb-6d449d02eacc", |
26 | | - language="de", |
27 | | - template_document=operations.GenerateDocumentRequestBodyTemplateDocument( |
28 | | - filename="my-template-{{order.order_number}}.docx", |
29 | | - s3ref=shared.S3Reference( |
30 | | - bucket="document-api-prod", |
31 | | - key="uploads/my-template.pdf", |
| 151 | +req = components.ConvertDocumentRequest( |
| 152 | + input_document=components.InputDocument( |
| 153 | + s3ref=components.S3Reference( |
| 154 | + bucket='document-api-prod', |
| 155 | + key='uploads/my-template.pdf', |
32 | 156 | ), |
33 | 157 | ), |
34 | | - user_id="100321", |
| 158 | + output_format=components.OutputFormat.PDF, |
| 159 | + output_filename='converted.pdf', |
35 | 160 | ) |
36 | | - |
37 | | -res = s.documents.generate_document(req) |
38 | 161 |
|
39 | | -if res.generate_document_200_application_json_object is not None: |
| 162 | +res = s.documents.convert_document(req) |
| 163 | + |
| 164 | +if res.convert_document_response is not None: |
40 | 165 | # handle response |
| 166 | + pass |
| 167 | + |
41 | 168 | ``` |
42 | | -<!-- End SDK Example Usage --> |
| 169 | +<!-- End Server Selection [server] --> |
| 170 | + |
| 171 | +<!-- Start Custom HTTP Client [http-client] --> |
| 172 | +## Custom HTTP Client |
| 173 | + |
| 174 | +The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object. |
43 | 175 |
|
44 | | -<!-- Start SDK Available Operations --> |
45 | | -## SDK Available Operations |
| 176 | +For example, you could specify a header for every request that this sdk makes as follows: |
| 177 | +```python |
| 178 | +import epilot |
| 179 | +import requests |
| 180 | + |
| 181 | +http_client = requests.Session() |
| 182 | +http_client.headers.update({'x-custom-header': 'someValue'}) |
| 183 | +s = epilot.Epilot(client=http_client) |
| 184 | +``` |
| 185 | +<!-- End Custom HTTP Client [http-client] --> |
| 186 | + |
| 187 | +<!-- Start Authentication [security] --> |
| 188 | +## Authentication |
| 189 | + |
| 190 | +### Per-Client Security Schemes |
| 191 | + |
| 192 | +This SDK supports the following security scheme globally: |
| 193 | + |
| 194 | +| Name | Type | Scheme | |
| 195 | +| ------------- | ------------- | ------------- | |
| 196 | +| `epilot_auth` | http | HTTP Bearer | |
| 197 | + |
| 198 | +To authenticate with the API the `epilot_auth` parameter must be set when initializing the SDK client instance. For example: |
| 199 | +```python |
| 200 | +import epilot |
| 201 | +from epilot.models import components |
| 202 | + |
| 203 | +s = epilot.Epilot( |
| 204 | + epilot_auth="<YOUR_BEARER_TOKEN_HERE>", |
| 205 | +) |
| 206 | + |
| 207 | +req = components.ConvertDocumentRequest( |
| 208 | + input_document=components.InputDocument( |
| 209 | + s3ref=components.S3Reference( |
| 210 | + bucket='document-api-prod', |
| 211 | + key='uploads/my-template.pdf', |
| 212 | + ), |
| 213 | + ), |
| 214 | + output_format=components.OutputFormat.PDF, |
| 215 | + output_filename='converted.pdf', |
| 216 | +) |
| 217 | + |
| 218 | +res = s.documents.convert_document(req) |
| 219 | + |
| 220 | +if res.convert_document_response is not None: |
| 221 | + # handle response |
| 222 | + pass |
| 223 | + |
| 224 | +``` |
| 225 | +<!-- End Authentication [security] --> |
46 | 226 |
|
| 227 | +<!-- Placeholder for Future Speakeasy SDK Sections --> |
47 | 228 |
|
48 | | -### documents |
49 | 229 |
|
50 | | -* `generate_document` - generateDocument |
51 | | -<!-- End SDK Available Operations --> |
52 | 230 |
|
53 | 231 | ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) |
0 commit comments