@financeable/aggregation 0.9.1 → 0.10.0

package/docs/sdks/applications/README.md

@@ -13,6 +13,7 @@ Create an application in the Financeable platform.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createApplication" method="post" path="/applications" -->
 ```typescript
 import { Financeable } from "@financeable/aggregation";
 

package/docs/sdks/oauthtoken/README.md

@@ -13,6 +13,7 @@ Obtain an OAuth client_credentials token
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getToken" method="post" path="/oauth/token" -->
 ```typescript
 import { Financeable } from "@financeable/aggregation";
 

package/docs/sdks/supportingdocuments/README.md

@@ -13,6 +13,7 @@ Create a supporting document record in Financeable, and returns a pre-signed URL
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="SupportingDocuments_create" method="post" path="/supporting-documents" -->
 ```typescript
 import { Financeable } from "@financeable/aggregation";
 

package/examples/README.md

@@ -0,0 +1,31 @@
+# @financeable/aggregation Examples
+
+This directory contains example scripts demonstrating how to use the @financeable/aggregation SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/applicationsCreate.example.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @financeable/aggregation SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx applicationsCreate.ts
+ */
+
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function main() {
+  const result = await financeable.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,
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
+        },
+        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",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+main().catch(console.error);