Skip to content

Commit 2fb78eb

Browse files
dcoplowedcoplowe
authored
Merge pull request #92 from codatio/speakeasy-sdk-regen-1682409465
chore: speakeasy sdk regeneration - Generate Common SDK
2 parents dbcfabd + 0881698 commit 2fb78eb

31 files changed

Lines changed: 1172 additions & 272 deletions

‎common/README.md‎

Lines changed: 39 additions & 40 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,8 +25,8 @@ req = shared.CompanyRequestBody(
2525
description="corrupti",
2626
name="Kelvin Sporer",
2727
)
28-
29-
res = s.companies.create_company(req)
28+
29+
res = s.companies.create(req)
3030

3131
if res.company is not None:
3232
# handle response
@@ -37,58 +37,57 @@ 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](docs/companies/README.md#create) - Create company
43+
* [delete](docs/companies/README.md#delete) - Delete a company
44+
* [get](docs/companies/README.md#get) - Get company
45+
* [list](docs/companies/README.md#list) - List companies
46+
* [update](docs/companies/README.md#update) - 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](docs/connections/README.md#create) - Create connection
51+
* [delete](docs/connections/README.md#delete) - Delete connection
52+
* [get](docs/connections/README.md#get) - Get connection
53+
* [list](docs/connections/README.md#list) - List connections
54+
* [unlink_connection](docs/connections/README.md#unlink_connection) - Unlink connection
55+
* [update_authorization](docs/connections/README.md#update_authorization) - 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](docs/datastatus/README.md#get) - Get data status
60+
* [get_pull_operation](docs/datastatus/README.md#get_pull_operation) - Get pull operation
61+
* [list_pull_operations](docs/datastatus/README.md#list_pull_operations) - Get pull operations
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](docs/integrations/README.md#get) - Get integration
66+
* [get_branding](docs/integrations/README.md#get_branding) - Get branding
67+
* [list](docs/integrations/README.md#list) - 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_model_options](docs/pushdata/README.md#get_model_options) - Get push options
72+
* [get_operation](docs/pushdata/README.md#get_operation) - Get push operation
73+
* [list_operations](docs/pushdata/README.md#list_operations) - List push operations
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+
* [all](docs/refreshdata/README.md#all) - Queue pull operations
78+
* [by_data_type](docs/refreshdata/README.md#by_data_type) - Queue pull operation
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/README.md#get_profile) - Get profile
83+
* [get_sync_settings](docs/settings/README.md#get_sync_settings) - Update all sync settings
84+
* [update_profile](docs/settings/README.md#update_profile) - Update profile
8685

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

89-
* `create_rule` - Create webhook
90-
* `get_webhook` - Get webhook
91-
* `list_rules` - List webhooks
88+
* [create](docs/webhooks/README.md#create) - Create webhook
89+
* [get](docs/webhooks/README.md#get) - Get webhook
90+
* [list](docs/webhooks/README.md#list) - List webhooks
9291
<!-- End SDK Available Operations -->
9392

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

‎common/RELEASES.md‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,4 +182,28 @@ 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
194+
195+
## 2023-04-25 14:17:47
196+
### Changes
197+
Based on:
198+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
199+
- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
200+
### Releases
201+
- [PyPI v0.9.1] https://pypi.org/project/codat-common/0.9.1 - common
202+
203+
## 2023-04-26 14:59:32
204+
### Changes
205+
Based on:
206+
- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Common.yaml
207+
- Speakeasy CLI 1.25.1 (2.22.0) https://github.com/speakeasy-api/speakeasy
208+
### Releases
209+
- [PyPI v0.10.0] https://pypi.org/project/codat-common/0.10.0 - common

‎common/USAGE.md‎

Lines changed: 3 additions & 3 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,8 +14,8 @@ req = shared.CompanyRequestBody(
1414
description="corrupti",
1515
name="Kelvin Sporer",
1616
)
17-
18-
res = s.companies.create_company(req)
17+
18+
res = s.companies.create(req)
1919

2020
if res.company is not None:
2121
# handle response

‎common/docs/codatcommon/README.md‎

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

‎common/docs/companies/README.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# companies
2+
3+
## Overview
4+
5+
Create and manage your Codat companies.
6+
7+
### Available Operations
8+
9+
* [create](#create) - Create company
10+
* [delete](#delete) - Delete a company
11+
* [get](#get) - Get company
12+
* [list](#list) - List companies
13+
* [update](#update) - Update company
14+
15+
## create
16+
17+
Create a new company
18+
19+
### Example Usage
20+
21+
```python
22+
import codatcommon
23+
from codatcommon.models import shared
24+
25+
s = codatcommon.CodatCommon(
26+
security=shared.Security(
27+
auth_header="YOUR_API_KEY_HERE",
28+
),
29+
)
30+
31+
32+
req = shared.CompanyRequestBody(
33+
description="corrupti",
34+
name="Ben Mueller",
35+
)
36+
37+
res = s.companies.create(req)
38+
39+
if res.company is not None:
40+
# handle response
41+
```
42+
43+
## delete
44+
45+
Delete the given company from Codat.
46+
This operation is not reversible.
47+
48+
### Example Usage
49+
50+
```python
51+
import codatcommon
52+
from codatcommon.models import operations
53+
54+
s = codatcommon.CodatCommon(
55+
security=shared.Security(
56+
auth_header="YOUR_API_KEY_HERE",
57+
),
58+
)
59+
60+
61+
req = operations.DeleteCompanyRequest(
62+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
63+
)
64+
65+
res = s.companies.delete(req)
66+
67+
if res.status_code == 200:
68+
# handle response
69+
```
70+
71+
## get
72+
73+
Get metadata for a single company
74+
75+
### Example Usage
76+
77+
```python
78+
import codatcommon
79+
from codatcommon.models import operations
80+
81+
s = codatcommon.CodatCommon(
82+
security=shared.Security(
83+
auth_header="YOUR_API_KEY_HERE",
84+
),
85+
)
86+
87+
88+
req = operations.GetCompanyRequest(
89+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
90+
)
91+
92+
res = s.companies.get(req)
93+
94+
if res.company is not None:
95+
# handle response
96+
```
97+
98+
## list
99+
100+
List all companies that you have created in Codat.
101+
102+
### Example Usage
103+
104+
```python
105+
import codatcommon
106+
from codatcommon.models import operations
107+
108+
s = codatcommon.CodatCommon(
109+
security=shared.Security(
110+
auth_header="YOUR_API_KEY_HERE",
111+
),
112+
)
113+
114+
115+
req = operations.ListCompaniesRequest(
116+
order_by="-modifiedDate",
117+
page=1,
118+
page_size=100,
119+
query="iure",
120+
)
121+
122+
res = s.companies.list(req)
123+
124+
if res.companies is not None:
125+
# handle response
126+
```
127+
128+
## update
129+
130+
Updates the given company with a new name and description
131+
132+
### Example Usage
133+
134+
```python
135+
import codatcommon
136+
from codatcommon.models import operations, shared
137+
138+
s = codatcommon.CodatCommon(
139+
security=shared.Security(
140+
auth_header="YOUR_API_KEY_HERE",
141+
),
142+
)
143+
144+
145+
req = operations.UpdateCompanyRequest(
146+
company_request_body=shared.CompanyRequestBody(
147+
description="magnam",
148+
name="Larry Windler",
149+
),
150+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
151+
)
152+
153+
res = s.companies.update(req)
154+
155+
if res.company is not None:
156+
# handle response
157+
```

0 commit comments

Comments
 (0)