Merge pull request #626 from codatio/speakeasy-sdk-regen-1727874684

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

Author: dcoplowe

.speakeasy/workflow.lock

@@ -1,4 +1,4 @@
-speakeasyVersion: 1.396.7
+speakeasyVersion: 1.405.9
 sources:
     bank-feeds-source:
         sourceNamespace: bank-feeds-source
@@ -30,8 +30,8 @@ sources:
             - main
     sync-for-payables-source:
         sourceNamespace: sync-for-payables-source
-        sourceRevisionDigest: sha256:daca0e08a3d44b87bb2242380dfc8be94f2cb83b1ea0a252af7f31f9b0c2c247
-        sourceBlobDigest: sha256:6ed96ad8ecab289621839d0df446a473e3dc8ea83765e3316020a6670b44da0b
+        sourceRevisionDigest: sha256:15cdb98984bf13e095abd0570737564feb6d1c56000e3ff22b3dec5e0616315f
+        sourceBlobDigest: sha256:b2999b2b9b935bfc647fe90125f27429ceca251baba134fe2e1b28ee05204eb6
         tags:
             - latest
             - main
@@ -73,8 +73,8 @@ targets:
     sync-for-payables-library:
         source: sync-for-payables-source
         sourceNamespace: sync-for-payables-source
-        sourceRevisionDigest: sha256:daca0e08a3d44b87bb2242380dfc8be94f2cb83b1ea0a252af7f31f9b0c2c247
-        sourceBlobDigest: sha256:6ed96ad8ecab289621839d0df446a473e3dc8ea83765e3316020a6670b44da0b
+        sourceRevisionDigest: sha256:15cdb98984bf13e095abd0570737564feb6d1c56000e3ff22b3dec5e0616315f
+        sourceBlobDigest: sha256:b2999b2b9b935bfc647fe90125f27429ceca251baba134fe2e1b28ee05204eb6
     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

@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: false
   telemetryEnabled: true
 typescript:
-  version: 4.0.0
+  version: 5.0.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
@@ -24,6 +24,7 @@ typescript:
   description: Streamline your customers' accounts payable workflow.
   enumFormat: union
   flattenGlobalSecurity: true
+  flatteningOrder: body-first
   imports:
     option: openapi
     paths:

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

@@ -57,7 +57,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

sync-for-payables/FUNCTIONS.md

@@ -322,15 +322,24 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
 
-| Error Object                    | Status Code                     | Content Type                    |
-| ------------------------------- | ------------------------------- | ------------------------------- |
-| errors.ErrorMessage             | 400,401,402,403,404,429,500,503 | application/json                |
-| errors.SDKError                 | 4xx-5xx                         | */*                             |
+If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. 
+| HTTP Client Error                                    | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- |
+| RequestAbortedError                                  | HTTP request was aborted by the client               |
+| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
+| ConnectionError                                      | HTTP client was unable to make a request to a server |
+| InvalidRequestError                                  | Any input used to create a request is invalid        |
+| UnexpectedClientError                                | Unrecognised or unexpected error                     |
 
+In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `list` method may throw the following errors:
+
+| Error Type                             | Status Code                            | Content Type                           |
+| -------------------------------------- | -------------------------------------- | -------------------------------------- |
+| errors.ErrorMessage                    | 400, 401, 402, 403, 404, 429, 500, 503 | application/json                       |
+| errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
 
 ```typescript
 import { CodatSyncPayables } from "@codat/sync-for-payables";
@@ -379,6 +388,8 @@ async function run() {
 run();
 
 ```
+
+Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->

sync-for-payables/README.md

@@ -8,4 +8,14 @@ Based on:
 ### Generated
 - [typescript v4.0.0] sync-for-payables
 ### Releases
-- [NPM v4.0.0] https://www.npmjs.com/package/@codat/sync-for-payables/v/4.0.0 - sync-for-payables
+- [NPM v4.0.0] https://www.npmjs.com/package/@codat/sync-for-payables/v/4.0.0 - sync-for-payables
+
+## 2024-10-02 13:11:12
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.405.9 (2.429.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v5.0.0] sync-for-payables
+### Releases
+- [NPM v5.0.0] https://www.npmjs.com/package/@codat/sync-for-payables/v/5.0.0 - sync-for-payables

sync-for-payables/RELEASES.md

@@ -1,6 +1,6 @@
 # ErrorMessage
 
-The request made is not valid.
+Your `query` parameter was not correctly formed
 
 ## Example Usage
 

sync-for-payables/docs/sdk/models/errors/errormessage.md

@@ -10,9 +10,9 @@ let value: CreateBankAccountRequest = {
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   bankAccountPrototype: {
     name: "<value>",
-    accountType: "Unknown",
+    accountType: "Credit",
     accountNumber: "<value>",
-    currency: "USD",
+    currency: "GBP",
   },
 };
 ```

sync-for-payables/docs/sdk/models/operations/createbankaccountrequest.md

@@ -9,7 +9,7 @@ import { Decimal } from "@codat/sync-for-payables/sdk/types";
 let value: CreateBillPaymentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  billId: "EILBDVJVNUAGVKRQ",
+  billId: "13d946f0-c5d5-42bc-b092-97ece17923ab",
   billPaymentPrototype: {
     amount: new Decimal("1329.54"),
     date: "2022-10-23T00:00:00Z",

sync-for-payables/docs/sdk/models/operations/createbillpaymentrequest.md

@@ -10,8 +10,8 @@ let value: CreateSupplierRequest = {
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   supplierPrototype: {
     supplierName: "<value>",
-    phone: "+44 25691 154789",
-    status: "Active",
+    phone: "(877) 492-8687",
+    status: "Unknown",
   },
 };
 ```