@codat/lending 0.1.0 → 1.1.0

package/docs/sdks/financialstatementsprofitandloss/README.md

@@ -0,0 +1,91 @@
+# financialStatementsProfitAndLoss
+
+### Available Operations
+
+* [get](#get) - Get profit and loss
+* [getCategorizedAccounts](#getcategorizedaccounts) - Get categorized profit and loss statement
+
+## get
+
+Gets the latest profit and loss for a company.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetAccountingProfitAndLossResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.financialStatementsProfitAndLoss.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  periodLength: 4,
+  periodsToCompare: 20,
+  startMonth: "2022-10-23T00:00:00.000Z",
+}).then((res: GetAccountingProfitAndLossResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                    | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                    | [operations.GetAccountingProfitAndLossRequest](../../models/operations/getaccountingprofitandlossrequest.md) | :heavy_check_mark:                                                                                           | The request object to use for the request.                                                                   |
+| `retries`                                                                                                    | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                       | :heavy_minus_sign:                                                                                           | Configuration to override the default retry behavior of the client.                                          |
+| `config`                                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                 | :heavy_minus_sign:                                                                                           | Available config options for making requests.                                                                |
+
+
+### Response
+
+**Promise<[operations.GetAccountingProfitAndLossResponse](../../models/operations/getaccountingprofitandlossresponse.md)>**
+
+
+## getCategorizedAccounts
+
+The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date.
+
+Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/enhanced-financials/overview#categorize-accounts) to a more suitable one.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetCategorizedProfitAndLossStatementResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.financialStatementsProfitAndLoss.getCategorizedAccounts({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  numberOfPeriods: 324141,
+  reportDate: "29-09-2020",
+}).then((res: GetCategorizedProfitAndLossStatementResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                                                        | Type                                                                                                                             | Required                                                                                                                         | Description                                                                                                                      |
+| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                                        | [operations.GetCategorizedProfitAndLossStatementRequest](../../models/operations/getcategorizedprofitandlossstatementrequest.md) | :heavy_check_mark:                                                                                                               | The request object to use for the request.                                                                                       |
+| `retries`                                                                                                                        | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                           | :heavy_minus_sign:                                                                                                               | Configuration to override the default retry behavior of the client.                                                              |
+| `config`                                                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                                     | :heavy_minus_sign:                                                                                                               | Available config options for making requests.                                                                                    |
+
+
+### Response
+
+**Promise<[operations.GetCategorizedProfitAndLossStatementResponse](../../models/operations/getcategorizedprofitandlossstatementresponse.md)>**
+

package/docs/sdks/liabilities/README.md

@@ -6,12 +6,12 @@ Debt and other liabilities.
 
 ### Available Operations
 
-* [getLoanSummary](#getloansummary) - Get enhanced loan summaries
-* [listLoanTransactions](#listloantransactions) - List enhanced loan transactions
+* [getLoanSummary](#getloansummary) - Get loan summaries
+* [listLoanTransactions](#listloantransactions) - List loan transactions
 
 ## getLoanSummary
 
-The *Get enhanced loan summaries* endpoint returns a summary by integration type of all loans identified in each integration.
+The *Get loan summaries* endpoint returns a summary by integration type of all loans identified in each integration.
 
 The endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection.
 
@@ -55,7 +55,7 @@ sdk.liabilities.getLoanSummary({
 
 ## listLoanTransactions
 
-The *List enhanced loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations.
+The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations.
 
 This detail gives analysts a better idea of the loan obligations a company may have.
 

package/docs/sdks/managedata/README.md

@@ -1,18 +1,10 @@
 # manageData
 
-## Overview
-
-Control how data is retrieved from an integration.
-
 ### Available Operations
 
-* [get](#get) - Get data status
-* [getPullOperation](#getpulloperation) - Get pull operation
-* [listPullOperations](#listpulloperations) - List pull operations
-* [refreshAllDataTypes](#refreshalldatatypes) - Refresh all data
-* [refreshDataType](#refreshdatatype) - Refresh data type
+* [getStatus](#getstatus) - Get data status
 
-## get
+## getStatus
 
 Get the state of each data type for a company
 
@@ -28,7 +20,7 @@ const sdk = new CodatLending({
   },
 });
 
-sdk.manageData.get({
+sdk.manageData.getStatus({
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
 }).then((res: GetDataStatusResponse) => {
   if (res.statusCode == 200) {
@@ -50,173 +42,3 @@ sdk.manageData.get({
 
 **Promise<[operations.GetDataStatusResponse](../../models/operations/getdatastatusresponse.md)>**
 
-
-## getPullOperation
-
-Retrieve information about a single dataset or pull operation.
-
-### Example Usage
-
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetPullOperationResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.manageData.getPullOperation({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  datasetId: "eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18",
-}).then((res: GetPullOperationResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-
-### Parameters
-
-| Parameter                                                                                | Type                                                                                     | Required                                                                                 | Description                                                                              |
-| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| `request`                                                                                | [operations.GetPullOperationRequest](../../models/operations/getpulloperationrequest.md) | :heavy_check_mark:                                                                       | The request object to use for the request.                                               |
-| `retries`                                                                                | [utils.RetryConfig](../../models/utils/retryconfig.md)                                   | :heavy_minus_sign:                                                                       | Configuration to override the default retry behavior of the client.                      |
-| `config`                                                                                 | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                             | :heavy_minus_sign:                                                                       | Available config options for making requests.                                            |
-
-
-### Response
-
-**Promise<[operations.GetPullOperationResponse](../../models/operations/getpulloperationresponse.md)>**
-
-
-## listPullOperations
-
-Gets the pull operation history (datasets) for a given company.
-
-### Example Usage
-
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListPullOperationsResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.manageData.listPullOperations({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "ad",
-}).then((res: ListPullOperationsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-
-### Parameters
-
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.ListPullOperationsRequest](../../models/operations/listpulloperationsrequest.md) | :heavy_check_mark:                                                                           | The request object to use for the request.                                                   |
-| `retries`                                                                                    | [utils.RetryConfig](../../models/utils/retryconfig.md)                                       | :heavy_minus_sign:                                                                           | Configuration to override the default retry behavior of the client.                          |
-| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
-
-
-### Response
-
-**Promise<[operations.ListPullOperationsResponse](../../models/operations/listpulloperationsresponse.md)>**
-
-
-## refreshAllDataTypes
-
-Refreshes all data types with `fetch on first link` set to `true` for a given company.
-
-This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
-
-[Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.
-
-### Example Usage
-
-```typescript
-import { CodatLending } from "@codat/lending";
-import { RefreshAllDataTypesResponse } from "@codat/lending/dist/sdk/models/operations";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.manageData.refreshAllDataTypes({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: RefreshAllDataTypesResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-
-### Parameters
-
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.RefreshAllDataTypesRequest](../../models/operations/refreshalldatatypesrequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
-| `retries`                                                                                      | [utils.RetryConfig](../../models/utils/retryconfig.md)                                         | :heavy_minus_sign:                                                                             | Configuration to override the default retry behavior of the client.                            |
-| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
-
-
-### Response
-
-**Promise<[operations.RefreshAllDataTypesResponse](../../models/operations/refreshalldatatypesresponse.md)>**
-
-
-## refreshDataType
-
-Refreshes a given data type for a given company.
-
-This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
-
-### Example Usage
-
-```typescript
-import { CodatLending } from "@codat/lending";
-import { RefreshDataTypeResponse } from "@codat/lending/dist/sdk/models/operations";
-import { DataType } from "@codat/lending/dist/sdk/models/shared";
-
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-
-sdk.manageData.refreshDataType({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "929396fe-a759-46eb-90fa-aa2352c59559",
-  dataType: DataType.Invoices,
-}).then((res: RefreshDataTypeResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-
-### Parameters
-
-| Parameter                                                                              | Type                                                                                   | Required                                                                               | Description                                                                            |
-| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
-| `request`                                                                              | [operations.RefreshDataTypeRequest](../../models/operations/refreshdatatyperequest.md) | :heavy_check_mark:                                                                     | The request object to use for the request.                                             |
-| `retries`                                                                              | [utils.RetryConfig](../../models/utils/retryconfig.md)                                 | :heavy_minus_sign:                                                                     | Configuration to override the default retry behavior of the client.                    |
-| `config`                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                           | :heavy_minus_sign:                                                                     | Available config options for making requests.                                          |
-
-
-### Response
-
-**Promise<[operations.RefreshDataTypeResponse](../../models/operations/refreshdatatyperesponse.md)>**
-

package/docs/sdks/managedatapulloperations/README.md

@@ -0,0 +1,89 @@
+# manageDataPullOperations
+
+### Available Operations
+
+* [get](#get) - Get pull operation
+* [list](#list) - List pull operations
+
+## get
+
+Retrieve information about a single dataset or pull operation.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetPullOperationResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.manageDataPullOperations.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  datasetId: "eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18",
+}).then((res: GetPullOperationResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                | Type                                                                                     | Required                                                                                 | Description                                                                              |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `request`                                                                                | [operations.GetPullOperationRequest](../../models/operations/getpulloperationrequest.md) | :heavy_check_mark:                                                                       | The request object to use for the request.                                               |
+| `retries`                                                                                | [utils.RetryConfig](../../models/utils/retryconfig.md)                                   | :heavy_minus_sign:                                                                       | Configuration to override the default retry behavior of the client.                      |
+| `config`                                                                                 | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                             | :heavy_minus_sign:                                                                       | Available config options for making requests.                                            |
+
+
+### Response
+
+**Promise<[operations.GetPullOperationResponse](../../models/operations/getpulloperationresponse.md)>**
+
+
+## list
+
+Gets the pull operation history (datasets) for a given company.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { ListPullOperationsResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.manageDataPullOperations.list({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  orderBy: "-modifiedDate",
+  page: 1,
+  pageSize: 100,
+  query: "natus",
+}).then((res: ListPullOperationsResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `request`                                                                                    | [operations.ListPullOperationsRequest](../../models/operations/listpulloperationsrequest.md) | :heavy_check_mark:                                                                           | The request object to use for the request.                                                   |
+| `retries`                                                                                    | [utils.RetryConfig](../../models/utils/retryconfig.md)                                       | :heavy_minus_sign:                                                                           | Configuration to override the default retry behavior of the client.                          |
+| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
+
+
+### Response
+
+**Promise<[operations.ListPullOperationsResponse](../../models/operations/listpulloperationsresponse.md)>**
+

package/docs/sdks/managedatarefresh/README.md

@@ -0,0 +1,93 @@
+# manageDataRefresh
+
+### Available Operations
+
+* [allDataTypes](#alldatatypes) - Refresh all data
+* [dataType](#datatype) - Refresh data type
+
+## allDataTypes
+
+Refreshes all data types with `fetch on first link` set to `true` for a given company.
+
+This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+
+[Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { RefreshAllDataTypesResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.manageDataRefresh.allDataTypes({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+}).then((res: RefreshAllDataTypesResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `request`                                                                                      | [operations.RefreshAllDataTypesRequest](../../models/operations/refreshalldatatypesrequest.md) | :heavy_check_mark:                                                                             | The request object to use for the request.                                                     |
+| `retries`                                                                                      | [utils.RetryConfig](../../models/utils/retryconfig.md)                                         | :heavy_minus_sign:                                                                             | Configuration to override the default retry behavior of the client.                            |
+| `config`                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                   | :heavy_minus_sign:                                                                             | Available config options for making requests.                                                  |
+
+
+### Response
+
+**Promise<[operations.RefreshAllDataTypesResponse](../../models/operations/refreshalldatatypesresponse.md)>**
+
+
+## dataType
+
+Refreshes a given data type for a given company.
+
+This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { RefreshDataTypeResponse } from "@codat/lending/dist/sdk/models/operations";
+import { DataType } from "@codat/lending/dist/sdk/models/shared";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.manageDataRefresh.dataType({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "29396fea-7596-4eb1-8faa-a2352c595590",
+  dataType: DataType.Invoices,
+}).then((res: RefreshDataTypeResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                              | Type                                                                                   | Required                                                                               | Description                                                                            |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `request`                                                                              | [operations.RefreshDataTypeRequest](../../models/operations/refreshdatatyperequest.md) | :heavy_check_mark:                                                                     | The request object to use for the request.                                             |
+| `retries`                                                                              | [utils.RetryConfig](../../models/utils/retryconfig.md)                                 | :heavy_minus_sign:                                                                     | Configuration to override the default retry behavior of the client.                    |
+| `config`                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                           | :heavy_minus_sign:                                                                     | Available config options for making requests.                                          |
+
+
+### Response
+
+**Promise<[operations.RefreshDataTypeResponse](../../models/operations/refreshdatatyperesponse.md)>**
+