Merge pull request #636 from codatio/speakeasy-sdk-regen-1731929393

chore: 🐝 Update SDK - Generate Lending library LENDING-LIBRARY 6.0.0
codatio · Nov 18, 2024 · ca67139 · ca67139
2 parents 97419dc + 1eb7198
commit ca67139
Show file tree

Hide file tree

Showing 675 changed files with 10,510 additions and 933 deletions.
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,4 +1,4 @@
-speakeasyVersion: 1.431.0
+speakeasyVersion: 1.440.1
 sources:
     bank-feeds-source:
         sourceNamespace: bank-feeds-source
@@ -9,11 +9,11 @@ sources:
             - main
     lending-source:
         sourceNamespace: lending-source
-        sourceRevisionDigest: sha256:bd7877dd3f3d99abd879a74e4be10c6181664007b1474c4ab8235112a43564e6
-        sourceBlobDigest: sha256:4525ee073b57729cfcb4c57cd3715fd634d44b091eb42b011966d87654980fc2
+        sourceRevisionDigest: sha256:b3548be46af843e3792df7d5d24e0b1cbf514587a99c9f58d2ad68781f4568bd
+        sourceBlobDigest: sha256:0bb930c7190c9e61384e5af6224f76ea004ad9bc0788b264aaa35b9ebad5699f
         tags:
             - latest
-            - main
+            - speakeasy-sdk-regen-1731929393
     platform-source:
         sourceNamespace: platform-source
         sourceRevisionDigest: sha256:a1a4c526fcfc87fde0b60e9b93d029b97f71ddefc60ac7e114d8195c03ba60a2
@@ -65,8 +65,10 @@ targets:
     lending-library:
         source: lending-source
         sourceNamespace: lending-source
-        sourceRevisionDigest: sha256:bd7877dd3f3d99abd879a74e4be10c6181664007b1474c4ab8235112a43564e6
-        sourceBlobDigest: sha256:4525ee073b57729cfcb4c57cd3715fd634d44b091eb42b011966d87654980fc2
+        sourceRevisionDigest: sha256:b3548be46af843e3792df7d5d24e0b1cbf514587a99c9f58d2ad68781f4568bd
+        sourceBlobDigest: sha256:0bb930c7190c9e61384e5af6224f76ea004ad9bc0788b264aaa35b9ebad5699f
+        codeSamplesNamespace: lending-source-code-samples
+        codeSamplesRevisionDigest: sha256:95281315f00396773c4691cce5871db7b7afce89c5a0fc4264e9fd374e0d5021
     platform-library:
         source: platform-source
         sourceNamespace: platform-source
@@ -226,6 +228,10 @@ workflow:
             publish:
                 npm:
                     token: $npm_token
+            codeSamples:
+                registry:
+                    location: registry.speakeasyapi.dev/codat/codat/lending-source-code-samples
+                blocking: false
         platform-library:
             target: typescript
             source: platform-source

diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml
@@ -126,6 +126,10 @@ targets:
         publish:
             npm:
                 token: $npm_token
+        codeSamples:
+            registry:
+                location: registry.speakeasyapi.dev/codat/codat/lending-source-code-samples
+            blocking: false
     platform-library:
         target: typescript
         source: platform-source

diff --git a/lending/.speakeasy/gen.lock b/lending/.speakeasy/gen.lock
diff --git a/lending/.speakeasy/gen.yaml b/lending/.speakeasy/gen.yaml
@@ -14,14 +14,15 @@ generation:
     oAuth2PasswordEnabled: false
   telemetryEnabled: true
 typescript:
-  version: 5.0.0
+  version: 6.0.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
     peerDependencies: {}
   additionalPackageJSON: {}
   author: Codat
   clientServerStatusCodesAsErrors: true
+  defaultErrorName: SDKError
   description: Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.
   enumFormat: union
   flattenGlobalSecurity: true

diff --git a/lending/README.md b/lending/README.md
@@ -769,10 +769,10 @@ If a HTTP request fails, an operation my also throw an error from the `sdk/model
 
 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                               | \*/\*                                  |
+| Error Type          | Status Code                            | Content Type     |
+| ------------------- | -------------------------------------- | ---------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json |
+| errors.SDKError     | 4XX, 5XX                               | \*/\*            |
 
 ```typescript
 import { CodatLending } from "@codat/lending";
@@ -828,43 +828,9 @@ Validation errors can also occur when either method arguments or data returned f
 <!-- Start Server Selection [server] -->
 ## Server Selection
 
-### Select Server by Index
-
-You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
-
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `https://api.codat.io` | None |
-
-```typescript
-import { CodatLending } from "@codat/lending";
-
-const codatLending = new CodatLending({
-  serverIdx: 0,
-  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
-  const result = await codatLending.companies.list({
-    page: 1,
-    pageSize: 100,
-    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
-    orderBy: "-modifiedDate",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-
-```
-
-
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
-
+The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { CodatLending } from "@codat/lending";
 
@@ -946,9 +912,9 @@ const sdk = new CodatLending({ httpClient });
 
 This SDK supports the following security scheme globally:
 
-| Name         | Type         | Scheme       |
-| ------------ | ------------ | ------------ |
-| `authHeader` | apiKey       | API key      |
+| Name         | Type   | Scheme  |
+| ------------ | ------ | ------- |
+| `authHeader` | apiKey | API key |
 
 To authenticate with the API the `authHeader` parameter must be set when initializing the SDK client instance. For example:
 ```typescript

diff --git a/lending/RELEASES.md b/lending/RELEASES.md
@@ -118,4 +118,14 @@ Based on:
 ### Generated
 - [typescript v5.0.0] lending
 ### Releases
-- [NPM v5.0.0] https://www.npmjs.com/package/@codat/lending/v/5.0.0 - lending
+- [NPM v5.0.0] https://www.npmjs.com/package/@codat/lending/v/5.0.0 - lending
+
+## 2024-11-18 11:29:43
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.440.1 (2.460.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v6.0.0] lending
+### Releases
+- [NPM v6.0.0] https://www.npmjs.com/package/@codat/lending/v/6.0.0 - lending
diff --git a/lending/docs/sdk/models/operations/createaccountrequest.md b/lending/docs/sdk/models/operations/createaccountrequest.md
@@ -15,8 +15,8 @@ let value: CreateAccountRequest = {
     description:
       "Invoices the business has issued but has not yet collected payment on.",
     fullyQualifiedCategory: "Asset.Current",
-    fullyQualifiedName: "Fixed Asset",
-    currency: "GBP",
+    fullyQualifiedName: "Cash On Hand",
+    currency: "EUR",
     currentBalance: new Decimal("0"),
     type: "Asset",
     status: "Active",

diff --git a/lending/docs/sdk/models/operations/createsourceaccountrequest.md b/lending/docs/sdk/models/operations/createsourceaccountrequest.md
@@ -11,15 +11,24 @@ let value: CreateSourceAccountRequest = {
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
   requestBody: {
     id: "acc-002",
-    accountName: "account-081",
-    accountType: "Credit",
-    accountNumber: "12345670",
-    sortCode: "123456",
+    accountName: "account-083",
+    accountType: "savings",
+    accountNumber: "23456789",
+    routingInfo: {
+      bankCode: "21001088",
+      type: "bankcode",
+    },
     currency: "GBP",
-    balance: new Decimal("99.99"),
-    modifiedDate: "2023-01-09T14:14:14.1057478Z",
+    balance: new Decimal("400"),
+    accountInfo: {
+      description: "account description 2",
+      nickname: "account 1290",
+      accountOpenDate: "2023-05-23T00:00:00Z",
+      availableBalance: new Decimal("400"),
+    },
+    modifiedDate: "2024-08-02T00:00:00.000Z",
     status: "pending",
-    feedStartDate: "2022-10-23T00:00:00Z",
+    feedStartDate: "2024-05-01T00:00:00Z",
   },
 };
 ```

diff --git a/lending/docs/sdk/models/operations/createsourceaccountrequestbody.md b/lending/docs/sdk/models/operations/createsourceaccountrequestbody.md
@@ -7,21 +7,21 @@
 
 ```typescript
 const value: shared.SourceAccountV2 = {
-  id: "acc-002",
-  accountName: "account-083",
-  accountType: "savings",
-  accountNumber: "23456789",
+  id: "acc-001",
+  accountName: "account-081",
+  accountType: "checking",
+  accountNumber: "12345670",
   routingInfo: {
     bankCode: "21001088",
     type: "bankcode",
   },
   currency: "GBP",
-  balance: new Decimal("400"),
+  balance: new Decimal("99.99"),
   accountInfo: {
-    description: "account description 2",
-    nickname: "account 1290",
-    accountOpenDate: "2023-05-23T00:00:00Z",
-    availableBalance: new Decimal("400"),
+    description: "account description 1",
+    nickname: "account 123",
+    accountOpenDate: "2023-05-06T00:00:00Z",
+    availableBalance: new Decimal("10"),
   },
   modifiedDate: "2024-08-02T00:00:00.000Z",
   status: "pending",
@@ -33,13 +33,13 @@ const value: shared.SourceAccountV2 = {
 
 ```typescript
 const value: shared.SourceAccount = {
-  id: "acc-002",
-  accountName: "account-081",
+  id: "acc-003",
+  accountName: "account-095",
   accountType: "Credit",
-  accountNumber: "12345670",
+  accountNumber: "12345671",
   sortCode: "123456",
-  currency: "GBP",
-  balance: new Decimal("99.99"),
+  currency: "USD",
+  balance: new Decimal("0"),
   modifiedDate: "2023-01-09T14:14:14.1057478Z",
   status: "pending",
   feedStartDate: "2022-10-23T00:00:00Z",

diff --git a/lending/docs/sdk/models/operations/createtransferrequest.md b/lending/docs/sdk/models/operations/createtransferrequest.md
@@ -13,11 +13,15 @@ let value: CreateTransferRequest = {
     sourceModifiedDate: "2022-10-23T00:00:00Z",
     date: "2022-10-23T00:00:00Z",
     from: {
-      accountRef: {},
+      accountRef: {
+        dataType: "invoice",
+      },
       currency: "GBP",
     },
     to: {
-      accountRef: {},
+      accountRef: {
+        dataType: "invoice",
+      },
       currency: "GBP",
     },
     depositedRecordRefs: [

diff --git a/lending/docs/sdk/models/operations/downloadaccountingcustomerattachmentrequest.md b/lending/docs/sdk/models/operations/downloadaccountingcustomerattachmentrequest.md
@@ -8,7 +8,7 @@ import { DownloadAccountingCustomerAttachmentRequest } from "@codat/lending/sdk/
 let value: DownloadAccountingCustomerAttachmentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  customerId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
+  customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab",
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 };
 ```

diff --git a/...ing/docs/sdk/models/operations/downloadaccountingdirectcostattachmentrequest.md b/...ing/docs/sdk/models/operations/downloadaccountingdirectcostattachmentrequest.md
@@ -8,7 +8,7 @@ import { DownloadAccountingDirectCostAttachmentRequest } from "@codat/lending/sd
 let value: DownloadAccountingDirectCostAttachmentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  directCostId: "13d946f0-c5d5-42bc-b092-97ece17923ab",
+  directCostId: "7110701885",
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 };
 ```

diff --git a/...g/docs/sdk/models/operations/downloadaccountingdirectincomeattachmentrequest.md b/...g/docs/sdk/models/operations/downloadaccountingdirectincomeattachmentrequest.md
@@ -8,7 +8,7 @@ import { DownloadAccountingDirectIncomeAttachmentRequest } from "@codat/lending/
 let value: DownloadAccountingDirectIncomeAttachmentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  directIncomeId: "7110701885",
+  directIncomeId: "EILBDVJVNUAGVKRQ",
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 };
 ```

diff --git a/lending/docs/sdk/models/operations/downloadaccountinginvoiceattachmentrequest.md b/lending/docs/sdk/models/operations/downloadaccountinginvoiceattachmentrequest.md
@@ -8,7 +8,7 @@ import { DownloadAccountingInvoiceAttachmentRequest } from "@codat/lending/sdk/m
 let value: DownloadAccountingInvoiceAttachmentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  invoiceId: "EILBDVJVNUAGVKRQ",
+  invoiceId: "13d946f0-c5d5-42bc-b092-97ece17923ab",
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 };
 ```

diff --git a/lending/docs/sdk/models/operations/downloadaccountinginvoicepdfrequest.md b/lending/docs/sdk/models/operations/downloadaccountinginvoicepdfrequest.md
@@ -7,7 +7,7 @@ import { DownloadAccountingInvoicePdfRequest } from "@codat/lending/sdk/models/o
 
 let value: DownloadAccountingInvoicePdfRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  invoiceId: "EILBDVJVNUAGVKRQ",
+  invoiceId: "7110701885",
 };
 ```
 

diff --git a/lending/docs/sdk/models/operations/downloadaccountingsupplierattachmentrequest.md b/lending/docs/sdk/models/operations/downloadaccountingsupplierattachmentrequest.md
@@ -8,7 +8,7 @@ import { DownloadAccountingSupplierAttachmentRequest } from "@codat/lending/sdk/
 let value: DownloadAccountingSupplierAttachmentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  supplierId: "EILBDVJVNUAGVKRQ",
+  supplierId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 };
 ```

diff --git a/lending/docs/sdk/models/operations/generateexcelreportrequest.md b/lending/docs/sdk/models/operations/generateexcelreportrequest.md
@@ -7,7 +7,7 @@ import { GenerateExcelReportRequest } from "@codat/lending/sdk/models/operations
 
 let value: GenerateExcelReportRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  reportType: "enhancedFinancials",
+  reportType: "enhancedInvoices",
 };
 ```
 

diff --git a/lending/docs/sdk/models/operations/generateloansummaryrequest.md b/lending/docs/sdk/models/operations/generateloansummaryrequest.md
@@ -7,7 +7,7 @@ import { GenerateLoanSummaryRequest } from "@codat/lending/sdk/models/operations
 
 let value: GenerateLoanSummaryRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  sourceType: "commerce",
+  sourceType: "banking",
 };
 ```
 

diff --git a/lending/docs/sdk/models/operations/getaccountingaccountrequest.md b/lending/docs/sdk/models/operations/getaccountingaccountrequest.md
@@ -7,7 +7,7 @@ import { GetAccountingAccountRequest } from "@codat/lending/sdk/models/operation
 
 let value: GetAccountingAccountRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  accountId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
+  accountId: "EILBDVJVNUAGVKRQ",
 };
 ```
 

diff --git a/lending/docs/sdk/models/operations/getaccountingbillattachmentrequest.md b/lending/docs/sdk/models/operations/getaccountingbillattachmentrequest.md
@@ -8,7 +8,7 @@ import { GetAccountingBillAttachmentRequest } from "@codat/lending/sdk/models/op
 let value: GetAccountingBillAttachmentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  billId: "7110701885",
+  billId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 };
 ```

diff --git a/lending/docs/sdk/models/operations/getaccountingbillcreditnoterequest.md b/lending/docs/sdk/models/operations/getaccountingbillcreditnoterequest.md
@@ -7,7 +7,7 @@ import { GetAccountingBillCreditNoteRequest } from "@codat/lending/sdk/models/op
 
 let value: GetAccountingBillCreditNoteRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  billCreditNoteId: "7110701885",
+  billCreditNoteId: "EILBDVJVNUAGVKRQ",
 };
 ```
 

diff --git a/lending/docs/sdk/models/operations/getaccountingbillrequest.md b/lending/docs/sdk/models/operations/getaccountingbillrequest.md
@@ -7,7 +7,7 @@ import { GetAccountingBillRequest } from "@codat/lending/sdk/models/operations";
 
 let value: GetAccountingBillRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  billId: "EILBDVJVNUAGVKRQ",
+  billId: "7110701885",
 };
 ```
 

diff --git a/lending/docs/sdk/models/operations/getaccountingcustomerattachmentrequest.md b/lending/docs/sdk/models/operations/getaccountingcustomerattachmentrequest.md
@@ -8,7 +8,7 @@ import { GetAccountingCustomerAttachmentRequest } from "@codat/lending/sdk/model
 let value: GetAccountingCustomerAttachmentRequest = {
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  customerId: "13d946f0-c5d5-42bc-b092-97ece17923ab",
+  customerId: "7110701885",
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 };
 ```