Skip to content

chore: speakeasy sdk regeneration - Generate Document SDK #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 84 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
0bf41c8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.3
speakeasybot Apr 1, 2023
2d5a21d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 6, 2023
810223c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.6
speakeasybot Apr 7, 2023
473cddd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.19.7
speakeasybot Apr 12, 2023
8c7005a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.0
speakeasybot Apr 14, 2023
bf18d02
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.1
speakeasybot Apr 18, 2023
0df34fb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.20.2
speakeasybot Apr 19, 2023
72d620f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.21.4
speakeasybot Apr 21, 2023
af1ff54
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.22.1
speakeasybot Apr 22, 2023
18aaca5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.23.1
speakeasybot Apr 26, 2023
afc0624
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.25.1
speakeasybot Apr 27, 2023
4da8487
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.2
speakeasybot Apr 28, 2023
b74768e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.4
speakeasybot Apr 29, 2023
7b135f9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.26.5
speakeasybot May 2, 2023
34b22bf
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.27.0
speakeasybot May 3, 2023
d2257cb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.0
speakeasybot May 5, 2023
9e95a4c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.1
speakeasybot May 6, 2023
42a985c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.29.2
speakeasybot May 10, 2023
a22bea4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.0
speakeasybot May 11, 2023
d81b2dd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.30.1
speakeasybot May 12, 2023
c19bd1f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.31.1
speakeasybot May 13, 2023
bcaa318
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.32.0
speakeasybot May 16, 2023
5ebab56
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.33.2
speakeasybot May 17, 2023
25a97b0
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.34.0
speakeasybot May 18, 2023
22820f9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.35.0
speakeasybot May 19, 2023
7c7d447
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.37.5
speakeasybot May 23, 2023
536d006
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.39.0
speakeasybot May 27, 2023
c728930
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.2
speakeasybot Jun 1, 2023
680d19e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.40.3
speakeasybot Jun 2, 2023
3d1fa54
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.43.0
speakeasybot Jun 3, 2023
e353114
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.44.2
speakeasybot Jun 7, 2023
04de404
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.0
speakeasybot Jun 8, 2023
4924d9b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.45.2
speakeasybot Jun 9, 2023
aec712b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.0
speakeasybot Jun 10, 2023
32910ce
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.1
speakeasybot Jun 11, 2023
b8da7bf
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.47.3
speakeasybot Jun 14, 2023
6ba4694
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.48.0
speakeasybot Jun 16, 2023
0f48e6d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.0
speakeasybot Jun 20, 2023
5032f17
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
75b5cd7
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
b94545c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
94e76bd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.51.3
speakeasybot Jun 29, 2023
ffe4f75
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
97bda11
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
289de30
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
645fa85
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
e13be40
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
1ede2a9
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.56.4
speakeasybot Jul 12, 2023
7fbb2bc
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
4bab67e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
a468867
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.60.0
speakeasybot Jul 17, 2023
d2c3df8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
884b055
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
06fa7a4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
786602f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
3b37583
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
14ce9b5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
a334472
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
96b2a5c
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
141acbd
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
c04a316
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
f788970
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.72.0
speakeasybot Aug 15, 2023
505c2ad
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
932c327
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.11
speakeasybot Aug 25, 2023
c3df76f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.16
speakeasybot Aug 26, 2023
194231f
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
9b218e0
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.76.1
speakeasybot Aug 31, 2023
08baec4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
39ae88e
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
b119a07
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
de126cb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
8494ee8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
0d5ccd8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
7be67d5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
30654f8
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
d801fc4
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
d5bc78d
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
f6cef74
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
55fc4bb
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
6dd769b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
45b8a1a
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.99.1
speakeasybot Oct 13, 2023
97defe5
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
f8ea07b
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
b3a1e09
ci: regenerated with OpenAPI Doc 1.0.0, Speakeay CLI 1.109.0
speakeasybot Oct 28, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions document/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This allows generated code to be indexed correctly
*.py linguist-generated=false
7 changes: 7 additions & 0 deletions document/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.python-version
.DS_Store
venv/
src/*.egg-info/
__pycache__/
.pytest_cache/
.python-version`
164 changes: 152 additions & 12 deletions document/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,38 +16,178 @@ from epilot.models import operations, shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE",
epilot_auth="",
),
)


req = operations.GenerateDocumentRequestBody(
context_entity_id="bcd0aab9-b544-42b0-8bfb-6d449d02eacc",
language="de",
context_entity_id='bcd0aab9-b544-42b0-8bfb-6d449d02eacc',
language='de',
template_document=operations.GenerateDocumentRequestBodyTemplateDocument(
filename="my-template-{{order.order_number}}.docx",
filename='my-template-{{order.order_number}}.docx',
s3ref=shared.S3Reference(
bucket="document-api-prod",
key="uploads/my-template.pdf",
bucket='document-api-prod',
key='uploads/my-template.pdf',
),
),
user_id="100321",
user_id='100321',
)

res = s.documents.generate_document(req)

if res.generate_document_200_application_json_object is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->

<!-- Start SDK Available Operations -->
## SDK Available Operations
## Available Resources and Operations


### documents
### [documents](docs/sdks/documents/README.md)

* `generate_document` - generateDocument
* [generate_document](docs/sdks/documents/README.md#generate_document) - generateDocument
* [generate_document_v2](docs/sdks/documents/README.md#generate_document_v2) - generateDocumentV2
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->

<!-- End Dev Containers -->



<!-- Start Pagination -->
# Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.

Here's an example of one such pagination call:
<!-- End Pagination -->



<!-- Start Error Handling -->
# Error Handling

Handling errors in your 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.


<!-- End Error Handling -->



<!-- Start Server Selection -->
# Server Selection

## Select Server by Index

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:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://document.sls.epilot.io` | None |

For example:


```python
import epilot
from epilot.models import operations, shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="",
),
server_idx=0
)

req = operations.GenerateDocumentRequestBody(
context_entity_id='bcd0aab9-b544-42b0-8bfb-6d449d02eacc',
language='de',
template_document=operations.GenerateDocumentRequestBodyTemplateDocument(
filename='my-template-{{order.order_number}}.docx',
s3ref=shared.S3Reference(
bucket='document-api-prod',
key='uploads/my-template.pdf',
),
),
user_id='100321',
)

res = s.documents.generate_document(req)

if res.generate_document_200_application_json_object is not None:
# handle response
pass
```


## Override Server URL Per-Client

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:


```python
import epilot
from epilot.models import operations, shared

s = epilot.Epilot(
security=shared.Security(
epilot_auth="",
),
server_url="https://document.sls.epilot.io"
)

req = operations.GenerateDocumentRequestBody(
context_entity_id='bcd0aab9-b544-42b0-8bfb-6d449d02eacc',
language='de',
template_document=operations.GenerateDocumentRequestBodyTemplateDocument(
filename='my-template-{{order.order_number}}.docx',
s3ref=shared.S3Reference(
bucket='document-api-prod',
key='uploads/my-template.pdf',
),
),
user_id='100321',
)

res = s.documents.generate_document(req)

if res.generate_document_200_application_json_object is not None:
# handle response
pass
```
<!-- End Server Selection -->



<!-- Start Custom HTTP Client -->
# Custom HTTP Client

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.


For example, you could specify a header for every request that your sdk makes as follows:

```python
import epilot
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = epilot.Epilot(client: http_client)
```


<!-- End Custom HTTP Client -->

<!-- Placeholder for Future Speakeasy SDK Sections -->



### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
Loading