@financeable/aggregation 0.8.3 → 0.9.0

package/FUNCTIONS.md

@@ -20,8 +20,7 @@ specific category of applications.
 
 ```typescript
 import { FinanceableCore } from "@financeable/aggregation/core.js";
-import { supportingDocumentsCreate } from "@financeable/aggregation/funcs/supportingDocumentsCreate.js";
-import { SDKValidationError } from "@financeable/aggregation/models/errors/sdkvalidationerror.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.
@@ -30,48 +29,166 @@ const financeable = new FinanceableCore({
 });
 
 async function run() {
-  const res = await supportingDocumentsCreate(financeable, {
-    mimeType: "text/csv",
-    requestBody: {
-      data: {
-        type: "supporting-documents",
-        attributes: {
-          filename: "example.file",
-          documentType: "BANK STATEMENT",
+  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,
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
         },
-        relationships: {
-          application: {
-            data: {
-              type: "consumer-secured-applications",
-              id: "<id>",
+        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",
             },
           },
         },
       },
     },
   });
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("applicationsCreate failed:", res.error);
   }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();