Merge pull request #623 from codatio/speakeasy-sdk-regen-1733826101

chore: 🐝 Update SDK - Generate Platform library PLATFORM-LIBRARY 4.0.1

Author: dcoplowe

.speakeasy/workflow.lock

@@ -60,11 +60,11 @@ sources:
             - 3.0.0
     platform-source:
         sourceNamespace: platform-source
-        sourceRevisionDigest: sha256:43fa77abcae884c23afeea140d8e7fcbc14211c707ef801439ad9508b35b21d4
+        sourceRevisionDigest: sha256:ef966dca35b7fc3432b6fe7fe6e38581da34ceb42470f02262ebf598963169dc
         sourceBlobDigest: sha256:d80a27e44fffb9c61f16a99e7d25c294f39be1a5a761d51a87c76477f8589f54
         tags:
             - latest
-            - speakeasy-sdk-regen-1732624899
+            - speakeasy-sdk-regen-1733826101
             - 3.0.0
     sync-for-commerce-source:
         sourceNamespace: sync-for-commerce-source
@@ -145,10 +145,10 @@ targets:
     platform-library:
         source: platform-source
         sourceNamespace: platform-source
-        sourceRevisionDigest: sha256:43fa77abcae884c23afeea140d8e7fcbc14211c707ef801439ad9508b35b21d4
+        sourceRevisionDigest: sha256:ef966dca35b7fc3432b6fe7fe6e38581da34ceb42470f02262ebf598963169dc
         sourceBlobDigest: sha256:d80a27e44fffb9c61f16a99e7d25c294f39be1a5a761d51a87c76477f8589f54
-        codeSamplesNamespace: platform-source-code-samples
-        codeSamplesRevisionDigest: sha256:598d4e7d1cb1d3316e6d179038d87797bb54958b2e25315ce6235a50f4afb859
+        codeSamplesNamespace: platform-source-python-code-samples
+        codeSamplesRevisionDigest: sha256:cc21677e648343a1df5cdf584cfa6f2e48b3dcbd87c470a8ac58c4854c494b65
     sync-for-commerce-library:
         source: sync-for-commerce-source
         sourceNamespace: sync-for-commerce-source

platform/.speakeasy/gen.lock

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

platform/.speakeasy/gen.yaml

@@ -36,17 +36,22 @@ These end points cover creating and managing your companies, data connections, a
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [Platform](#platform)
+  * [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] -->
@@ -92,18 +97,25 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 from codat_platform import CodatPlatform
 from codat_platform.models import shared
 
-with CodatPlatform(
-    security=shared.Security(
-        auth_header="Basic BASE_64_ENCODED(API_KEY)",
-    ),
-) as s:
-    res = s.settings.create_api_key(request={
-        "name": "azure-invoice-finance-processor",
+with CodatPlatform() as codat_platform:
+    codat_platform.company_data_connection_status_changed(request={
+        "alert_id": "a9367074-b5c3-42c4-9be4-be129f43577e",
+        "client_id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
+        "client_name": "Bank of Dave",
+        "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
+        "data": {
+            "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+            "new_status": shared.DataConnectionStatus.LINKED,
+            "old_status": shared.DataConnectionStatus.PENDING_AUTH,
+            "platform_key": "gbol",
+        },
+        "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+        "message": "Data connection for SandBox status changed from PendingAuth to Linked",
+        "rule_id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
+        "rule_type": "DataConnectionStatusChanged",
     })
 
-    if res is not None:
-        # handle response
-        pass
+    # Use the SDK ...
 ```
 
 </br>
@@ -116,18 +128,25 @@ from codat_platform import CodatPlatform
 from codat_platform.models import shared
 
 async def main():
-    async with CodatPlatform(
-        security=shared.Security(
-            auth_header="Basic BASE_64_ENCODED(API_KEY)",
-        ),
-    ) as s:
-        res = await s.settings.create_api_key_async(request={
-            "name": "azure-invoice-finance-processor",
+    async with CodatPlatform() as codat_platform:
+        await codat_platform.company_data_connection_status_changed_async(request={
+            "alert_id": "a9367074-b5c3-42c4-9be4-be129f43577e",
+            "client_id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
+            "client_name": "Bank of Dave",
+            "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
+            "data": {
+                "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+                "new_status": shared.DataConnectionStatus.LINKED,
+                "old_status": shared.DataConnectionStatus.PENDING_AUTH,
+                "platform_key": "gbol",
+            },
+            "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+            "message": "Data connection for SandBox status changed from PendingAuth to Linked",
+            "rule_id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
+            "rule_type": "DataConnectionStatusChanged",
         })
 
-        if res is not None:
-            # handle response
-            pass
+        # Use the SDK ...
 
 asyncio.run(main())
 ```
@@ -234,14 +253,14 @@ To change the default retry strategy for a single API call, simply provide a `Re
 ```python
 from codat_platform import CodatPlatform
 from codat_platform.models import shared
-from codatplatform.utils import BackoffStrategy, RetryConfig
+from codat_platform.utils import BackoffStrategy, RetryConfig
 
 with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.settings.create_api_key(request={
+) as codat_platform:
+    res = codat_platform.settings.create_api_key(request={
         "name": "azure-invoice-finance-processor",
     },
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
@@ -256,15 +275,15 @@ If you'd like to override the default retry strategy for all operations that sup
 ```python
 from codat_platform import CodatPlatform
 from codat_platform.models import shared
-from codatplatform.utils import BackoffStrategy, RetryConfig
+from codat_platform.utils import BackoffStrategy, RetryConfig
 
 with CodatPlatform(
     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.settings.create_api_key(request={
+) as codat_platform:
+    res = codat_platform.settings.create_api_key(request={
         "name": "azure-invoice-finance-processor",
     })
 
@@ -306,10 +325,10 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
+) as codat_platform:
     res = None
     try:
-        res = s.settings.create_api_key(request={
+        res = codat_platform.settings.create_api_key(request={
             "name": "azure-invoice-finance-processor",
         })
 
@@ -341,8 +360,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.settings.create_api_key(request={
+) as codat_platform:
+    res = codat_platform.settings.create_api_key(request={
         "name": "azure-invoice-finance-processor",
     })
 
@@ -454,8 +473,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.settings.create_api_key(request={
+) as codat_platform:
+    res = codat_platform.settings.create_api_key(request={
         "name": "azure-invoice-finance-processor",
     })
 

platform/README.md

@@ -108,4 +108,14 @@ Based on:
 ### Generated
 - [python v4.0.0] platform
 ### Releases
-- [PyPI v4.0.0] https://pypi.org/project/codat-platform/4.0.0 - platform
+- [PyPI v4.0.0] https://pypi.org/project/codat-platform/4.0.0 - platform
+
+## 2024-12-10 10:21:32
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.453.8 (2.474.15) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v4.0.1] platform
+### Releases
+- [PyPI v4.0.1] https://pypi.org/project/codat-platform/4.0.1 - platform

platform/RELEASES.md

@@ -8,8 +8,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.settings.create_api_key(request={
+) as codat_platform:
+    res = codat_platform.settings.create_api_key(request={
         "name": "azure-invoice-finance-processor",
     })
 
@@ -32,8 +32,8 @@ async def main():
         security=shared.Security(
             auth_header="Basic BASE_64_ENCODED(API_KEY)",
         ),
-    ) as s:
-        res = await s.settings.create_api_key_async(request={
+    ) as codat_platform:
+        res = await codat_platform.settings.create_api_key_async(request={
             "name": "azure-invoice-finance-processor",
         })
 

platform/USAGE.md

@@ -32,8 +32,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    s.companies.add_product(request={
+) as codat_platform:
+    codat_platform.companies.add_product(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "product_identifier": "lending",
     })
@@ -75,8 +75,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.create(request={
+) as codat_platform:
+    res = codat_platform.companies.create(request={
         "name": "Technicalium",
     })
 
@@ -122,8 +122,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    s.companies.delete(request={
+) as codat_platform:
+    codat_platform.companies.delete(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
     })
 
@@ -163,8 +163,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.get(request={
+) as codat_platform:
+    res = codat_platform.companies.get(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
     })
 
@@ -207,8 +207,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.get_access_token(request={
+) as codat_platform:
+    res = codat_platform.companies.get_access_token(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
     })
 
@@ -253,8 +253,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.list(request={
+) as codat_platform:
+    res = codat_platform.companies.list(request={
         "order_by": "-modifiedDate",
         "page": 1,
         "page_size": 100,
@@ -301,8 +301,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    s.companies.remove_product(request={
+) as codat_platform:
+    codat_platform.companies.remove_product(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "product_identifier": "expenses",
     })
@@ -342,8 +342,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.update(request={
+) as codat_platform:
+    res = codat_platform.companies.update(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "company_request_body": {
             "name": "New Name",

platform/docs/sdks/companies/README.md

@@ -25,8 +25,8 @@ with CodatPlatform(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.connection_management.get_access_token(request={
+) as codat_platform:
+    res = codat_platform.connection_management.get_access_token(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
     })