Skip to content

Commit e4bb860

Browse files
dcoplowedcoplowe
authored
Merge pull request #100 from codatio/speakeasy-sdk-regen-1682521186
chore: speakeasy sdk regeneration - Generate Sync Commerce SDK
2 parents f176e03 + 217b704 commit e4bb860

File tree

91 files changed

+1181
-262
lines changed

Some content is hidden

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

91 files changed

+1181
-262
lines changed

‎synccommerce/README.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ Embedded accounting integrations for POS and eCommerce platforms.
66
## SDK Installation
77

88
```bash
9-
pip install codat-synccommerce
9+
pip install codat-sync-for-commerce
1010
```
1111
<!-- End SDK Installation -->
1212

1313
## SDK Example Usage
1414
<!-- Start SDK Example Usage -->
1515
```python
16-
import codat
17-
from codat.models import operations, shared
16+
import codatsynccommerce
17+
from codatsynccommerce.models import shared
1818

19-
s = codat.Codat(
19+
s = codatsynccommerce.CodatSyncCommerce(
2020
security=shared.Security(
2121
auth_header="YOUR_API_KEY_HERE",
2222
),
@@ -26,7 +26,7 @@ s = codat.Codat(
2626
req = shared.CreateCompany(
2727
name="Bob's Burgers",
2828
)
29-
29+
3030
res = s.company_management.create_company(req)
3131

3232
if res.company is not None:
@@ -38,37 +38,37 @@ if res.company is not None:
3838
## Available Resources and Operations
3939

4040

41-
### company_management
41+
### [company_management](docs/companymanagement/README.md)
4242

43-
* `create_company` - Create a sync for commerce company
44-
* `create_connection` - Create a data connection
45-
* `list_companies` - List companies
46-
* `list_connections` - List data connections
47-
* `update_connection` - Update data connection
43+
* [create_company](docs/companymanagement/README.md#create_company) - Create Sync for Commerce company
44+
* [create_connection](docs/companymanagement/README.md#create_connection) - Create connection
45+
* [list_companies](docs/companymanagement/README.md#list_companies) - List companies
46+
* [list_connections](docs/companymanagement/README.md#list_connections) - List data connections
47+
* [update_connection](docs/companymanagement/README.md#update_connection) - Update data connection
4848

49-
### configuration
49+
### [configuration](docs/configuration/README.md)
5050

51-
* `get_configuration` - Retrieve config preferences set for a company.
52-
* `get_sync_status` - Get status for a company's syncs
53-
* `set_configuration` - Create or update configuration.
51+
* [get_configuration](docs/configuration/README.md#get_configuration) - Retrieve config preferences set for a company.
52+
* [get_sync_status](docs/configuration/README.md#get_sync_status) - Get status for a company's syncs
53+
* [set_configuration](docs/configuration/README.md#set_configuration) - Create or update configuration.
5454

55-
### integrations
55+
### [integrations](docs/integrations/README.md)
5656

57-
* `get_integration_branding` - Get branding for an integration
58-
* `list_integrations` - List information on Codat's supported integrations
57+
* [get_integration_branding](docs/integrations/README.md#get_integration_branding) - Get branding for an integration
58+
* [list_integrations](docs/integrations/README.md#list_integrations) - List information on Codat's supported integrations
5959

60-
### sync
60+
### [sync](docs/sync/README.md)
6161

62-
* `request_sync` - Run a Commerce sync from the last successful sync
63-
* `request_sync_for_date_range` - Run a Commerce sync from a given date range
62+
* [request_sync](docs/sync/README.md#request_sync) - Run a Commerce sync from the last successful sync
63+
* [request_sync_for_date_range](docs/sync/README.md#request_sync_for_date_range) - Run a Commerce sync from a given date range
6464

65-
### sync_flow_preferences
65+
### [sync_flow_preferences](docs/syncflowpreferences/README.md)
6666

67-
* `get_config_text_sync_flow` - Retrieve preferences for text fields on Sync Flow
68-
* `get_sync_flow_url` - Retrieve sync flow url
69-
* `get_visible_accounts` - List visible accounts
70-
* `update_config_text_sync_flow` - Update preferences for text fields on sync flow
71-
* `update_visible_accounts_sync_flow` - Update the visible accounts on Sync Flow
67+
* [get_config_text_sync_flow](docs/syncflowpreferences/README.md#get_config_text_sync_flow) - Retrieve preferences for text fields on Sync Flow
68+
* [get_sync_flow_url](docs/syncflowpreferences/README.md#get_sync_flow_url) - Retrieve sync flow url
69+
* [get_visible_accounts](docs/syncflowpreferences/README.md#get_visible_accounts) - List visible accounts
70+
* [update_config_text_sync_flow](docs/syncflowpreferences/README.md#update_config_text_sync_flow) - Update preferences for text fields on sync flow
71+
* [update_visible_accounts_sync_flow](docs/syncflowpreferences/README.md#update_visible_accounts_sync_flow) - Update the visible accounts on Sync Flow
7272
<!-- End SDK Available Operations -->
7373

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

‎synccommerce/RELEASES.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,4 +174,12 @@ Based on:
174174
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
175175
- Speakeasy CLI 1.19.3 (2.16.7) https://github.com/speakeasy-api/speakeasy
176176
### Releases
177-
- [PyPI v0.8.5] https://pypi.org/project/codat-synccommerce/0.8.5 - synccommerce
177+
- [PyPI v0.8.5] https://pypi.org/project/codat-synccommerce/0.8.5 - synccommerce
178+
179+
## 2023-04-26 14:59:44
180+
### Changes
181+
Based on:
182+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
183+
- Speakeasy CLI 1.25.1 (2.22.0) https://github.com/speakeasy-api/speakeasy
184+
### Releases
185+
- [PyPI v0.9.0] https://pypi.org/project/codat-sync-for-commerce/0.9.0 - synccommerce

‎synccommerce/USAGE.md‎

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

6-
s = codat.Codat(
6+
s = codatsynccommerce.CodatSyncCommerce(
77
security=shared.Security(
88
auth_header="YOUR_API_KEY_HERE",
99
),
@@ -13,7 +13,7 @@ s = codat.Codat(
1313
req = shared.CreateCompany(
1414
name="Bob's Burgers",
1515
)
16-
16+
1717
res = s.company_management.create_company(req)
1818

1919
if res.company is not None:

‎synccommerce/docs/codatsynccommerce/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CodatSyncCommerce SDK
2+
3+
## Overview
4+
5+
The API for Sync for Commerce. Sync for Commerce is an API and a set of supporting tools. It has been built to enable e-commerce, point of sale platforms to provide high-quality integrations with numerous accounting platform through standardized API, seamlessly transforming business sale's data into accounting artefacts.
6+
[Read More...](https://docs.codat.io/sfc/overview)
7+
8+
### Available Operations
9+

‎synccommerce/docs/companymanagement/README.md‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# company_management
2+
3+
## Overview
4+
5+
Create new and manage existing Sync for Commerce companies.
6+
7+
### Available Operations
8+
9+
* [create_company](#create_company) - Create Sync for Commerce company
10+
* [create_connection](#create_connection) - Create connection
11+
* [list_companies](#list_companies) - List companies
12+
* [list_connections](#list_connections) - List data connections
13+
* [update_connection](#update_connection) - Update data connection
14+
15+
## create_company
16+
17+
Creates a Codat company with a commerce partner data connection.
18+
19+
### Example Usage
20+
21+
```python
22+
import codatsynccommerce
23+
from codatsynccommerce.models import shared
24+
25+
s = codatsynccommerce.CodatSyncCommerce(
26+
security=shared.Security(
27+
auth_header="YOUR_API_KEY_HERE",
28+
),
29+
)
30+
31+
32+
req = shared.CreateCompany(
33+
name="Bob's Burgers",
34+
)
35+
36+
res = s.company_management.create_company(req)
37+
38+
if res.company is not None:
39+
# handle response
40+
```
41+
42+
## create_connection
43+
44+
Create a data connection for company.
45+
46+
### Example Usage
47+
48+
```python
49+
import codatsynccommerce
50+
from codatsynccommerce.models import operations
51+
52+
s = codatsynccommerce.CodatSyncCommerce(
53+
security=shared.Security(
54+
auth_header="YOUR_API_KEY_HERE",
55+
),
56+
)
57+
58+
59+
req = operations.CreateConnectionRequest(
60+
request_body="corrupti",
61+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
62+
)
63+
64+
res = s.company_management.create_connection(req)
65+
66+
if res.connection is not None:
67+
# handle response
68+
```
69+
70+
## list_companies
71+
72+
Retrieve a list of all companies the client has created.
73+
74+
### Example Usage
75+
76+
```python
77+
import codatsynccommerce
78+
from codatsynccommerce.models import operations
79+
80+
s = codatsynccommerce.CodatSyncCommerce(
81+
security=shared.Security(
82+
auth_header="YOUR_API_KEY_HERE",
83+
),
84+
)
85+
86+
87+
req = operations.ListCompaniesRequest(
88+
order_by="-modifiedDate",
89+
page=1,
90+
page_size=100,
91+
query="provident",
92+
)
93+
94+
res = s.company_management.list_companies(req)
95+
96+
if res.companies is not None:
97+
# handle response
98+
```
99+
100+
## list_connections
101+
102+
Retrieve previously created data connections.
103+
104+
### Example Usage
105+
106+
```python
107+
import codatsynccommerce
108+
from codatsynccommerce.models import operations
109+
110+
s = codatsynccommerce.CodatSyncCommerce(
111+
security=shared.Security(
112+
auth_header="YOUR_API_KEY_HERE",
113+
),
114+
)
115+
116+
117+
req = operations.ListConnectionsRequest(
118+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
119+
order_by="-modifiedDate",
120+
page=1,
121+
page_size=100,
122+
query="distinctio",
123+
)
124+
125+
res = s.company_management.list_connections(req)
126+
127+
if res.connections is not None:
128+
# handle response
129+
```
130+
131+
## update_connection
132+
133+
Update a data connection
134+
135+
### Example Usage
136+
137+
```python
138+
import codatsynccommerce
139+
from codatsynccommerce.models import operations, shared
140+
141+
s = codatsynccommerce.CodatSyncCommerce(
142+
security=shared.Security(
143+
auth_header="YOUR_API_KEY_HERE",
144+
),
145+
)
146+
147+
148+
req = operations.UpdateConnectionRequest(
149+
update_connection=shared.UpdateConnection(
150+
status="Linked",
151+
),
152+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
153+
connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
154+
)
155+
156+
res = s.company_management.update_connection(req)
157+
158+
if res.connection is not None:
159+
# handle response
160+
```

‎synccommerce/docs/configuration/README.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# configuration
2+
3+
## Overview
4+
5+
Expressively configure preferences for any given Sync for Commerce company.
6+
7+
### Available Operations
8+
9+
* [get_configuration](#get_configuration) - Retrieve config preferences set for a company.
10+
* [get_sync_status](#get_sync_status) - Get status for a company's syncs
11+
* [set_configuration](#set_configuration) - Create or update configuration.
12+
13+
## get_configuration
14+
15+
Retrieve current config preferences.
16+
17+
### Example Usage
18+
19+
```python
20+
import codatsynccommerce
21+
from codatsynccommerce.models import operations
22+
23+
s = codatsynccommerce.CodatSyncCommerce(
24+
security=shared.Security(
25+
auth_header="YOUR_API_KEY_HERE",
26+
),
27+
)
28+
29+
30+
req = operations.GetConfigurationRequest(
31+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
32+
)
33+
34+
res = s.configuration.get_configuration(req)
35+
36+
if res.configuration is not None:
37+
# handle response
38+
```
39+
40+
## get_sync_status
41+
42+
Check the sync history and sync status for a company.
43+
44+
### Example Usage
45+
46+
```python
47+
import codatsynccommerce
48+
from codatsynccommerce.models import operations
49+
50+
s = codatsynccommerce.CodatSyncCommerce(
51+
security=shared.Security(
52+
auth_header="YOUR_API_KEY_HERE",
53+
),
54+
)
55+
56+
57+
req = operations.GetSyncStatusRequest(
58+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
59+
)
60+
61+
res = s.configuration.get_sync_status(req)
62+
63+
if res.status_code == 200:
64+
# handle response
65+
```
66+
67+
## set_configuration
68+
69+
Make changes to configuration preferences.
70+
71+
### Example Usage
72+
73+
```python
74+
import codatsynccommerce
75+
from codatsynccommerce.models import operations
76+
77+
s = codatsynccommerce.CodatSyncCommerce(
78+
security=shared.Security(
79+
auth_header="YOUR_API_KEY_HERE",
80+
),
81+
)
82+
83+
84+
req = operations.SetConfigurationRequest(
85+
company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
86+
)
87+
88+
res = s.configuration.set_configuration(req)
89+
90+
if res.configuration is not None:
91+
# handle response
92+
```

0 commit comments

Comments
 (0)