@financeable/lenders 0.1.1 → 0.2.0

package/FUNCTIONS.md

@@ -20,41 +20,31 @@ specific category of applications.
 
 ```typescript
 import { FinanceableLendersCore } from "@financeable/lenders/core.js";
-import { createPepperConsumer } from "@financeable/lenders/funcs/createPepperConsumer.js";
+import { consumersCreatePepper } from "@financeable/lenders/funcs/consumersCreatePepper.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 createPepperConsumer(financeableLenders, {
+  const res = await consumersCreatePepper(financeableLenders, {
     id: "<id>",
-    applicationType: "<value>",
-    user: {
-      email: {
-        status: "<value>",
-        address: "710 Richmond Close",
-      },
-    },
-    entities: [],
-    assets: [],
     customers: [
       {
         id: "<id>",
-        customerTitle: "<value>",
+        customerTitle: "Miss",
         firstName: "Cornelius",
         lastName: "Renner",
         idNumber: "<value>",
-        idExpiryDate: "<value>",
         idCardNumber: "<value>",
+        idExpiryDate: "<value>",
       },
     ],
-    loanDetails: {
-      deposit: 1321.8,
-      payout: 8717.28,
-      tradeIn: 5190.75,
+    asset: {},
+    productDetails: {
+      productName: "<value>",
+      productType: "<value>",
     },
-    notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
       pepperBaseUrl: "https://criminal-cosset.biz",
@@ -62,12 +52,18 @@ async function run() {
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
+    humanId: "<id>",
+    loanDetails: {
+      deposit: 1321.8,
+      tradeIn: 5190.75,
+      payout: 8717.28,
+    },
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("createPepperConsumer failed:", res.error);
+    console.log("consumersCreatePepper failed:", res.error);
   }
 }
 

package/README.md

@@ -172,34 +172,24 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.createPepperConsumer({
+  const result = await financeableLenders.consumers.createPepper({
     id: "<id>",
-    applicationType: "<value>",
-    user: {
-      email: {
-        status: "<value>",
-        address: "710 Richmond Close",
-      },
-    },
-    entities: [],
-    assets: [],
     customers: [
       {
         id: "<id>",
-        customerTitle: "<value>",
+        customerTitle: "Miss",
         firstName: "Cornelius",
         lastName: "Renner",
         idNumber: "<value>",
-        idExpiryDate: "<value>",
         idCardNumber: "<value>",
+        idExpiryDate: "<value>",
       },
     ],
-    loanDetails: {
-      deposit: 1321.8,
-      payout: 8717.28,
-      tradeIn: 5190.75,
+    asset: {},
+    productDetails: {
+      productName: "<value>",
+      productType: "<value>",
     },
-    notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
       pepperBaseUrl: "https://criminal-cosset.biz",
@@ -207,6 +197,12 @@ async function run() {
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
+    humanId: "<id>",
+    loanDetails: {
+      deposit: 1321.8,
+      tradeIn: 5190.75,
+      payout: 8717.28,
+    },
   });
 
   console.log(result);
@@ -223,9 +219,9 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [FinanceableLenders SDK](docs/sdks/financeablelenders/README.md)
+### [consumers](docs/sdks/consumers/README.md)
 
-* [createPepperConsumer](docs/sdks/financeablelenders/README.md#createpepperconsumer) - Pepper Consumer route
+* [createPepper](docs/sdks/consumers/README.md#createpepper) - Pepper Consumer route
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -245,7 +241,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`createPepperConsumer`](docs/sdks/financeablelenders/README.md#createpepperconsumer) - Pepper Consumer route
+- [`consumersCreatePepper`](docs/sdks/consumers/README.md#createpepper) - Pepper Consumer route
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -262,34 +258,24 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.createPepperConsumer({
+  const result = await financeableLenders.consumers.createPepper({
     id: "<id>",
-    applicationType: "<value>",
-    user: {
-      email: {
-        status: "<value>",
-        address: "710 Richmond Close",
-      },
-    },
-    entities: [],
-    assets: [],
     customers: [
       {
         id: "<id>",
-        customerTitle: "<value>",
+        customerTitle: "Miss",
         firstName: "Cornelius",
         lastName: "Renner",
         idNumber: "<value>",
-        idExpiryDate: "<value>",
         idCardNumber: "<value>",
+        idExpiryDate: "<value>",
       },
     ],
-    loanDetails: {
-      deposit: 1321.8,
-      payout: 8717.28,
-      tradeIn: 5190.75,
+    asset: {},
+    productDetails: {
+      productName: "<value>",
+      productType: "<value>",
     },
-    notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
       pepperBaseUrl: "https://criminal-cosset.biz",
@@ -297,6 +283,12 @@ async function run() {
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
+    humanId: "<id>",
+    loanDetails: {
+      deposit: 1321.8,
+      tradeIn: 5190.75,
+      payout: 8717.28,
+    },
   }, {
     retries: {
       strategy: "backoff",
@@ -335,34 +327,24 @@ const financeableLenders = new FinanceableLenders({
 });
 
 async function run() {
-  const result = await financeableLenders.createPepperConsumer({
+  const result = await financeableLenders.consumers.createPepper({
     id: "<id>",
-    applicationType: "<value>",
-    user: {
-      email: {
-        status: "<value>",
-        address: "710 Richmond Close",
-      },
-    },
-    entities: [],
-    assets: [],
     customers: [
       {
         id: "<id>",
-        customerTitle: "<value>",
+        customerTitle: "Miss",
         firstName: "Cornelius",
         lastName: "Renner",
         idNumber: "<value>",
-        idExpiryDate: "<value>",
         idCardNumber: "<value>",
+        idExpiryDate: "<value>",
       },
     ],
-    loanDetails: {
-      deposit: 1321.8,
-      payout: 8717.28,
-      tradeIn: 5190.75,
+    asset: {},
+    productDetails: {
+      productName: "<value>",
+      productType: "<value>",
     },
-    notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
       pepperBaseUrl: "https://criminal-cosset.biz",
@@ -370,6 +352,12 @@ async function run() {
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
+    humanId: "<id>",
+    loanDetails: {
+      deposit: 1321.8,
+      tradeIn: 5190.75,
+      payout: 8717.28,
+    },
   });
 
   console.log(result);
@@ -403,34 +391,24 @@ const financeableLenders = new FinanceableLenders();
 
 async function run() {
   try {
-    const result = await financeableLenders.createPepperConsumer({
+    const result = await financeableLenders.consumers.createPepper({
       id: "<id>",
-      applicationType: "<value>",
-      user: {
-        email: {
-          status: "<value>",
-          address: "710 Richmond Close",
-        },
-      },
-      entities: [],
-      assets: [],
       customers: [
         {
           id: "<id>",
-          customerTitle: "<value>",
+          customerTitle: "Miss",
           firstName: "Cornelius",
           lastName: "Renner",
           idNumber: "<value>",
-          idExpiryDate: "<value>",
           idCardNumber: "<value>",
+          idExpiryDate: "<value>",
         },
       ],
-      loanDetails: {
-        deposit: 1321.8,
-        payout: 8717.28,
-        tradeIn: 5190.75,
+      asset: {},
+      productDetails: {
+        productName: "<value>",
+        productType: "<value>",
       },
-      notes: "<value>",
       lenderCredentials: {
         pepperMerchantId: "<id>",
         pepperBaseUrl: "https://criminal-cosset.biz",
@@ -438,6 +416,12 @@ async function run() {
         pepperClientSecret: "<value>",
         pepperUsername: "<value>",
       },
+      humanId: "<id>",
+      loanDetails: {
+        deposit: 1321.8,
+        tradeIn: 5190.75,
+        payout: 8717.28,
+      },
     });
 
     console.log(result);
@@ -466,10 +450,10 @@ run();
 **Primary errors:**
 * [`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`.
-  * [`CreatePepperConsumerResponseResponseBody`](./src/models/errors/createpepperconsumerresponseresponsebody.ts): Access is unauthorized. Status code `401`.
-  * [`CreatePepperConsumerResponse403ResponseBody`](./src/models/errors/createpepperconsumerresponse403responsebody.ts): Access is forbidden. Status code `403`.
-  * [`CreatePepperConsumerResponse404ResponseBody`](./src/models/errors/createpepperconsumerresponse404responsebody.ts): The server cannot find the requested resource. Status code `404`.
-  * [`CreatePepperConsumerResponse500ResponseBody`](./src/models/errors/createpepperconsumerresponse500responsebody.ts): Server error. Status code `500`.
+  * [`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>
 
@@ -503,34 +487,24 @@ const financeableLenders = new FinanceableLenders({
 });
 
 async function run() {
-  const result = await financeableLenders.createPepperConsumer({
+  const result = await financeableLenders.consumers.createPepper({
     id: "<id>",
-    applicationType: "<value>",
-    user: {
-      email: {
-        status: "<value>",
-        address: "710 Richmond Close",
-      },
-    },
-    entities: [],
-    assets: [],
     customers: [
       {
         id: "<id>",
-        customerTitle: "<value>",
+        customerTitle: "Miss",
         firstName: "Cornelius",
         lastName: "Renner",
         idNumber: "<value>",
-        idExpiryDate: "<value>",
         idCardNumber: "<value>",
+        idExpiryDate: "<value>",
       },
     ],
-    loanDetails: {
-      deposit: 1321.8,
-      payout: 8717.28,
-      tradeIn: 5190.75,
+    asset: {},
+    productDetails: {
+      productName: "<value>",
+      productType: "<value>",
     },
-    notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
       pepperBaseUrl: "https://criminal-cosset.biz",
@@ -538,6 +512,12 @@ async function run() {
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
+    humanId: "<id>",
+    loanDetails: {
+      deposit: 1321.8,
+      tradeIn: 5190.75,
+      payout: 8717.28,
+    },
   });
 
   console.log(result);