@financeable/lenders 0.5.6 → 0.7.0

package/FUNCTIONS.md

@@ -1,11 +1,11 @@
 # Standalone Functions
 
 > [!NOTE]
-> This section is useful if you are using a bundler and targetting browsers and
+> This section is useful if you are using a bundler and targeting browsers and
 > runtimes where the size of an application affects performance and load times. 
 
 Every method in this SDK is also available as a standalone function. This
-alternative API is suitable when targetting the browser or serverless runtimes
+alternative API is suitable when targeting the browser or serverless runtimes
 and using a bundler to build your application since all unused functionality
 will be tree-shaken away. This includes code for unused methods, Zod schemas,
 encoding helpers and response handlers. The result is dramatically smaller
@@ -20,14 +20,16 @@ specific category of applications.
 
 ```typescript
 import { FinanceableLendersCore } from "@financeable/lenders/core.js";
-import { createCommercialSubmission } from "@financeable/lenders/funcs/createCommercialSubmission.js";
+import { commercialSubmissionsCreate } from "@financeable/lenders/funcs/commercialSubmissionsCreate.js";
 
 // Use `FinanceableLendersCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const financeableLenders = new FinanceableLendersCore();
+const financeableLenders = new FinanceableLendersCore({
+  apiKeyAuth: process.env["FINACEABLELENDERS_API_KEY_AUTH"] ?? "",
+});
 
 async function run() {
-  const res = await createCommercialSubmission(financeableLenders, {
+  const res = await commercialSubmissionsCreate(financeableLenders, {
     lender: "Moneyplace",
     requestBody: {
       id: "<id>",
@@ -38,7 +40,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("createCommercialSubmission failed:", res.error);
+    console.log("commercialSubmissionsCreate failed:", res.error);
   }
 }
 

package/README.md

@@ -17,7 +17,17 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage _
 <!-- Start Summary [summary] -->
 ## Summary
 
+Financeable Lenders API: ## Authentication
 
+All requests must include an API key in the `X-API-Key` request header.
+
+Missing, malformed, or revoked keys return a JSON:API error document
+(`application/vnd.api+json`) with HTTP `401 Unauthorized`. The error
+object's `source.header` field is set to `X-API-Key` so clients can
+identify which credential failed. Insufficient permissions for a valid
+key return `403 Forbidden` with the same source convention.
+
+Keys must never be sent in the query string or request body.
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
@@ -27,6 +37,7 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage _
   * [SDK Installation](#sdk-installation)
   * [Requirements](#requirements)
   * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
   * [Retries](#retries)
@@ -93,7 +104,8 @@ Add the following server definition to your `claude_desktop_config.json` file:
       "args": [
         "-y", "--package", "@financeable/lenders",
         "--",
-        "mcp", "start"
+        "mcp", "start",
+        "--api-key-auth", "..."
       ]
     }
   }
@@ -115,7 +127,8 @@ Create a `.cursor/mcp.json` file in your project root with the following content
       "args": [
         "-y", "--package", "@financeable/lenders",
         "--",
-        "mcp", "start"
+        "mcp", "start",
+        "--api-key-auth", "..."
       ]
     }
   }
@@ -169,10 +182,12 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 ```typescript
 import { FinanceableLenders } from "@financeable/lenders";
 
-const financeableLenders = new FinanceableLenders();
+const financeableLenders = new FinanceableLenders({
+  apiKeyAuth: process.env["FINACEABLELENDERS_API_KEY_AUTH"] ?? "",
+});
 
 async function run() {
-  const result = await financeableLenders.createCommercialSubmission({
+  const result = await financeableLenders.commercial.submissions.create({
     lender: "Moneyplace",
     requestBody: {
       id: "<id>",
@@ -188,18 +203,63 @@ 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             |
+| ------------ | ------ | ------- | -------------------------------- |
+| `apiKeyAuth` | apiKey | API key | `FINACEABLELENDERS_API_KEY_AUTH` |
+
+To authenticate with the API the `apiKeyAuth` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { FinanceableLenders } from "@financeable/lenders";
+
+const financeableLenders = new FinanceableLenders({
+  apiKeyAuth: process.env["FINACEABLELENDERS_API_KEY_AUTH"] ?? "",
+});
+
+async function run() {
+  const result = await financeableLenders.commercial.submissions.create({
+    lender: "Moneyplace",
+    requestBody: {
+      id: "<id>",
+      type: "commercial",
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
 <details open>
 <summary>Available methods</summary>
 
-### [FinanceableLenders SDK](docs/sdks/financeablelenders/README.md)
+### [Commercial.Submissions](docs/sdks/submissions/README.md)
+
+* [create](docs/sdks/submissions/README.md#create) - Create commercial submission route
 
-* [createCommercialSubmission](docs/sdks/financeablelenders/README.md#createcommercialsubmission) - Create commercial submission route
-* [createConsumerSubmission](docs/sdks/financeablelenders/README.md#createconsumersubmission) - Create consumer submission route
-* [createDocumentsSubmission](docs/sdks/financeablelenders/README.md#createdocumentssubmission) - Create documents submission route
-* [createPersonalSubmission](docs/sdks/financeablelenders/README.md#createpersonalsubmission) - Create personal submission route
+### [Consumer.Submissions](docs/sdks/financeablelenderssubmissions/README.md)
+
+* [create](docs/sdks/financeablelenderssubmissions/README.md#create) - Create consumer submission route
+
+### [Documents.Submissions](docs/sdks/financeablelendersdocumentssubmissions/README.md)
+
+* [create](docs/sdks/financeablelendersdocumentssubmissions/README.md#create) - Create documents submission route
+
+### [Personal.Submissions](docs/sdks/financeablelenderspersonalsubmissions/README.md)
+
+* [create](docs/sdks/financeablelenderspersonalsubmissions/README.md#create) - Create personal submission route
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -219,10 +279,10 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`createCommercialSubmission`](docs/sdks/financeablelenders/README.md#createcommercialsubmission) - Create commercial submission route
-- [`createConsumerSubmission`](docs/sdks/financeablelenders/README.md#createconsumersubmission) - Create consumer submission route
-- [`createDocumentsSubmission`](docs/sdks/financeablelenders/README.md#createdocumentssubmission) - Create documents submission route
-- [`createPersonalSubmission`](docs/sdks/financeablelenders/README.md#createpersonalsubmission) - Create personal submission route
+- [`commercialSubmissionsCreate`](docs/sdks/submissions/README.md#create) - Create commercial submission route
+- [`consumerSubmissionsCreate`](docs/sdks/financeablelenderssubmissions/README.md#create) - Create consumer submission route
+- [`documentsSubmissionsCreate`](docs/sdks/financeablelendersdocumentssubmissions/README.md#create) - Create documents submission route
+- [`personalSubmissionsCreate`](docs/sdks/financeablelenderspersonalsubmissions/README.md#create) - Create personal submission route
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -236,10 +296,12 @@ To change the default retry strategy for a single API call, simply provide a ret
 ```typescript
 import { FinanceableLenders } from "@financeable/lenders";
 
-const financeableLenders = new FinanceableLenders();
+const financeableLenders = new FinanceableLenders({
+  apiKeyAuth: process.env["FINACEABLELENDERS_API_KEY_AUTH"] ?? "",
+});
 
 async function run() {
-  const result = await financeableLenders.createCommercialSubmission({
+  const result = await financeableLenders.commercial.submissions.create({
     lender: "Moneyplace",
     requestBody: {
       id: "<id>",
@@ -280,10 +342,11 @@ const financeableLenders = new FinanceableLenders({
     },
     retryConnectionErrors: false,
   },
+  apiKeyAuth: process.env["FINACEABLELENDERS_API_KEY_AUTH"] ?? "",
 });
 
 async function run() {
-  const result = await financeableLenders.createCommercialSubmission({
+  const result = await financeableLenders.commercial.submissions.create({
     lender: "Moneyplace",
     requestBody: {
       id: "<id>",
@@ -318,11 +381,13 @@ run();
 import { FinanceableLenders } from "@financeable/lenders";
 import * as errors from "@financeable/lenders/models/errors";
 
-const financeableLenders = new FinanceableLenders();
+const financeableLenders = new FinanceableLenders({
+  apiKeyAuth: process.env["FINACEABLELENDERS_API_KEY_AUTH"] ?? "",
+});
 
 async function run() {
   try {
-    const result = await financeableLenders.createCommercialSubmission({
+    const result = await financeableLenders.commercial.submissions.create({
       lender: "Moneyplace",
       requestBody: {
         id: "<id>",
@@ -340,7 +405,7 @@ async function run() {
       console.log(error.headers);
 
       // Depending on the method different errors may be thrown
-      if (error instanceof errors.CreateCommercialSubmissionResponseBody) {
+      if (error instanceof errors.ResponseBody) {
         console.log(error.data$.lender); // components.Lenders
         console.log(error.data$.errors); // ApiError[][]
       }
@@ -353,10 +418,15 @@ run();
 ```
 
 ### Error Classes
-**Primary error:**
+**Primary errors:**
 * [`FinanceableLendersError`](./src/models/errors/financeablelenderserror.ts): The base class for HTTP error responses.
+  * [`ResponseBody`](./src/models/errors/responsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`.
+  * [`ResponseResponseBody`](./src/models/errors/responseresponsebody.ts): Access is unauthorized. Status code `401`.
+  * [`Response403ResponseBody`](./src/models/errors/response403responsebody.ts): Access is forbidden. Status code `403`.
+  * [`Response404ResponseBody`](./src/models/errors/response404responsebody.ts): The server cannot find the requested resource. Status code `404`.
+  * [`Response500ResponseBody`](./src/models/errors/response500responsebody.ts): Server error. Status code `500`.
 
-<details><summary>Less common errors (26)</summary>
+<details><summary>Less common errors (6)</summary>
 
 <br />
 
@@ -369,31 +439,9 @@ run();
 
 
 **Inherit from [`FinanceableLendersError`](./src/models/errors/financeablelenderserror.ts)**:
-* [`CreateCommercialSubmissionResponseBody`](./src/models/errors/createcommercialsubmissionresponsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`. Applicable to 1 of 4 methods.*
-* [`CreateConsumerSubmissionResponseBody`](./src/models/errors/createconsumersubmissionresponsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`. Applicable to 1 of 4 methods.*
-* [`CreateDocumentsSubmissionResponseBody`](./src/models/errors/createdocumentssubmissionresponsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`. Applicable to 1 of 4 methods.*
-* [`CreatePersonalSubmissionResponseBody`](./src/models/errors/createpersonalsubmissionresponsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`. Applicable to 1 of 4 methods.*
-* [`CreateCommercialSubmissionResponseResponseBody`](./src/models/errors/createcommercialsubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`. Applicable to 1 of 4 methods.*
-* [`CreateConsumerSubmissionResponseResponseBody`](./src/models/errors/createconsumersubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`. Applicable to 1 of 4 methods.*
-* [`CreateDocumentsSubmissionResponseResponseBody`](./src/models/errors/createdocumentssubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`. Applicable to 1 of 4 methods.*
-* [`CreatePersonalSubmissionResponseResponseBody`](./src/models/errors/createpersonalsubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`. Applicable to 1 of 4 methods.*
-* [`CreateCommercialSubmissionResponse403ResponseBody`](./src/models/errors/createcommercialsubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`. Applicable to 1 of 4 methods.*
-* [`CreateConsumerSubmissionResponse403ResponseBody`](./src/models/errors/createconsumersubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`. Applicable to 1 of 4 methods.*
-* [`CreateDocumentsSubmissionResponse403ResponseBody`](./src/models/errors/createdocumentssubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`. Applicable to 1 of 4 methods.*
-* [`CreatePersonalSubmissionResponse403ResponseBody`](./src/models/errors/createpersonalsubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`. Applicable to 1 of 4 methods.*
-* [`CreateCommercialSubmissionResponse404ResponseBody`](./src/models/errors/createcommercialsubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`. Applicable to 1 of 4 methods.*
-* [`CreateConsumerSubmissionResponse404ResponseBody`](./src/models/errors/createconsumersubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`. Applicable to 1 of 4 methods.*
-* [`CreateDocumentsSubmissionResponse404ResponseBody`](./src/models/errors/createdocumentssubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`. Applicable to 1 of 4 methods.*
-* [`CreatePersonalSubmissionResponse404ResponseBody`](./src/models/errors/createpersonalsubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`. Applicable to 1 of 4 methods.*
-* [`CreateCommercialSubmissionResponse500ResponseBody`](./src/models/errors/createcommercialsubmissionresponse500responsebody.ts): Server error. Status code `500`. Applicable to 1 of 4 methods.*
-* [`CreateConsumerSubmissionResponse500ResponseBody`](./src/models/errors/createconsumersubmissionresponse500responsebody.ts): Server error. Status code `500`. Applicable to 1 of 4 methods.*
-* [`CreateDocumentsSubmissionResponse500ResponseBody`](./src/models/errors/createdocumentssubmissionresponse500responsebody.ts): Server error. Status code `500`. Applicable to 1 of 4 methods.*
-* [`CreatePersonalSubmissionResponse500ResponseBody`](./src/models/errors/createpersonalsubmissionresponse500responsebody.ts): Server error. Status code `500`. Applicable to 1 of 4 methods.*
 * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 
 </details>
-
-\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -407,10 +455,11 @@ import { FinanceableLenders } from "@financeable/lenders";
 
 const financeableLenders = new FinanceableLenders({
   serverURL: "https://aws.lenders.api.financeable.com.au/api/v1",
+  apiKeyAuth: process.env["FINACEABLELENDERS_API_KEY_AUTH"] ?? "",
 });
 
 async function run() {
-  const result = await financeableLenders.createCommercialSubmission({
+  const result = await financeableLenders.commercial.submissions.create({
     lender: "Moneyplace",
     requestBody: {
       id: "<id>",