@financeable/aggregation 0.2.0

package/financeable-typescript/RUNTIMES.md

@@ -0,0 +1,22 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018

package/financeable-typescript/docs/sdks/applications/README.md

@@ -0,0 +1,427 @@
+# Applications
+(*applications*)
+
+## Overview
+
+### Available Operations
+
+* [create](#create) - Create an application in the Financeable platform.
+* [list](#list) - Retrieve a list of applications
+* [get](#get) - Retrieve an application by its ID
+
+## create
+
+Create an application in the Financeable platform.
+
+### 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,
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
+        },
+        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();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { applicationsCreate } from "@financeable/aggregation/funcs/applicationsCreate.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore();
+
+async function run() {
+  const res = await applicationsCreate(financeable, {
+    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,
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+          ],
+        },
+        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",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.ApplicationResourceBulkSubmission](../../models/components/applicationresourcebulksubmission.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CreateApplicationResponseBody](../../models/operations/createapplicationresponsebody.md)\>**
+
+### Errors
+
+| Error Type                           | Status Code                          | Content Type                         |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| errors.CreateApplicationResponseBody | 403                                  | application/json                     |
+| errors.APIError                      | 4XX, 5XX                             | \*/\*                                |
+
+## list
+
+Retrieve a list of applications
+
+### Example Usage
+
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable();
+
+async function run() {
+  const result = await financeable.applications.list({});
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { applicationsList } from "@financeable/aggregation/funcs/applicationsList.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore();
+
+async function run() {
+  const res = await applicationsList(financeable, {});
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetApplicationsRequest](../../models/operations/getapplicationsrequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.GetApplicationsResponseBody](../../models/operations/getapplicationsresponsebody.md)\>**
+
+### Errors
+
+| Error Type                         | Status Code                        | Content Type                       |
+| ---------------------------------- | ---------------------------------- | ---------------------------------- |
+| errors.GetApplicationsResponseBody | 403                                | application/json                   |
+| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
+
+## get
+
+Retrieve an application by its ID
+
+### Example Usage
+
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable();
+
+async function run() {
+  const result = await financeable.applications.get({
+    id: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { applicationsGet } from "@financeable/aggregation/funcs/applicationsGet.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore();
+
+async function run() {
+  const res = await applicationsGet(financeable, {
+    id: "<id>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetApplicationRequest](../../models/operations/getapplicationrequest.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.GetApplicationResponseBody](../../models/operations/getapplicationresponsebody.md)\>**
+
+### Errors
+
+| Error Type                        | Status Code                       | Content Type                      |
+| --------------------------------- | --------------------------------- | --------------------------------- |
+| errors.GetApplicationResponseBody | 403                               | application/json                  |
+| errors.APIError                   | 4XX, 5XX                          | \*/\*                             |

package/financeable-typescript/docs/sdks/financeable/README.md

@@ -0,0 +1,5 @@
+# Financeable SDK
+
+## Overview
+
+### Available Operations

package/financeable-typescript/src/core.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "./lib/sdks.js";
+
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export class FinanceableCore extends ClientSDK {}

package/financeable-typescript/src/funcs/applicationsCreate.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { FinanceableCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Create an application in the Financeable platform.
+ */
+export async function applicationsCreate(
+  client: FinanceableCore,
+  request: components.ApplicationResourceBulkSubmission,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    operations.CreateApplicationResponseBody,
+    | errors.CreateApplicationResponseBody
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.ApplicationResourceBulkSubmission$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/applications")();
+
+  const headers = new Headers({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  });
+
+  const context = {
+    operationID: "createApplication",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: null,
+
+    securitySource: null,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    method: "POST",
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["403", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.CreateApplicationResponseBody,
+    | errors.CreateApplicationResponseBody
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(201, operations.CreateApplicationResponseBody$inboundSchema),
+    M.jsonErr(403, errors.CreateApplicationResponseBody$inboundSchema),
+    M.fail(["4XX", "5XX"]),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}