@financeable/aggregation 0.5.0 → 0.6.0

package/.devcontainer/README.md

@@ -1,6 +1,6 @@
 
 <div align="center">
-    <a href="https://codespaces.new/financeable-com-au/financeable-aggregation-api.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
+    <a href="https://codespaces.new/financeable-com-au/financeable-aggregation-sdk.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
 </div>
 <br>
 

package/FUNCTIONS.md

@@ -20,8 +20,7 @@ specific category of applications.
 
 ```typescript
 import { FinanceableCore } from "@financeable/aggregation/core.js";
-import { applicationsCreate } from "@financeable/aggregation/funcs/applicationsCreate.js";
-import { CommercialAssetType } from "@financeable/aggregation/models/components";
+import { supportingDocumentsCreate } from "@financeable/aggregation/funcs/supportingDocumentsCreate.js";
 import { SDKValidationError } from "@financeable/aggregation/models/errors/sdkvalidationerror.js";
 
 // Use `FinanceableCore` for best tree-shaking performance.
@@ -31,136 +30,16 @@ const financeable = new FinanceableCore({
 });
 
 async function run() {
-  const res = await applicationsCreate(financeable, {
-    data: {
-      type: "applications",
-      attributes: {
-        purpose: "Purchase of a motor vehicle",
-        applicationType: "consumer",
-      },
-      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: {
-                title: "Mr",
-                firstName: "John",
-                lastName: "Smith",
-                dateOfBirth: "01-01-1990",
-                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,
-                      },
-                    },
-                  ],
-                },
-              },
-            },
-          ],
-        },
-        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",
+  const res = await supportingDocumentsCreate(financeable, {
+    mimeType: "text/plain",
+    requestBody: {
+      data: {
+        type: "supporting-documents",
+        relationships: {
+          application: {
+            data: {
+              type: "consumer-secured-applications",
+              id: "<id>",
             },
           },
         },