@financeable/lenders 0.3.0 → 0.3.18

package/FUNCTIONS.md

@@ -20,21 +20,25 @@ specific category of applications.
 
 ```typescript
 import { FinanceableLendersCore } from "@financeable/lenders/core.js";
-import { createSubmission } from "@financeable/lenders/funcs/createSubmission.js";
+import { createCommercialSubmission } from "@financeable/lenders/funcs/createCommercialSubmission.js";
 
 // Use `FinanceableLendersCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const financeableLenders = new FinanceableLendersCore();
 
 async function run() {
-  const res = await createSubmission(financeableLenders, {
-    lender: "Latitude",
+  const res = await createCommercialSubmission(financeableLenders, {
+    lender: "Moneyplace",
+    requestBody: {
+      id: "<id>",
+      type: "commercial",
+    },
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("createSubmission failed:", res.error);
+    console.log("createCommercialSubmission failed:", res.error);
   }
 }
 

package/README.md

@@ -172,8 +172,12 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.createSubmission({
-    lender: "Latitude",
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
+    requestBody: {
+      id: "<id>",
+      type: "commercial",
+    },
   });
 
   console.log(result);
@@ -192,7 +196,10 @@ run();
 
 ### [FinanceableLenders SDK](docs/sdks/financeablelenders/README.md)
 
-* [createSubmission](docs/sdks/financeablelenders/README.md#createsubmission) - 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
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -212,7 +219,10 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`createSubmission`](docs/sdks/financeablelenders/README.md#createsubmission) - 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
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -229,8 +239,12 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.createSubmission({
-    lender: "Latitude",
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
+    requestBody: {
+      id: "<id>",
+      type: "commercial",
+    },
   }, {
     retries: {
       strategy: "backoff",
@@ -269,8 +283,12 @@ const financeableLenders = new FinanceableLenders({
 });
 
 async function run() {
-  const result = await financeableLenders.createSubmission({
-    lender: "Latitude",
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
+    requestBody: {
+      id: "<id>",
+      type: "commercial",
+    },
   });
 
   console.log(result);
@@ -304,8 +322,12 @@ const financeableLenders = new FinanceableLenders();
 
 async function run() {
   try {
-    const result = await financeableLenders.createSubmission({
-      lender: "Latitude",
+    const result = await financeableLenders.createCommercialSubmission({
+      lender: "Moneyplace",
+      requestBody: {
+        id: "<id>",
+        type: "commercial",
+      },
     });
 
     console.log(result);
@@ -318,7 +340,7 @@ async function run() {
       console.log(error.headers);
 
       // Depending on the method different errors may be thrown
-      if (error instanceof errors.CreateSubmissionResponseBody) {
+      if (error instanceof errors.CreateCommercialSubmissionResponseBody) {
         console.log(error.data$.lender); // components.Lenders
         console.log(error.data$.errors); // ApiError[][]
       }
@@ -331,15 +353,10 @@ run();
 ```
 
 ### Error Classes
-**Primary errors:**
+**Primary error:**
 * [`FinanceableLendersError`](./src/models/errors/financeablelenderserror.ts): The base class for HTTP error responses.
-  * [`CreateSubmissionResponseBody`](./src/models/errors/createsubmissionresponsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`.
-  * [`CreateSubmissionResponseResponseBody`](./src/models/errors/createsubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`.
-  * [`CreateSubmissionResponse403ResponseBody`](./src/models/errors/createsubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`.
-  * [`CreateSubmissionResponse404ResponseBody`](./src/models/errors/createsubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`.
-  * [`CreateSubmissionResponse500ResponseBody`](./src/models/errors/createsubmissionresponse500responsebody.ts): Server error. Status code `500`.
 
-<details><summary>Less common errors (6)</summary>
+<details><summary>Less common errors (26)</summary>
 
 <br />
 
@@ -352,9 +369,31 @@ 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] -->
@@ -371,8 +410,12 @@ const financeableLenders = new FinanceableLenders({
 });
 
 async function run() {
-  const result = await financeableLenders.createSubmission({
-    lender: "Latitude",
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
+    requestBody: {
+      id: "<id>",
+      type: "commercial",
+    },
   });
 
   console.log(result);