@financeable/aggregation 0.10.1 → 0.11.0-alpha.1

package/README.md

@@ -331,6 +331,74 @@ run();
 
 * [create](docs/sdks/applications/README.md#create) - Create an application in the Financeable platform.
 
+### [assets](docs/sdks/assets/README.md)
+
+* [assetsCreate](docs/sdks/assets/README.md#assetscreate) - Create a new asset.
+* [assetsGet](docs/sdks/assets/README.md#assetsget) - Get an asset by its ID.
+* [assetsUpdate](docs/sdks/assets/README.md#assetsupdate) - Update an asset.
+* [assetsDelete](docs/sdks/assets/README.md#assetsdelete) - Delete an asset.
+
+### [customerAddresses](docs/sdks/customeraddresses/README.md)
+
+* [customerAddressesList](docs/sdks/customeraddresses/README.md#customeraddresseslist) - Get all addresses for a customer.
+* [customerAddressesCreate](docs/sdks/customeraddresses/README.md#customeraddressescreate) - Create a new address for a customer.
+* [customerAddressesGet](docs/sdks/customeraddresses/README.md#customeraddressesget) - Get an address by its ID.
+* [customerAddressesUpdate](docs/sdks/customeraddresses/README.md#customeraddressesupdate) - Update an address.
+* [customerAddressesDelete](docs/sdks/customeraddresses/README.md#customeraddressesdelete) - Delete an address.
+
+### [customerAssets](docs/sdks/customerassets/README.md)
+
+* [customerAssetsList](docs/sdks/customerassets/README.md#customerassetslist) - Get all assets for a customer.
+* [customerAssetsCreate](docs/sdks/customerassets/README.md#customerassetscreate) - Create a new asset for a customer.
+* [customerAssetsGet](docs/sdks/customerassets/README.md#customerassetsget) - Get an asset by its ID.
+* [customerAssetsUpdate](docs/sdks/customerassets/README.md#customerassetsupdate) - Update an asset.
+* [customerAssetsDelete](docs/sdks/customerassets/README.md#customerassetsdelete) - Delete an asset.
+
+### [customerExpenses](docs/sdks/customerexpenses/README.md)
+
+* [customerExpensesList](docs/sdks/customerexpenses/README.md#customerexpenseslist) - Get all expenses for a customer.
+* [customerExpensesCreate](docs/sdks/customerexpenses/README.md#customerexpensescreate) - Create a new expense for a customer.
+* [customerExpensesGet](docs/sdks/customerexpenses/README.md#customerexpensesget) - Get an expense by its ID.
+* [customerExpensesUpdate](docs/sdks/customerexpenses/README.md#customerexpensesupdate) - Update an expense.
+* [customerExpensesDelete](docs/sdks/customerexpenses/README.md#customerexpensesdelete) - Delete an expense.
+
+### [customerIncome](docs/sdks/customerincome/README.md)
+
+* [customerIncomeList](docs/sdks/customerincome/README.md#customerincomelist) - Get all income for a customer.
+* [customerIncomeCreate](docs/sdks/customerincome/README.md#customerincomecreate) - Create a new income record for a customer.
+* [customerIncomeGet](docs/sdks/customerincome/README.md#customerincomeget) - Get an income record by its ID.
+* [customerIncomeUpdate](docs/sdks/customerincome/README.md#customerincomeupdate) - Update an income record.
+* [customerIncomeDelete](docs/sdks/customerincome/README.md#customerincomedelete) - Delete an income record.
+
+### [customerLiabilities](docs/sdks/customerliabilities/README.md)
+
+* [customerLiabilitiesList](docs/sdks/customerliabilities/README.md#customerliabilitieslist) - Get all liabilities for a customer.
+* [customerLiabilitiesCreate](docs/sdks/customerliabilities/README.md#customerliabilitiescreate) - Create a new liability for a customer.
+* [customerLiabilitiesGet](docs/sdks/customerliabilities/README.md#customerliabilitiesget) - Get a liability by its ID.
+* [customerLiabilitiesUpdate](docs/sdks/customerliabilities/README.md#customerliabilitiesupdate) - Update a liability.
+* [customerLiabilitiesDelete](docs/sdks/customerliabilities/README.md#customerliabilitiesdelete) - Delete a liability.
+
+### [customers](docs/sdks/customers/README.md)
+
+* [customersCreate](docs/sdks/customers/README.md#customerscreate) - Create a new customer record.
+* [customersGet](docs/sdks/customers/README.md#customersget) - Get a customer record by its ID.
+* [customersUpdate](docs/sdks/customers/README.md#customersupdate) - Update a customer record.
+* [customersDelete](docs/sdks/customers/README.md#customersdelete) - Delete a customer record.
+
+### [entities](docs/sdks/entities/README.md)
+
+* [entitiesCreate](docs/sdks/entities/README.md#entitiescreate) - Create a new entity.
+* [entitiesGet](docs/sdks/entities/README.md#entitiesget) - Get an entity by its ID.
+* [entitiesUpdate](docs/sdks/entities/README.md#entitiesupdate) - Update an entity.
+* [entitiesDelete](docs/sdks/entities/README.md#entitiesdelete) - Delete an entity.
+
+
+### [loanDetails](docs/sdks/loandetails/README.md)
+
+* [loanDetailsCreate](docs/sdks/loandetails/README.md#loandetailscreate) - Create a new loan details record.
+* [loanDetailsGet](docs/sdks/loandetails/README.md#loandetailsget) - Get a loan details record by its ID.
+* [loanDetailsUpdate](docs/sdks/loandetails/README.md#loandetailsupdate) - Update a loan details record.
+* [loanDetailsDelete](docs/sdks/loandetails/README.md#loandetailsdelete) - Delete a loan details record.
 
 ### [oauthToken](docs/sdks/oauthtoken/README.md)
 
@@ -359,6 +427,47 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 <summary>Available standalone functions</summary>
 
 - [`applicationsCreate`](docs/sdks/applications/README.md#create) - Create an application in the Financeable platform.
+- [`assetsAssetsCreate`](docs/sdks/assets/README.md#assetscreate) - Create a new asset.
+- [`assetsAssetsDelete`](docs/sdks/assets/README.md#assetsdelete) - Delete an asset.
+- [`assetsAssetsGet`](docs/sdks/assets/README.md#assetsget) - Get an asset by its ID.
+- [`assetsAssetsUpdate`](docs/sdks/assets/README.md#assetsupdate) - Update an asset.
+- [`customerAddressesCustomerAddressesCreate`](docs/sdks/customeraddresses/README.md#customeraddressescreate) - Create a new address for a customer.
+- [`customerAddressesCustomerAddressesDelete`](docs/sdks/customeraddresses/README.md#customeraddressesdelete) - Delete an address.
+- [`customerAddressesCustomerAddressesGet`](docs/sdks/customeraddresses/README.md#customeraddressesget) - Get an address by its ID.
+- [`customerAddressesCustomerAddressesList`](docs/sdks/customeraddresses/README.md#customeraddresseslist) - Get all addresses for a customer.
+- [`customerAddressesCustomerAddressesUpdate`](docs/sdks/customeraddresses/README.md#customeraddressesupdate) - Update an address.
+- [`customerAssetsCustomerAssetsCreate`](docs/sdks/customerassets/README.md#customerassetscreate) - Create a new asset for a customer.
+- [`customerAssetsCustomerAssetsDelete`](docs/sdks/customerassets/README.md#customerassetsdelete) - Delete an asset.
+- [`customerAssetsCustomerAssetsGet`](docs/sdks/customerassets/README.md#customerassetsget) - Get an asset by its ID.
+- [`customerAssetsCustomerAssetsList`](docs/sdks/customerassets/README.md#customerassetslist) - Get all assets for a customer.
+- [`customerAssetsCustomerAssetsUpdate`](docs/sdks/customerassets/README.md#customerassetsupdate) - Update an asset.
+- [`customerExpensesCustomerExpensesCreate`](docs/sdks/customerexpenses/README.md#customerexpensescreate) - Create a new expense for a customer.
+- [`customerExpensesCustomerExpensesDelete`](docs/sdks/customerexpenses/README.md#customerexpensesdelete) - Delete an expense.
+- [`customerExpensesCustomerExpensesGet`](docs/sdks/customerexpenses/README.md#customerexpensesget) - Get an expense by its ID.
+- [`customerExpensesCustomerExpensesList`](docs/sdks/customerexpenses/README.md#customerexpenseslist) - Get all expenses for a customer.
+- [`customerExpensesCustomerExpensesUpdate`](docs/sdks/customerexpenses/README.md#customerexpensesupdate) - Update an expense.
+- [`customerIncomeCustomerIncomeCreate`](docs/sdks/customerincome/README.md#customerincomecreate) - Create a new income record for a customer.
+- [`customerIncomeCustomerIncomeDelete`](docs/sdks/customerincome/README.md#customerincomedelete) - Delete an income record.
+- [`customerIncomeCustomerIncomeGet`](docs/sdks/customerincome/README.md#customerincomeget) - Get an income record by its ID.
+- [`customerIncomeCustomerIncomeList`](docs/sdks/customerincome/README.md#customerincomelist) - Get all income for a customer.
+- [`customerIncomeCustomerIncomeUpdate`](docs/sdks/customerincome/README.md#customerincomeupdate) - Update an income record.
+- [`customerLiabilitiesCustomerLiabilitiesCreate`](docs/sdks/customerliabilities/README.md#customerliabilitiescreate) - Create a new liability for a customer.
+- [`customerLiabilitiesCustomerLiabilitiesDelete`](docs/sdks/customerliabilities/README.md#customerliabilitiesdelete) - Delete a liability.
+- [`customerLiabilitiesCustomerLiabilitiesGet`](docs/sdks/customerliabilities/README.md#customerliabilitiesget) - Get a liability by its ID.
+- [`customerLiabilitiesCustomerLiabilitiesList`](docs/sdks/customerliabilities/README.md#customerliabilitieslist) - Get all liabilities for a customer.
+- [`customerLiabilitiesCustomerLiabilitiesUpdate`](docs/sdks/customerliabilities/README.md#customerliabilitiesupdate) - Update a liability.
+- [`customersCustomersCreate`](docs/sdks/customers/README.md#customerscreate) - Create a new customer record.
+- [`customersCustomersDelete`](docs/sdks/customers/README.md#customersdelete) - Delete a customer record.
+- [`customersCustomersGet`](docs/sdks/customers/README.md#customersget) - Get a customer record by its ID.
+- [`customersCustomersUpdate`](docs/sdks/customers/README.md#customersupdate) - Update a customer record.
+- [`entitiesEntitiesCreate`](docs/sdks/entities/README.md#entitiescreate) - Create a new entity.
+- [`entitiesEntitiesDelete`](docs/sdks/entities/README.md#entitiesdelete) - Delete an entity.
+- [`entitiesEntitiesGet`](docs/sdks/entities/README.md#entitiesget) - Get an entity by its ID.
+- [`entitiesEntitiesUpdate`](docs/sdks/entities/README.md#entitiesupdate) - Update an entity.
+- [`loanDetailsLoanDetailsCreate`](docs/sdks/loandetails/README.md#loandetailscreate) - Create a new loan details record.
+- [`loanDetailsLoanDetailsDelete`](docs/sdks/loandetails/README.md#loandetailsdelete) - Delete a loan details record.
+- [`loanDetailsLoanDetailsGet`](docs/sdks/loandetails/README.md#loandetailsget) - Get a loan details record by its ID.
+- [`loanDetailsLoanDetailsUpdate`](docs/sdks/loandetails/README.md#loandetailsupdate) - Update a loan details record.
 - [`oauthTokenGet`](docs/sdks/oauthtoken/README.md#get) - Obtain an OAuth client_credentials token
 - [`supportingDocumentsCreate`](docs/sdks/supportingdocuments/README.md#create) - Create a supporting document record in Financeable, and returns a pre-signed URL to upload this document with.
 

package/docs/sdks/assets/README.md

@@ -0,0 +1,369 @@
+# Assets
+(*assets*)
+
+## Overview
+
+### Available Operations
+
+* [assetsCreate](#assetscreate) - Create a new asset.
+* [assetsGet](#assetsget) - Get an asset by its ID.
+* [assetsUpdate](#assetsupdate) - Update an asset.
+* [assetsDelete](#assetsdelete) - Delete an asset.
+
+## assetsCreate
+
+Create a new asset.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="Assets_create" method="post" path="/assets" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.assets.assetsCreate({
+    data: {
+      type: "assets",
+      attributes: {},
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { assetsAssetsCreate } from "@financeable/aggregation/funcs/assetsAssetsCreate.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await assetsAssetsCreate(financeable, {
+    data: {
+      type: "assets",
+      attributes: {},
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("assetsAssetsCreate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AssetsCreateRequestBody](../../models/operations/assetscreaterequestbody.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.AssetsCreateResponse](../../models/operations/assetscreateresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## assetsGet
+
+Get an asset by its ID.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="Assets_get" method="get" path="/assets/{assetId}" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.assets.assetsGet({
+    assetId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { assetsAssetsGet } from "@financeable/aggregation/funcs/assetsAssetsGet.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await assetsAssetsGet(financeable, {
+    assetId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("assetsAssetsGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AssetsGetRequest](../../models/operations/assetsgetrequest.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.AssetsGetResponse](../../models/operations/assetsgetresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## assetsUpdate
+
+Update an asset.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="Assets_update" method="patch" path="/assets/{assetId}" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.assets.assetsUpdate({
+    assetId: "<id>",
+    requestBody: {
+      data: {
+        attributes: {
+          id: "12345678901",
+          ageOfAsset: 3,
+          ageOfAssetAtEnd: 8,
+          condition: "USED",
+          assetType: "CARAVAN",
+          assetValue: "35000.00",
+          make: "Toyota",
+          assetModel: "Camry",
+          registrationNumber: "ABC123",
+          registrationState: "VIC",
+          vin: "1HGCM82633A123456",
+          supplierName: "Mr and Mrs Smith",
+          supplierABN: "12345678901",
+          supplierAddress: "123 Car Street, Melbourne VIC 3000",
+          supplierPhone: "0412345678",
+          supplierContactName: "John Smith",
+          supplierEmail: "john.smith@mrandmrssmith.com.au",
+          privateSale: false,
+          typeOfSale: "AUTHORISED_SELLER",
+          description: "2020 Toyota Camry Hybrid SL, Silver, 45,000km",
+          netAssetValue: "32000.00",
+          isLuxury: false,
+          additionalFees: {},
+          additionalTaxes: {},
+        },
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { assetsAssetsUpdate } from "@financeable/aggregation/funcs/assetsAssetsUpdate.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await assetsAssetsUpdate(financeable, {
+    assetId: "<id>",
+    requestBody: {
+      data: {
+        attributes: {
+          id: "12345678901",
+          ageOfAsset: 3,
+          ageOfAssetAtEnd: 8,
+          condition: "USED",
+          assetType: "CARAVAN",
+          assetValue: "35000.00",
+          make: "Toyota",
+          assetModel: "Camry",
+          registrationNumber: "ABC123",
+          registrationState: "VIC",
+          vin: "1HGCM82633A123456",
+          supplierName: "Mr and Mrs Smith",
+          supplierABN: "12345678901",
+          supplierAddress: "123 Car Street, Melbourne VIC 3000",
+          supplierPhone: "0412345678",
+          supplierContactName: "John Smith",
+          supplierEmail: "john.smith@mrandmrssmith.com.au",
+          privateSale: false,
+          typeOfSale: "AUTHORISED_SELLER",
+          description: "2020 Toyota Camry Hybrid SL, Silver, 45,000km",
+          netAssetValue: "32000.00",
+          isLuxury: false,
+          additionalFees: {},
+          additionalTaxes: {},
+        },
+      },
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("assetsAssetsUpdate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AssetsUpdateRequest](../../models/operations/assetsupdaterequest.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.AssetsUpdateResponse](../../models/operations/assetsupdateresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## assetsDelete
+
+Delete an asset.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="Assets_delete" method="delete" path="/assets/{assetId}" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.assets.assetsDelete({
+    assetId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { assetsAssetsDelete } from "@financeable/aggregation/funcs/assetsAssetsDelete.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await assetsAssetsDelete(financeable, {
+    assetId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("assetsAssetsDelete failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AssetsDeleteRequest](../../models/operations/assetsdeleterequest.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.AssetsDeleteResponseBody](../../models/operations/assetsdeleteresponsebody.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |