Skip to content

Commit 568a534

Browse files
dcoplowedcoplowe
authored
Merge pull request #460 from codatio/speakeasy-sdk-regen-1697551944
chore: speakeasy sdk regeneration - Generate Common library
2 parents d3e170c + 07dd8fc commit 568a534

File tree

284 files changed

+2240
-1519
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

284 files changed

+2240
-1519
lines changed

‎previous-versions/common/README.md‎

Lines changed: 96 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,108 @@ Manage the building blocks of Codat, including companies, connections, and more.
55
<!-- End Codat Library Description -->
66

77
<!-- Start SDK Installation -->
8-
replace me
8+
## SDK Installation
9+
10+
```bash
11+
pip install codat-common
12+
```
913
<!-- End SDK Installation -->
1014

1115
## Example Usage
1216
<!-- Start SDK Example Usage -->
13-
replace me
17+
```python
18+
import codatcommon
19+
from codatcommon.models import shared
20+
21+
s = codatcommon.CodatCommon(
22+
auth_header="",
23+
)
24+
25+
req = shared.CompanyRequestBody(
26+
description='Requested early access to the new financing scheme.',
27+
name='Bank of Dave',
28+
)
29+
30+
res = s.companies.create(req)
31+
32+
if res.company is not None:
33+
# handle response
34+
pass
35+
```
1436
<!-- End SDK Example Usage -->
1537

1638
<!-- Start SDK Available Operations -->
17-
replace me
39+
## Available Resources and Operations
40+
41+
42+
### [companies](docs/sdks/companies/README.md)
43+
44+
* [create](docs/sdks/companies/README.md#create) - Create company
45+
* [delete](docs/sdks/companies/README.md#delete) - Delete a company
46+
* [get](docs/sdks/companies/README.md#get) - Get company
47+
* [list](docs/sdks/companies/README.md#list) - List companies
48+
* [update](docs/sdks/companies/README.md#update) - Update company
49+
50+
### [connections](docs/sdks/connections/README.md)
51+
52+
* [create](docs/sdks/connections/README.md#create) - Create connection
53+
* [delete](docs/sdks/connections/README.md#delete) - Delete connection
54+
* [get](docs/sdks/connections/README.md#get) - Get connection
55+
* [list](docs/sdks/connections/README.md#list) - List connections
56+
* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection
57+
* [update_authorization](docs/sdks/connections/README.md#update_authorization) - Update authorization
58+
59+
### [integrations](docs/sdks/integrations/README.md)
60+
61+
* [get](docs/sdks/integrations/README.md#get) - Get integration
62+
* [get_branding](docs/sdks/integrations/README.md#get_branding) - Get branding
63+
* [list](docs/sdks/integrations/README.md#list) - List integrations
64+
65+
### [push_data](docs/sdks/pushdata/README.md)
66+
67+
* [get_model_options](docs/sdks/pushdata/README.md#get_model_options) - Get push options
68+
* [get_operation](docs/sdks/pushdata/README.md#get_operation) - Get push operation
69+
* [list_operations](docs/sdks/pushdata/README.md#list_operations) - List push operations
70+
71+
### [refresh_data](docs/sdks/refreshdata/README.md)
72+
73+
* [all](docs/sdks/refreshdata/README.md#all) - Refresh all data
74+
* [by_data_type](docs/sdks/refreshdata/README.md#by_data_type) - Refresh data type
75+
* [get](docs/sdks/refreshdata/README.md#get) - Get data status
76+
* [get_pull_operation](docs/sdks/refreshdata/README.md#get_pull_operation) - Get pull operation
77+
* [list_pull_operations](docs/sdks/refreshdata/README.md#list_pull_operations) - List pull operations
78+
79+
### [settings](docs/sdks/settings/README.md)
80+
81+
* [create_api_key](docs/sdks/settings/README.md#create_api_key) - Create API key
82+
* [delete_api_key](docs/sdks/settings/README.md#delete_api_key) - Delete API key
83+
* [~~get_profile~~](docs/sdks/settings/README.md#get_profile) - Get profile :warning: **Deprecated**
84+
* [get_sync_settings](docs/sdks/settings/README.md#get_sync_settings) - Get sync settings
85+
* [list_api_keys](docs/sdks/settings/README.md#list_api_keys) - List API keys
86+
* [update_profile](docs/sdks/settings/README.md#update_profile) - Update profile
87+
* [update_sync_settings](docs/sdks/settings/README.md#update_sync_settings) - Update all sync settings
88+
89+
### [supplemental_data](docs/sdks/supplementaldata/README.md)
90+
91+
* [configure](docs/sdks/supplementaldata/README.md#configure) - Configure
92+
* [get_configuration](docs/sdks/supplementaldata/README.md#get_configuration) - Get configuration
93+
94+
### [webhooks](docs/sdks/webhooks/README.md)
95+
96+
* [create](docs/sdks/webhooks/README.md#create) - Create webhook
97+
* [get](docs/sdks/webhooks/README.md#get) - Get webhook
98+
* [list](docs/sdks/webhooks/README.md#list) - List webhooks
1899
<!-- End SDK Available Operations -->
100+
101+
102+
103+
<!-- Start Dev Containers -->
104+
105+
106+
107+
<!-- End Dev Containers -->
108+
109+
<!-- Placeholder for Future Speakeasy SDK Sections -->
110+
111+
19112
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎previous-versions/common/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:18
4+
### Changes
5+
Based on:
6+
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
7+
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
8+
### Generated
9+
- [python v0.34.0] previous-versions/common
10+
### Releases
11+
- [PyPI v0.34.0] https://pypi.org/project/codat-common/0.34.0 - previous-versions/common

‎previous-versions/common/USAGE.md‎

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

88
s = codatcommon.CodatCommon(
9-
security=shared.Security(
10-
auth_header="",
11-
),
9+
auth_header="",
1210
)
1311

1412
req = shared.CompanyRequestBody(
@@ -20,5 +18,6 @@ res = s.companies.create(req)
2018

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

‎previous-versions/common/docs/models/operations/configuresupplementaldatarequest.md‎

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

44
## Fields
55

6-
| Field | Type | Required | Description | Example |
7-
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
8-
| `supplemental_data_configuration` | [Optional[shared.SupplementalDataConfiguration]](../../models/shared/supplementaldataconfiguration.md) | :heavy_minus_sign: | The configuration for the specified platform and data type. | |
9-
| `data_type` | [ConfigureSupplementalDataDataType](../../models/operations/configuresupplementaldatadatatype.md) | :heavy_check_mark: | Data types that support supplemental data | invoices |
10-
| `platform_key` | *str* | :heavy_check_mark: | N/A | |
6+
| Field | Type | Required | Description | Example |
7+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8+
| `supplemental_data_configuration` | [Optional[shared.SupplementalDataConfiguration]](../../models/shared/supplementaldataconfiguration.md) | :heavy_minus_sign: | The configuration for the specified platform and data type. | |
9+
| `data_type` | [ConfigureSupplementalDataDataType](../../models/operations/configuresupplementaldatadatatype.md) | :heavy_check_mark: | Supported supplemental data data type. | invoices |
10+
| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol |

‎previous-versions/common/docs/models/operations/configuresupplementaldataresponse.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8-
| `content_type` | *str* | :heavy_check_mark: | N/A |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
99
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
10-
| `status_code` | *int* | :heavy_check_mark: | N/A |
11-
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
10+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

0 commit comments

Comments
 (0)