Skip to content

Commit e067534

Browse files
dcoplowedcoplowe
authored
Merge pull request #205 from codatio/speakeasy-sdk-regen-1687219621
chore: speakeasy sdk regeneration - Generate Sync Commerce SDK
2 parents 4d45593 + c5c4aec commit e067534

File tree

21 files changed

+293
-103
lines changed

21 files changed

+293
-103
lines changed

‎synccommerce/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.python-version
2+
.DS_Store
13
venv/
24
src/*.egg-info/
35
__pycache__/

‎synccommerce/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ if res.company is not None:
4848
### [configuration](docs/sdks/configuration/README.md)
4949

5050
* [get_configuration](docs/sdks/configuration/README.md#get_configuration) - Retrieve config preferences set for a company.
51-
* [get_sync_status](docs/sdks/configuration/README.md#get_sync_status) - Get status for a company's syncs
5251
* [set_configuration](docs/sdks/configuration/README.md#set_configuration) - Create or update configuration.
5352

5453
### [integrations](docs/sdks/integrations/README.md)
@@ -58,8 +57,9 @@ if res.company is not None:
5857

5958
### [sync](docs/sdks/sync/README.md)
6059

61-
* [request_sync](docs/sdks/sync/README.md#request_sync) - Run a Commerce sync from the last successful sync
62-
* [request_sync_for_date_range](docs/sdks/sync/README.md#request_sync_for_date_range) - Run a Commerce sync from a given date range
60+
* [get_sync_status](docs/sdks/sync/README.md#get_sync_status) - Get status for a company's syncs
61+
* [request_sync](docs/sdks/sync/README.md#request_sync) - Sync new
62+
* [request_sync_for_date_range](docs/sdks/sync/README.md#request_sync_for_date_range) - Sync range
6363

6464
### [sync_flow_preferences](docs/sdks/syncflowpreferences/README.md)
6565

‎synccommerce/RELEASES.md‎

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,4 +446,76 @@ Based on:
446446
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
447447
- Speakeasy CLI 1.48.0 (2.41.1) https://github.com/speakeasy-api/speakeasy
448448
### Releases
449-
- [PyPI v0.24.1] https://pypi.org/project/codat-sync-for-commerce/0.24.1 - synccommerce
449+
- [PyPI v0.24.1] https://pypi.org/project/codat-sync-for-commerce/0.24.1 - synccommerce
450+
451+
## 2023-06-20 00:06:57
452+
### Changes
453+
Based on:
454+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
455+
- Speakeasy CLI 1.49.0 (2.41.4) https://github.com/speakeasy-api/speakeasy
456+
### Releases
457+
- [PyPI v0.24.2] https://pypi.org/project/codat-sync-for-commerce/0.24.2 - synccommerce
458+
459+
## 2023-06-21 00:08:07
460+
### Changes
461+
Based on:
462+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
463+
- Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy
464+
### Releases
465+
- [PyPI v0.24.3] https://pypi.org/project/codat-sync-for-commerce/0.24.3 - synccommerce
466+
467+
## 2023-06-23 00:09:40
468+
### Changes
469+
Based on:
470+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
471+
- Speakeasy CLI 1.50.1 (2.43.2) https://github.com/speakeasy-api/speakeasy
472+
### Releases
473+
- [PyPI v0.25.0] https://pypi.org/project/codat-sync-for-commerce/0.25.0 - synccommerce
474+
475+
## 2023-06-27 00:09:05
476+
### Changes
477+
Based on:
478+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
479+
- Speakeasy CLI 1.51.1 (2.50.2) https://github.com/speakeasy-api/speakeasy
480+
### Releases
481+
- [PyPI v0.26.0] https://pypi.org/project/codat-sync-for-commerce/0.26.0 - synccommerce
482+
483+
## 2023-06-30 00:08:25
484+
### Changes
485+
Based on:
486+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
487+
- Speakeasy CLI 1.51.3 (2.52.2) https://github.com/speakeasy-api/speakeasy
488+
### Releases
489+
- [PyPI v0.27.0] https://pypi.org/project/codat-sync-for-commerce/0.27.0 - synccommerce
490+
491+
## 2023-07-01 00:10:00
492+
### Changes
493+
Based on:
494+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
495+
- Speakeasy CLI 1.52.0 (2.55.0) https://github.com/speakeasy-api/speakeasy
496+
### Releases
497+
- [PyPI v0.28.0] https://pypi.org/project/codat-sync-for-commerce/0.28.0 - synccommerce
498+
499+
## 2023-07-06 00:09:57
500+
### Changes
501+
Based on:
502+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
503+
- Speakeasy CLI 1.52.2 (2.57.2) https://github.com/speakeasy-api/speakeasy
504+
### Releases
505+
- [PyPI v0.29.0] https://pypi.org/project/codat-sync-for-commerce/0.29.0 - synccommerce
506+
507+
## 2023-07-07 00:09:27
508+
### Changes
509+
Based on:
510+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
511+
- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy
512+
### Releases
513+
- [PyPI v0.30.0] https://pypi.org/project/codat-sync-for-commerce/0.30.0 - synccommerce
514+
515+
## 2023-07-07 09:23:36
516+
### Changes
517+
Based on:
518+
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
519+
- Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy
520+
### Releases
521+
- [PyPI v0.30.1] https://pypi.org/project/codat-sync-for-commerce/0.30.1 - synccommerce

‎synccommerce/docs/models/operations/requestsyncfordaterangerequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55

66
| Field | Type | Required | Description | Example |
77
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
8-
| `date_range` | [Optional[shared.DateRange]](../../models/shared/daterange.md) | :heavy_minus_sign: | N/A | |
8+
| `sync_range` | [Optional[shared.SyncRange]](../../models/shared/syncrange.md) | :heavy_minus_sign: | N/A | |
99
| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |

‎synccommerce/docs/models/shared/company.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Company
22

3-
A company in Codat represent a small or medium sized business, whose data you wish to share
3+
In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/codat-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.
4+
5+
Typically each company is one of your customers.
6+
7+
When you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company.
48

59

610
## Fields

‎synccommerce/docs/models/shared/connection.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# Connection
22

3-
A connection represents the link between a `company` and a source of data.
3+
A connection represents a [company's](https://docs.codat.io/codat-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
4+
5+
A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
6+
7+
- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
8+
- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
9+
- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
10+
Any combination of accounting, banking, and commerce data connections is allowed.
11+
12+
Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview).
413

514

615
## Fields

‎synccommerce/docs/models/shared/syncrange.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SyncRange
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
8+
| `date_range` | [SyncRangeDateRange](../../models/shared/syncrangedaterange.md) | :heavy_check_mark: | N/A |

0 commit comments

Comments
 (0)