@financeable/lenders 0.1.0 → 0.1.1

package/FUNCTIONS.md

@@ -20,14 +20,14 @@ specific category of applications.
 
 ```typescript
 import { FinanceableLendersCore } from "@financeable/lenders/core.js";
-import { consumersCreatePepper } from "@financeable/lenders/funcs/consumersCreatePepper.js";
+import { createPepperConsumer } from "@financeable/lenders/funcs/createPepperConsumer.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, {
+  const res = await createPepperConsumer(financeableLenders, {
     id: "<id>",
     applicationType: "<value>",
     user: {
@@ -67,7 +67,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("consumersCreatePepper failed:", res.error);
+    console.log("createPepperConsumer failed:", res.error);
   }
 }
 

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]
@@ -175,7 +172,7 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
+  const result = await financeableLenders.createPepperConsumer({
     id: "<id>",
     applicationType: "<value>",
     user: {
@@ -226,10 +223,9 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [consumers](docs/sdks/consumers/README.md)
-
-* [createPepper](docs/sdks/consumers/README.md#createpepper) - Pepper Consumer route
+### [FinanceableLenders SDK](docs/sdks/financeablelenders/README.md)
 
+* [createPepperConsumer](docs/sdks/financeablelenders/README.md#createpepperconsumer) - Pepper Consumer route
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -249,7 +245,7 @@ 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
+- [`createPepperConsumer`](docs/sdks/financeablelenders/README.md#createpepperconsumer) - Pepper Consumer route
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -266,7 +262,7 @@ import { FinanceableLenders } from "@financeable/lenders";
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
+  const result = await financeableLenders.createPepperConsumer({
     id: "<id>",
     applicationType: "<value>",
     user: {
@@ -339,7 +335,7 @@ const financeableLenders = new FinanceableLenders({
 });
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
+  const result = await financeableLenders.createPepperConsumer({
     id: "<id>",
     applicationType: "<value>",
     user: {
@@ -407,7 +403,7 @@ const financeableLenders = new FinanceableLenders();
 
 async function run() {
   try {
-    const result = await financeableLenders.consumers.createPepper({
+    const result = await financeableLenders.createPepperConsumer({
       id: "<id>",
       applicationType: "<value>",
       user: {
@@ -469,11 +465,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`.
+  * [`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`.
 
 <details><summary>Less common errors (6)</summary>
 
@@ -507,7 +503,7 @@ const financeableLenders = new FinanceableLenders({
 });
 
 async function run() {
-  const result = await financeableLenders.consumers.createPepper({
+  const result = await financeableLenders.createPepperConsumer({
     id: "<id>",
     applicationType: "<value>",
     user: {
@@ -597,7 +593,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.