@financeable/lenders 0.1.0 → 0.2.0

package/FUNCTIONS.md

@@ -29,32 +29,22 @@ const financeableLenders = new FinanceableLendersCore();
 async function run() {
   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,6 +52,12 @@ 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;

package/README.md

@@ -66,10 +66,7 @@ bun add @financeable/lenders
 ### Yarn
 
 ```bash
-yarn add @financeable/lenders zod
-
-# Note that Yarn does not install peer dependencies automatically. You will need
-# to install zod as shown above.
+yarn add @financeable/lenders
 ```
 
 > [!NOTE]
@@ -177,32 +174,22 @@ const financeableLenders = new FinanceableLenders();
 async function run() {
   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",
@@ -210,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);
@@ -230,7 +223,6 @@ run();
 
 * [createPepper](docs/sdks/consumers/README.md#createpepper) - Pepper Consumer route
 
-
 </details>
 <!-- End Available Resources and Operations [operations] -->
 
@@ -268,32 +260,22 @@ const financeableLenders = new FinanceableLenders();
 async function run() {
   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",
@@ -301,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",
@@ -341,32 +329,22 @@ const financeableLenders = new FinanceableLenders({
 async function run() {
   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",
@@ -374,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);
@@ -409,32 +393,22 @@ async function run() {
   try {
     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",
@@ -442,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);
@@ -469,11 +449,11 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`FinanceableLendersError`](./src/models/errors/financeablelenderserror.ts): The base class for HTTP error responses.
-  * [`CreatePepperConsumerResponseBody`](docs/models/errors/createpepperconsumerresponsebody.md): The server could not understand the request due to invalid syntax. Status code `400`.
-  * [`CreatePepperConsumerConsumersResponseBody`](docs/models/errors/createpepperconsumerconsumersresponsebody.md): Access is unauthorized. Status code `401`.
-  * [`CreatePepperConsumerConsumersResponseResponseBody`](docs/models/errors/createpepperconsumerconsumersresponseresponsebody.md): Access is forbidden. Status code `403`.
-  * [`CreatePepperConsumerConsumersResponse404ResponseBody`](docs/models/errors/createpepperconsumerconsumersresponse404responsebody.md): The server cannot find the requested resource. Status code `404`.
-  * [`CreatePepperConsumerConsumersResponse500ResponseBody`](docs/models/errors/createpepperconsumerconsumersresponse500responsebody.md): Server error. Status code `500`.
+  * [`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>
 
@@ -509,32 +489,22 @@ const financeableLenders = new FinanceableLenders({
 async function run() {
   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",
@@ -542,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);
@@ -597,7 +573,7 @@ httpClient.addHook("requestError", (error, request) => {
   console.groupEnd();
 });
 
-const sdk = new FinanceableLenders({ httpClient });
+const sdk = new FinanceableLenders({ httpClient: httpClient });
 ```
 <!-- End Custom HTTP Client [http-client] -->
 

package/RUNTIMES.md

@@ -2,9 +2,9 @@
 
 This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses 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 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
@@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:
 
 The following `tsconfig.json` options are recommended for projects using this
 SDK in order to get static type support for features like async iterables,
-streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
+streams and `fetch`-related APIs ([`for await...of`][for-await-of],
 [`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
 so on):
 
@@ -38,11 +38,11 @@ so on):
 {
   "compilerOptions": {
     "target": "es2020", // or higher
-    "lib": ["es2020", "dom", "dom.iterable"],
+    "lib": ["es2020", "dom", "dom.iterable"]
   }
 }
 ```
 
 While `target` can be set to older ECMAScript versions, it may result in extra,
 unnecessary compatibility code being generated if you are not targeting old
-runtimes.
+runtimes.