Skip to content

chore: speakeasy sdk regeneration - Generate Files library #459

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 17, 2023
Merged

chore: speakeasy sdk regeneration - Generate Files library #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 44 additions & 3 deletions previous-versions/files/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,56 @@
Use Codat's Files API to upload your SMB customers' files.

<!-- Start SDK Installation -->
replace me
## SDK Installation

```bash
pip install codat-files
```
<!-- End SDK Installation -->

## Example Usage
<!-- Start SDK Example Usage -->
replace me
```python
import codatfiles
from codatfiles.models import operations, shared

s = codatfiles.CodatFiles(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

req = operations.DownloadFilesRequest(
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
date_='2022-10-23T00:00:00.000Z',
)

res = s.files.download_files(req)

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

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


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

* [download_files](docs/sdks/files/README.md#download_files) - Download all files for a company
* [list_files](docs/sdks/files/README.md#list_files) - List all files uploaded by a company
* [upload_files](docs/sdks/files/README.md#upload_files) - Upload files for a company
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->



<!-- End Dev Containers -->

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


### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
11 changes: 11 additions & 0 deletions previous-versions/files/RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@


## 2023-10-17 14:12:27
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Files.yaml
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.1.0] previous-versions/files
### Releases
- [PyPI v0.1.0] https://pypi.org/project/codat-files/0.1.0 - previous-versions/files
5 changes: 2 additions & 3 deletions previous-versions/files/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ import codatfiles
from codatfiles.models import operations, shared

s = codatfiles.CodatFiles(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

req = operations.DownloadFilesRequest(
Expand All @@ -20,5 +18,6 @@ res = s.files.download_files(req)

if res.data is not None:
# handle response
pass
```
<!-- End SDK Example Usage -->
16 changes: 16 additions & 0 deletions previous-versions/files/docs/models/operations/downloadfileserrormessage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# DownloadFilesErrorMessage

One or more of the resources you referenced could not be found.
This might be because your company or data connection id is wrong, or was already deleted.


## Fields

| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
2 changes: 1 addition & 1 deletion previous-versions/files/docs/models/operations/downloadfilesrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

| Field | Type | Required | Description | Example |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `date_` | *Optional[str]* | :heavy_minus_sign: | Only download files uploaded on this date. | 2022-10-23T00:00:00.000Z |
15 changes: 8 additions & 7 deletions previous-versions/files/docs/models/operations/downloadfilesresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | N/A |
| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success |
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. |
| `status_code` | *int* | :heavy_check_mark: | N/A |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success |
| `error_message` | [Optional[DownloadFilesErrorMessage]](../../models/operations/downloadfileserrormessage.md) | :heavy_minus_sign: | One or more of the resources you referenced could not be found.<br/>This might be because your company or data connection id is wrong, or was already deleted. |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | The request made is not valid. |
16 changes: 16 additions & 0 deletions previous-versions/files/docs/models/operations/listfileserrormessage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# ListFilesErrorMessage

One or more of the resources you referenced could not be found.
This might be because your company or data connection id is wrong, or was already deleted.


## Fields

| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
2 changes: 1 addition & 1 deletion previous-versions/files/docs/models/operations/listfilesrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
Loading