@financeable/aggregation 0.8.1 → 0.9.0

package/README.md

@@ -379,20 +379,154 @@ const financeable = new Financeable({
 });
 
 async function run() {
-  const result = await financeable.supportingDocuments.create({
-    mimeType: "text/csv",
-    requestBody: {
-      data: {
-        type: "supporting-documents",
-        attributes: {
-          filename: "example.file",
-          documentType: "BANK STATEMENT",
+  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,
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
         },
-        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",
             },
           },
         },
@@ -411,7 +545,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -438,20 +571,154 @@ const financeable = new Financeable({
 });
 
 async function run() {
-  const result = await financeable.supportingDocuments.create({
-    mimeType: "text/csv",
-    requestBody: {
-      data: {
-        type: "supporting-documents",
-        attributes: {
-          filename: "example.file",
-          documentType: "BANK STATEMENT",
+  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,
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
         },
-        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",
             },
           },
         },
@@ -459,7 +726,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -471,47 +737,175 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `create` method may throw the following errors:
+[`FinanceableError`](./src/models/errors/financeableerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| 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    | \*/\*            |
-
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+| Property            | Type       | Description                                            |
+| ------------------- | ---------- | ------------------------------------------------------ |
+| `error.message`     | `string`   | Error message                                          |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                     |
+| `error.headers`     | `Headers`  | HTTP response headers                                  |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned. |
+| `error.rawResponse` | `Response` | Raw HTTP response                                      |
 
+### Example
 ```typescript
 import { Financeable } from "@financeable/aggregation";
-import {
-  One,
-  SDKValidationError,
-  SupportingDocumentsCreateResponseBody,
-  Two,
-} from "@financeable/aggregation/models/errors";
+import * as errors from "@financeable/aggregation/models/errors";
 
 const financeable = new Financeable({
   clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
 });
 
 async function run() {
-  let result;
   try {
-    result = await financeable.supportingDocuments.create({
-      mimeType: "text/csv",
-      requestBody: {
-        data: {
-          type: "supporting-documents",
-          attributes: {
-            filename: "example.file",
-            documentType: "BANK STATEMENT",
+    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,
+                        },
+                      },
+                    ],
+                  },
+                },
+              },
+            ],
           },
-          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",
               },
             },
           },
@@ -519,35 +913,13 @@ async function run() {
       },
     });
 
-    // Handle the result
     console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof SupportingDocumentsCreateResponseBody): {
-        // Handle err.data$: SupportingDocumentsCreateResponseBodyData
-        console.error(err);
-        return;
-      }
-      case (err instanceof One): {
-        // Handle err.data$: OneData
-        return;
-      }
-      case (err instanceof Two): {
-        // Handle err.data$: TwoData
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
-      }
+  } catch (error) {
+    if (error instanceof errors.FinanceableError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
     }
   }
 }
@@ -556,17 +928,26 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+### Error Classes
+**Primary error:**
+* [`FinanceableError`](./src/models/errors/financeableerror.ts): The base class for HTTP error responses.
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+<details><summary>Less common errors (6)</summary>
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`FinanceableError`](./src/models/errors/financeableerror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
 <!-- End Error Handling [errors] -->
 
 <!-- No Server Selection [server] -->