ci: regenerated with OpenAPI Doc 2.1.0, Speakeay CLI 1.19.2

speakeasybot · speakeasybot · commit 662d16be1c74 · 2023-03-29T00:22:25.000Z
diff --git a/commerce/RELEASES.md b/commerce/RELEASES.md
@@ -158,4 +158,12 @@ Based on:
 - OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Commerce.yaml
 - Speakeasy CLI 1.18.9 (2.16.4) https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.9.1] https://pypi.org/project/codat-commerce/0.9.1 - commerce
+- [PyPI v0.9.1] https://pypi.org/project/codat-commerce/0.9.1 - commerce
+
+## 2023-03-29 00:22:13
+### Changes
+Based on:
+- OpenAPI Doc 2.1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Commerce.yaml
+- Speakeasy CLI 1.19.2 (2.16.5) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.9.2] https://pypi.org/project/codat-commerce/0.9.2 - commerce
diff --git a/commerce/gen.yaml b/commerce/gen.yaml
@@ -1,16 +1,16 @@
 configVersion: 1.0.0
 management:
-  docChecksum: f5ac9a50081db95668ddf00d5a91939b
+  docChecksum: e82cca9032619d65c284dfc97572f754
   docVersion: 2.1.0
-  speakeasyVersion: 1.18.9
-  generationVersion: 2.16.4
+  speakeasyVersion: 1.19.2
+  generationVersion: 2.16.5
 generation:
   telemetryEnabled: false
   sdkClassName: codat
   sdkFlattening: true
   singleTagPerOp: false
 python:
-  version: 0.9.1
+  version: 0.9.2
   author: Speakeasy
   description: Python Client SDK Generated by Speakeasy
   packageName: codat-commerce
diff --git a/commerce/setup.py b/commerce/setup.py
@@ -10,7 +10,7 @@
 
 setuptools.setup(
     name="codat-commerce",
-    version="0.9.1",
+    version="0.9.2",
     author="Speakeasy",
     description="Python Client SDK Generated by Speakeasy",
     long_description=long_description,
diff --git a/commerce/src/codat/models/operations/get_commerce_info.py b/commerce/src/codat/models/operations/get_commerce_info.py
@@ -77,14 +77,16 @@ class GetCommerceInfoSourceModifiedDate:
     r"""In the Codat system, company information includes standard commercial details about 
     a linked company, such as their address, phone number, and company registration.
     
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=companyInfo) for this data type.
+    
     """
     
     account_balances: Optional[list[GetCommerceInfoSourceModifiedDateAccountBalances]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountBalances'), 'exclude': lambda f: f is None }})
     r"""The available and current cash balances for the company's accounts"""  
     addresses: Optional[list[GetCommerceInfoSourceModifiedDateAddress]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('addresses'), 'exclude': lambda f: f is None }})
     r"""Addresses associated with the company"""  
     base_currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('baseCurrency'), 'exclude': lambda f: f is None }})
-    r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. e.g. _GBP_.
+    r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
     
     ## Unknown currencies
     
diff --git a/commerce/src/codat/models/operations/get_companies_companyid_connections_connectionid_data_commerce_taxcomponents.py b/commerce/src/codat/models/operations/get_companies_companyid_connections_connectionid_data_commerce_taxcomponents.py
@@ -18,6 +18,10 @@ class GetCompaniesCompanyIDConnectionsConnectionIDDataCommerceTaxComponentsReque
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class GetCompaniesCompanyIDConnectionsConnectionIDDataCommerceTaxComponents200ApplicationJSONSourceModifiedDate:
+    r"""The Tax Components endpoints return tax rates data from the commerce platform, including tax rate names and values. This is to support the mapping of tax rates from the commerce platform to those in the accounting platform.
+    
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for this data type.
+    """
     
     id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }})
     r"""A unique, persistent identifier for this record"""  
diff --git a/commerce/src/codat/models/operations/list_commerce_customers.py b/commerce/src/codat/models/operations/list_commerce_customers.py
@@ -67,7 +67,10 @@ class ListCommerceCustomers200ApplicationJSONSourceModifiedDateAddress:
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommerceCustomers200ApplicationJSONSourceModifiedDate:
-    r"""Represents a customer who has placed an order in the commerce system\""""
+    r"""When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn.
+    
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-customers) for this data type.
+    """
     
     id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }})
     r"""A unique, persistent identifier for this record"""  
diff --git a/commerce/src/codat/models/operations/list_commerce_disputes.py b/commerce/src/codat/models/operations/list_commerce_disputes.py
@@ -74,6 +74,15 @@ class ListCommerceDisputes200ApplicationJSONSourceModifiedDateStatusEnum(str, En
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommerceDisputes200ApplicationJSONSourceModifiedDate:
+    r"""A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example:  
+    - They didn't receive an order.  
+    - The product they received was different to the commerce store's description.  
+    - They've been the victim of online fraud.  
+    
+    You can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks.
+    
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-disputes) for this data type.
+    """
     
     currency: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency') }})
     r"""Currency of the disputed transaction."""  
diff --git a/commerce/src/codat/models/operations/list_commerce_locations.py b/commerce/src/codat/models/operations/list_commerce_locations.py
@@ -65,11 +65,7 @@ class ListCommerceLocations200ApplicationJSONSourceModifiedDate:
     
     Locations also holds information on geographic locations where orders were placed, as referenced in the Orders data type.
     
-    From the Locations endpoints you can retrieve:
-    
-    A list of all the Locations of a commerce company: `GET /companies/{companyId}/connections/{connectionId}/data/commerce-locations`.
-    The details of an individual location: `GET /companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}`.
-    
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-locations) for this data type.
     """
     
     id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }})
diff --git a/commerce/src/codat/models/operations/list_commerce_orders.py b/commerce/src/codat/models/operations/list_commerce_orders.py
@@ -177,15 +177,9 @@ class ListCommerceOrders200ApplicationJSONSourceModifiedDateServiceCharges:
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommerceOrders200ApplicationJSONSourceModifiedDate:
-    r"""Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order.
+    r"""Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR).
     
-    From the Orders endpoints you can retrieve:
-    
-    A list of all the orders for a commerce company:
-    `GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders`.
-    The details of an individual order:
-    `GET /companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}`.
-    Note that for refunds `quantity` is a negative value and `unitPrice` is a positive value.
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-orders) for this data type.
     
     """
     
diff --git a/commerce/src/codat/models/operations/list_commerce_paymentmethods.py b/commerce/src/codat/models/operations/list_commerce_paymentmethods.py
@@ -50,6 +50,10 @@ class ListCommercePaymentMethods200ApplicationJSONSourceModifiedDateStatusEnum(s
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommercePaymentMethods200ApplicationJSONSourceModifiedDate:
+    r"""A Payment Method represents the payment method(s) used to make payments.
+    
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for this data type.
+    """
     
     id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }})
     r"""A unique, persistent identifier for this record"""  
diff --git a/commerce/src/codat/models/operations/list_commerce_payments.py b/commerce/src/codat/models/operations/list_commerce_payments.py
@@ -64,7 +64,14 @@ class ListCommercePayments200ApplicationJSONSourceModifiedDateStatusEnum(str, En
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommercePayments200ApplicationJSONSourceModifiedDate:
-    r"""A payment made in a commerce platform"""
+    r"""Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status.
+    
+    Refunds are recorded as separate, negative payments. Note that a refund can only occur in relation to a payment that has been completed (i.e. has a status of `Paid`). When a customer cancels an order _before_ a payment has been completed, the payment shows as `Cancelled`.
+    
+    You can use data from the Payments endpoints to calculate key metrics, such as gross sales and monthly recurring revenue (MRR).
+    
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-payments) for this data type.
+    """
     
     id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }})
     r"""A unique, persistent identifier for this record"""  
diff --git a/commerce/src/codat/models/operations/list_commerce_productcategories.py b/commerce/src/codat/models/operations/list_commerce_productcategories.py
@@ -53,6 +53,7 @@ class ListCommerceProductCategories200ApplicationJSONProductCategoryRecordRef:
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommerceProductCategories200ApplicationJSONProductCategoryModifiedDate:
+    r"""The date the record was last updated in Codat's cache."""
     
     modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }})
     r"""The date on which this record was last modified in Codat."""  
@@ -61,6 +62,7 @@ class ListCommerceProductCategories200ApplicationJSONProductCategoryModifiedDate
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommerceProductCategories200ApplicationJSONProductCategorySourceModifiedDate:
+    r"""Date the product was last changed in the commerce or point of sale platform."""
     
     source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }})
     r"""The date on which this record was last modified in the originating system"""  
@@ -69,14 +71,23 @@ class ListCommerceProductCategories200ApplicationJSONProductCategorySourceModifi
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class ListCommerceProductCategories200ApplicationJSONProductCategory:
-    r"""Product categories are used to classify a group of products together, either by type (eg \"Furniture\"), or sometimes by tax profile."""
-    
-    ancestor_refs: Optional[list[ListCommerceProductCategories200ApplicationJSONProductCategoryRecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ancestorRefs'), 'exclude': lambda f: f is None }})  
-    has_children: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hasChildren'), 'exclude': lambda f: f is None }})  
-    id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }})  
-    modified_date: Optional[ListCommerceProductCategories200ApplicationJSONProductCategoryModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }})  
-    name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }})  
-    source_modified_date: Optional[ListCommerceProductCategories200ApplicationJSONProductCategorySourceModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }})  
+    r"""Product categories are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.
+    
+    Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for this data type.
+    """
+    
+    ancestor_refs: Optional[list[ListCommerceProductCategories200ApplicationJSONProductCategoryRecordRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ancestorRefs'), 'exclude': lambda f: f is None }})
+    r"""A collection of parent product categories implicitly ordered with the immediate parent last in the list."""  
+    has_children: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hasChildren'), 'exclude': lambda f: f is None }})
+    r"""A boolean indicating whether there are other product categories beneath this one in the hierarchy."""  
+    id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }})
+    r"""The unique identifier of the product category"""  
+    modified_date: Optional[ListCommerceProductCategories200ApplicationJSONProductCategoryModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }})
+    r"""The date the record was last updated in Codat's cache."""  
+    name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }})
+    r"""The name of the product category"""  
+    source_modified_date: Optional[ListCommerceProductCategories200ApplicationJSONProductCategorySourceModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }})
+    r"""Date the product was last changed in the commerce or point of sale platform."""  
     
 
 @dataclass_json(undefined=Undefined.EXCLUDE)
diff --git a/commerce/src/codat/models/operations/list_commerce_products.py b/commerce/src/codat/models/operations/list_commerce_products.py
diff --git a/commerce/src/codat/models/operations/list_commerce_transactions.py b/commerce/src/codat/models/operations/list_commerce_transactions.py
diff --git a/commerce/src/codat/sdk.py b/commerce/src/codat/sdk.py
