Skip to content

Commit 7834a72

Browse files
committed
ci: regenerated with OpenAPI Doc 1.1, Speakeay CLI 1.50.1
1 parent 0c123bb commit 7834a72

8 files changed

Lines changed: 48 additions & 12 deletions

File tree

synccommerce/RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,4 +462,12 @@ Based on:
462462
- OpenAPI Doc 1.1 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Sync-Commerce.yaml
463463
- Speakeasy CLI 1.49.1 (2.41.5) https://github.com/speakeasy-api/speakeasy
464464
### Releases
465-
- [PyPI v0.24.3] https://pypi.org/project/codat-sync-for-commerce/0.24.3 - synccommerce
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

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/gen.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
configVersion: 1.0.0
22
management:
3-
docChecksum: 18f1a8797b8b00132eaff063c74ac346
3+
docChecksum: 6adb2177a882164715f20b24bdbd2ecb
44
docVersion: "1.1"
5-
speakeasyVersion: 1.49.1
6-
generationVersion: 2.41.5
5+
speakeasyVersion: 1.50.1
6+
generationVersion: 2.43.2
77
generation:
88
sdkClassName: CodatSyncCommerce
99
singleTagPerOp: false
1010
telemetryEnabled: true
1111
python:
12-
version: 0.24.3
12+
version: 0.25.0
1313
author: Speakeasy
1414
description: Python Client SDK Generated by Speakeasy
1515
maxMethodParams: 0

synccommerce/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
setuptools.setup(
1212
name="codat-sync-for-commerce",
13-
version="0.24.3",
13+
version="0.25.0",
1414
author="Speakeasy",
1515
description="Python Client SDK Generated by Speakeasy",
1616
long_description=long_description,

synccommerce/src/codatsynccommerce/models/shared/company.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@
1212

1313
@dataclasses.dataclass
1414
class Company:
15-
r"""A company in Codat represent a small or medium sized business, whose data you wish to share"""
15+
r"""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.
16+
17+
Typically each company is one of your customers.
18+
19+
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.
20+
"""
1621
id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }})
1722
r"""Unique identifier for your SMB in Codat."""
1823
name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }})

synccommerce/src/codatsynccommerce/models/shared/connection.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,17 @@ class ConnectionSourceType(str, Enum):
2222

2323
@dataclasses.dataclass
2424
class Connection:
25-
r"""A connection represents the link between a `company` and a source of data."""
25+
r"""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.
26+
27+
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:
28+
29+
- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
30+
- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
31+
- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
32+
Any combination of accounting, banking, and commerce data connections is allowed.
33+
34+
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).
35+
"""
2636
created: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created') }})
2737
r"""In Codat's data model, dates and times are represented using the <a class=\\"external\\" href=\\"https://en.wikipedia.org/wiki/ISO_8601\\" target=\\"_blank\\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
2838

synccommerce/src/codatsynccommerce/sdkconfiguration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ class SDKConfiguration:
1818
server_idx: int = 0
1919
language: str = 'python'
2020
openapi_doc_version: str = '1.1'
21-
sdk_version: str = '0.24.3'
22-
gen_version: str = '2.41.5'
21+
sdk_version: str = '0.25.0'
22+
gen_version: str = '2.43.2'
2323

2424
def get_server_details(self) -> tuple[str, dict[str, str]]:
2525
if self.server_url:

0 commit comments

Comments
 (0)