@financeable/lenders 0.2.0 → 0.3.7

package/FUNCTIONS.md

@@ -20,50 +20,21 @@ specific category of applications.
 
 ```typescript
 import { FinanceableLendersCore } from "@financeable/lenders/core.js";
-import { consumersCreatePepper } from "@financeable/lenders/funcs/consumersCreatePepper.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 consumersCreatePepper(financeableLenders, {
-    id: "<id>",
-    customers: [
-      {
-        id: "<id>",
-        customerTitle: "Miss",
-        firstName: "Cornelius",
-        lastName: "Renner",
-        idNumber: "<value>",
-        idCardNumber: "<value>",
-        idExpiryDate: "<value>",
-      },
-    ],
-    asset: {},
-    productDetails: {
-      productName: "<value>",
-      productType: "<value>",
-    },
-    lenderCredentials: {
-      pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://criminal-cosset.biz",
-      pepperClientId: "<id>",
-      pepperClientSecret: "<value>",
-      pepperUsername: "<value>",
-    },
-    humanId: "<id>",
-    loanDetails: {
-      deposit: 1321.8,
-      tradeIn: 5190.75,
-      payout: 8717.28,
-    },
+  const res = await createCommercialSubmission(financeableLenders, {
+    lender: "Moneyplace",
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("consumersCreatePepper failed:", res.error);
+    console.log("createCommercialSubmission failed:", res.error);
   }
 }
 

package/README.md

@@ -172,37 +172,8 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
-    id: "<id>",
-    customers: [
-      {
-        id: "<id>",
-        customerTitle: "Miss",
-        firstName: "Cornelius",
-        lastName: "Renner",
-        idNumber: "<value>",
-        idCardNumber: "<value>",
-        idExpiryDate: "<value>",
-      },
-    ],
-    asset: {},
-    productDetails: {
-      productName: "<value>",
-      productType: "<value>",
-    },
-    lenderCredentials: {
-      pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://criminal-cosset.biz",
-      pepperClientId: "<id>",
-      pepperClientSecret: "<value>",
-      pepperUsername: "<value>",
-    },
-    humanId: "<id>",
-    loanDetails: {
-      deposit: 1321.8,
-      tradeIn: 5190.75,
-      payout: 8717.28,
-    },
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
   });
 
   console.log(result);
@@ -219,9 +190,11 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [consumers](docs/sdks/consumers/README.md)
+### [FinanceableLenders SDK](docs/sdks/financeablelenders/README.md)
 
-* [createPepper](docs/sdks/consumers/README.md#createpepper) - Pepper Consumer route
+* [createCommercialSubmission](docs/sdks/financeablelenders/README.md#createcommercialsubmission) - Create commercial submission route
+* [createSubmission](docs/sdks/financeablelenders/README.md#createsubmission) - Create consumer submission route
+* [createPersonalSubmission](docs/sdks/financeablelenders/README.md#createpersonalsubmission) - Create personal submission route
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -241,7 +214,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`consumersCreatePepper`](docs/sdks/consumers/README.md#createpepper) - Pepper Consumer route
+- [`createCommercialSubmission`](docs/sdks/financeablelenders/README.md#createcommercialsubmission) - Create commercial submission route
+- [`createPersonalSubmission`](docs/sdks/financeablelenders/README.md#createpersonalsubmission) - Create personal submission route
+- [`createSubmission`](docs/sdks/financeablelenders/README.md#createsubmission) - Create consumer submission route
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -258,37 +233,8 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
-    id: "<id>",
-    customers: [
-      {
-        id: "<id>",
-        customerTitle: "Miss",
-        firstName: "Cornelius",
-        lastName: "Renner",
-        idNumber: "<value>",
-        idCardNumber: "<value>",
-        idExpiryDate: "<value>",
-      },
-    ],
-    asset: {},
-    productDetails: {
-      productName: "<value>",
-      productType: "<value>",
-    },
-    lenderCredentials: {
-      pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://criminal-cosset.biz",
-      pepperClientId: "<id>",
-      pepperClientSecret: "<value>",
-      pepperUsername: "<value>",
-    },
-    humanId: "<id>",
-    loanDetails: {
-      deposit: 1321.8,
-      tradeIn: 5190.75,
-      payout: 8717.28,
-    },
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
   }, {
     retries: {
       strategy: "backoff",
@@ -327,37 +273,8 @@ const financeableLenders = new FinanceableLenders({
 });
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
-    id: "<id>",
-    customers: [
-      {
-        id: "<id>",
-        customerTitle: "Miss",
-        firstName: "Cornelius",
-        lastName: "Renner",
-        idNumber: "<value>",
-        idCardNumber: "<value>",
-        idExpiryDate: "<value>",
-      },
-    ],
-    asset: {},
-    productDetails: {
-      productName: "<value>",
-      productType: "<value>",
-    },
-    lenderCredentials: {
-      pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://criminal-cosset.biz",
-      pepperClientId: "<id>",
-      pepperClientSecret: "<value>",
-      pepperUsername: "<value>",
-    },
-    humanId: "<id>",
-    loanDetails: {
-      deposit: 1321.8,
-      tradeIn: 5190.75,
-      payout: 8717.28,
-    },
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
   });
 
   console.log(result);
@@ -391,37 +308,8 @@ const financeableLenders = new FinanceableLenders();
 
 async function run() {
   try {
-    const result = await financeableLenders.consumers.createPepper({
-      id: "<id>",
-      customers: [
-        {
-          id: "<id>",
-          customerTitle: "Miss",
-          firstName: "Cornelius",
-          lastName: "Renner",
-          idNumber: "<value>",
-          idCardNumber: "<value>",
-          idExpiryDate: "<value>",
-        },
-      ],
-      asset: {},
-      productDetails: {
-        productName: "<value>",
-        productType: "<value>",
-      },
-      lenderCredentials: {
-        pepperMerchantId: "<id>",
-        pepperBaseUrl: "https://criminal-cosset.biz",
-        pepperClientId: "<id>",
-        pepperClientSecret: "<value>",
-        pepperUsername: "<value>",
-      },
-      humanId: "<id>",
-      loanDetails: {
-        deposit: 1321.8,
-        tradeIn: 5190.75,
-        payout: 8717.28,
-      },
+    const result = await financeableLenders.createCommercialSubmission({
+      lender: "Moneyplace",
     });
 
     console.log(result);
@@ -434,7 +322,7 @@ async function run() {
       console.log(error.headers);
 
       // Depending on the method different errors may be thrown
-      if (error instanceof errors.CreatePepperConsumerResponseBody) {
+      if (error instanceof errors.CreateCommercialSubmissionResponseBody) {
         console.log(error.data$.lender); // components.Lenders
         console.log(error.data$.errors); // ApiError[][]
       }
@@ -447,15 +335,10 @@ run();
 ```
 
 ### Error Classes
-**Primary errors:**
+**Primary error:**
 * [`FinanceableLendersError`](./src/models/errors/financeablelenderserror.ts): The base class for HTTP error responses.
-  * [`CreatePepperConsumerResponseBody`](./src/models/errors/createpepperconsumerresponsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`.
-  * [`CreatePepperConsumerConsumersResponseBody`](./src/models/errors/createpepperconsumerconsumersresponsebody.ts): Access is unauthorized. Status code `401`.
-  * [`CreatePepperConsumerConsumersResponseResponseBody`](./src/models/errors/createpepperconsumerconsumersresponseresponsebody.ts): Access is forbidden. Status code `403`.
-  * [`CreatePepperConsumerConsumersResponse404ResponseBody`](./src/models/errors/createpepperconsumerconsumersresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`.
-  * [`CreatePepperConsumerConsumersResponse500ResponseBody`](./src/models/errors/createpepperconsumerconsumersresponse500responsebody.ts): Server error. Status code `500`.
 
-<details><summary>Less common errors (6)</summary>
+<details><summary>Less common errors (21)</summary>
 
 <br />
 
@@ -468,9 +351,26 @@ 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 3 methods.*
+* [`CreateSubmissionResponseBody`](./src/models/errors/createsubmissionresponsebody.ts): The server could not understand the request due to invalid syntax. Status code `400`. Applicable to 1 of 3 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 3 methods.*
+* [`CreateCommercialSubmissionResponseResponseBody`](./src/models/errors/createcommercialsubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`. Applicable to 1 of 3 methods.*
+* [`CreateSubmissionResponseResponseBody`](./src/models/errors/createsubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`. Applicable to 1 of 3 methods.*
+* [`CreatePersonalSubmissionResponseResponseBody`](./src/models/errors/createpersonalsubmissionresponseresponsebody.ts): Access is unauthorized. Status code `401`. Applicable to 1 of 3 methods.*
+* [`CreateCommercialSubmissionResponse403ResponseBody`](./src/models/errors/createcommercialsubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`. Applicable to 1 of 3 methods.*
+* [`CreateSubmissionResponse403ResponseBody`](./src/models/errors/createsubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`. Applicable to 1 of 3 methods.*
+* [`CreatePersonalSubmissionResponse403ResponseBody`](./src/models/errors/createpersonalsubmissionresponse403responsebody.ts): Access is forbidden. Status code `403`. Applicable to 1 of 3 methods.*
+* [`CreateCommercialSubmissionResponse404ResponseBody`](./src/models/errors/createcommercialsubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`. Applicable to 1 of 3 methods.*
+* [`CreateSubmissionResponse404ResponseBody`](./src/models/errors/createsubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`. Applicable to 1 of 3 methods.*
+* [`CreatePersonalSubmissionResponse404ResponseBody`](./src/models/errors/createpersonalsubmissionresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`. Applicable to 1 of 3 methods.*
+* [`CreateCommercialSubmissionResponse500ResponseBody`](./src/models/errors/createcommercialsubmissionresponse500responsebody.ts): Server error. Status code `500`. Applicable to 1 of 3 methods.*
+* [`CreateSubmissionResponse500ResponseBody`](./src/models/errors/createsubmissionresponse500responsebody.ts): Server error. Status code `500`. Applicable to 1 of 3 methods.*
+* [`CreatePersonalSubmissionResponse500ResponseBody`](./src/models/errors/createpersonalsubmissionresponse500responsebody.ts): Server error. Status code `500`. Applicable to 1 of 3 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] -->
@@ -483,41 +383,12 @@ The default server can be overridden globally by passing a URL to the `serverURL
 import { FinanceableLenders } from "@financeable/lenders";
 
 const financeableLenders = new FinanceableLenders({
-  serverURL: "https://aws.lenders.api.financeable.com.au/api/v2",
+  serverURL: "https://aws.lenders.api.financeable.com.au/api/v1",
 });
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
-    id: "<id>",
-    customers: [
-      {
-        id: "<id>",
-        customerTitle: "Miss",
-        firstName: "Cornelius",
-        lastName: "Renner",
-        idNumber: "<value>",
-        idCardNumber: "<value>",
-        idExpiryDate: "<value>",
-      },
-    ],
-    asset: {},
-    productDetails: {
-      productName: "<value>",
-      productType: "<value>",
-    },
-    lenderCredentials: {
-      pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://criminal-cosset.biz",
-      pepperClientId: "<id>",
-      pepperClientSecret: "<value>",
-      pepperUsername: "<value>",
-    },
-    humanId: "<id>",
-    loanDetails: {
-      deposit: 1321.8,
-      tradeIn: 5190.75,
-      payout: 8717.28,
-    },
+  const result = await financeableLenders.createCommercialSubmission({
+    lender: "Moneyplace",
   });
 
   console.log(result);