Merge pull request #627 from codatio/speakeasy-sdk-regen-1733826200

chore: 🐝 Update SDK - Generate Sync for Commerce library SYNC-FOR-COMMERCE-LIBRARY 6.0.1

Author: dcoplowe

.speakeasy/workflow.lock

@@ -68,11 +68,11 @@ sources:
             - 3.0.0
     sync-for-commerce-source:
         sourceNamespace: sync-for-commerce-source
-        sourceRevisionDigest: sha256:6d5e5550a748f71a9e40dde1c1a69b1719d16b4ba34df3caad9d76471865ed5b
+        sourceRevisionDigest: sha256:df4334894c5b162a67c75770369c6fd6c0cf7b4ce5374c2f9654c2fc6da9fcb5
         sourceBlobDigest: sha256:1d1592cd53dae647bff1e58e43cb64f19f9da714cfc6f6198c43659b89b05369
         tags:
             - latest
-            - speakeasy-sdk-regen-1732635208
+            - speakeasy-sdk-regen-1733826200
             - "1.1"
     sync-for-expenses-source:
         sourceNamespace: sync-for-expenses-source
@@ -152,10 +152,10 @@ targets:
     sync-for-commerce-library:
         source: sync-for-commerce-source
         sourceNamespace: sync-for-commerce-source
-        sourceRevisionDigest: sha256:6d5e5550a748f71a9e40dde1c1a69b1719d16b4ba34df3caad9d76471865ed5b
+        sourceRevisionDigest: sha256:df4334894c5b162a67c75770369c6fd6c0cf7b4ce5374c2f9654c2fc6da9fcb5
         sourceBlobDigest: sha256:1d1592cd53dae647bff1e58e43cb64f19f9da714cfc6f6198c43659b89b05369
-        codeSamplesNamespace: sync-for-commerce-source-code-samples
-        codeSamplesRevisionDigest: sha256:3b9ecd425a767a3ec537a2496260b5f66bcc810311faa362630aecb65f6c8367
+        codeSamplesNamespace: sync-for-commerce-source-python-code-samples
+        codeSamplesRevisionDigest: sha256:f936f9db889b789f7d3b90695f9b203b63e08f2f32dc96d753e5bd322d6af49a
     sync-for-expenses-library:
         source: sync-for-expenses-source
         sourceNamespace: sync-for-expenses-source

sync-for-commerce/.speakeasy/gen.lock

@@ -3,10 +3,10 @@ id: 3b92187c-e150-4a7c-9381-a62db9757019
 management:
   docChecksum: 4dd3691e8d9cbb167c6a1a7bffed41b8
   docVersion: "1.1"
-  speakeasyVersion: 1.446.1
-  generationVersion: 2.462.1
-  releaseVersion: 6.0.0
-  configChecksum: 2a50d118ee0568e3c9e55392665245a1
+  speakeasyVersion: 1.453.8
+  generationVersion: 2.474.15
+  releaseVersion: 6.0.1
+  configChecksum: 397ff36e157098ee12c6ed9f5a8e5ee0
   repoURL: https://github.com/codatio/client-sdk-python.git
   repoSubDirectory: sync-for-commerce
   installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=sync-for-commerce
@@ -15,7 +15,7 @@ features:
   python:
     additionalDependencies: 1.0.0
     constsAndDefaults: 1.0.5
-    core: 5.6.8
+    core: 5.6.11
     defaultEnabledRetries: 0.2.0
     deprecations: 3.0.0
     enumUnions: 0.1.0
@@ -566,4 +566,12 @@ examples:
       responses:
         "400":
           application/json: {"canBeRetried": "Unknown", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "detailedErrorCode": 0, "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "service": "PullApi", "statusCode": 400}
+  Sync Connection Deleted:
+    speakeasy-default-sync-connection-deleted:
+      requestBody:
+        application/json: {"AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e", "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "ClientName": "Bank of Dave", "CompanyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "Message": "Sync connection for company Tesco (8a210b68-6988-11ed-a1eb-0242ac120002) deleted", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Sync Connection Deleted"}
+  connection.deleted:
+    speakeasy-default-connection-deleted:
+      requestBody:
+        application/json: {"eventType": "connection.created", "generatedDate": "2022-10-23T00:00:00Z", "id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "payload": {"connection": {"created": "2022-10-23T00:00:00Z", "id": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "integrationId": "fd321cb6-7963-4506-b873-e99593a45e30", "integrationKey": "dfxm", "lastSync": "2022-10-23T00:00:00Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "35b92968-9851-4095-ad60-395c95cbcba4", "sourceType": "Accounting", "status": "Linked"}, "referenceCompany": {"description": "Requested early access to the new financing scheme.", "id": "8a210b68-6988-11ed-a1eb-0242ac120002", "name": "Codat Ltd."}}}
 generatedTests: {}

sync-for-commerce/.speakeasy/gen.yaml

@@ -12,7 +12,7 @@ generation:
     oAuth2PasswordEnabled: false
   telemetryEnabled: true
 python:
-  version: 6.0.0
+  version: 6.0.1
   additionalDependencies:
     dev: {}
     main: {}

sync-for-commerce/README.md

@@ -32,17 +32,22 @@ Not seeing the endpoints you're expecting? We've [reorganized our products](http
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [Sync for Commerce](#sync-for-commerce)
+  * [Endpoints](#endpoints)
+  * [SDK Installation](#sdk-installation)
+  * [Example Usage](#example-usage)
+  * [IDE Support](#ide-support)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [Debugging](#debugging)
+  * [Support](#support)
 
-* [SDK Installation](#sdk-installation)
-* [IDE Support](#ide-support)
-* [SDK Example Usage](#sdk-example-usage)
-* [Available Resources and Operations](#available-resources-and-operations)
-* [Retries](#retries)
-* [Error Handling](#error-handling)
-* [Server Selection](#server-selection)
-* [Custom HTTP Client](#custom-http-client)
-* [Authentication](#authentication)
-* [Debugging](#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -88,18 +93,33 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 from codat_sync_for_commerce import CodatSyncCommerce
 from codat_sync_for_commerce.models import shared
 
-with CodatSyncCommerce(
-    security=shared.Security(
-        auth_header="Basic BASE_64_ENCODED(API_KEY)",
-    ),
-) as s:
-    res = s.sync_flow_settings.get_config_text_sync_flow(request={
-        "locale": shared.Locale.EN_US,
+with CodatSyncCommerce() as codat_sync_commerce:
+    codat_sync_commerce.connection_deleted(request={
+        "event_type": "connection.created",
+        "generated_date": "2022-10-23T00:00:00Z",
+        "id": "ba29118f-5406-4e59-b05c-ba307ca38d01",
+        "payload": {
+            "connection": {
+                "created": "2022-10-23T00:00:00Z",
+                "id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+                "integration_id": "fd321cb6-7963-4506-b873-e99593a45e30",
+                "integration_key": "dfxm",
+                "link_url": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start",
+                "platform_name": "Basiq",
+                "source_id": "35b92968-9851-4095-ad60-395c95cbcba4",
+                "source_type": shared.SourceType.ACCOUNTING,
+                "status": shared.DataConnectionStatus.LINKED,
+                "last_sync": "2022-10-23T00:00:00Z",
+            },
+            "reference_company": {
+                "description": "Requested early access to the new financing scheme.",
+                "id": "8a210b68-6988-11ed-a1eb-0242ac120002",
+                "name": "Codat Ltd.",
+            },
+        },
     })
 
-    if res is not None:
-        # handle response
-        pass
+    # Use the SDK ...
 ```
 
 </br>
@@ -112,18 +132,33 @@ from codat_sync_for_commerce import CodatSyncCommerce
 from codat_sync_for_commerce.models import shared
 
 async def main():
-    async with CodatSyncCommerce(
-        security=shared.Security(
-            auth_header="Basic BASE_64_ENCODED(API_KEY)",
-        ),
-    ) as s:
-        res = await s.sync_flow_settings.get_config_text_sync_flow_async(request={
-            "locale": shared.Locale.EN_US,
+    async with CodatSyncCommerce() as codat_sync_commerce:
+        await codat_sync_commerce.connection_deleted_async(request={
+            "event_type": "connection.created",
+            "generated_date": "2022-10-23T00:00:00Z",
+            "id": "ba29118f-5406-4e59-b05c-ba307ca38d01",
+            "payload": {
+                "connection": {
+                    "created": "2022-10-23T00:00:00Z",
+                    "id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+                    "integration_id": "fd321cb6-7963-4506-b873-e99593a45e30",
+                    "integration_key": "dfxm",
+                    "link_url": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start",
+                    "platform_name": "Basiq",
+                    "source_id": "35b92968-9851-4095-ad60-395c95cbcba4",
+                    "source_type": shared.SourceType.ACCOUNTING,
+                    "status": shared.DataConnectionStatus.LINKED,
+                    "last_sync": "2022-10-23T00:00:00Z",
+                },
+                "reference_company": {
+                    "description": "Requested early access to the new financing scheme.",
+                    "id": "8a210b68-6988-11ed-a1eb-0242ac120002",
+                    "name": "Codat Ltd.",
+                },
+            },
         })
 
-        if res is not None:
-            # handle response
-            pass
+        # Use the SDK ...
 
 asyncio.run(main())
 ```
@@ -187,14 +222,14 @@ To change the default retry strategy for a single API call, simply provide a `Re
 ```python
 from codat_sync_for_commerce import CodatSyncCommerce
 from codat_sync_for_commerce.models import shared
-from codatsynccommerce.utils import BackoffStrategy, RetryConfig
+from codat_sync_for_commerce.utils import BackoffStrategy, RetryConfig
 
 with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.sync_flow_settings.get_config_text_sync_flow(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.sync_flow_settings.get_config_text_sync_flow(request={
         "locale": shared.Locale.EN_US,
     },
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
@@ -209,15 +244,15 @@ If you'd like to override the default retry strategy for all operations that sup
 ```python
 from codat_sync_for_commerce import CodatSyncCommerce
 from codat_sync_for_commerce.models import shared
-from codatsynccommerce.utils import BackoffStrategy, RetryConfig
+from codat_sync_for_commerce.utils import BackoffStrategy, RetryConfig
 
 with CodatSyncCommerce(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.sync_flow_settings.get_config_text_sync_flow(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.sync_flow_settings.get_config_text_sync_flow(request={
         "locale": shared.Locale.EN_US,
     })
 
@@ -259,10 +294,10 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
+) as codat_sync_commerce:
     res = None
     try:
-        res = s.sync_flow_settings.get_config_text_sync_flow(request={
+        res = codat_sync_commerce.sync_flow_settings.get_config_text_sync_flow(request={
             "locale": shared.Locale.EN_US,
         })
 
@@ -294,8 +329,8 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.sync_flow_settings.get_config_text_sync_flow(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.sync_flow_settings.get_config_text_sync_flow(request={
         "locale": shared.Locale.EN_US,
     })
 
@@ -407,8 +442,8 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.sync_flow_settings.get_config_text_sync_flow(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.sync_flow_settings.get_config_text_sync_flow(request={
         "locale": shared.Locale.EN_US,
     })
 

sync-for-commerce/RELEASES.md

@@ -588,4 +588,14 @@ Based on:
 ### Generated
 - [python v6.0.0] sync-for-commerce
 ### Releases
-- [PyPI v6.0.0] https://pypi.org/project/codat-sync-for-commerce/6.0.0 - sync-for-commerce
+- [PyPI v6.0.0] https://pypi.org/project/codat-sync-for-commerce/6.0.0 - sync-for-commerce
+
+## 2024-12-10 10:23:10
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.453.8 (2.474.15) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v6.0.1] sync-for-commerce
+### Releases
+- [PyPI v6.0.1] https://pypi.org/project/codat-sync-for-commerce/6.0.1 - sync-for-commerce

sync-for-commerce/USAGE.md

@@ -8,8 +8,8 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.sync_flow_settings.get_config_text_sync_flow(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.sync_flow_settings.get_config_text_sync_flow(request={
         "locale": shared.Locale.EN_US,
     })
 
@@ -32,8 +32,8 @@ async def main():
         security=shared.Security(
             auth_header="Basic BASE_64_ENCODED(API_KEY)",
         ),
-    ) as s:
-        res = await s.sync_flow_settings.get_config_text_sync_flow_async(request={
+    ) as codat_sync_commerce:
+        res = await codat_sync_commerce.sync_flow_settings.get_config_text_sync_flow_async(request={
             "locale": shared.Locale.EN_US,
         })
 

sync-for-commerce/docs/sdks/advancedcontrols/README.md

@@ -26,8 +26,8 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.advanced_controls.create_company(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.advanced_controls.create_company(request={
         "name": "string",
         "description": "Requested early access to the new financing scheme.",
     })
@@ -70,8 +70,8 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.advanced_controls.get_configuration(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.advanced_controls.get_configuration(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
     })
 
@@ -113,8 +113,8 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.advanced_controls.list_companies(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.advanced_controls.list_companies(request={
         "order_by": "-modifiedDate",
         "page": 1,
         "page_size": 100,
@@ -159,8 +159,8 @@ with CodatSyncCommerce(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.advanced_controls.set_configuration(request={
+) as codat_sync_commerce:
+    res = codat_sync_commerce.advanced_controls.set_configuration(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
     })