Merge pull request #625 from codatio/speakeasy-sdk-regen-1733826112

chore: 🐝 Update SDK - Generate Lending library LENDING-LIBRARY 10.0.1

Author: dcoplowe

.speakeasy/workflow.lock

@@ -52,11 +52,11 @@ sources:
             - main
     lending-source:
         sourceNamespace: lending-source
-        sourceRevisionDigest: sha256:3f872850d34670b950341643ce0476ecaaba175c4e2c36d5e7e266797115ffbd
+        sourceRevisionDigest: sha256:6a6559ff1708203015c12ef0715df1944b69a78beaaaf74d668bb0699683c35f
         sourceBlobDigest: sha256:b52d78f87b496418a9a1d7ee5f4b78f4ee3ed0a257fba5a6bd13e82a5ed3548f
         tags:
             - latest
-            - speakeasy-sdk-regen-1732640659
+            - speakeasy-sdk-regen-1733826112
             - 3.0.0
     platform-source:
         sourceNamespace: platform-source
@@ -138,10 +138,10 @@ targets:
     lending-library:
         source: lending-source
         sourceNamespace: lending-source
-        sourceRevisionDigest: sha256:3f872850d34670b950341643ce0476ecaaba175c4e2c36d5e7e266797115ffbd
+        sourceRevisionDigest: sha256:6a6559ff1708203015c12ef0715df1944b69a78beaaaf74d668bb0699683c35f
         sourceBlobDigest: sha256:b52d78f87b496418a9a1d7ee5f4b78f4ee3ed0a257fba5a6bd13e82a5ed3548f
-        codeSamplesNamespace: lending-source-code-samples
-        codeSamplesRevisionDigest: sha256:b7511b3055b763213950c5ee099869857756beb6faec11baddc339e4682a9062
+        codeSamplesNamespace: lending-source-python-code-samples
+        codeSamplesRevisionDigest: sha256:d10023577a87c786508ad9634f78b1fd6e72689dc60fbe3caf6a62bc74e50528
     platform-library:
         source: platform-source
         sourceNamespace: platform-source

lending/.speakeasy/gen.lock

@@ -3,10 +3,10 @@ id: c22ee3eb-abe5-40e9-bcf6-8be944e72a7b
 management:
   docChecksum: 9d2203249a565b88959fb122711a1f33
   docVersion: 3.0.0
-  speakeasyVersion: 1.447.0
-  generationVersion: 2.463.0
-  releaseVersion: 10.0.0
-  configChecksum: 86504764483be53c74a1b92dec0be5a9
+  speakeasyVersion: 1.453.8
+  generationVersion: 2.474.15
+  releaseVersion: 10.0.1
+  configChecksum: 0c3003cb61623fa1f82cc340f29da6b8
   repoURL: https://github.com/codatio/client-sdk-python.git
   repoSubDirectory: lending
   installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=lending
@@ -15,7 +15,7 @@ features:
   python:
     additionalDependencies: 1.0.0
     constsAndDefaults: 1.0.5
-    core: 5.6.8
+    core: 5.6.11
     decimal: 1.0.0
     defaultEnabledRetries: 0.2.0
     deprecations: 3.0.0
@@ -11348,4 +11348,28 @@ examples:
       responses:
         "400":
           application/json: {"canBeRetried": "Unknown", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "detailedErrorCode": 0, "error": "Error processing request - not valid.", "service": "PublicApi", "statusCode": 400}
+  Account categories updated:
+    speakeasy-default-account-categories-updated:
+      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", "Data": {"modifiedDate": "2022-10-23"}, "DataConnectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "Message": "Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Account Categories Updated"}
+  Client rate limit reached:
+    speakeasy-default-client-rate-limit-reached:
+      requestBody:
+        application/json: {"AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e", "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "ClientName": "Bank of Dave", "Data": {"DailyQuota": 1000, "ExpiresUtc": "2022-10-23T00:00:00Z"}, "Message": "The current daily rate limit quota of 1000 requests for bae71d36-ff47-420a-b4a6-f8c9ddf41140 has been reached.", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Rate Limit Reached"}
+  Client rate limit reset:
+    speakeasy-default-client-rate-limit-reset:
+      requestBody:
+        application/json: {"AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e", "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "ClientName": "Bank of Dave", "Data": {"DailyQuota": 1000, "ExpiresUtc": "2022-10-23T00:00:00Z", "QuotaRemaining": 1000, "ResetReason": "The quota was reset because it is a new day."}, "Message": "The current daily rate limit quota for client 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e has been reset to 1000 requests.", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Rate Limit Reset"}
+  client.rateLimit.reached:
+    Reached:
+      requestBody:
+        application/json: {"eventType": "client.rateLimit.reached", "generatedDate": "2024-09-01T00:00:00Z", "id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "payload": {"dailyQuota": 12000, "expiryDate": "2024-09-01T12:14:14Z", "quotaRemaining": 0}}
+  client.rateLimit.reset:
+    Reset:
+      requestBody:
+        application/json: {"eventType": "client.rateLimit.reset", "generatedDate": "2024-09-01T00:00:00Z", "id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "payload": {"dailyQuota": 12000, "expiryDate": "2024-09-01T23:59:99Z", "quotaRemaining": 11993}}
+  report.categorizedBankStatement.generate.successful:
+    Successful:
+      requestBody:
+        application/json: {"eventType": "reports.categorizedBankStatement.generate.successful", "generatedDate": "2023-05-03T10:00:23Z", "id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "payload": {"id": "bb42ce7e-720a-4ac5-b640-f24f53ff47c8", "referenceCompany": {"description": "internal_id_mxO7rLfo", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "name": "Bank of Dave", "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}}}
 generatedTests: {}

lending/.speakeasy/gen.yaml

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

lending/README.md

@@ -38,18 +38,23 @@ The Lending API is built on top of the latest accounting, commerce, and banking
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [Lending](#lending)
+  * [Endpoints](#endpoints)
+  * [SDK Installation](#sdk-installation)
+  * [Example Usage](#example-usage)
+  * [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)
+  * [IDE Support](#ide-support)
+  * [File uploads](#file-uploads)
+  * [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)
-* [File uploads](#file-uploads)
-* [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] -->
@@ -83,21 +88,23 @@ poetry add codat-lending
 ```python
 # Synchronous Example
 from codat_lending import CodatLending
-from codat_lending.models import shared
 
-with CodatLending(
-    security=shared.Security(
-        auth_header="Basic BASE_64_ENCODED(API_KEY)",
-    ),
-) as s:
-    res = s.companies.create(request={
-        "name": "Technicalium",
-        "description": "Requested early access to the new financing scheme.",
+with CodatLending() as codat_lending:
+    codat_lending.account_categories_updated(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": {
+            "modified_date": "2022-10-23",
+        },
+        "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+        "message": "Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.",
+        "rule_id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
+        "rule_type": "Account Categories Updated",
     })
 
-    if res is not None:
-        # handle response
-        pass
+    # Use the SDK ...
 ```
 
 </br>
@@ -107,22 +114,24 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from codat_lending import CodatLending
-from codat_lending.models import shared
 
 async def main():
-    async with CodatLending(
-        security=shared.Security(
-            auth_header="Basic BASE_64_ENCODED(API_KEY)",
-        ),
-    ) as s:
-        res = await s.companies.create_async(request={
-            "name": "Technicalium",
-            "description": "Requested early access to the new financing scheme.",
+    async with CodatLending() as codat_lending:
+        await codat_lending.account_categories_updated_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": {
+                "modified_date": "2022-10-23",
+            },
+            "data_connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+            "message": "Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968.",
+            "rule_id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
+            "rule_type": "Account Categories Updated",
         })
 
-        if res is not None:
-            # handle response
-            pass
+        # Use the SDK ...
 
 asyncio.run(main())
 ```
@@ -492,14 +501,14 @@ To change the default retry strategy for a single API call, simply provide a `Re
 ```python
 from codat_lending import CodatLending
 from codat_lending.models import shared
-from codatlending.utils import BackoffStrategy, RetryConfig
+from codat_lending.utils import BackoffStrategy, RetryConfig
 
 with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.create(request={
+) as codat_lending:
+    res = codat_lending.companies.create(request={
         "name": "Technicalium",
         "description": "Requested early access to the new financing scheme.",
     },
@@ -515,15 +524,15 @@ If you'd like to override the default retry strategy for all operations that sup
 ```python
 from codat_lending import CodatLending
 from codat_lending.models import shared
-from codatlending.utils import BackoffStrategy, RetryConfig
+from codat_lending.utils import BackoffStrategy, RetryConfig
 
 with CodatLending(
     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.companies.create(request={
+) as codat_lending:
+    res = codat_lending.companies.create(request={
         "name": "Technicalium",
         "description": "Requested early access to the new financing scheme.",
     })
@@ -566,10 +575,10 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
+) as codat_lending:
     res = None
     try:
-        res = s.companies.create(request={
+        res = codat_lending.companies.create(request={
             "name": "Technicalium",
             "description": "Requested early access to the new financing scheme.",
         })
@@ -602,8 +611,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.create(request={
+) as codat_lending:
+    res = codat_lending.companies.create(request={
         "name": "Technicalium",
         "description": "Requested early access to the new financing scheme.",
     })
@@ -716,8 +725,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.create(request={
+) as codat_lending:
+    res = codat_lending.companies.create(request={
         "name": "Technicalium",
         "description": "Requested early access to the new financing scheme.",
     })
@@ -757,8 +766,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    s.file_upload.upload(request={
+) as codat_lending:
+    codat_lending.file_upload.upload(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
     })

lending/RELEASES.md

@@ -158,4 +158,14 @@ Based on:
 ### Generated
 - [python v10.0.0] lending
 ### Releases
-- [PyPI v10.0.0] https://pypi.org/project/codat-lending/10.0.0 - lending
+- [PyPI v10.0.0] https://pypi.org/project/codat-lending/10.0.0 - lending
+
+## 2024-12-10 10:21:43
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.453.8 (2.474.15) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v10.0.1] lending
+### Releases
+- [PyPI v10.0.1] https://pypi.org/project/codat-lending/10.0.1 - lending

lending/USAGE.md

@@ -8,8 +8,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.create(request={
+) as codat_lending:
+    res = codat_lending.companies.create(request={
         "name": "Technicalium",
         "description": "Requested early access to the new financing scheme.",
     })
@@ -33,8 +33,8 @@ async def main():
         security=shared.Security(
             auth_header="Basic BASE_64_ENCODED(API_KEY)",
         ),
-    ) as s:
-        res = await s.companies.create_async(request={
+    ) as codat_lending:
+        res = await codat_lending.companies.create_async(request={
             "name": "Technicalium",
             "description": "Requested early access to the new financing scheme.",
         })

lending/docs/sdks/accountbalances/README.md

@@ -26,8 +26,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.banking.account_balances.list(request={
+) as codat_lending:
+    res = codat_lending.banking.account_balances.list(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
         "order_by": "-modifiedDate",

lending/docs/sdks/accounts/README.md

@@ -27,8 +27,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.accounting_bank_data.accounts.get(request={
+) as codat_lending:
+    res = codat_lending.accounting_bank_data.accounts.get(request={
         "account_id": "7110701885",
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -77,8 +77,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.accounting_bank_data.accounts.list(request={
+) as codat_lending:
+    res = codat_lending.accounting_bank_data.accounts.list(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
         "order_by": "-modifiedDate",

lending/docs/sdks/accounttransactions/README.md

@@ -27,8 +27,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.transactions.account_transactions.get(request={
+) as codat_lending:
+    res = codat_lending.transactions.account_transactions.get(request={
         "account_transaction_id": "<id>",
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
@@ -77,8 +77,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.transactions.account_transactions.list(request={
+) as codat_lending:
+    res = codat_lending.transactions.account_transactions.list(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
         "order_by": "-modifiedDate",

lending/docs/sdks/balancesheet/README.md

@@ -22,8 +22,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.financial_statements.balance_sheet.get(request={
+) as codat_lending:
+    res = codat_lending.financial_statements.balance_sheet.get(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "period_length": 4,
         "periods_to_compare": 20,
@@ -70,8 +70,8 @@ with CodatLending(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.financial_statements.balance_sheet.get_categorized_accounts(request={
+) as codat_lending:
+    res = codat_lending.financial_statements.balance_sheet.get_categorized_accounts(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "report_date": "29-09-2020",
     })