Merge pull request #624 from codatio/speakeasy-sdk-regen-1733826158

chore: 🐝 Update SDK - Generate Sync for Payables library SYNC-FOR-PAYABLES-LIBRARY 8.0.3

Author: dcoplowe

.speakeasy/workflow.lock

@@ -84,11 +84,11 @@ sources:
             - prealpha
     sync-for-payables-source:
         sourceNamespace: sync-for-payables-source
-        sourceRevisionDigest: sha256:24533e2542e722cc2a54d350b8124a864d69ed4460b3fda7156caf3e8d822ca0
+        sourceRevisionDigest: sha256:91db2475a2b22bd8d3aa4cc563979bf0c9c887c393c979537263a5f541ab8b04
         sourceBlobDigest: sha256:57b656eed2c5a98f97da8f59e196bb8052ead3cc7c87673cdf5e19c6badbb570
         tags:
             - latest
-            - speakeasy-sdk-regen-1732702202
+            - speakeasy-sdk-regen-1733826158
             - 3.0.0
     sync-for-payables-version-1-source:
         sourceNamespace: sync-for-payables-version-1-source
@@ -166,10 +166,10 @@ targets:
     sync-for-payables-library:
         source: sync-for-payables-source
         sourceNamespace: sync-for-payables-source
-        sourceRevisionDigest: sha256:24533e2542e722cc2a54d350b8124a864d69ed4460b3fda7156caf3e8d822ca0
+        sourceRevisionDigest: sha256:91db2475a2b22bd8d3aa4cc563979bf0c9c887c393c979537263a5f541ab8b04
         sourceBlobDigest: sha256:57b656eed2c5a98f97da8f59e196bb8052ead3cc7c87673cdf5e19c6badbb570
         codeSamplesNamespace: sync-for-payables-source-python-code-samples
-        codeSamplesRevisionDigest: sha256:ee15bf6aec481ca23d8e2cb43d251e239334292e4affce738c03ef74f3e092b3
+        codeSamplesRevisionDigest: sha256:9a230d00f4713b828e0a51c12d169f4c326865409b7aedb7525060826c7d7ef1
     sync-for-payables-version-1-library:
         source: sync-for-payables-version-1-source
         sourceNamespace: sync-for-payables-version-1-source

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

@@ -3,10 +3,10 @@ id: 0722f07c-657c-4062-93f1-39ee3fe757d0
 management:
   docChecksum: 05c2a60eb0f4b40cda5e4a92d94e7b93
   docVersion: 3.0.0
-  speakeasyVersion: 1.448.0
-  generationVersion: 2.466.0
-  releaseVersion: 8.0.2
-  configChecksum: 770f66b877a0dda395dc34450854e097
+  speakeasyVersion: 1.453.8
+  generationVersion: 2.474.15
+  releaseVersion: 8.0.3
+  configChecksum: 52f1dd427d39b22a834f77dd51ec7337
   repoURL: https://github.com/codatio/client-sdk-python.git
   repoSubDirectory: sync-for-payables
   installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=sync-for-payables
@@ -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
@@ -954,4 +954,20 @@ examples:
       responses:
         "400":
           application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
+  client.rateLimit.reached:
+    Reached:
+      requestBody:
+        application/json: {"id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "client.rateLimit.reached", "generatedDate": "2024-09-01T00:00:00Z", "payload": {"dailyQuota": 12000, "quotaRemaining": 0, "expiryDate": "2024-09-01T12:14:14Z"}}
+  client.rateLimit.reset:
+    Reset:
+      requestBody:
+        application/json: {"id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "client.rateLimit.reset", "generatedDate": "2024-09-01T00:00:00Z", "payload": {"dailyQuota": 12000, "quotaRemaining": 11993, "expiryDate": "2024-09-01T23:59:99Z"}}
+  Client rate limit reached:
+    speakeasy-default-client-rate-limit-reached:
+      requestBody:
+        application/json: {"ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "ClientName": "Bank of Dave", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Rate Limit Reached", "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e", "Message": "The current daily rate limit quota of 1000 requests for bae71d36-ff47-420a-b4a6-f8c9ddf41140 has been reached.", "Data": {"DailyQuota": 1000, "ExpiresUtc": "2022-10-23T00:00:00Z"}}
+  Client rate limit reset:
+    speakeasy-default-client-rate-limit-reset:
+      requestBody:
+        application/json: {"ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "ClientName": "Bank of Dave", "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "RuleType": "Rate Limit Reset", "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e", "Message": "The current daily rate limit quota for client 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e has been reset to 1000 requests.", "Data": {"QuotaRemaining": 1000, "ResetReason": "The quota was reset because it is a new day.", "DailyQuota": 1000, "ExpiresUtc": "2022-10-23T00:00:00Z"}}
 generatedTests: {}

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

@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: false
     oAuth2PasswordEnabled: false
 python:
-  version: 8.0.2
+  version: 8.0.3
   additionalDependencies:
     dev: {}
     main: {}

sync-for-payables/README.md

@@ -35,23 +35,20 @@ poetry add codat-sync-for-payables
 ```python
 # Synchronous Example
 from codat_sync_for_payables import CodatSyncPayables
-from codat_sync_for_payables.models import shared
 
-with CodatSyncPayables(
-    security=shared.Security(
-        auth_header="Basic BASE_64_ENCODED(API_KEY)",
-    ),
-) as s:
-    res = s.companies.list(request={
-        "page": 1,
-        "page_size": 100,
-        "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
-        "order_by": "-modifiedDate",
+with CodatSyncPayables() as codat_sync_payables:
+    codat_sync_payables.client_rate_limit_reached(request={
+        "id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b",
+        "event_type": "client.rateLimit.reached",
+        "generated_date": "2024-09-01T00:00:00Z",
+        "payload": {
+            "daily_quota": 12000,
+            "quota_remaining": 0,
+            "expiry_date": "2024-09-01T12:14:14Z",
+        },
     })
 
-    if res is not None:
-        # handle response
-        pass
+    # Use the SDK ...
 ```
 
 </br>
@@ -61,24 +58,21 @@ The same SDK client can also be used to make asychronous requests by importing a
 # Asynchronous Example
 import asyncio
 from codat_sync_for_payables import CodatSyncPayables
-from codat_sync_for_payables.models import shared
 
 async def main():
-    async with CodatSyncPayables(
-        security=shared.Security(
-            auth_header="Basic BASE_64_ENCODED(API_KEY)",
-        ),
-    ) as s:
-        res = await s.companies.list_async(request={
-            "page": 1,
-            "page_size": 100,
-            "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
-            "order_by": "-modifiedDate",
+    async with CodatSyncPayables() as codat_sync_payables:
+        await codat_sync_payables.client_rate_limit_reached_async(request={
+            "id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b",
+            "event_type": "client.rateLimit.reached",
+            "generated_date": "2024-09-01T00:00:00Z",
+            "payload": {
+                "daily_quota": 12000,
+                "quota_remaining": 0,
+                "expiry_date": "2024-09-01T12:14:14Z",
+            },
         })
 
-        if res is not None:
-            # handle response
-            pass
+        # Use the SDK ...
 
 asyncio.run(main())
 ```
@@ -174,18 +168,23 @@ The bill pay kit is an API and a set of supporting tools designed to integrate a
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+  * [SDK Installation](#sdk-installation)
+  * [Example Usage](#example-usage)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Supported Integrations](#supported-integrations)
+  * [Endpoints](#endpoints)
+  * [IDE Support](#ide-support)
+  * [File uploads](#file-uploads)
+  * [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)
-* [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 IDE Support [idesupport] -->
@@ -216,8 +215,8 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.bills.upload_attachment(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.bills.upload_attachment(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
         "bill_id": "EILBDVJVNUAGVKRQ",
@@ -239,14 +238,14 @@ To change the default retry strategy for a single API call, simply provide a `Re
 ```python
 from codat_sync_for_payables import CodatSyncPayables
 from codat_sync_for_payables.models import shared
-from codatsyncpayables.utils import BackoffStrategy, RetryConfig
+from codat_sync_for_payables.utils import BackoffStrategy, RetryConfig
 
 with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.list(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.companies.list(request={
         "page": 1,
         "page_size": 100,
         "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
@@ -264,15 +263,15 @@ If you'd like to override the default retry strategy for all operations that sup
 ```python
 from codat_sync_for_payables import CodatSyncPayables
 from codat_sync_for_payables.models import shared
-from codatsyncpayables.utils import BackoffStrategy, RetryConfig
+from codat_sync_for_payables.utils import BackoffStrategy, RetryConfig
 
 with CodatSyncPayables(
     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.list(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.companies.list(request={
         "page": 1,
         "page_size": 100,
         "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
@@ -317,10 +316,10 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
+) as codat_sync_payables:
     res = None
     try:
-        res = s.companies.list(request={
+        res = codat_sync_payables.companies.list(request={
             "page": 1,
             "page_size": 100,
             "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
@@ -355,8 +354,8 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.list(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.companies.list(request={
         "page": 1,
         "page_size": 100,
         "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
@@ -471,8 +470,8 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.list(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.companies.list(request={
         "page": 1,
         "page_size": 100,
         "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",

sync-for-payables/RELEASES.md

@@ -68,4 +68,14 @@ Based on:
 ### Generated
 - [python v8.0.2] sync-for-payables
 ### Releases
-- [PyPI v8.0.2] https://pypi.org/project/codat-sync-for-payables/8.0.2 - sync-for-payables
+- [PyPI v8.0.2] https://pypi.org/project/codat-sync-for-payables/8.0.2 - sync-for-payables
+
+## 2024-12-10 10:22:29
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.453.8 (2.474.15) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v8.0.3] sync-for-payables
+### Releases
+- [PyPI v8.0.3] https://pypi.org/project/codat-sync-for-payables/8.0.3 - sync-for-payables

sync-for-payables/USAGE.md

@@ -8,8 +8,8 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.companies.list(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.companies.list(request={
         "page": 1,
         "page_size": 100,
         "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
@@ -35,8 +35,8 @@ async def main():
         security=shared.Security(
             auth_header="Basic BASE_64_ENCODED(API_KEY)",
         ),
-    ) as s:
-        res = await s.companies.list_async(request={
+    ) as codat_sync_payables:
+        res = await codat_sync_payables.companies.list_async(request={
             "page": 1,
             "page_size": 100,
             "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",

sync-for-payables/docs/sdks/bankaccounts/README.md

@@ -25,8 +25,8 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.bank_accounts.create(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.bank_accounts.create(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
         "bank_account_prototype": {

sync-for-payables/docs/sdks/billpayments/README.md

@@ -28,8 +28,8 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.bill_payments.get_payment_options(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.bill_payments.get_payment_options(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
         "continuation_token": "continuationToken=eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ==",
@@ -77,8 +77,8 @@ with CodatSyncPayables(
     security=shared.Security(
         auth_header="Basic BASE_64_ENCODED(API_KEY)",
     ),
-) as s:
-    res = s.bill_payments.create(request={
+) as codat_sync_payables:
+    res = codat_sync_payables.bill_payments.create(request={
         "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
         "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
         "bill_id": "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",