@financeable/lenders 0.1.1 → 0.3.0

package/src/models/components/customer.ts

@@ -0,0 +1,307 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  CreditProfile,
+  CreditProfile$inboundSchema,
+  CreditProfile$Outbound,
+  CreditProfile$outboundSchema,
+} from "./creditprofile.js";
+import {
+  CustomerDisclaimer,
+  CustomerDisclaimer$inboundSchema,
+  CustomerDisclaimer$Outbound,
+  CustomerDisclaimer$outboundSchema,
+} from "./customerdisclaimer.js";
+import {
+  CustomerProfile,
+  CustomerProfile$inboundSchema,
+  CustomerProfile$Outbound,
+  CustomerProfile$outboundSchema,
+} from "./customerprofile.js";
+import {
+  CustomerTitle,
+  CustomerTitle$inboundSchema,
+  CustomerTitle$outboundSchema,
+} from "./customertitle.js";
+import {
+  Document,
+  Document$inboundSchema,
+  Document$Outbound,
+  Document$outboundSchema,
+} from "./document.js";
+import {
+  Email,
+  Email$inboundSchema,
+  Email$Outbound,
+  Email$outboundSchema,
+} from "./email.js";
+import {
+  Employer,
+  Employer$inboundSchema,
+  Employer$Outbound,
+  Employer$outboundSchema,
+} from "./employer.js";
+import {
+  Expense,
+  Expense$inboundSchema,
+  Expense$Outbound,
+  Expense$outboundSchema,
+} from "./expense.js";
+import {
+  IDState,
+  IDState$inboundSchema,
+  IDState$outboundSchema,
+} from "./idstate.js";
+import {
+  IDType,
+  IDType$inboundSchema,
+  IDType$outboundSchema,
+} from "./idtype.js";
+import {
+  Income,
+  Income$inboundSchema,
+  Income$Outbound,
+  Income$outboundSchema,
+} from "./income.js";
+import {
+  Liability,
+  Liability$inboundSchema,
+  Liability$Outbound,
+  Liability$outboundSchema,
+} from "./liability.js";
+import {
+  PhoneNumber,
+  PhoneNumber$inboundSchema,
+  PhoneNumber$Outbound,
+  PhoneNumber$outboundSchema,
+} from "./phonenumber.js";
+
+/**
+ * Base customer model
+ */
+export type Customer = {
+  id?: string | undefined;
+  /**
+   * Customer title enumeration
+   */
+  customerTitle?: CustomerTitle | undefined;
+  firstName?: string | undefined;
+  middleNames?: string | undefined;
+  lastName?: string | undefined;
+  dateOfBirth?: string | undefined;
+  idNumber?: string | undefined;
+  idCardNumber?: string | undefined;
+  /**
+   * ID type enumeration
+   */
+  idType?: IDType | undefined;
+  idExpiryDate?: string | undefined;
+  /**
+   * ID state enumeration
+   */
+  idState?: IDState | undefined;
+  idCountry?: string | undefined;
+  licenceState?: string | undefined;
+  applicantType?: string | undefined;
+  isCustomerDetailsSaved?: boolean | undefined;
+  isDetailsLinkSend?: boolean | undefined;
+  /**
+   * Customer profile model
+   */
+  customerProfile?: CustomerProfile | undefined;
+  addresses?: Array<Address> | undefined;
+  emails?: Array<Email> | undefined;
+  phoneNumbers?: Array<PhoneNumber> | undefined;
+  customerAssets?: Array<ApplicantAsset> | undefined;
+  liabilities?: Array<Liability> | undefined;
+  applications?: Array<string> | undefined;
+  entities?: Array<string> | undefined;
+  employers?: Array<Employer> | undefined;
+  income?: Array<Income> | undefined;
+  expenses?: Array<Expense> | undefined;
+  documents?: Array<Document> | undefined;
+  /**
+   * Customer disclaimer model
+   */
+  customerDisclaimer?: CustomerDisclaimer | undefined;
+  /**
+   * Credit profile model
+   */
+  creditProfile?: CreditProfile | undefined;
+};
+
+/** @internal */
+export const Customer$inboundSchema: z.ZodType<
+  Customer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  customerTitle: CustomerTitle$inboundSchema.optional(),
+  firstName: z.string().optional(),
+  middleNames: z.string().optional(),
+  lastName: z.string().optional(),
+  dateOfBirth: z.string().optional(),
+  IDNumber: z.string().optional(),
+  IDCardNumber: z.string().optional(),
+  IDType: IDType$inboundSchema.optional(),
+  IDExpiryDate: z.string().optional(),
+  IDState: IDState$inboundSchema.optional(),
+  IDCountry: z.string().optional(),
+  licenceState: z.string().optional(),
+  applicantType: z.string().optional(),
+  isCustomerDetailsSaved: z.boolean().optional(),
+  isDetailsLinkSend: z.boolean().optional(),
+  customerProfile: CustomerProfile$inboundSchema.optional(),
+  addresses: z.array(Address$inboundSchema).optional(),
+  emails: z.array(Email$inboundSchema).optional(),
+  phoneNumbers: z.array(PhoneNumber$inboundSchema).optional(),
+  customerAssets: z.array(ApplicantAsset$inboundSchema).optional(),
+  liabilities: z.array(Liability$inboundSchema).optional(),
+  applications: z.array(z.string()).optional(),
+  entities: z.array(z.string()).optional(),
+  employers: z.array(Employer$inboundSchema).optional(),
+  income: z.array(Income$inboundSchema).optional(),
+  expenses: z.array(Expense$inboundSchema).optional(),
+  documents: z.array(Document$inboundSchema).optional(),
+  customerDisclaimer: CustomerDisclaimer$inboundSchema.optional(),
+  creditProfile: CreditProfile$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "IDNumber": "idNumber",
+    "IDCardNumber": "idCardNumber",
+    "IDType": "idType",
+    "IDExpiryDate": "idExpiryDate",
+    "IDState": "idState",
+    "IDCountry": "idCountry",
+  });
+});
+
+/** @internal */
+export type Customer$Outbound = {
+  _id?: string | undefined;
+  customerTitle?: string | undefined;
+  firstName?: string | undefined;
+  middleNames?: string | undefined;
+  lastName?: string | undefined;
+  dateOfBirth?: string | undefined;
+  IDNumber?: string | undefined;
+  IDCardNumber?: string | undefined;
+  IDType?: string | undefined;
+  IDExpiryDate?: string | undefined;
+  IDState?: string | undefined;
+  IDCountry?: string | undefined;
+  licenceState?: string | undefined;
+  applicantType?: string | undefined;
+  isCustomerDetailsSaved?: boolean | undefined;
+  isDetailsLinkSend?: boolean | undefined;
+  customerProfile?: CustomerProfile$Outbound | undefined;
+  addresses?: Array<Address$Outbound> | undefined;
+  emails?: Array<Email$Outbound> | undefined;
+  phoneNumbers?: Array<PhoneNumber$Outbound> | undefined;
+  customerAssets?: Array<ApplicantAsset$Outbound> | undefined;
+  liabilities?: Array<Liability$Outbound> | undefined;
+  applications?: Array<string> | undefined;
+  entities?: Array<string> | undefined;
+  employers?: Array<Employer$Outbound> | undefined;
+  income?: Array<Income$Outbound> | undefined;
+  expenses?: Array<Expense$Outbound> | undefined;
+  documents?: Array<Document$Outbound> | undefined;
+  customerDisclaimer?: CustomerDisclaimer$Outbound | undefined;
+  creditProfile?: CreditProfile$Outbound | undefined;
+};
+
+/** @internal */
+export const Customer$outboundSchema: z.ZodType<
+  Customer$Outbound,
+  z.ZodTypeDef,
+  Customer
+> = z.object({
+  id: z.string().optional(),
+  customerTitle: CustomerTitle$outboundSchema.optional(),
+  firstName: z.string().optional(),
+  middleNames: z.string().optional(),
+  lastName: z.string().optional(),
+  dateOfBirth: z.string().optional(),
+  idNumber: z.string().optional(),
+  idCardNumber: z.string().optional(),
+  idType: IDType$outboundSchema.optional(),
+  idExpiryDate: z.string().optional(),
+  idState: IDState$outboundSchema.optional(),
+  idCountry: z.string().optional(),
+  licenceState: z.string().optional(),
+  applicantType: z.string().optional(),
+  isCustomerDetailsSaved: z.boolean().optional(),
+  isDetailsLinkSend: z.boolean().optional(),
+  customerProfile: CustomerProfile$outboundSchema.optional(),
+  addresses: z.array(Address$outboundSchema).optional(),
+  emails: z.array(Email$outboundSchema).optional(),
+  phoneNumbers: z.array(PhoneNumber$outboundSchema).optional(),
+  customerAssets: z.array(ApplicantAsset$outboundSchema).optional(),
+  liabilities: z.array(Liability$outboundSchema).optional(),
+  applications: z.array(z.string()).optional(),
+  entities: z.array(z.string()).optional(),
+  employers: z.array(Employer$outboundSchema).optional(),
+  income: z.array(Income$outboundSchema).optional(),
+  expenses: z.array(Expense$outboundSchema).optional(),
+  documents: z.array(Document$outboundSchema).optional(),
+  customerDisclaimer: CustomerDisclaimer$outboundSchema.optional(),
+  creditProfile: CreditProfile$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    idNumber: "IDNumber",
+    idCardNumber: "IDCardNumber",
+    idType: "IDType",
+    idExpiryDate: "IDExpiryDate",
+    idState: "IDState",
+    idCountry: "IDCountry",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Customer$ {
+  /** @deprecated use `Customer$inboundSchema` instead. */
+  export const inboundSchema = Customer$inboundSchema;
+  /** @deprecated use `Customer$outboundSchema` instead. */
+  export const outboundSchema = Customer$outboundSchema;
+  /** @deprecated use `Customer$Outbound` instead. */
+  export type Outbound = Customer$Outbound;
+}
+
+export function customerToJSON(customer: Customer): string {
+  return JSON.stringify(Customer$outboundSchema.parse(customer));
+}
+
+export function customerFromJSON(
+  jsonString: string,
+): SafeParseResult<Customer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Customer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Customer' from JSON`,
+  );
+}

package/src/models/components/customerassettypes.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Customer asset types enumeration
+ */
+export const CustomerAssetTypes = {
+  ResidentialPropertyOccupying: "Residential property (occupying)",
+  CashSavings: "Cash (savings)",
+  InvestmentProperty: "Investment Property",
+  Superannuation: "Superannuation",
+  MotorVehicle: "Motor vehicle",
+  MotorBike: "Motor Bike",
+  CommercialProperty: "Commercial property",
+  InvestmentShares: "Investment (shares)",
+  Other: "Other",
+} as const;
+/**
+ * Customer asset types enumeration
+ */
+export type CustomerAssetTypes = ClosedEnum<typeof CustomerAssetTypes>;
+
+/** @internal */
+export const CustomerAssetTypes$inboundSchema: z.ZodNativeEnum<
+  typeof CustomerAssetTypes
+> = z.nativeEnum(CustomerAssetTypes);
+
+/** @internal */
+export const CustomerAssetTypes$outboundSchema: z.ZodNativeEnum<
+  typeof CustomerAssetTypes
+> = CustomerAssetTypes$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerAssetTypes$ {
+  /** @deprecated use `CustomerAssetTypes$inboundSchema` instead. */
+  export const inboundSchema = CustomerAssetTypes$inboundSchema;
+  /** @deprecated use `CustomerAssetTypes$outboundSchema` instead. */
+  export const outboundSchema = CustomerAssetTypes$outboundSchema;
+}