Skip to content

Commit b6d5763

Browse files
dcoplowedcoplowe
authored
Merge pull request #459 from codatio/speakeasy-sdk-regen-1697551952
chore: speakeasy sdk regeneration - Generate Files library
2 parents 568a534 + 763c6be commit b6d5763

35 files changed

+566
-211
lines changed

‎previous-versions/files/README.md‎

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,56 @@
66
Use Codat's Files API to upload your SMB customers' files.
77

88
<!-- Start SDK Installation -->
9-
replace me
9+
## SDK Installation
10+
11+
```bash
12+
pip install codat-files
13+
```
1014
<!-- End SDK Installation -->
1115

1216
## Example Usage
1317
<!-- Start SDK Example Usage -->
14-
replace me
18+
```python
19+
import codatfiles
20+
from codatfiles.models import operations, shared
21+
22+
s = codatfiles.CodatFiles(
23+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
24+
)
25+
26+
req = operations.DownloadFilesRequest(
27+
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
28+
date_='2022-10-23T00:00:00.000Z',
29+
)
30+
31+
res = s.files.download_files(req)
32+
33+
if res.data is not None:
34+
# handle response
35+
pass
36+
```
1537
<!-- End SDK Example Usage -->
1638

1739
<!-- Start SDK Available Operations -->
18-
replace me
40+
## Available Resources and Operations
41+
42+
43+
### [files](docs/sdks/files/README.md)
44+
45+
* [download_files](docs/sdks/files/README.md#download_files) - Download all files for a company
46+
* [list_files](docs/sdks/files/README.md#list_files) - List all files uploaded by a company
47+
* [upload_files](docs/sdks/files/README.md#upload_files) - Upload files for a company
1948
<!-- End SDK Available Operations -->
49+
50+
51+
52+
<!-- Start Dev Containers -->
53+
54+
55+
56+
<!-- End Dev Containers -->
57+
58+
<!-- Placeholder for Future Speakeasy SDK Sections -->
59+
60+
2061
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎previous-versions/files/RELEASES.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
3+
## 2023-10-17 14:12:27
4+
### Changes
5+
Based on:
6+
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Files.yaml
7+
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
8+
### Generated
9+
- [python v0.1.0] previous-versions/files
10+
### Releases
11+
- [PyPI v0.1.0] https://pypi.org/project/codat-files/0.1.0 - previous-versions/files

‎previous-versions/files/USAGE.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ import codatfiles
66
from codatfiles.models import operations, shared
77

88
s = codatfiles.CodatFiles(
9-
security=shared.Security(
10-
auth_header="Basic BASE_64_ENCODED(API_KEY)",
11-
),
9+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
1210
)
1311

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

2119
if res.data is not None:
2220
# handle response
21+
pass
2322
```
2423
<!-- End SDK Example Usage -->

‎previous-versions/files/docs/models/operations/downloadfileserrormessage.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# DownloadFilesErrorMessage
2+
3+
One or more of the resources you referenced could not be found.
4+
This might be because your company or data connection id is wrong, or was already deleted.
5+
6+
7+
## Fields
8+
9+
| Field | Type | Required | Description |
10+
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
11+
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
12+
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
13+
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
14+
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
15+
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
16+
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |

‎previous-versions/files/docs/models/operations/downloadfilesrequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55

66
| Field | Type | Required | Description | Example |
77
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
8-
| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
8+
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
99
| `date_` | *Optional[str]* | :heavy_minus_sign: | Only download files uploaded on this date. | 2022-10-23T00:00:00.000Z |

‎previous-versions/files/docs/models/operations/downloadfilesresponse.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description |
7-
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8-
| `content_type` | *str* | :heavy_check_mark: | N/A |
9-
| `data` | *Optional[bytes]* | :heavy_minus_sign: | Success |
10-
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. |
11-
| `status_code` | *int* | :heavy_check_mark: | N/A |
12-
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
6+
| Field | Type | Required | Description |
7+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `data` | *Optional[requests_http.Response]* | :heavy_minus_sign: | Success |
10+
| `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. |
11+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
12+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
13+
| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | The request made is not valid. |

‎previous-versions/files/docs/models/operations/listfileserrormessage.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# ListFilesErrorMessage
2+
3+
One or more of the resources you referenced could not be found.
4+
This might be because your company or data connection id is wrong, or was already deleted.
5+
6+
7+
## Fields
8+
9+
| Field | Type | Required | Description |
10+
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
11+
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
12+
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
13+
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
14+
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
15+
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
16+
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |

‎previous-versions/files/docs/models/operations/listfilesrequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55

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

0 commit comments

Comments
 (0)