@codat/lending 7.2.0 → 7.4.0

package/docs/sdks/sourceaccounts/README.md

@@ -1,307 +0,0 @@
-# SourceAccounts
-(*loanWriteback.sourceAccounts*)
-
-## Overview
-
-### Available Operations
-
-* [create](#create) - Create source account
-* [listMappings](#listmappings) - List bank feed account mappings
-* [createMapping](#createmapping) - Create bank feed account mapping
-
-## create
-
-The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software.
-
-> ### Versioning
-> If you are integrating the Bank Feeds API with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below.
-
-### Example Usage
-
-```typescript
-import { CodatLending } from "@codat/lending";
-
-const codatLending = new CodatLending({
-  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
-  const result = await codatLending.loanWriteback.sourceAccounts.create({
-    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-    requestBody: {
-      currency: "USD",
-      modifiedDate: "2022-10-23T00:00:00Z",
-      accountInfo: {
-        accountOpenDate: "2022-10-23",
-      },
-    },
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatLendingCore } from "@codat/lending/core.js";
-import { loanWritebackSourceAccountsCreate } from "@codat/lending/funcs/loanWritebackSourceAccountsCreate.js";
-
-// Use `CodatLendingCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatLending = new CodatLendingCore({
-  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
-  const res = await loanWritebackSourceAccountsCreate(codatLending, {
-    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-    requestBody: {
-      currency: "USD",
-      modifiedDate: "2022-10-23T00:00:00Z",
-      accountInfo: {
-        accountOpenDate: "2022-10-23",
-      },
-    },
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateSourceAccountRequest](../../sdk/models/operations/createsourceaccountrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.CreateSourceAccountResponseBody](../../sdk/models/operations/createsourceaccountresponsebody.md)\>**
-
-### Errors
-
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorMessage                    | 400, 401, 402, 403, 404, 429, 500, 503 | application/json                       |
-| errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
-
-## listMappings
-
-The *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts.
-
-A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
-
-> **For custom builds only**
-> 
-> Only use this endpoint if you are building your own account management UI.
-
-### Example Usage
-
-```typescript
-import { CodatLending } from "@codat/lending";
-
-const codatLending = new CodatLending({
-  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
-  const result = await codatLending.loanWriteback.sourceAccounts.listMappings({
-    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatLendingCore } from "@codat/lending/core.js";
-import { loanWritebackSourceAccountsListMappings } from "@codat/lending/funcs/loanWritebackSourceAccountsListMappings.js";
-
-// Use `CodatLendingCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatLending = new CodatLendingCore({
-  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
-  const res = await loanWritebackSourceAccountsListMappings(codatLending, {
-    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetBankAccountMappingRequest](../../sdk/models/operations/getbankaccountmappingrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[shared.BankFeedMapping[]](../../models/.md)\>**
-
-### Errors
-
-| Error Type                        | Status Code                       | Content Type                      |
-| --------------------------------- | --------------------------------- | --------------------------------- |
-| errors.ErrorMessage               | 401, 402, 403, 404, 429, 500, 503 | application/json                  |
-| errors.SDKError                   | 4XX, 5XX                          | \*/\*                             |
-
-## createMapping
-
-The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account).
-
-A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).
-
-To find valid target account options, first call the [List bank feed account mappings](https://docs.codat.io//bank-feeds-api#/operations/get-bank-account-mapping) endpoint.
-
-> **For custom builds only**
->
-> Only use this endpoint if you are building your own account management UI.
-
-#### Account mapping variability
-
-The method of mapping the source account to the target account varies depending on the accounting software your company uses.
-
-#### Mapping options:
-
-1. **API Mapping**: Integrate the mapping journey directly into your application for a seamless user experience.
-2. **Codat UI Mapping**: If you prefer a quicker setup, you can utilize Codat's provided user interface for mapping.
-3. **Accounting Platform Mapping**: For some accounting software, the mapping process must be conducted within the software itself.
-
-### Integration-specific behaviour
-
-| Bank Feed Integration | API Mapping | Codat UI Mapping | Accounting Platform Mapping |
-| --------------------- | ----------- | ---------------- | --------------------------- |
-| Xero                  | ✅          | ✅               |                             |
-| FreeAgent             | ✅          | ✅               |                             |
-| Oracle NetSuite       | ✅          | ✅               |                             |
-| Exact Online (NL)     | ✅          | ✅               |                             |
-| QuickBooks Online     |             |                  | ✅                          |
-| Sage                  |             |                  | ✅                          |
-
-### Example Usage
-
-```typescript
-import { CodatLending } from "@codat/lending";
-
-const codatLending = new CodatLending({
-  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
-  const result = await codatLending.loanWriteback.sourceAccounts.createMapping({
-    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-    bankFeedBankAccountMapping: {
-      sourceAccountId: "acc-002",
-      targetAccountId: "account-081",
-    },
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatLendingCore } from "@codat/lending/core.js";
-import { loanWritebackSourceAccountsCreateMapping } from "@codat/lending/funcs/loanWritebackSourceAccountsCreateMapping.js";
-
-// Use `CodatLendingCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatLending = new CodatLendingCore({
-  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
-  const res = await loanWritebackSourceAccountsCreateMapping(codatLending, {
-    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-    bankFeedBankAccountMapping: {
-      sourceAccountId: "acc-002",
-      targetAccountId: "account-081",
-    },
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateBankAccountMappingRequest](../../sdk/models/operations/createbankaccountmappingrequest.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[shared.BankFeedBankAccountMappingResponse](../../sdk/models/shared/bankfeedbankaccountmappingresponse.md)\>**
-
-### Errors
-
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorMessage                    | 400, 401, 402, 403, 404, 429, 500, 503 | application/json                       |
-| errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |