@financeable/lenders 0.1.1 → 0.3.0

package/examples/createPepperConsumer.example.ts

@@ -1,59 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import dotenv from "dotenv";
-dotenv.config();
-/**
- * Example usage of the @financeable/lenders SDK
- *
- * To run this example from the examples directory:
- * npm run build && npx tsx createPepperConsumer.example.ts
- */
-
-import { FinanceableLenders } from "@financeable/lenders";
-
-const financeableLenders = new FinanceableLenders();
-
-async function main() {
-  const result = await financeableLenders.createPepperConsumer({
-    id: "<id>",
-    applicationType: "<value>",
-    user: {
-      email: {
-        status: "<value>",
-        address: "710 Richmond Close",
-      },
-    },
-    entities: [],
-    assets: [],
-    customers: [
-      {
-        id: "<id>",
-        customerTitle: "<value>",
-        firstName: "Cornelius",
-        lastName: "Renner",
-        idNumber: "<value>",
-        idExpiryDate: "<value>",
-        idCardNumber: "<value>",
-      },
-    ],
-    loanDetails: {
-      deposit: 1321.8,
-      payout: 8717.28,
-      tradeIn: 5190.75,
-    },
-    notes: "<value>",
-    lenderCredentials: {
-      pepperMerchantId: "<id>",
-      pepperBaseUrl: "https://criminal-cosset.biz",
-      pepperClientId: "<id>",
-      pepperClientSecret: "<value>",
-      pepperUsername: "<value>",
-    },
-  });
-
-  console.log(result);
-}
-
-main().catch(console.error);

package/src/models/components/pepperconsumerasset.ts

@@ -1,172 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  Label,
-  Label$inboundSchema,
-  Label$Outbound,
-  Label$outboundSchema,
-} from "./label.js";
-
-/**
- * Pepper Consumer Asset
- */
-export type PepperConsumerAsset = {
-  ageOfAsset?: string | undefined;
-  ageOfAssetAtEnd?: string | undefined;
-  assetType?: string | undefined;
-  assetValue?: number | undefined;
-  averageKM?: string | undefined;
-  condition?: string | null | undefined;
-  description?: string | undefined;
-  /**
-   * Label object model
-   */
-  glassesMake?: Label | undefined;
-  /**
-   * Label object model
-   */
-  glassesModel?: Label | undefined;
-  glassesNVIC?: any | undefined;
-  /**
-   * Label object model
-   */
-  glassesVariant?: Label | undefined;
-  make?: string | undefined;
-  model?: string | undefined;
-  registrationNumber?: string | undefined;
-  registrationState?: string | undefined;
-  specifications?: any | undefined;
-  supplierABN?: string | undefined;
-  supplierAddress?: string | undefined;
-  supplierEmail?: string | undefined;
-  supplierName?: string | undefined;
-  supplierPhone?: string | undefined;
-  typeOfSale?: string | undefined;
-  vin?: string | undefined;
-};
-
-/** @internal */
-export const PepperConsumerAsset$inboundSchema: z.ZodType<
-  PepperConsumerAsset,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  ageOfAsset: z.string().optional(),
-  ageOfAssetAtEnd: z.string().optional(),
-  assetType: z.string().optional(),
-  assetValue: z.number().optional(),
-  averageKM: z.string().optional(),
-  condition: z.nullable(z.string()).optional(),
-  description: z.string().optional(),
-  glassesMake: Label$inboundSchema.optional(),
-  glassesModel: Label$inboundSchema.optional(),
-  glassesNVIC: z.any().optional(),
-  glassesVariant: Label$inboundSchema.optional(),
-  make: z.string().optional(),
-  model: z.string().optional(),
-  registrationNumber: z.string().optional(),
-  registrationState: z.string().optional(),
-  specifications: z.any().optional(),
-  supplierABN: z.string().optional(),
-  supplierAddress: z.string().optional(),
-  supplierEmail: z.string().optional(),
-  supplierName: z.string().optional(),
-  supplierPhone: z.string().optional(),
-  typeOfSale: z.string().optional(),
-  vin: z.string().optional(),
-});
-
-/** @internal */
-export type PepperConsumerAsset$Outbound = {
-  ageOfAsset?: string | undefined;
-  ageOfAssetAtEnd?: string | undefined;
-  assetType?: string | undefined;
-  assetValue?: number | undefined;
-  averageKM?: string | undefined;
-  condition?: string | null | undefined;
-  description?: string | undefined;
-  glassesMake?: Label$Outbound | undefined;
-  glassesModel?: Label$Outbound | undefined;
-  glassesNVIC?: any | undefined;
-  glassesVariant?: Label$Outbound | undefined;
-  make?: string | undefined;
-  model?: string | undefined;
-  registrationNumber?: string | undefined;
-  registrationState?: string | undefined;
-  specifications?: any | undefined;
-  supplierABN?: string | undefined;
-  supplierAddress?: string | undefined;
-  supplierEmail?: string | undefined;
-  supplierName?: string | undefined;
-  supplierPhone?: string | undefined;
-  typeOfSale?: string | undefined;
-  vin?: string | undefined;
-};
-
-/** @internal */
-export const PepperConsumerAsset$outboundSchema: z.ZodType<
-  PepperConsumerAsset$Outbound,
-  z.ZodTypeDef,
-  PepperConsumerAsset
-> = z.object({
-  ageOfAsset: z.string().optional(),
-  ageOfAssetAtEnd: z.string().optional(),
-  assetType: z.string().optional(),
-  assetValue: z.number().optional(),
-  averageKM: z.string().optional(),
-  condition: z.nullable(z.string()).optional(),
-  description: z.string().optional(),
-  glassesMake: Label$outboundSchema.optional(),
-  glassesModel: Label$outboundSchema.optional(),
-  glassesNVIC: z.any().optional(),
-  glassesVariant: Label$outboundSchema.optional(),
-  make: z.string().optional(),
-  model: z.string().optional(),
-  registrationNumber: z.string().optional(),
-  registrationState: z.string().optional(),
-  specifications: z.any().optional(),
-  supplierABN: z.string().optional(),
-  supplierAddress: z.string().optional(),
-  supplierEmail: z.string().optional(),
-  supplierName: z.string().optional(),
-  supplierPhone: z.string().optional(),
-  typeOfSale: z.string().optional(),
-  vin: z.string().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PepperConsumerAsset$ {
-  /** @deprecated use `PepperConsumerAsset$inboundSchema` instead. */
-  export const inboundSchema = PepperConsumerAsset$inboundSchema;
-  /** @deprecated use `PepperConsumerAsset$outboundSchema` instead. */
-  export const outboundSchema = PepperConsumerAsset$outboundSchema;
-  /** @deprecated use `PepperConsumerAsset$Outbound` instead. */
-  export type Outbound = PepperConsumerAsset$Outbound;
-}
-
-export function pepperConsumerAssetToJSON(
-  pepperConsumerAsset: PepperConsumerAsset,
-): string {
-  return JSON.stringify(
-    PepperConsumerAsset$outboundSchema.parse(pepperConsumerAsset),
-  );
-}
-
-export function pepperConsumerAssetFromJSON(
-  jsonString: string,
-): SafeParseResult<PepperConsumerAsset, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PepperConsumerAsset$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PepperConsumerAsset' from JSON`,
-  );
-}

package/src/models/components/pepperconsumercustomer.ts

@@ -1,273 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  Address,
-  Address$inboundSchema,
-  Address$Outbound,
-  Address$outboundSchema,
-} from "./address.js";
-import {
-  ApplicantAsset,
-  ApplicantAsset$inboundSchema,
-  ApplicantAsset$Outbound,
-  ApplicantAsset$outboundSchema,
-} from "./applicantasset.js";
-import {
-  Email,
-  Email$inboundSchema,
-  Email$Outbound,
-  Email$outboundSchema,
-} from "./email.js";
-import {
-  Employer,
-  Employer$inboundSchema,
-  Employer$Outbound,
-  Employer$outboundSchema,
-} from "./employer.js";
-import {
-  PepperConsumerCustomerProfile,
-  PepperConsumerCustomerProfile$inboundSchema,
-  PepperConsumerCustomerProfile$Outbound,
-  PepperConsumerCustomerProfile$outboundSchema,
-} from "./pepperconsumercustomerprofile.js";
-import {
-  PepperConsumerIncome,
-  PepperConsumerIncome$inboundSchema,
-  PepperConsumerIncome$Outbound,
-  PepperConsumerIncome$outboundSchema,
-} from "./pepperconsumerincome.js";
-import {
-  PepperConsumerLiability,
-  PepperConsumerLiability$inboundSchema,
-  PepperConsumerLiability$Outbound,
-  PepperConsumerLiability$outboundSchema,
-} from "./pepperconsumerliability.js";
-import {
-  PhoneNumber,
-  PhoneNumber$inboundSchema,
-  PhoneNumber$Outbound,
-  PhoneNumber$outboundSchema,
-} from "./phonenumber.js";
-
-export type CreditProfile = {
-  score?: number | undefined;
-};
-
-/**
- * Pepper Consumer Customer
- */
-export type PepperConsumerCustomer = {
-  id: string;
-  customerTitle: string;
-  creditProfile?: CreditProfile | undefined;
-  firstName: string;
-  middleNames?: string | undefined;
-  lastName: string;
-  dateOfBirth?: string | undefined;
-  documents?: any | undefined;
-  phoneNumbers?: Array<PhoneNumber> | undefined;
-  emails?: Array<Email> | undefined;
-  idNumber: string;
-  idExpiryDate: string;
-  idCardNumber: string;
-  /**
-   * Pepper Consumer Customer Profile
-   */
-  customerProfile?: PepperConsumerCustomerProfile | undefined;
-  addresses?: Array<Address> | undefined;
-  employers?: Array<Employer> | undefined;
-  expenses?: Array<any> | undefined;
-  liabilities?: Array<PepperConsumerLiability> | undefined;
-  income?: Array<PepperConsumerIncome> | undefined;
-  customerAssets?: Array<ApplicantAsset> | undefined;
-  customerDisclaimer?: any | undefined;
-  title?: string | undefined;
-};
-
-/** @internal */
-export const CreditProfile$inboundSchema: z.ZodType<
-  CreditProfile,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  score: z.number().int().optional(),
-});
-
-/** @internal */
-export type CreditProfile$Outbound = {
-  score?: number | undefined;
-};
-
-/** @internal */
-export const CreditProfile$outboundSchema: z.ZodType<
-  CreditProfile$Outbound,
-  z.ZodTypeDef,
-  CreditProfile
-> = z.object({
-  score: z.number().int().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CreditProfile$ {
-  /** @deprecated use `CreditProfile$inboundSchema` instead. */
-  export const inboundSchema = CreditProfile$inboundSchema;
-  /** @deprecated use `CreditProfile$outboundSchema` instead. */
-  export const outboundSchema = CreditProfile$outboundSchema;
-  /** @deprecated use `CreditProfile$Outbound` instead. */
-  export type Outbound = CreditProfile$Outbound;
-}
-
-export function creditProfileToJSON(creditProfile: CreditProfile): string {
-  return JSON.stringify(CreditProfile$outboundSchema.parse(creditProfile));
-}
-
-export function creditProfileFromJSON(
-  jsonString: string,
-): SafeParseResult<CreditProfile, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => CreditProfile$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreditProfile' from JSON`,
-  );
-}
-
-/** @internal */
-export const PepperConsumerCustomer$inboundSchema: z.ZodType<
-  PepperConsumerCustomer,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  _id: z.string(),
-  customerTitle: z.string(),
-  creditProfile: z.lazy(() => CreditProfile$inboundSchema).optional(),
-  firstName: z.string(),
-  middleNames: z.string().optional(),
-  lastName: z.string(),
-  dateOfBirth: z.string().optional(),
-  documents: z.any().optional(),
-  phoneNumbers: z.array(PhoneNumber$inboundSchema).optional(),
-  emails: z.array(Email$inboundSchema).optional(),
-  IDNumber: z.string(),
-  IDExpiryDate: z.string(),
-  IDCardNumber: z.string(),
-  customerProfile: PepperConsumerCustomerProfile$inboundSchema.optional(),
-  addresses: z.array(Address$inboundSchema).optional(),
-  employers: z.array(Employer$inboundSchema).optional(),
-  expenses: z.array(z.any()).optional(),
-  liabilities: z.array(PepperConsumerLiability$inboundSchema).optional(),
-  income: z.array(PepperConsumerIncome$inboundSchema).optional(),
-  customerAssets: z.array(ApplicantAsset$inboundSchema).optional(),
-  customerDisclaimer: z.any().optional(),
-  title: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "_id": "id",
-    "IDNumber": "idNumber",
-    "IDExpiryDate": "idExpiryDate",
-    "IDCardNumber": "idCardNumber",
-  });
-});
-
-/** @internal */
-export type PepperConsumerCustomer$Outbound = {
-  _id: string;
-  customerTitle: string;
-  creditProfile?: CreditProfile$Outbound | undefined;
-  firstName: string;
-  middleNames?: string | undefined;
-  lastName: string;
-  dateOfBirth?: string | undefined;
-  documents?: any | undefined;
-  phoneNumbers?: Array<PhoneNumber$Outbound> | undefined;
-  emails?: Array<Email$Outbound> | undefined;
-  IDNumber: string;
-  IDExpiryDate: string;
-  IDCardNumber: string;
-  customerProfile?: PepperConsumerCustomerProfile$Outbound | undefined;
-  addresses?: Array<Address$Outbound> | undefined;
-  employers?: Array<Employer$Outbound> | undefined;
-  expenses?: Array<any> | undefined;
-  liabilities?: Array<PepperConsumerLiability$Outbound> | undefined;
-  income?: Array<PepperConsumerIncome$Outbound> | undefined;
-  customerAssets?: Array<ApplicantAsset$Outbound> | undefined;
-  customerDisclaimer?: any | undefined;
-  title?: string | undefined;
-};
-
-/** @internal */
-export const PepperConsumerCustomer$outboundSchema: z.ZodType<
-  PepperConsumerCustomer$Outbound,
-  z.ZodTypeDef,
-  PepperConsumerCustomer
-> = z.object({
-  id: z.string(),
-  customerTitle: z.string(),
-  creditProfile: z.lazy(() => CreditProfile$outboundSchema).optional(),
-  firstName: z.string(),
-  middleNames: z.string().optional(),
-  lastName: z.string(),
-  dateOfBirth: z.string().optional(),
-  documents: z.any().optional(),
-  phoneNumbers: z.array(PhoneNumber$outboundSchema).optional(),
-  emails: z.array(Email$outboundSchema).optional(),
-  idNumber: z.string(),
-  idExpiryDate: z.string(),
-  idCardNumber: z.string(),
-  customerProfile: PepperConsumerCustomerProfile$outboundSchema.optional(),
-  addresses: z.array(Address$outboundSchema).optional(),
-  employers: z.array(Employer$outboundSchema).optional(),
-  expenses: z.array(z.any()).optional(),
-  liabilities: z.array(PepperConsumerLiability$outboundSchema).optional(),
-  income: z.array(PepperConsumerIncome$outboundSchema).optional(),
-  customerAssets: z.array(ApplicantAsset$outboundSchema).optional(),
-  customerDisclaimer: z.any().optional(),
-  title: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    id: "_id",
-    idNumber: "IDNumber",
-    idExpiryDate: "IDExpiryDate",
-    idCardNumber: "IDCardNumber",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PepperConsumerCustomer$ {
-  /** @deprecated use `PepperConsumerCustomer$inboundSchema` instead. */
-  export const inboundSchema = PepperConsumerCustomer$inboundSchema;
-  /** @deprecated use `PepperConsumerCustomer$outboundSchema` instead. */
-  export const outboundSchema = PepperConsumerCustomer$outboundSchema;
-  /** @deprecated use `PepperConsumerCustomer$Outbound` instead. */
-  export type Outbound = PepperConsumerCustomer$Outbound;
-}
-
-export function pepperConsumerCustomerToJSON(
-  pepperConsumerCustomer: PepperConsumerCustomer,
-): string {
-  return JSON.stringify(
-    PepperConsumerCustomer$outboundSchema.parse(pepperConsumerCustomer),
-  );
-}
-
-export function pepperConsumerCustomerFromJSON(
-  jsonString: string,
-): SafeParseResult<PepperConsumerCustomer, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PepperConsumerCustomer$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PepperConsumerCustomer' from JSON`,
-  );
-}

package/src/models/components/pepperconsumercustomerprofile.ts

@@ -1,91 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-/**
- * Pepper Consumer Customer Profile
- */
-export type PepperConsumerCustomerProfile = {
-  maritalStatus?: string | undefined;
-  numberOfDependants?: number | undefined;
-  residencyStatus?: string | undefined;
-  livingArrangements?: string | undefined;
-  contactNumber?: string | undefined;
-  rentAmount?: string | undefined;
-};
-
-/** @internal */
-export const PepperConsumerCustomerProfile$inboundSchema: z.ZodType<
-  PepperConsumerCustomerProfile,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  maritalStatus: z.string().optional(),
-  numberOfDependants: z.number().int().optional(),
-  residencyStatus: z.string().optional(),
-  livingArrangements: z.string().optional(),
-  contactNumber: z.string().optional(),
-  rentAmount: z.string().optional(),
-});
-
-/** @internal */
-export type PepperConsumerCustomerProfile$Outbound = {
-  maritalStatus?: string | undefined;
-  numberOfDependants?: number | undefined;
-  residencyStatus?: string | undefined;
-  livingArrangements?: string | undefined;
-  contactNumber?: string | undefined;
-  rentAmount?: string | undefined;
-};
-
-/** @internal */
-export const PepperConsumerCustomerProfile$outboundSchema: z.ZodType<
-  PepperConsumerCustomerProfile$Outbound,
-  z.ZodTypeDef,
-  PepperConsumerCustomerProfile
-> = z.object({
-  maritalStatus: z.string().optional(),
-  numberOfDependants: z.number().int().optional(),
-  residencyStatus: z.string().optional(),
-  livingArrangements: z.string().optional(),
-  contactNumber: z.string().optional(),
-  rentAmount: z.string().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PepperConsumerCustomerProfile$ {
-  /** @deprecated use `PepperConsumerCustomerProfile$inboundSchema` instead. */
-  export const inboundSchema = PepperConsumerCustomerProfile$inboundSchema;
-  /** @deprecated use `PepperConsumerCustomerProfile$outboundSchema` instead. */
-  export const outboundSchema = PepperConsumerCustomerProfile$outboundSchema;
-  /** @deprecated use `PepperConsumerCustomerProfile$Outbound` instead. */
-  export type Outbound = PepperConsumerCustomerProfile$Outbound;
-}
-
-export function pepperConsumerCustomerProfileToJSON(
-  pepperConsumerCustomerProfile: PepperConsumerCustomerProfile,
-): string {
-  return JSON.stringify(
-    PepperConsumerCustomerProfile$outboundSchema.parse(
-      pepperConsumerCustomerProfile,
-    ),
-  );
-}
-
-export function pepperConsumerCustomerProfileFromJSON(
-  jsonString: string,
-): SafeParseResult<PepperConsumerCustomerProfile, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PepperConsumerCustomerProfile$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PepperConsumerCustomerProfile' from JSON`,
-  );
-}