@codat/lending 0.1.0 → 1.1.0

package/docs/sdks/transactionstransfers/README.md

@@ -0,0 +1,103 @@
+# transactionsTransfers
+
+### Available Operations
+
+* [get](#get) - Get transfer
+* [list](#list) - List transfers
+
+## get
+
+The *Get transfer* endpoint returns a single transfer for a given transferId.
+
+[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
+
+Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { GetAccountingTransferResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.transactionsTransfers.get({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  transferId: "ipsa",
+}).then((res: GetAccountingTransferResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `request`                                                                                          | [operations.GetAccountingTransferRequest](../../models/operations/getaccountingtransferrequest.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.GetAccountingTransferResponse](../../models/operations/getaccountingtransferresponse.md)>**
+
+
+## list
+
+The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.
+
+[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
+
+Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+    
+
+### Example Usage
+
+```typescript
+import { CodatLending } from "@codat/lending";
+import { ListAccountingTransfersResponse } from "@codat/lending/dist/sdk/models/operations";
+
+const sdk = new CodatLending({
+  security: {
+    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+  },
+});
+
+sdk.transactionsTransfers.list({
+  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+  orderBy: "-modifiedDate",
+  page: 1,
+  pageSize: 100,
+  query: "omnis",
+}).then((res: ListAccountingTransfersResponse) => {
+  if (res.statusCode == 200) {
+    // handle response
+  }
+});
+```
+
+### Parameters
+
+| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                              | [operations.ListAccountingTransfersRequest](../../models/operations/listaccountingtransfersrequest.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.ListAccountingTransfersResponse](../../models/operations/listaccountingtransfersresponse.md)>**
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codat/lending",
-  "version": "0.1.0",
+  "version": "1.1.0",
   "author": "Codat",
   "scripts": {
     "prepare": "tsc --build"

package/dist/sdk/cashflow.d.ts

@@ -1,112 +0,0 @@
-import * as utils from "../internal/utils";
-import * as operations from "./models/operations";
-import { SDKConfiguration } from "./sdk";
-import { AxiosRequestConfig } from "axios";
-/**
- * Retrieve banking data from linked bank accounts.
- */
-export declare class CashFlow {
-    private sdkConfiguration;
-    constructor(sdkConfig: SDKConfiguration);
-    /**
-     * Get account
-     *
-     * @remarks
-     * The *Get account* endpoint returns a single account for a given accountId.
-     *
-     * [Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-accounts) for integrations that support getting a specific account.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getBankAccount(req: operations.GetBankingAccountRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetBankingAccountResponse>;
-    /**
-     * Get bank transaction
-     *
-     * @remarks
-     * The *Get transaction* endpoint returns a single transaction for a given transactionId.
-     *
-     * [Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactions) for integrations that support getting a specific transaction.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getBankTransaction(req: operations.GetBankingTransactionRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetBankingTransactionResponse>;
-    /**
-     * Get transaction category
-     *
-     * @remarks
-     * The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId.
-     *
-     * [Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
-     *
-     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/banking?view=tab-by-data-type&dataType=banking-transactionCategories) for integrations that support getting a specific transaction category.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getBankTransactionCategory(req: operations.GetBankingTransactionCategoryRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetBankingTransactionCategoryResponse>;
-    /**
-     * Get enhanced cash flow report
-     *
-     * @remarks
-     * > **Categorization engine**
-     * >
-     * > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.
-     *
-     * The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources.
-     */
-    getEnhancedCashFlowTransactions(req: operations.GetEnhancedCashFlowTransactionsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetEnhancedCashFlowTransactionsResponse>;
-    /**
-     * List account balances
-     *
-     * @remarks
-     * The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) for a given company's connection.
-     *
-     * [Account balances](https://docs.codat.io/banking-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listBankAccountBalances(req: operations.ListBankingAccountBalancesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListBankingAccountBalancesResponse>;
-    /**
-     * List accounts
-     *
-     * @remarks
-     * The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/banking-api#/schemas/Account) for a given company's connection.
-     *
-     * [Accounts](https://docs.codat.io/banking-api#/schemas/Account) are financial accounts maintained by a bank or other financial institution.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listBankAccounts(req: operations.ListBankingAccountsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListBankingAccountsResponse>;
-    /**
-     * List transaction categories
-     *
-     * @remarks
-     * The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) for a given company's connection.
-     *
-     * [Transaction categories](https://docs.codat.io/banking-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listBankTransactionCategories(req: operations.ListBankingTransactionCategoriesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListBankingTransactionCategoriesResponse>;
-    /**
-     * List transactions
-     *
-     * @remarks
-     * The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/banking-api#/schemas/Transaction) for a given company's connection.
-     *
-     * [Transactions](https://docs.codat.io/banking-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    listBankTransactions(req: operations.ListBankingTransactionsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListBankingTransactionsResponse>;
-}

package/dist/sdk/financials.d.ts

@@ -1,75 +0,0 @@
-import * as utils from "../internal/utils";
-import * as operations from "./models/operations";
-import { SDKConfiguration } from "./sdk";
-import { AxiosRequestConfig } from "axios";
-/**
- * Financial data and reports from a linked accounting platform.
- */
-export declare class Financials {
-    private sdkConfiguration;
-    constructor(sdkConfig: SDKConfiguration);
-    /**
-     * Get account
-     *
-     * @remarks
-     * 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.
-     *
-     * 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.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     *
-     */
-    getAccount(req: operations.GetAccountingAccountRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingAccountResponse>;
-    /**
-     * Get balance sheet
-     *
-     * @remarks
-     * Gets the latest balance sheet for a company.
-     */
-    getBalanceSheet(req: operations.GetAccountingBalanceSheetRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingBalanceSheetResponse>;
-    /**
-     * Get cash flow statement
-     *
-     * @remarks
-     * Gets the latest cash flow statement for a company.
-     */
-    getCashFlowStatement(req: operations.GetAccountingCashFlowStatementRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingCashFlowStatementResponse>;
-    /**
-     * Get enhanced balance sheet accounts
-     *
-     * @remarks
-     * The *Get enhanced balance sheet accounts* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per 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.
-     */
-    getEnhancedBalanceSheetAccounts(req: operations.GetEnhancedBalanceSheetAccountsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetEnhancedBalanceSheetAccountsResponse>;
-    /**
-     * Get enhanced profit and loss accounts
-     *
-     * @remarks
-     * The *Get enhanced profit and loss accounts* 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.
-     */
-    getEnhancedProfitAndLossAccounts(req: operations.GetEnhancedProfitAndLossAccountsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetEnhancedProfitAndLossAccountsResponse>;
-    /**
-     * Get profit and loss
-     *
-     * @remarks
-     * Gets the latest profit and loss for a company.
-     */
-    getProfitAndLoss(req: operations.GetAccountingProfitAndLossRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingProfitAndLossResponse>;
-    /**
-     * List accounts
-     *
-     * @remarks
-     * The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-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.
-     *
-     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-     */
-    listAccounts(req: operations.ListAccountingAccountsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingAccountsResponse>;
-}

package/docs/models/operations/unlinkconnectionrequestbody.md

@@ -1,8 +0,0 @@
-# UnlinkConnectionRequestBody
-
-
-## Fields
-
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `status`           | *string*           | :heavy_minus_sign: | N/A                |