@financeable/aggregation 0.5.1 → 0.6.1

package/docs/sdks/applications/README.md

@@ -6,8 +6,6 @@
 ### Available Operations
 
 * [create](#create) - Create an application in the Financeable platform.
-* [list](#list) - Retrieve a list of applications
-* [get](#get) - Retrieve an application by its ID
 
 ## create
 
@@ -17,7 +15,6 @@ Create an application in the Financeable platform.
 
 ```typescript
 import { Financeable } from "@financeable/aggregation";
-import { CommercialAssetType } from "@financeable/aggregation/models/components";
 
 const financeable = new Financeable({
   clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
@@ -26,136 +23,33 @@ const financeable = new Financeable({
 async function run() {
   const result = await financeable.applications.create({
     data: {
-      type: "applications",
+      type: "entities",
       attributes: {
-        purpose: "Purchase of a motor vehicle",
-        applicationType: "consumer",
+        applicationType: "commercialSecured",
       },
       relationships: {
-        loanDetails: {
-          data: {
-            type: "loan-details",
-            attributes: {
-              repayments: 12,
-              repaymentFrequency: "monthly",
-              repaymentStructure: "group-payments",
-              loanAmount: "10280.95",
-              purpose: "Purchase of a motor vehicle",
-              term: 48,
-              balloon: 5,
-              deposit: "2500",
-              originationFee: 200,
-              rate: "0.15",
-              rateAdjustment: "-0.01",
-            },
-          },
-        },
-        entities: {
-          data: [
-            {
-              type: "entities",
-              attributes: {
-                businessNames: [
-                  "<value>",
-                  "<value>",
-                ],
-                entityName: "<value>",
-                abn: "<value>",
-                acn: "<value>",
-                state: "QLD",
-                entityType: "Australian Private Company",
-              },
-            },
-          ],
-        },
         customers: {
           data: [
             {
               type: "customers",
               attributes: {
+                id: "<id>",
                 title: "Mr",
-                firstName: "John",
-                lastName: "Smith",
-                dateOfBirth: "01-01-1990",
+                firstName: "Annie",
+                lastName: "Wiegand",
+                dateOfBirth: "1944-05-18",
                 idExpiryDate: "<value>",
               },
               relationships: {
                 addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        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: "addresses",
-                      attributes: {
-                        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,
-                      },
-                    },
-                  ],
+                  data: [],
                 },
               },
             },
           ],
         },
-        asset: {
-          data: {
-            type: "assets",
-            attributes: {
-              ageOfAsset: 3,
-              ageOfAssetAtEnd: 8,
-              condition: "USED",
-              assetType: CommercialAssetType.MotorVehicleLessThan45Tonnes,
-              purpose: "VEHICLE",
-              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: "DEALER",
-              description: "2020 Toyota Camry Hybrid SL, Silver, 45,000km",
-              netAssetValue: "32000.00",
-              isLuxury: false,
-              additionalFees: "995.00",
-              additionalTaxes: "0.00",
-            },
-          },
+        entities: {
+          data: [],
         },
       },
     },
@@ -175,7 +69,6 @@ The standalone function version of this method:
 ```typescript
 import { FinanceableCore } from "@financeable/aggregation/core.js";
 import { applicationsCreate } from "@financeable/aggregation/funcs/applicationsCreate.js";
-import { CommercialAssetType } from "@financeable/aggregation/models/components";
 
 // Use `FinanceableCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -186,136 +79,33 @@ const financeable = new FinanceableCore({
 async function run() {
   const res = await applicationsCreate(financeable, {
     data: {
-      type: "applications",
+      type: "entities",
       attributes: {
-        purpose: "Purchase of a motor vehicle",
-        applicationType: "consumer",
+        applicationType: "commercialSecured",
       },
       relationships: {
-        loanDetails: {
-          data: {
-            type: "loan-details",
-            attributes: {
-              repayments: 12,
-              repaymentFrequency: "monthly",
-              repaymentStructure: "group-payments",
-              loanAmount: "10280.95",
-              purpose: "Purchase of a motor vehicle",
-              term: 48,
-              balloon: 5,
-              deposit: "2500",
-              originationFee: 200,
-              rate: "0.15",
-              rateAdjustment: "-0.01",
-            },
-          },
-        },
-        entities: {
-          data: [
-            {
-              type: "entities",
-              attributes: {
-                businessNames: [
-                  "<value>",
-                  "<value>",
-                ],
-                entityName: "<value>",
-                abn: "<value>",
-                acn: "<value>",
-                state: "QLD",
-                entityType: "Australian Private Company",
-              },
-            },
-          ],
-        },
         customers: {
           data: [
             {
               type: "customers",
               attributes: {
+                id: "<id>",
                 title: "Mr",
-                firstName: "John",
-                lastName: "Smith",
-                dateOfBirth: "01-01-1990",
+                firstName: "Annie",
+                lastName: "Wiegand",
+                dateOfBirth: "1944-05-18",
                 idExpiryDate: "<value>",
               },
               relationships: {
                 addresses: {
-                  data: [
-                    {
-                      type: "addresses",
-                      attributes: {
-                        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: "addresses",
-                      attributes: {
-                        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,
-                      },
-                    },
-                  ],
+                  data: [],
                 },
               },
             },
           ],
         },
-        asset: {
-          data: {
-            type: "assets",
-            attributes: {
-              ageOfAsset: 3,
-              ageOfAssetAtEnd: 8,
-              condition: "USED",
-              assetType: CommercialAssetType.MotorVehicleLessThan45Tonnes,
-              purpose: "VEHICLE",
-              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: "DEALER",
-              description: "2020 Toyota Camry Hybrid SL, Silver, 45,000km",
-              netAssetValue: "32000.00",
-              isLuxury: false,
-              additionalFees: "995.00",
-              additionalTaxes: "0.00",
-            },
-          },
+        entities: {
+          data: [],
         },
       },
     },
@@ -338,7 +128,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.ApplicationResourceBulkSubmission](../../models/components/applicationresourcebulksubmission.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `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.                                                                                                               |
@@ -349,157 +139,8 @@ run();
 
 ### Errors
 
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.ResponseBody | 403                 | application/json    |
-| errors.APIError     | 4XX, 5XX            | \*/\*               |
-
-## list
-
-Retrieve a list of applications
-
-### Example Usage
-
-```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({});
-
-  // Handle the result
-  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) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetApplicationsRequest](../../models/operations/getapplicationsrequest.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.GetApplicationsResponseBody](../../models/operations/getapplicationsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.ResponseBody | 403                 | application/json    |
-| errors.APIError     | 4XX, 5XX            | \*/\*               |
-
-## get
-
-Retrieve an application by its ID
-
-### Example Usage
-
-```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>",
-  });
-
-  // Handle the result
-  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) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-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.GetApplicationResponseBody](../../models/operations/getapplicationresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.ResponseBody | 403                 | application/json    |
-| errors.APIError     | 4XX, 5XX            | \*/\*               |
+| Error Type                                       | Status Code                                      | Content Type                                     |
+| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
+| errors.CreateApplicationResponseBody             | 403                                              | application/json                                 |
+| errors.CreateApplicationApplicationsResponseBody | 404                                              | application/json                                 |
+| errors.APIError                                  | 4XX, 5XX                                         | \*/\*                                            |

package/docs/sdks/oauthtoken/README.md

@@ -5,9 +5,9 @@
 
 ### Available Operations
 
-* [get](#get) - Obtain an OAuth client_credentials token
+* [oauthToken](#oauthtoken) - Obtain an OAuth client_credentials token
 
-## get
+## oauthToken
 
 Obtain an OAuth client_credentials token
 
@@ -21,7 +21,7 @@ const financeable = new Financeable({
 });
 
 async function run() {
-  const result = await financeable.oauthToken.get({
+  const result = await financeable.oauthToken.oauthToken({
     grantType: "client_credentials",
     clientId: "<id>",
     clientSecret: "<value>",
@@ -41,7 +41,7 @@ The standalone function version of this method:
 
 ```typescript
 import { FinanceableCore } from "@financeable/aggregation/core.js";
-import { oauthTokenGet } from "@financeable/aggregation/funcs/oauthTokenGet.js";
+import { oauthTokenOauthToken } from "@financeable/aggregation/funcs/oauthTokenOauthToken.js";
 
 // Use `FinanceableCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -50,7 +50,7 @@ const financeable = new FinanceableCore({
 });
 
 async function run() {
-  const res = await oauthTokenGet(financeable, {
+  const res = await oauthTokenOauthToken(financeable, {
     grantType: "client_credentials",
     clientId: "<id>",
     clientSecret: "<value>",

package/docs/sdks/supportingdocuments/README.md

@@ -0,0 +1,121 @@
+# SupportingDocuments
+(*supportingDocuments*)
+
+## Overview
+
+### Available Operations
+
+* [create](#create) - Create a supporting document record in Financeable, and returns a pre-signed URL to upload this document with.
+
+## create
+
+Create a supporting document record in Financeable, and returns a pre-signed URL to upload this document with.
+
+### Example Usage
+
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.supportingDocuments.create({
+    mimeType: "text/plain",
+    requestBody: {
+      data: {
+        type: "supporting-documents",
+        attributes: {
+          filename: "example.file",
+          documentType: "ASIC FILE",
+        },
+        relationships: {
+          application: {
+            data: {
+              type: "consumer-secured-applications",
+              id: "<id>",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { supportingDocumentsCreate } from "@financeable/aggregation/funcs/supportingDocumentsCreate.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 supportingDocumentsCreate(financeable, {
+    mimeType: "text/plain",
+    requestBody: {
+      data: {
+        type: "supporting-documents",
+        attributes: {
+          filename: "example.file",
+          documentType: "ASIC FILE",
+        },
+        relationships: {
+          application: {
+            data: {
+              type: "consumer-secured-applications",
+              id: "<id>",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.SupportingDocumentsCreateRequest](../../models/operations/supportingdocumentscreaterequest.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.SupportingDocumentsCreateResponseBody](../../models/operations/supportingdocumentscreateresponsebody.md)\>**
+
+### Errors
+
+| Error Type                                   | Status Code                                  | Content Type                                 |
+| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
+| errors.SupportingDocumentsCreateResponseBody | 400                                          | application/json                             |
+| errors.One                                   | 404                                          | application/json                             |
+| errors.Two                                   | 404                                          | application/json                             |
+| errors.APIError                              | 4XX, 5XX                                     | \*/\*                                        |