Skip to content

Commit c864683

Browse files
dcoplowedcoplowe
authored
Merge pull request #315 from codatio/speakeasy-sdk-regen-1694604655
chore: speakeasy sdk regeneration - Generate Sync for Commerce library
2 parents 8f0bf9b + 36945be commit c864683

Some content is hidden

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

54 files changed

+482
-207
lines changed

‎sync-for-commerce/README.md‎

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,78 @@
33
Embedded accounting integrations for POS and eCommerce platforms.
44

55
<!-- Start SDK Installation -->
6-
replace me
6+
## SDK Installation
7+
8+
```bash
9+
pip install codat-sync-for-commerce
10+
```
711
<!-- End SDK Installation -->
812

913
## Example Usage
1014
<!-- Start SDK Example Usage -->
11-
replace me
15+
16+
17+
```python
18+
import codatsynccommerce
19+
from codatsynccommerce.models import shared
20+
21+
s = codatsynccommerce.CodatSyncCommerce(
22+
security=shared.Security(
23+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
24+
),
25+
)
26+
27+
req = shared.CreateCompany(
28+
description='Requested early access to the new financing scheme.',
29+
name='Bank of Dave',
30+
)
31+
32+
res = s.advanced_controls.create_company(req)
33+
34+
if res.company is not None:
35+
# handle response
36+
```
1237
<!-- End SDK Example Usage -->
1338

1439
<!-- Start SDK Available Operations -->
15-
replace me
40+
## Available Resources and Operations
41+
42+
43+
### [advanced_controls](docs/sdks/advancedcontrols/README.md)
44+
45+
* [create_company](docs/sdks/advancedcontrols/README.md#create_company) - Create company
46+
* [get_configuration](docs/sdks/advancedcontrols/README.md#get_configuration) - Get company configuration
47+
* [list_companies](docs/sdks/advancedcontrols/README.md#list_companies) - List companies
48+
* [set_configuration](docs/sdks/advancedcontrols/README.md#set_configuration) - Set configuration
49+
50+
### [connections](docs/sdks/connections/README.md)
51+
52+
* [create](docs/sdks/connections/README.md#create) - Create connection
53+
* [get_sync_flow_url](docs/sdks/connections/README.md#get_sync_flow_url) - Start new sync flow
54+
* [list](docs/sdks/connections/README.md#list) - List connections
55+
* [update_authorization](docs/sdks/connections/README.md#update_authorization) - Update authorization
56+
* [update_connection](docs/sdks/connections/README.md#update_connection) - Update connection
57+
58+
### [integrations](docs/sdks/integrations/README.md)
59+
60+
* [get_branding](docs/sdks/integrations/README.md#get_branding) - Get branding for an integration
61+
* [list](docs/sdks/integrations/README.md#list) - List integrations
62+
63+
### [sync](docs/sdks/sync/README.md)
64+
65+
* [get](docs/sdks/sync/README.md#get) - Get sync status
66+
* [get_last_successful_sync](docs/sdks/sync/README.md#get_last_successful_sync) - Last successful sync
67+
* [get_latest_sync](docs/sdks/sync/README.md#get_latest_sync) - Latest sync status
68+
* [get_status](docs/sdks/sync/README.md#get_status) - Get sync status
69+
* [list](docs/sdks/sync/README.md#list) - List sync statuses
70+
* [request](docs/sdks/sync/README.md#request) - Initiate new sync
71+
* [request_for_date_range](docs/sdks/sync/README.md#request_for_date_range) - Initiate sync for specific range
72+
73+
### [sync_flow_settings](docs/sdks/syncflowsettings/README.md)
74+
75+
* [get_config_text_sync_flow](docs/sdks/syncflowsettings/README.md#get_config_text_sync_flow) - Get preferences for text fields
76+
* [get_visible_accounts](docs/sdks/syncflowsettings/README.md#get_visible_accounts) - List visible accounts
77+
* [update_config_text_sync_flow](docs/sdks/syncflowsettings/README.md#update_config_text_sync_flow) - Update preferences for text fields
78+
* [update_visible_accounts_sync_flow](docs/sdks/syncflowsettings/README.md#update_visible_accounts_sync_flow) - Update visible accounts
1679
<!-- End SDK Available Operations -->
1780
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎sync-for-commerce/RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,4 +528,14 @@ Based on:
528528
### Generated
529529
- [python v0.31.0] sync-for-commerce
530530
### Releases
531-
- [PyPI v0.31.0] https://pypi.org/project/codat-sync-for-commerce/0.31.0 - sync-for-commerce
531+
- [PyPI v0.31.0] https://pypi.org/project/codat-sync-for-commerce/0.31.0 - sync-for-commerce
532+
533+
## 2023-09-13 11:30:50
534+
### Changes
535+
Based on:
536+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
537+
- Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy
538+
### Generated
539+
- [python v1.1.0] sync-for-commerce
540+
### Releases
541+
- [PyPI v1.1.0] https://pypi.org/project/codat-sync-for-commerce/1.1.0 - sync-for-commerce

‎sync-for-commerce/USAGE.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ s = codatsynccommerce.CodatSyncCommerce(
1212
)
1313

1414
req = shared.CreateCompany(
15-
name='Bob's Burgers',
15+
description='Requested early access to the new financing scheme.',
16+
name='Bank of Dave',
1617
)
1718

1819
res = s.advanced_controls.create_company(req)

‎sync-for-commerce/docs/models/operations/getsyncstatusresponse.md‎

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

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `bad_request` | *Optional[Any]* | :heavy_minus_sign: | Bad Request |
89
| `content_type` | *str* | :heavy_check_mark: | N/A |
10+
| `not_found` | *Optional[Any]* | :heavy_minus_sign: | Not Found |
911
| `status_code` | *int* | :heavy_check_mark: | N/A |
10-
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
12+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
13+
| `sync_status` | [Optional[shared.SyncStatus]](../../models/shared/syncstatus.md) | :heavy_minus_sign: | Success |

‎sync-for-commerce/docs/models/shared/branding.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Branding
22

3-
Success
4-
53

64
## Fields
75

‎sync-for-commerce/docs/models/shared/companies.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Companies
22

3-
Success
4-
53

64
## Fields
75

‎sync-for-commerce/docs/models/shared/companysyncstatus.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# CompanySyncStatus
22

3-
Success
4-
53

64
## Fields
75

‎sync-for-commerce/docs/models/shared/configuration.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Configuration
22

3-
Success
4-
53

64
## Fields
75

‎sync-for-commerce/docs/models/shared/connections.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Connections
22

3-
OK
4-
53

64
## Fields
75

‎sync-for-commerce/docs/models/shared/createcompany.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description | Example |
7-
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
8-
| `name` | *str* | :heavy_check_mark: | Name of the company in Codat with a partner-commerce data connection. | Bob's Burgers |
6+
| Field | Type | Required | Description | Example |
7+
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
8+
| `description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
9+
| `name` | *str* | :heavy_check_mark: | Name of company being connected. | Bank of Dave |

0 commit comments

Comments
 (0)