@financeable/aggregation 0.2.1 → 0.3.1

package/README.md

@@ -954,6 +954,7 @@ You can also enable a default debug logger by setting an environment variable `F
   * [SDK Installation](#sdk-installation-1)
   * [Requirements](#requirements-1)
   * [SDK Example Usage](#sdk-example-usage-1)
+  * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations-1)
   * [Standalone functions](#standalone-functions-1)
   * [Retries](#retries-1)
@@ -1011,128 +1012,16 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 ```typescript
 import { Financeable } from "@financeable/aggregation";
 
-const financeable = new Financeable();
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
 
 async function run() {
-  const result = await financeable.applications.create({
-    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",
-            },
-          },
-        },
-        customers: {
-          data: [
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "John",
-                lastName: "Smith",
-                dateOfBirth: "01-01-1990",
-                idExpiryDate: "01-01-2025",
-                idType: "licence",
-                idNumber: "12345678",
-              },
-              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: "asset",
-            attributes: {
-              ageOfAsset: 3,
-              ageOfAssetAtEnd: 8,
-              condition: "USED",
-              assetType: "MOTOR_VEHICLE_(<4.5_TONNES)",
-              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 result = await financeable.getToken({
+    grantType: "client_credentials",
+    clientId: "<id>",
+    clientSecret: "<value>",
+    scope: "<value>",
   });
 
   // Handle the result
@@ -1144,6 +1033,42 @@ run();
 ```
 <!-- End SDK Example Usage [usage] -->
 
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name                | Type   | Scheme       | Environment Variable             |
+| ------------------- | ------ | ------------ | -------------------------------- |
+| `clientCredentials` | oauth2 | OAuth2 token | `FINANCEABLE_CLIENT_CREDENTIALS` |
+
+To authenticate with the API the `clientCredentials` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.getToken({
+    grantType: "client_credentials",
+    clientId: "<id>",
+    clientSecret: "<value>",
+    scope: "<value>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -1156,6 +1081,9 @@ run();
 * [list](docs/sdks/applications/README.md#list) - Retrieve a list of applications
 * [get](docs/sdks/applications/README.md#get) - Retrieve an application by its ID
 
+### [Financeable SDK](docs/sdks/financeable/README.md)
+
+* [getToken](docs/sdks/financeable/README.md#gettoken) - Obtain an OAuth client_credentials token
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -1178,6 +1106,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`applicationsCreate`](docs/sdks/applications/README.md#create) - Create an application in the Financeable platform.
 - [`applicationsGet`](docs/sdks/applications/README.md#get) - Retrieve an application by its ID
 - [`applicationsList`](docs/sdks/applications/README.md#list) - Retrieve a list of applications
+- [`getToken`](docs/sdks/financeable/README.md#gettoken) - Obtain an OAuth client_credentials token
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -1191,128 +1120,16 @@ To change the default retry strategy for a single API call, simply provide a ret
 ```typescript
 import { Financeable } from "@financeable/aggregation";
 
-const financeable = new Financeable();
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
 
 async function run() {
-  const result = await financeable.applications.create({
-    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",
-            },
-          },
-        },
-        customers: {
-          data: [
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "John",
-                lastName: "Smith",
-                dateOfBirth: "01-01-1990",
-                idExpiryDate: "01-01-2025",
-                idType: "licence",
-                idNumber: "12345678",
-              },
-              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: "asset",
-            attributes: {
-              ageOfAsset: 3,
-              ageOfAssetAtEnd: 8,
-              condition: "USED",
-              assetType: "MOTOR_VEHICLE_(<4.5_TONNES)",
-              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 result = await financeable.getToken({
+    grantType: "client_credentials",
+    clientId: "<id>",
+    clientSecret: "<value>",
+    scope: "<value>",
   }, {
     retries: {
       strategy: "backoff",
@@ -1349,128 +1166,15 @@ const financeable = new Financeable({
     },
     retryConnectionErrors: false,
   },
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
 });
 
 async function run() {
-  const result = await financeable.applications.create({
-    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",
-            },
-          },
-        },
-        customers: {
-          data: [
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "John",
-                lastName: "Smith",
-                dateOfBirth: "01-01-1990",
-                idExpiryDate: "01-01-2025",
-                idType: "licence",
-                idNumber: "12345678",
-              },
-              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: "asset",
-            attributes: {
-              ageOfAsset: 3,
-              ageOfAssetAtEnd: 8,
-              condition: "USED",
-              assetType: "MOTOR_VEHICLE_(<4.5_TONNES)",
-              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 result = await financeable.getToken({
+    grantType: "client_credentials",
+    clientId: "<id>",
+    clientSecret: "<value>",
+    scope: "<value>",
   });
 
   // Handle the result
@@ -1501,7 +1205,9 @@ import {
   SDKValidationError,
 } from "@financeable/aggregation/models/errors";
 
-const financeable = new Financeable();
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
 
 async function run() {
   let result;
@@ -1541,9 +1247,7 @@ async function run() {
                   firstName: "John",
                   lastName: "Smith",
                   dateOfBirth: "01-01-1990",
-                  idExpiryDate: "01-01-2025",
-                  idType: "licence",
-                  idNumber: "12345678",
+                  idExpiryDate: "<value>",
                 },
                 relationships: {
                   addresses: {
@@ -1674,134 +1378,21 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { Financeable } from "@financeable/aggregation";
 
 const financeable = new Financeable({
   serverURL: "https://api.financeable.com.au",
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
 });
 
 async function run() {
-  const result = await financeable.applications.create({
-    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",
-            },
-          },
-        },
-        customers: {
-          data: [
-            {
-              type: "customers",
-              attributes: {
-                title: "Mr",
-                firstName: "John",
-                lastName: "Smith",
-                dateOfBirth: "01-01-1990",
-                idExpiryDate: "01-01-2025",
-                idType: "licence",
-                idNumber: "12345678",
-              },
-              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: "asset",
-            attributes: {
-              ageOfAsset: 3,
-              ageOfAssetAtEnd: 8,
-              condition: "USED",
-              assetType: "MOTOR_VEHICLE_(<4.5_TONNES)",
-              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 result = await financeable.getToken({
+    grantType: "client_credentials",
+    clientId: "<id>",
+    clientSecret: "<value>",
+    scope: "<value>",
   });
 
   // Handle the result