@financeable/aggregation 0.12.1 → 0.13.1

package/docs/sdks/applications/README.md

@@ -1,527 +0,0 @@
-# Applications
-(*applications*)
-
-## Overview
-
-### Available Operations
-
-* [create](#create) - Create an application in the Financeable platform.
-* [list](#list) - List all applications from the tenant. This endpoint does not support the 'include' query parameter; relationships must be fetched via the 'Get Application' endpoint.
-* [get](#get) - Retrieve a specific application from the Financeable platform.
-
-## create
-
-Create an application in the Financeable platform.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="createApplication" method="post" path="/applications" -->
-```typescript
-import { Financeable } from "@financeable/aggregation";
-
-const financeable = new Financeable({
-  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
-});
-
-async function run() {
-  const result = await financeable.applications.create({
-    data: {
-      type: "entities",
-      attributes: {
-        applicationType: "consumerSecured",
-        associatedBrokerEmail: "<value>",
-      },
-      relationships: {
-        customers: {
-          data: [
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "Courtney",
-                lastName: "Greenfelder",
-                dateOfBirth: "1981-06-22",
-                idExpiryDate: "<value>",
-              },
-              relationships: {
-                addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        id: "12345678901",
-                        addressType: "residential",
-                        fullAddress: "42 Wallaby Way, Sydney NSW 2000",
-                        city: "Sydney",
-                        postCode: "2000",
-                        streetAddress: "42 Wallaby Way",
-                        addressLine2: "",
-                        streetNumber: "42",
-                        streetType: "Way",
-                        street: "Wallaby",
-                        state: "NSW",
-                        country: "Australia",
-                        status: "current",
-                        monthsAt: 24,
-                        yearsAt: 2,
-                      },
-                    },
-                  ],
-                },
-              },
-            },
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "Courtney",
-                lastName: "Greenfelder",
-                dateOfBirth: "1981-06-22",
-                idExpiryDate: "<value>",
-              },
-              relationships: {
-                addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        id: "12345678901",
-                        addressType: "residential",
-                        fullAddress: "42 Wallaby Way, Sydney NSW 2000",
-                        city: "Sydney",
-                        postCode: "2000",
-                        streetAddress: "42 Wallaby Way",
-                        addressLine2: "",
-                        streetNumber: "42",
-                        streetType: "Way",
-                        street: "Wallaby",
-                        state: "NSW",
-                        country: "Australia",
-                        status: "current",
-                        monthsAt: 24,
-                        yearsAt: 2,
-                      },
-                    },
-                  ],
-                },
-              },
-            },
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "Courtney",
-                lastName: "Greenfelder",
-                dateOfBirth: "1981-06-22",
-                idExpiryDate: "<value>",
-              },
-              relationships: {
-                addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        id: "12345678901",
-                        addressType: "residential",
-                        fullAddress: "42 Wallaby Way, Sydney NSW 2000",
-                        city: "Sydney",
-                        postCode: "2000",
-                        streetAddress: "42 Wallaby Way",
-                        addressLine2: "",
-                        streetNumber: "42",
-                        streetType: "Way",
-                        street: "Wallaby",
-                        state: "NSW",
-                        country: "Australia",
-                        status: "current",
-                        monthsAt: 24,
-                        yearsAt: 2,
-                      },
-                    },
-                  ],
-                },
-              },
-            },
-          ],
-        },
-        asset: {
-          data: {
-            type: "assets",
-            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: "995.00",
-              additionalTaxes: "0.00",
-            },
-          },
-        },
-      },
-    },
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { FinanceableCore } from "@financeable/aggregation/core.js";
-import { applicationsCreate } from "@financeable/aggregation/funcs/applicationsCreate.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 applicationsCreate(financeable, {
-    data: {
-      type: "entities",
-      attributes: {
-        applicationType: "consumerSecured",
-        associatedBrokerEmail: "<value>",
-      },
-      relationships: {
-        customers: {
-          data: [
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "Courtney",
-                lastName: "Greenfelder",
-                dateOfBirth: "1981-06-22",
-                idExpiryDate: "<value>",
-              },
-              relationships: {
-                addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        id: "12345678901",
-                        addressType: "residential",
-                        fullAddress: "42 Wallaby Way, Sydney NSW 2000",
-                        city: "Sydney",
-                        postCode: "2000",
-                        streetAddress: "42 Wallaby Way",
-                        addressLine2: "",
-                        streetNumber: "42",
-                        streetType: "Way",
-                        street: "Wallaby",
-                        state: "NSW",
-                        country: "Australia",
-                        status: "current",
-                        monthsAt: 24,
-                        yearsAt: 2,
-                      },
-                    },
-                  ],
-                },
-              },
-            },
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "Courtney",
-                lastName: "Greenfelder",
-                dateOfBirth: "1981-06-22",
-                idExpiryDate: "<value>",
-              },
-              relationships: {
-                addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        id: "12345678901",
-                        addressType: "residential",
-                        fullAddress: "42 Wallaby Way, Sydney NSW 2000",
-                        city: "Sydney",
-                        postCode: "2000",
-                        streetAddress: "42 Wallaby Way",
-                        addressLine2: "",
-                        streetNumber: "42",
-                        streetType: "Way",
-                        street: "Wallaby",
-                        state: "NSW",
-                        country: "Australia",
-                        status: "current",
-                        monthsAt: 24,
-                        yearsAt: 2,
-                      },
-                    },
-                  ],
-                },
-              },
-            },
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "Courtney",
-                lastName: "Greenfelder",
-                dateOfBirth: "1981-06-22",
-                idExpiryDate: "<value>",
-              },
-              relationships: {
-                addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        id: "12345678901",
-                        addressType: "residential",
-                        fullAddress: "42 Wallaby Way, Sydney NSW 2000",
-                        city: "Sydney",
-                        postCode: "2000",
-                        streetAddress: "42 Wallaby Way",
-                        addressLine2: "",
-                        streetNumber: "42",
-                        streetType: "Way",
-                        street: "Wallaby",
-                        state: "NSW",
-                        country: "Australia",
-                        status: "current",
-                        monthsAt: 24,
-                        yearsAt: 2,
-                      },
-                    },
-                  ],
-                },
-              },
-            },
-          ],
-        },
-        asset: {
-          data: {
-            type: "assets",
-            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: "995.00",
-              additionalTaxes: "0.00",
-            },
-          },
-        },
-      },
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("applicationsCreate failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateApplicationRequestBody](../../models/operations/createapplicationrequestbody.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.CreateApplicationResponse](../../models/operations/createapplicationresponse.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |
-
-## list
-
-List all applications from the tenant. This endpoint does not support the 'include' query parameter; relationships must be fetched via the 'Get Application' endpoint.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="listApplications" method="get" path="/applications" -->
-```typescript
-import { Financeable } from "@financeable/aggregation";
-
-const financeable = new Financeable({
-  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
-});
-
-async function run() {
-  const result = await financeable.applications.list({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { FinanceableCore } from "@financeable/aggregation/core.js";
-import { applicationsList } from "@financeable/aggregation/funcs/applicationsList.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 applicationsList(financeable, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("applicationsList failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListApplicationsRequest](../../models/operations/listapplicationsrequest.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.ListApplicationsResponse](../../models/operations/listapplicationsresponse.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |
-
-## get
-
-Retrieve a specific application from the Financeable platform.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="getApplication" method="get" path="/applications/{id}" -->
-```typescript
-import { Financeable } from "@financeable/aggregation";
-
-const financeable = new Financeable({
-  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
-});
-
-async function run() {
-  const result = await financeable.applications.get({
-    id: "<id>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { FinanceableCore } from "@financeable/aggregation/core.js";
-import { applicationsGet } from "@financeable/aggregation/funcs/applicationsGet.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 applicationsGet(financeable, {
-    id: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("applicationsGet failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetApplicationRequest](../../models/operations/getapplicationrequest.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.GetApplicationResponse](../../models/operations/getapplicationresponse.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/oauthtoken/README.md

@@ -1,87 +0,0 @@
-# OauthToken
-(*oauthToken*)
-
-## Overview
-
-### Available Operations
-
-* [get](#get) - Obtain an OAuth client_credentials token
-
-## get
-
-Obtain an OAuth client_credentials token
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="getToken" method="post" path="/oauth/token" -->
-```typescript
-import { Financeable } from "@financeable/aggregation";
-
-const financeable = new Financeable({
-  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
-});
-
-async function run() {
-  const result = await financeable.oauthToken.get({
-    grantType: "client_credentials",
-    clientId: "<id>",
-    clientSecret: "<value>",
-    scope: "<value>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { FinanceableCore } from "@financeable/aggregation/core.js";
-import { oauthTokenGet } from "@financeable/aggregation/funcs/oauthTokenGet.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 oauthTokenGet(financeable, {
-    grantType: "client_credentials",
-    clientId: "<id>",
-    clientSecret: "<value>",
-    scope: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("oauthTokenGet failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.TokenRequest](../../models/components/tokenrequest.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\<[components.TokenResponse](../../models/components/tokenresponse.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |