@financeable/lenders 0.0.4 → 0.1.0

package/FUNCTIONS.md

@@ -21,7 +21,6 @@ specific category of applications.
 ```typescript
 import { FinanceableLendersCore } from "@financeable/lenders/core.js";
 import { consumersCreatePepper } from "@financeable/lenders/funcs/consumersCreatePepper.js";
-import { SDKValidationError } from "@financeable/lenders/models/errors/sdkvalidationerror.js";
 
 // Use `FinanceableLendersCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -34,64 +33,42 @@ async function run() {
     user: {
       email: {
         status: "<value>",
-        address: "3183 Hoppe Drives",
+        address: "710 Richmond Close",
       },
     },
-    entities: [
-  
-    ],
-    assets: [
-      {},
-      {},
-      {},
-    ],
+    entities: [],
+    assets: [],
     customers: [
       {
         id: "<id>",
         customerTitle: "<value>",
-        firstName: "Mikayla",
-        lastName: "White",
+        firstName: "Cornelius",
+        lastName: "Renner",
         idNumber: "<value>",
         idExpiryDate: "<value>",
         idCardNumber: "<value>",
       },
     ],
     loanDetails: {
-      deposit: 3638.13,
-      payout: 1234.78,
-      tradeIn: 7692.67,
+      deposit: 1321.8,
+      payout: 8717.28,
+      tradeIn: 5190.75,
     },
     notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://glaring-meatloaf.org",
+      pepperBaseUrl: "https://criminal-cosset.biz",
       pepperClientId: "<id>",
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
   });
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("consumersCreatePepper failed:", res.error);
   }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/README.md

@@ -181,42 +181,37 @@ async function run() {
     user: {
       email: {
         status: "<value>",
-        address: "3183 Hoppe Drives",
+        address: "710 Richmond Close",
       },
     },
     entities: [],
-    assets: [
-      {},
-      {},
-      {},
-    ],
+    assets: [],
     customers: [
       {
         id: "<id>",
         customerTitle: "<value>",
-        firstName: "Mikayla",
-        lastName: "White",
+        firstName: "Cornelius",
+        lastName: "Renner",
         idNumber: "<value>",
         idExpiryDate: "<value>",
         idCardNumber: "<value>",
       },
     ],
     loanDetails: {
-      deposit: 3638.13,
-      payout: 1234.78,
-      tradeIn: 7692.67,
+      deposit: 1321.8,
+      payout: 8717.28,
+      tradeIn: 5190.75,
     },
     notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://glaring-meatloaf.org",
+      pepperBaseUrl: "https://criminal-cosset.biz",
       pepperClientId: "<id>",
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -277,35 +272,31 @@ async function run() {
     user: {
       email: {
         status: "<value>",
-        address: "3183 Hoppe Drives",
+        address: "710 Richmond Close",
       },
     },
     entities: [],
-    assets: [
-      {},
-      {},
-      {},
-    ],
+    assets: [],
     customers: [
       {
         id: "<id>",
         customerTitle: "<value>",
-        firstName: "Mikayla",
-        lastName: "White",
+        firstName: "Cornelius",
+        lastName: "Renner",
         idNumber: "<value>",
         idExpiryDate: "<value>",
         idCardNumber: "<value>",
       },
     ],
     loanDetails: {
-      deposit: 3638.13,
-      payout: 1234.78,
-      tradeIn: 7692.67,
+      deposit: 1321.8,
+      payout: 8717.28,
+      tradeIn: 5190.75,
     },
     notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://glaring-meatloaf.org",
+      pepperBaseUrl: "https://criminal-cosset.biz",
       pepperClientId: "<id>",
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
@@ -323,7 +314,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -355,42 +345,37 @@ async function run() {
     user: {
       email: {
         status: "<value>",
-        address: "3183 Hoppe Drives",
+        address: "710 Richmond Close",
       },
     },
     entities: [],
-    assets: [
-      {},
-      {},
-      {},
-    ],
+    assets: [],
     customers: [
       {
         id: "<id>",
         customerTitle: "<value>",
-        firstName: "Mikayla",
-        lastName: "White",
+        firstName: "Cornelius",
+        lastName: "Renner",
         idNumber: "<value>",
         idExpiryDate: "<value>",
         idCardNumber: "<value>",
       },
     ],
     loanDetails: {
-      deposit: 3638.13,
-      payout: 1234.78,
-      tradeIn: 7692.67,
+      deposit: 1321.8,
+      payout: 8717.28,
+      tradeIn: 5190.75,
     },
     notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://glaring-meatloaf.org",
+      pepperBaseUrl: "https://criminal-cosset.biz",
       pepperClientId: "<id>",
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -402,118 +387,76 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `createPepper` method may throw the following errors:
+[`FinanceableLendersError`](./src/models/errors/financeablelenderserror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| Error Type                                                  | Status Code | Content Type     |
-| ----------------------------------------------------------- | ----------- | ---------------- |
-| errors.CreatePepperConsumerResponseBody                     | 400         | application/json |
-| errors.CreatePepperConsumerConsumersResponseBody            | 401         | application/json |
-| errors.CreatePepperConsumerConsumersResponseResponseBody    | 403         | application/json |
-| errors.CreatePepperConsumerConsumersResponse404ResponseBody | 404         | application/json |
-| errors.CreatePepperConsumerConsumersResponse500ResponseBody | 500         | application/json |
-| errors.APIError                                             | 4XX, 5XX    | \*/\*            |
-
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { FinanceableLenders } from "@financeable/lenders";
-import {
-  CreatePepperConsumerConsumersResponse404ResponseBody,
-  CreatePepperConsumerConsumersResponse500ResponseBody,
-  CreatePepperConsumerConsumersResponseBody,
-  CreatePepperConsumerConsumersResponseResponseBody,
-  CreatePepperConsumerResponseBody,
-  SDKValidationError,
-} from "@financeable/lenders/models/errors";
+import * as errors from "@financeable/lenders/models/errors";
 
 const financeableLenders = new FinanceableLenders();
 
 async function run() {
-  let result;
   try {
-    result = await financeableLenders.consumers.createPepper({
+    const result = await financeableLenders.consumers.createPepper({
       id: "<id>",
       applicationType: "<value>",
       user: {
         email: {
           status: "<value>",
-          address: "3183 Hoppe Drives",
+          address: "710 Richmond Close",
         },
       },
       entities: [],
-      assets: [
-        {},
-        {},
-        {},
-      ],
+      assets: [],
       customers: [
         {
           id: "<id>",
           customerTitle: "<value>",
-          firstName: "Mikayla",
-          lastName: "White",
+          firstName: "Cornelius",
+          lastName: "Renner",
           idNumber: "<value>",
           idExpiryDate: "<value>",
           idCardNumber: "<value>",
         },
       ],
       loanDetails: {
-        deposit: 3638.13,
-        payout: 1234.78,
-        tradeIn: 7692.67,
+        deposit: 1321.8,
+        payout: 8717.28,
+        tradeIn: 5190.75,
       },
       notes: "<value>",
       lenderCredentials: {
         pepperMerchantId: "<id>",
-        pepperBaseUrl: "https://glaring-meatloaf.org",
+        pepperBaseUrl: "https://criminal-cosset.biz",
         pepperClientId: "<id>",
         pepperClientSecret: "<value>",
         pepperUsername: "<value>",
       },
     });
 
-    // Handle the result
     console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof CreatePepperConsumerResponseBody): {
-        // Handle err.data$: CreatePepperConsumerResponseBodyData
-        console.error(err);
-        return;
-      }
-      case (err instanceof CreatePepperConsumerConsumersResponseBody): {
-        // Handle err.data$: CreatePepperConsumerConsumersResponseBodyData
-        console.error(err);
-        return;
-      }
-      case (err instanceof CreatePepperConsumerConsumersResponseResponseBody): {
-        // Handle err.data$: CreatePepperConsumerConsumersResponseResponseBodyData
-        console.error(err);
-        return;
-      }
-      case (err
-        instanceof CreatePepperConsumerConsumersResponse404ResponseBody): {
-        // Handle err.data$: CreatePepperConsumerConsumersResponse404ResponseBodyData
-        console.error(err);
-        return;
-      }
-      case (err
-        instanceof CreatePepperConsumerConsumersResponse500ResponseBody): {
-        // Handle err.data$: CreatePepperConsumerConsumersResponse500ResponseBodyData
-        console.error(err);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.FinanceableLendersError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.CreatePepperConsumerResponseBody) {
+        console.log(error.data$.lender); // components.Lenders
+        console.log(error.data$.errors); // ApiError[][]
       }
     }
   }
@@ -523,17 +466,31 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+### 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`.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+
+**Inherit from [`FinanceableLendersError`](./src/models/errors/financeablelenderserror.ts)**:
+* [`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>
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -556,42 +513,37 @@ async function run() {
     user: {
       email: {
         status: "<value>",
-        address: "3183 Hoppe Drives",
+        address: "710 Richmond Close",
       },
     },
     entities: [],
-    assets: [
-      {},
-      {},
-      {},
-    ],
+    assets: [],
     customers: [
       {
         id: "<id>",
         customerTitle: "<value>",
-        firstName: "Mikayla",
-        lastName: "White",
+        firstName: "Cornelius",
+        lastName: "Renner",
         idNumber: "<value>",
         idExpiryDate: "<value>",
         idCardNumber: "<value>",
       },
     ],
     loanDetails: {
-      deposit: 3638.13,
-      payout: 1234.78,
-      tradeIn: 7692.67,
+      deposit: 1321.8,
+      payout: 8717.28,
+      tradeIn: 5190.75,
     },
     notes: "<value>",
     lenderCredentials: {
       pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://glaring-meatloaf.org",
+      pepperBaseUrl: "https://criminal-cosset.biz",
       pepperClientId: "<id>",
       pepperClientSecret: "<value>",
       pepperUsername: "<value>",
     },
   });
 
-  // Handle the result
   console.log(result);
 }