@financeable/aggregation 0.2.0 → 0.2.1

package/README.md

@@ -1,5 +1,936 @@
 # financeable-aggregation-api
 
+
+## Summary
+
+
+## Table of Contents
+
+* [financeable-aggregation-api](#financeable-aggregation-api)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+
+## SDK Installation
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
+
+```bash
+npm add https://github.com/financeable-com-au/financeable-aggregation-api
+```
+
+### PNPM
+
+```bash
+pnpm add https://github.com/financeable-com-au/financeable-aggregation-api
+```
+
+### Bun
+
+```bash
+bun add https://github.com/financeable-com-au/financeable-aggregation-api
+```
+
+### Yarn
+
+```bash
+yarn add https://github.com/financeable-com-au/financeable-aggregation-api zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
+```
+
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+
+## SDK Example Usage
+
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable();
+
+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: [
+            {
+              id: "<id>",
+              type: "customers",
+              attributes: {
+                title: "Mr",
+                firstName: "John",
+                lastName: "Smith",
+                dateOfBirth: "01-01-1990",
+                idExpiryDate: "01-01-2025",
+                idType: "licence",
+                idNumber: "12345678",
+              },
+              relationships: {
+                addresses: {
+                  data: [
+                    {
+                      id: "<id>",
+                      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,
+                      },
+                    },
+                    {
+                      id: "<id>",
+                      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: {
+            id: "<id>",
+            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",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [applications](docs/sdks/applications/README.md)
+
+* [create](docs/sdks/applications/README.md#create) - Create an application in the Financeable platform.
+* [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
+
+
+</details>
+
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`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
+
+</details>
+
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable();
+
+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: [
+            {
+              id: "<id>",
+              type: "customers",
+              attributes: {
+                title: "Mr",
+                firstName: "John",
+                lastName: "Smith",
+                dateOfBirth: "01-01-1990",
+                idExpiryDate: "01-01-2025",
+                idType: "licence",
+                idNumber: "12345678",
+              },
+              relationships: {
+                addresses: {
+                  data: [
+                    {
+                      id: "<id>",
+                      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,
+                      },
+                    },
+                    {
+                      id: "<id>",
+                      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: {
+            id: "<id>",
+            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",
+            },
+          },
+        },
+      },
+    },
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+});
+
+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: [
+            {
+              id: "<id>",
+              type: "customers",
+              attributes: {
+                title: "Mr",
+                firstName: "John",
+                lastName: "Smith",
+                dateOfBirth: "01-01-1990",
+                idExpiryDate: "01-01-2025",
+                idType: "licence",
+                idNumber: "12345678",
+              },
+              relationships: {
+                addresses: {
+                  data: [
+                    {
+                      id: "<id>",
+                      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,
+                      },
+                    },
+                    {
+                      id: "<id>",
+                      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: {
+            id: "<id>",
+            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",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+## 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:
+
+| Error Type                           | Status Code | Content Type     |
+| ------------------------------------ | ----------- | ---------------- |
+| errors.CreateApplicationResponseBody | 403         | 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`.
+
+```typescript
+import { Financeable } from "@financeable/aggregation";
+import {
+  CreateApplicationResponseBody,
+  SDKValidationError,
+} from "@financeable/aggregation/models/errors";
+
+const financeable = new Financeable();
+
+async function run() {
+  let result;
+  try {
+    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: [
+              {
+                id: "<id>",
+                type: "customers",
+                attributes: {
+                  title: "Mr",
+                  firstName: "John",
+                  lastName: "Smith",
+                  dateOfBirth: "01-01-1990",
+                  idExpiryDate: "01-01-2025",
+                  idType: "licence",
+                  idNumber: "12345678",
+                },
+                relationships: {
+                  addresses: {
+                    data: [
+                      {
+                        id: "<id>",
+                        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,
+                        },
+                      },
+                      {
+                        id: "<id>",
+                        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: {
+              id: "<id>",
+              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",
+              },
+            },
+          },
+        },
+      },
+    });
+
+    // 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 CreateApplicationResponseBody): {
+        // Handle err.data$: CreateApplicationResponseBodyData
+        console.error(err);
+        return;
+      }
+      default: {
+        // Other errors such as network errors, see HTTPClientErrors for more details
+        throw err;
+      }
+    }
+  }
+}
+
+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.
+
+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:
+
+| 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                     |
+
+## Server Selection
+
+### 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:
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  serverURL: "https://api.financeable.com.au",
+});
+
+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: [
+            {
+              id: "<id>",
+              type: "customers",
+              attributes: {
+                title: "Mr",
+                firstName: "John",
+                lastName: "Smith",
+                dateOfBirth: "01-01-1990",
+                idExpiryDate: "01-01-2025",
+                idType: "licence",
+                idNumber: "12345678",
+              },
+              relationships: {
+                addresses: {
+                  data: [
+                    {
+                      id: "<id>",
+                      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,
+                      },
+                    },
+                    {
+                      id: "<id>",
+                      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: {
+            id: "<id>",
+            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",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { Financeable } from "@financeable/aggregation";
+import { HTTPClient } from "@financeable/aggregation/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new Financeable({ httpClient });
+```
+
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const sdk = new Financeable({ debugLogger: console });
+```
+
+You can also enable a default debug logger by setting an environment variable `FINANCEABLE_DEBUG` to true.
+
+  
 <!-- Start Summary [summary] -->
 ## Summary
 
@@ -20,40 +951,46 @@
   * [Server Selection](#server-selection)
   * [Custom HTTP Client](#custom-http-client)
   * [Debugging](#debugging)
+  * [SDK Installation](#sdk-installation-1)
+  * [Requirements](#requirements-1)
+  * [SDK Example Usage](#sdk-example-usage-1)
+  * [Available Resources and Operations](#available-resources-and-operations-1)
+  * [Standalone functions](#standalone-functions-1)
+  * [Retries](#retries-1)
+  * [Error Handling](#error-handling-1)
+  * [Server Selection](#server-selection-1)
+  * [Custom HTTP Client](#custom-http-client-1)
+  * [Debugging](#debugging-1)
 
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
 
 ```bash
-npm add https://github.com/financeable-com-au/financeable-aggregation-api
+npm add @financeable/aggregation
 ```
 
 ### PNPM
 
 ```bash
-pnpm add https://github.com/financeable-com-au/financeable-aggregation-api
+pnpm add @financeable/aggregation
 ```
 
 ### Bun
 
 ```bash
-bun add https://github.com/financeable-com-au/financeable-aggregation-api
+bun add @financeable/aggregation
 ```
 
 ### Yarn
 
 ```bash
-yarn add https://github.com/financeable-com-au/financeable-aggregation-api zod
+yarn add @financeable/aggregation zod
 
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
@@ -106,7 +1043,6 @@ async function run() {
         customers: {
           data: [
             {
-              id: "<id>",
               type: "customers",
               attributes: {
                 title: "Mr",
@@ -121,7 +1057,6 @@ async function run() {
                 addresses: {
                   data: [
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -141,7 +1076,6 @@ async function run() {
                       },
                     },
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -168,7 +1102,6 @@ async function run() {
         },
         asset: {
           data: {
-            id: "<id>",
             type: "asset",
             attributes: {
               ageOfAsset: 3,
@@ -290,7 +1223,6 @@ async function run() {
         customers: {
           data: [
             {
-              id: "<id>",
               type: "customers",
               attributes: {
                 title: "Mr",
@@ -305,7 +1237,6 @@ async function run() {
                 addresses: {
                   data: [
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -325,7 +1256,6 @@ async function run() {
                       },
                     },
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -352,7 +1282,6 @@ async function run() {
         },
         asset: {
           data: {
-            id: "<id>",
             type: "asset",
             attributes: {
               ageOfAsset: 3,
@@ -452,7 +1381,6 @@ async function run() {
         customers: {
           data: [
             {
-              id: "<id>",
               type: "customers",
               attributes: {
                 title: "Mr",
@@ -467,7 +1395,6 @@ async function run() {
                 addresses: {
                   data: [
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -487,7 +1414,6 @@ async function run() {
                       },
                     },
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -514,7 +1440,6 @@ async function run() {
         },
         asset: {
           data: {
-            id: "<id>",
             type: "asset",
             attributes: {
               ageOfAsset: 3,
@@ -610,7 +1535,6 @@ async function run() {
           customers: {
             data: [
               {
-                id: "<id>",
                 type: "customers",
                 attributes: {
                   title: "Mr",
@@ -625,7 +1549,6 @@ async function run() {
                   addresses: {
                     data: [
                       {
-                        id: "<id>",
                         type: "addresses",
                         attributes: {
                           addressType: "residential",
@@ -645,7 +1568,6 @@ async function run() {
                         },
                       },
                       {
-                        id: "<id>",
                         type: "addresses",
                         attributes: {
                           addressType: "residential",
@@ -672,7 +1594,6 @@ async function run() {
           },
           asset: {
             data: {
-              id: "<id>",
               type: "asset",
               attributes: {
                 ageOfAsset: 3,
@@ -791,7 +1712,6 @@ async function run() {
         customers: {
           data: [
             {
-              id: "<id>",
               type: "customers",
               attributes: {
                 title: "Mr",
@@ -806,7 +1726,6 @@ async function run() {
                 addresses: {
                   data: [
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -826,7 +1745,6 @@ async function run() {
                       },
                     },
                     {
-                      id: "<id>",
                       type: "addresses",
                       attributes: {
                         addressType: "residential",
@@ -853,7 +1771,6 @@ async function run() {
         },
         asset: {
           data: {
-            id: "<id>",
             type: "asset",
             attributes: {
               ageOfAsset: 3,