Skip to content

Commit 1fc94bd

Browse files
committed
ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.23.0
1 parent f176e03 commit 1fc94bd

45 files changed

Lines changed: 1033 additions & 48 deletions

Some content is hidden

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

common/README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pip install codat-common
1212
<!-- Start SDK Example Usage -->
1313
```python
1414
import codatcommon
15-
from codatcommon.models import operations, shared
15+
from codatcommon.models import shared
1616

1717
s = codatcommon.CodatCommon(
1818
security=shared.Security(
@@ -25,7 +25,7 @@ req = shared.CompanyRequestBody(
2525
description="corrupti",
2626
name="Kelvin Sporer",
2727
)
28-
28+
2929
res = s.companies.create_company(req)
3030

3131
if res.company is not None:
@@ -37,58 +37,58 @@ if res.company is not None:
3737
## Available Resources and Operations
3838

3939

40-
### companies
40+
### [companies](docs/companies/README.md)
4141

42-
* `create_company` - Create company
43-
* `delete_company` - Delete a company
44-
* `get_company` - Get company
45-
* `list_companies` - List companies
46-
* `update_company` - Update company
42+
* [create_company](docs/companies/createcompany.md) - Create company
43+
* [delete_company](docs/companies/deletecompany.md) - Delete a company
44+
* [get_company](docs/companies/getcompany.md) - Get company
45+
* [list_companies](docs/companies/listcompanies.md) - List companies
46+
* [update_company](docs/companies/updatecompany.md) - Update company
4747

48-
### connections
48+
### [connections](docs/connections/README.md)
4949

50-
* `create_data_connection` - Create a data connection
51-
* `delete_company_connection` - Delete connection
52-
* `get_company_connection` - Get connection
53-
* `list_company_connections` - List connections
54-
* `unlink_company_connection` - Unlink connection
55-
* `update_connection_authorization` - Update authorization
50+
* [create_data_connection](docs/connections/createdataconnection.md) - Create a data connection
51+
* [delete_company_connection](docs/connections/deletecompanyconnection.md) - Delete connection
52+
* [get_company_connection](docs/connections/getcompanyconnection.md) - Get connection
53+
* [list_company_connections](docs/connections/listcompanyconnections.md) - List connections
54+
* [unlink_company_connection](docs/connections/unlinkcompanyconnection.md) - Unlink connection
55+
* [update_connection_authorization](docs/connections/updateconnectionauthorization.md) - Update authorization
5656

57-
### data_status
57+
### [data_status](docs/datastatus/README.md)
5858

59-
* `get_company_data_history` - Get pull operations
60-
* `get_company_data_status` - Get data status
61-
* `get_pull_operation` - Get pull operation
59+
* [get_company_data_history](docs/datastatus/getcompanydatahistory.md) - Get pull operations
60+
* [get_company_data_status](docs/datastatus/getcompanydatastatus.md) - Get data status
61+
* [get_pull_operation](docs/datastatus/getpulloperation.md) - Get pull operation
6262

63-
### integrations
63+
### [integrations](docs/integrations/README.md)
6464

65-
* `get_integration` - Get integration
66-
* `get_integrations_branding` - Get branding
67-
* `list_integrations` - List integrations
65+
* [get_integration](docs/integrations/getintegration.md) - Get integration
66+
* [get_integrations_branding](docs/integrations/getintegrationsbranding.md) - Get branding
67+
* [list_integrations](docs/integrations/listintegrations.md) - List integrations
6868

69-
### push_data
69+
### [push_data](docs/pushdata/README.md)
7070

71-
* `get_company_push_history` - List push operations
72-
* `get_create_update_model_options_by_data_type` - List push options
73-
* `get_push_operation` - Get push operation
71+
* [get_company_push_history](docs/pushdata/getcompanypushhistory.md) - List push operations
72+
* [get_create_update_model_options_by_data_type](docs/pushdata/getcreateupdatemodeloptionsbydatatype.md) - List push options
73+
* [get_push_operation](docs/pushdata/getpushoperation.md) - Get push operation
7474

75-
### refresh_data
75+
### [refresh_data](docs/refreshdata/README.md)
7676

77-
* `create_pull_operation` - Queue pull operation
78-
* `refresh_company_data` - Queue pull operations
77+
* [create_pull_operation](docs/refreshdata/createpulloperation.md) - Queue pull operation
78+
* [refresh_company_data](docs/refreshdata/refreshcompanydata.md) - Queue pull operations
7979

80-
### settings
80+
### [settings](docs/settings/README.md)
8181

82-
* `get_profile` - Get profile
83-
* `get_profile_sync_settings` - Get sync settings
84-
* `update_profile` - Update profile
85-
* `update_sync_settings` - Update all sync settings
82+
* [get_profile](docs/settings/getprofile.md) - Get profile
83+
* [get_profile_sync_settings](docs/settings/getprofilesyncsettings.md) - Get sync settings
84+
* [update_profile](docs/settings/updateprofile.md) - Update profile
85+
* [update_sync_settings](docs/settings/updatesyncsettings.md) - Update all sync settings
8686

87-
### webhooks
87+
### [webhooks](docs/webhooks/README.md)
8888

89-
* `create_rule` - Create webhook
90-
* `get_webhook` - Get webhook
91-
* `list_rules` - List webhooks
89+
* [create_rule](docs/webhooks/createrule.md) - Create webhook
90+
* [get_webhook](docs/webhooks/getwebhook.md) - Get webhook
91+
* [list_rules](docs/webhooks/listrules.md) - List webhooks
9292
<!-- End SDK Available Operations -->
9393

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

common/RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,4 +182,12 @@ Based on:
182182
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
183183
- Speakeasy CLI 1.20.1 (2.18.1) https://github.com/speakeasy-api/speakeasy
184184
### Releases
185-
- [PyPI v0.8.1] https://pypi.org/project/codat-common/0.8.1 - common
185+
- [PyPI v0.8.1] https://pypi.org/project/codat-common/0.8.1 - common
186+
187+
## 2023-04-25 07:57:44
188+
### Changes
189+
Based on:
190+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
191+
- Speakeasy CLI 1.23.0 (2.21.0) https://github.com/speakeasy-api/speakeasy
192+
### Releases
193+
- [PyPI v0.9.0] https://pypi.org/project/codat-common/0.9.0 - common

common/USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- Start SDK Example Usage -->
22
```python
33
import codatcommon
4-
from codatcommon.models import operations, shared
4+
from codatcommon.models import shared
55

66
s = codatcommon.CodatCommon(
77
security=shared.Security(
@@ -14,7 +14,7 @@ req = shared.CompanyRequestBody(
1414
description="corrupti",
1515
name="Kelvin Sporer",
1616
)
17-
17+
1818
res = s.companies.create_company(req)
1919

2020
if res.company is not None:

common/docs/codatcommon/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CodatCommon SDK
2+
3+
An API for the common components of all of Codat's products.
4+
5+
These end points cover creating and managing your companies, data connections, and integrations.
6+
7+
[Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies)
8+
9+
[See our OpenAPI spec](https://github.com/codatio/oas)
10+

common/docs/companies/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# companies
2+
3+
Create and manage your Codat companies.
4+
5+
6+
* [create_company](createcompany.md) - Create company
7+
* [delete_company](deletecompany.md) - Delete a company
8+
* [get_company](getcompany.md) - Get company
9+
* [list_companies](listcompanies.md) - List companies
10+
* [update_company](updatecompany.md) - Update company
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# create_company
2+
Available in: `companies`
3+
4+
Create a new company
5+
6+
## Example Usage
7+
```python
8+
import codatcommon
9+
from codatcommon.models import shared
10+
11+
s = codatcommon.CodatCommon(
12+
security=shared.Security(
13+
auth_header="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = shared.CompanyRequestBody(
19+
description="corrupti",
20+
name="Ben Mueller",
21+
)
22+
23+
res = s.companies.create_company(req)
24+
25+
if res.company is not None:
26+
# handle response
27+
```
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# delete_company
2+
Available in: `companies`
3+
4+
Delete the given company from Codat.
5+
This operation is not reversible.
6+
7+
## Example Usage
8+
```python
9+
import codatcommon
10+
from codatcommon.models import operations
11+
12+
s = codatcommon.CodatCommon(
13+
security=shared.Security(
14+
auth_header="YOUR_API_KEY_HERE",
15+
),
16+
)
17+
18+
19+
req = operations.DeleteCompanyRequest(
20+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
21+
)
22+
23+
res = s.companies.delete_company(req)
24+
25+
if res.status_code == 200:
26+
# handle response
27+
```
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# get_company
2+
Available in: `companies`
3+
4+
Get metadata for a single company
5+
6+
## Example Usage
7+
```python
8+
import codatcommon
9+
from codatcommon.models import operations
10+
11+
s = codatcommon.CodatCommon(
12+
security=shared.Security(
13+
auth_header="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = operations.GetCompanyRequest(
19+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
20+
)
21+
22+
res = s.companies.get_company(req)
23+
24+
if res.company is not None:
25+
# handle response
26+
```
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# list_companies
2+
Available in: `companies`
3+
4+
List all companies that you have created in Codat.
5+
6+
## Example Usage
7+
```python
8+
import codatcommon
9+
from codatcommon.models import operations
10+
11+
s = codatcommon.CodatCommon(
12+
security=shared.Security(
13+
auth_header="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = operations.ListCompaniesRequest(
19+
order_by="-modifiedDate",
20+
page=1,
21+
page_size=100,
22+
query="iure",
23+
)
24+
25+
res = s.companies.list_companies(req)
26+
27+
if res.companies is not None:
28+
# handle response
29+
```
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# update_company
2+
Available in: `companies`
3+
4+
Updates the given company with a new name and description
5+
6+
## Example Usage
7+
```python
8+
import codatcommon
9+
from codatcommon.models import operations, shared
10+
11+
s = codatcommon.CodatCommon(
12+
security=shared.Security(
13+
auth_header="YOUR_API_KEY_HERE",
14+
),
15+
)
16+
17+
18+
req = operations.UpdateCompanyRequest(
19+
company_request_body=shared.CompanyRequestBody(
20+
description="magnam",
21+
name="Larry Windler",
22+
),
23+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
24+
)
25+
26+
res = s.companies.update_company(req)
27+
28+
if res.company is not None:
29+
# handle response
30+
```

0 commit comments

Comments
 (0)