@codat/lending 3.1.0 → 3.3.0

package/docs/sdks/dataintegrity/README.md

@@ -1,4 +1,5 @@
 # DataIntegrity
+(*dataIntegrity*)
 
 ## Overview
 
@@ -20,27 +21,27 @@ The [details](https://docs.codat.io/lending-api#/schemas/DataIntegrityDetails) a
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { ListDataIntegrityDetailsResponse } from "@codat/lending/dist/sdk/models/operations";
 import { DataIntegrityDataType } from "@codat/lending/dist/sdk/models/shared";
 
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.dataIntegrity.details({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  dataType: DataIntegrityDataType.BankingAccounts,
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "deserunt",
-}).then((res: ListDataIntegrityDetailsResponse) => {
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.dataIntegrity.details({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    dataType: DataIntegrityDataType.BankingAccounts,
+    orderBy: "-modifiedDate",
+    page: 1,
+    pageSize: 100,
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -72,23 +73,24 @@ The response tells you:
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetDataIntegrityStatusResponse } from "@codat/lending/dist/sdk/models/operations";
 import { DataIntegrityDataType } from "@codat/lending/dist/sdk/models/shared";
 
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.dataIntegrity.status({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    dataType: DataIntegrityDataType.BankingAccounts,
+  });
 
-sdk.dataIntegrity.status({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  dataType: DataIntegrityDataType.BankingAccounts,
-}).then((res: GetDataIntegrityStatusResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -117,24 +119,24 @@ The endpoint response includes only the summary results, not transactions. To vi
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetDataIntegritySummariesResponse } from "@codat/lending/dist/sdk/models/operations";
 import { DataIntegrityDataType } from "@codat/lending/dist/sdk/models/shared";
 
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.dataIntegrity.summaries({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  dataType: DataIntegrityDataType.BankingAccounts,
-  query: "suscipit",
-}).then((res: GetDataIntegritySummariesResponse) => {
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.dataIntegrity.summaries({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    dataType: DataIntegrityDataType.BankingAccounts,
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters

package/docs/sdks/excelreports/README.md

@@ -1,4 +1,5 @@
 # ExcelReports
+(*excelReports*)
 
 ## Overview
 
@@ -22,23 +23,24 @@ You can [learn more](https://docs.codat.io/lending/excel/overview) about valid E
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { DownloadExcelReportResponse } from "@codat/lending/dist/sdk/models/operations";
 import { ExcelReportTypes } from "@codat/lending/dist/sdk/models/shared";
 
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.excelReports.download({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    reportType: ExcelReportTypes.EnhancedFinancials,
+  });
 
-sdk.excelReports.download({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  reportType: ExcelReportTypes.EnhancedFinancials,
-}).then((res: DownloadExcelReportResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -79,23 +81,24 @@ In response, the endpoint returns the [status](https://docs.codat.io/lending-api
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GenerateExcelReportResponse } from "@codat/lending/dist/sdk/models/operations";
 import { ExcelReportTypes } from "@codat/lending/dist/sdk/models/shared";
 
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.excelReports.generate({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    reportType: ExcelReportTypes.EnhancedInvoices,
+  });
 
-sdk.excelReports.generate({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  reportType: ExcelReportTypes.EnhancedFinancials,
-}).then((res: GenerateExcelReportResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -124,23 +127,24 @@ When the report generation completes successfully, the `inProgress` property wil
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetExcelReportGenerationStatusResponse } from "@codat/lending/dist/sdk/models/operations";
 import { ExcelReportTypes } from "@codat/lending/dist/sdk/models/shared";
 
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.excelReports.getStatus({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    reportType: ExcelReportTypes.EnhancedCashFlow,
+  });
 
-sdk.excelReports.getStatus({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  reportType: ExcelReportTypes.EnhancedCashFlow,
-}).then((res: GetExcelReportGenerationStatusResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters

package/docs/sdks/fileupload/README.md

@@ -1,4 +1,5 @@
 # FileUpload
+(*fileUpload*)
 
 ## Overview
 
@@ -18,22 +19,23 @@ The *Download files* endpoint downloads all files that have  been uploaded by to
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { DownloadFilesResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.fileUpload.download({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  date: "2022-10-23T00:00:00.000Z",
-}).then((res: DownloadFilesResponse) => {
+
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.fileUpload.download({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    date: "2022-10-23T00:00:00.000Z",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -58,21 +60,22 @@ sdk.fileUpload.download({
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { ListFilesResponse } from "@codat/lending/dist/sdk/models/operations";
 
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.fileUpload.listUploaded({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  });
 
-sdk.fileUpload.listUploaded({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: ListFilesResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -103,26 +106,27 @@ Uploaded files must meet the following requirements:
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { UploadFilesResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.fileUpload.upload({
-  requestBody: {
-    content: "delectus".encode(),
-    requestBody: "tempora",
-  },
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-}).then((res: UploadFilesResponse) => {
+
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.fileUpload.upload({
+    requestBody: {
+      content: "F?SRSKG@^n" as bytes <<<>>>,
+      requestBody: "ullam",
+    },
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters

package/docs/sdks/financialstatements/README.md

@@ -1,4 +1,5 @@
 # FinancialStatements
+(*financialStatements*)
 
 ### Available Operations
 

package/docs/sdks/financialstatementsaccounts/README.md

@@ -1,4 +1,5 @@
-# FinancialStatements.Accounts
+# FinancialStatementsAccounts
+(*financialStatements.accounts*)
 
 ### Available Operations
 
@@ -9,7 +10,7 @@
 
 The *Get account* endpoint returns a single account for a given accountId.
 
-[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
+[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions.
 
 Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account.
 
@@ -20,22 +21,23 @@ Before using this endpoint, you must have [retrieved data for the company](https
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetAccountingAccountResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.financialStatements.accounts.get({
-  accountId: "cum",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: GetAccountingAccountResponse) => {
+
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.financialStatements.accounts.get({
+    accountId: "Northeast Hatchback Kia",
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -54,9 +56,9 @@ sdk.financialStatements.accounts.get({
 
 ## list
 
-The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.
+The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection.
 
-[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.
+[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions.
 
 Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
 
@@ -64,25 +66,25 @@ Before using this endpoint, you must have [retrieved data for the company](https
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { ListAccountingAccountsResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.financialStatements.accounts.list({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "esse",
-}).then((res: ListAccountingAccountsResponse) => {
+
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.financialStatements.accounts.list({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    orderBy: "-modifiedDate",
+    page: 1,
+    pageSize: 100,
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters

package/docs/sdks/financialstatementsbalancesheet/README.md

@@ -1,4 +1,5 @@
-# FinancialStatements.BalanceSheet
+# FinancialStatementsBalanceSheet
+(*financialStatements.balanceSheet*)
 
 ### Available Operations
 
@@ -13,24 +14,25 @@ Gets the latest balance sheet for a company.
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetAccountingBalanceSheetResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.financialStatements.balanceSheet.get({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  periodLength: 4,
-  periodsToCompare: 20,
-  startMonth: "2022-10-23T00:00:00.000Z",
-}).then((res: GetAccountingBalanceSheetResponse) => {
+
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.financialStatements.balanceSheet.get({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    periodLength: 4,
+    periodsToCompare: 20,
+    startMonth: "2022-10-23T00:00:00.000Z",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -57,23 +59,23 @@ Codat suggests a category for each account automatically, but you can [change it
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetCategorizedBalanceSheetStatementResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.financialStatements.balanceSheet.getCategorizedAccounts({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  numberOfPeriods: 568434,
-  reportDate: "29-09-2020",
-}).then((res: GetCategorizedBalanceSheetStatementResponse) => {
+
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.financialStatements.balanceSheet.getCategorizedAccounts({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    reportDate: "29-09-2020",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters

package/docs/sdks/financialstatementscashflow/README.md

@@ -1,4 +1,5 @@
-# FinancialStatements.CashFlow
+# FinancialStatementsCashFlow
+(*financialStatements.cashFlow*)
 
 ### Available Operations
 
@@ -12,24 +13,25 @@ Gets the latest cash flow statement for a company.
 
 ```typescript
 import { CodatLending } from "@codat/lending";
-import { GetAccountingCashFlowStatementResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.financialStatements.cashFlow.get({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  periodLength: 4,
-  periodsToCompare: 20,
-  startMonth: "2022-10-23T00:00:00.000Z",
-}).then((res: GetAccountingCashFlowStatementResponse) => {
+
+(async() => {
+  const sdk = new CodatLending({
+    security: {
+      authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+    },
+  });
+
+  const res = await sdk.financialStatements.cashFlow.get({
+    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+    periodLength: 4,
+    periodsToCompare: 20,
+    startMonth: "2022-10-23T00:00:00.000Z",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters