Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
c198fda
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.19.3
speakeasybot Apr 1, 2023
1a9667b
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.19.6
speakeasybot Apr 6, 2023
fcac3a4
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.19.7
speakeasybot Apr 12, 2023
8a0e186
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.20.0
speakeasybot Apr 14, 2023
1f78996
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.20.1
speakeasybot Apr 18, 2023
1b2604f
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.20.2
speakeasybot Apr 19, 2023
81a4661
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.21.4
speakeasybot Apr 21, 2023
4c1fd84
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.22.1
speakeasybot Apr 22, 2023
8dbe765
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.23.1
speakeasybot Apr 26, 2023
b430d67
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.25.1
speakeasybot Apr 27, 2023
9a7a78c
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.26.2
speakeasybot Apr 28, 2023
51ae370
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.26.4
speakeasybot Apr 29, 2023
858a3e1
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.26.5
speakeasybot May 2, 2023
be7e51d
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.27.0
speakeasybot May 3, 2023
53dd2d8
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.29.0
speakeasybot May 5, 2023
f58c8b8
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.29.1
speakeasybot May 6, 2023
203a608
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.29.2
speakeasybot May 10, 2023
f559102
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.30.0
speakeasybot May 11, 2023
1f9b674
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.30.1
speakeasybot May 12, 2023
d322114
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.31.1
speakeasybot May 13, 2023
8e3130f
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.32.0
speakeasybot May 16, 2023
a6f8200
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.33.2
speakeasybot May 17, 2023
8bddfb0
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.34.0
speakeasybot May 18, 2023
4d68b6c
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.35.0
speakeasybot May 19, 2023
35f2e02
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.37.5
speakeasybot May 23, 2023
50cc476
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.39.0
speakeasybot May 27, 2023
b515b09
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.40.2
speakeasybot Jun 1, 2023
d82db2b
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.40.3
speakeasybot Jun 2, 2023
11dda57
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.43.0
speakeasybot Jun 3, 2023
de7afd1
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.44.2
speakeasybot Jun 7, 2023
82bd786
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.45.0
speakeasybot Jun 8, 2023
b40dd3e
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.45.2
speakeasybot Jun 9, 2023
c525942
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.47.0
speakeasybot Jun 10, 2023
b6190a8
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.47.1
speakeasybot Jun 11, 2023
757dfde
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.47.3
speakeasybot Jun 14, 2023
d7d7a82
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.48.0
speakeasybot Jun 16, 2023
d5413a7
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.49.0
speakeasybot Jun 20, 2023
b47f251
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.49.1
speakeasybot Jun 21, 2023
ef5406c
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.50.1
speakeasybot Jun 23, 2023
dfa87ad
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.51.1
speakeasybot Jun 27, 2023
3b866c3
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.51.3
speakeasybot Jun 29, 2023
30f46c3
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.52.0
speakeasybot Jul 1, 2023
3661663
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.52.2
speakeasybot Jul 6, 2023
536935c
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.53.0
speakeasybot Jul 7, 2023
a2c7f91
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.53.1
speakeasybot Jul 8, 2023
65d5043
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.56.0
speakeasybot Jul 11, 2023
4f71cdd
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.56.4
speakeasybot Jul 12, 2023
6689ff1
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.57.0
speakeasybot Jul 13, 2023
5bc6ccf
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.59.0
speakeasybot Jul 14, 2023
5462d63
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.60.0
speakeasybot Jul 17, 2023
6cb686b
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.61.0
speakeasybot Jul 18, 2023
72a1546
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.62.1
speakeasybot Jul 19, 2023
afe9ecf
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.64.0
speakeasybot Jul 22, 2023
312243b
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.65.0
speakeasybot Jul 26, 2023
3b55a52
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.65.1
speakeasybot Jul 27, 2023
ec87bf7
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.65.2
speakeasybot Jul 28, 2023
2d69153
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.66.1
speakeasybot Aug 1, 2023
f74dcf5
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.68.1
speakeasybot Aug 3, 2023
36a952f
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.68.3
speakeasybot Aug 4, 2023
d989aaf
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.69.1
speakeasybot Aug 8, 2023
ca7aec2
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.71.0
speakeasybot Aug 11, 2023
ba80c0b
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.72.0
speakeasybot Aug 15, 2023
41d7a43
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.3
speakeasybot Aug 19, 2023
4f71e86
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.6
speakeasybot Aug 22, 2023
1722464
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.7
speakeasybot Aug 23, 2023
70d3f59
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.11
speakeasybot Aug 25, 2023
dfbcc6f
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.16
speakeasybot Aug 26, 2023
a3d7237
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.74.17
speakeasybot Aug 29, 2023
f481a8a
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.76.1
speakeasybot Aug 31, 2023
95b6784
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.77.0
speakeasybot Sep 1, 2023
ad236e2
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.77.2
speakeasybot Sep 2, 2023
8e6db99
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.78.3
speakeasybot Sep 5, 2023
35ab229
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.82.5
speakeasybot Sep 12, 2023
de55d35
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.86.0
speakeasybot Sep 16, 2023
2d1e751
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.88.0
speakeasybot Sep 20, 2023
ae846a9
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.91.0
speakeasybot Sep 26, 2023
1f32a85
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.91.2
speakeasybot Sep 27, 2023
6f51aea
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.91.3
speakeasybot Sep 29, 2023
a4c3d95
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.92.2
speakeasybot Oct 1, 2023
d656542
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.92.3
speakeasybot Oct 2, 2023
9219b77
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.94.0
speakeasybot Oct 5, 2023
3cd3d2d
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.96.1
speakeasybot Oct 7, 2023
4cd4ff8
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.99.1
speakeasybot Oct 13, 2023
e82718f
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.101.0
speakeasybot Oct 18, 2023
94abcd3
ci: regenerated with OpenAPI Doc 0.1.0, Speakeay CLI 1.104.0
speakeasybot Oct 21, 2023
05e21bc
ci: regenerated with OpenAPI Doc 0.1.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 file/.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 file/.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`
167 changes: 151 additions & 16 deletions file/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,43 +12,178 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=file
<!-- Start SDK Example Usage -->
```python
import epilot
from epilot.models import operations, shared
from epilot.models import shared

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


req = shared.DeleteFilePayload(
s3ref=shared.S3Reference(
bucket="epilot-files-prod",
key="123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
bucket='epilot-files-prod',
key='123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
),
)

res = s.files.delete_file(req)

if res.status_code == 200:
# handle response
pass
```
<!-- End SDK Example Usage -->

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


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

### files
* [delete_file](docs/sdks/files/README.md#delete_file) - deleteFile
* [download_file](docs/sdks/files/README.md#download_file) - downloadFile
* [download_files](docs/sdks/files/README.md#download_files) - downloadFiles
* [download_s3_file](docs/sdks/files/README.md#download_s3_file) - downloadS3File
* [preview_file](docs/sdks/files/README.md#preview_file) - previewFile
* [preview_public_file](docs/sdks/files/README.md#preview_public_file) - previewPublicFile
* [preview_s3_file](docs/sdks/files/README.md#preview_s3_file) - previewS3File
* [preview_s3_file_get](docs/sdks/files/README.md#preview_s3_file_get) - previewS3FileGet
* [save_file](docs/sdks/files/README.md#save_file) - saveFile
* [upload_file](docs/sdks/files/README.md#upload_file) - uploadFile
* [upload_file_public](docs/sdks/files/README.md#upload_file_public) - uploadFilePublic

* `delete_file` - deleteFile
* `download_file` - downloadFile
* `download_s3_file` - downloadS3File
* `preview_file` - previewFile
* `preview_s3_file` - previewS3File
* `save_file` - saveFile
* `upload_file` - uploadFile
* `upload_file_public` - uploadFilePublic
### [session](docs/sdks/session/README.md)

* [delete_session](docs/sdks/session/README.md#delete_session) - deleteSession
* [get_session](docs/sdks/session/README.md#get_session) - getSession
<!-- 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://file.sls.epilot.io` | None |

For example:


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

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

req = shared.DeleteFilePayload(
s3ref=shared.S3Reference(
bucket='epilot-files-prod',
key='123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
),
)

res = s.files.delete_file(req)

if res.status_code == 200:
# 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 shared

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

req = shared.DeleteFilePayload(
s3ref=shared.S3Reference(
bucket='epilot-files-prod',
key='123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
),
)

res = s.files.delete_file(req)

if res.status_code == 200:
# 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