@financeable/lenders 0.2.0 → 0.3.0

package/src/models/components/typeofchangeexpected.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of change expected enumeration
+ */
+export const TypeOfChangeExpected = {
+  EndOfEmploymentContractLossOfEmployment:
+    "End of employment contract/ loss of employment",
+  LeavingEmployment: "Leaving employment",
+  IncreasedDebtRepaymentForANewExistingLoan:
+    "Increased debt repayment for a new/ existing loan",
+  LargeExpenditure: "Large expenditure",
+  MedicalTreatmentIllness: "Medical treatment/ illness",
+  ExtendedUnpaidLeaveEGStudyOrParentalLeave:
+    "Extended unpaid leave (e.g. study or parental leave)",
+  ChangeToFamilySituation: "Change to family situation",
+  Retirement: "Retirement",
+  BuyingAHouse: "Buying a house",
+  No: "No",
+  Other: "Other",
+} as const;
+/**
+ * Type of change expected enumeration
+ */
+export type TypeOfChangeExpected = ClosedEnum<typeof TypeOfChangeExpected>;
+
+/** @internal */
+export const TypeOfChangeExpected$inboundSchema: z.ZodNativeEnum<
+  typeof TypeOfChangeExpected
+> = z.nativeEnum(TypeOfChangeExpected);
+
+/** @internal */
+export const TypeOfChangeExpected$outboundSchema: z.ZodNativeEnum<
+  typeof TypeOfChangeExpected
+> = TypeOfChangeExpected$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TypeOfChangeExpected$ {
+  /** @deprecated use `TypeOfChangeExpected$inboundSchema` instead. */
+  export const inboundSchema = TypeOfChangeExpected$inboundSchema;
+  /** @deprecated use `TypeOfChangeExpected$outboundSchema` instead. */
+  export const outboundSchema = TypeOfChangeExpected$outboundSchema;
+}

package/src/models/components/user.ts

@@ -0,0 +1,147 @@
+/*
+ * 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 {
+  Email,
+  Email$inboundSchema,
+  Email$Outbound,
+  Email$outboundSchema,
+} from "./email.js";
+
+export type Organisation = {
+  name?: string | undefined;
+};
+
+/**
+ * User model
+ */
+export type User = {
+  id?: string | undefined;
+  organisation?: Organisation | undefined;
+  /**
+   * Email model
+   */
+  email?: Email | undefined;
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+};
+
+/** @internal */
+export const Organisation$inboundSchema: z.ZodType<
+  Organisation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+});
+
+/** @internal */
+export type Organisation$Outbound = {
+  name?: string | undefined;
+};
+
+/** @internal */
+export const Organisation$outboundSchema: z.ZodType<
+  Organisation$Outbound,
+  z.ZodTypeDef,
+  Organisation
+> = z.object({
+  name: 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 Organisation$ {
+  /** @deprecated use `Organisation$inboundSchema` instead. */
+  export const inboundSchema = Organisation$inboundSchema;
+  /** @deprecated use `Organisation$outboundSchema` instead. */
+  export const outboundSchema = Organisation$outboundSchema;
+  /** @deprecated use `Organisation$Outbound` instead. */
+  export type Outbound = Organisation$Outbound;
+}
+
+export function organisationToJSON(organisation: Organisation): string {
+  return JSON.stringify(Organisation$outboundSchema.parse(organisation));
+}
+
+export function organisationFromJSON(
+  jsonString: string,
+): SafeParseResult<Organisation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Organisation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Organisation' from JSON`,
+  );
+}
+
+/** @internal */
+export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
+  .object({
+    _id: z.string().optional(),
+    organisation: z.lazy(() => Organisation$inboundSchema).optional(),
+    email: Email$inboundSchema.optional(),
+    firstName: z.string().optional(),
+    lastName: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "_id": "id",
+    });
+  });
+
+/** @internal */
+export type User$Outbound = {
+  _id?: string | undefined;
+  organisation?: Organisation$Outbound | undefined;
+  email?: Email$Outbound | undefined;
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+};
+
+/** @internal */
+export const User$outboundSchema: z.ZodType<User$Outbound, z.ZodTypeDef, User> =
+  z.object({
+    id: z.string().optional(),
+    organisation: z.lazy(() => Organisation$outboundSchema).optional(),
+    email: Email$outboundSchema.optional(),
+    firstName: z.string().optional(),
+    lastName: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      id: "_id",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace User$ {
+  /** @deprecated use `User$inboundSchema` instead. */
+  export const inboundSchema = User$inboundSchema;
+  /** @deprecated use `User$outboundSchema` instead. */
+  export const outboundSchema = User$outboundSchema;
+  /** @deprecated use `User$Outbound` instead. */
+  export type Outbound = User$Outbound;
+}
+
+export function userToJSON(user: User): string {
+  return JSON.stringify(User$outboundSchema.parse(user));
+}
+
+export function userFromJSON(
+  jsonString: string,
+): SafeParseResult<User, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => User$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'User' from JSON`,
+  );
+}

package/src/models/components/whatareyoulookingforinyourloan.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * What are you looking for in your loan enumeration
+ */
+export const WhatAreYouLookingForInYourLoan = {
+  CompetitiveInterestRate: "Competitive Interest Rate",
+  Service: "Service",
+  BrokerRecommendation: "Broker Recommendation",
+  ICanMakeAdditionalRepaymentsAtNoCost:
+    "I can make additional repayments at no cost",
+  ICanRepayTheLoanEarlyFeesAndChargesApply:
+    "I can repay the loan early (fees & charges apply)",
+  ABalloonRepayment: "A balloon repayment",
+} as const;
+/**
+ * What are you looking for in your loan enumeration
+ */
+export type WhatAreYouLookingForInYourLoan = ClosedEnum<
+  typeof WhatAreYouLookingForInYourLoan
+>;
+
+/** @internal */
+export const WhatAreYouLookingForInYourLoan$inboundSchema: z.ZodNativeEnum<
+  typeof WhatAreYouLookingForInYourLoan
+> = z.nativeEnum(WhatAreYouLookingForInYourLoan);
+
+/** @internal */
+export const WhatAreYouLookingForInYourLoan$outboundSchema: z.ZodNativeEnum<
+  typeof WhatAreYouLookingForInYourLoan
+> = WhatAreYouLookingForInYourLoan$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WhatAreYouLookingForInYourLoan$ {
+  /** @deprecated use `WhatAreYouLookingForInYourLoan$inboundSchema` instead. */
+  export const inboundSchema = WhatAreYouLookingForInYourLoan$inboundSchema;
+  /** @deprecated use `WhatAreYouLookingForInYourLoan$outboundSchema` instead. */
+  export const outboundSchema = WhatAreYouLookingForInYourLoan$outboundSchema;
+}

package/src/models/components/whatisthepurposeofthisapplication.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * What is the purpose of this application enumeration
+ */
+export const WhatIsThePurposeOfThisApplication = {
+  PurchaseTheAsset: "Purchase the asset",
+  PurchaseTheAssetPlusFinanceInsurances:
+    "Purchase the asset plus finance insurances",
+  NA: "n/a",
+  RefinanceLoanOnTheAsset: "Refinance loan on the asset",
+  RefinanceLoanOnTheAssetPlusFinanceInsurances:
+    "Refinance loan on the asset plus finance insurances",
+} as const;
+/**
+ * What is the purpose of this application enumeration
+ */
+export type WhatIsThePurposeOfThisApplication = ClosedEnum<
+  typeof WhatIsThePurposeOfThisApplication
+>;
+
+/** @internal */
+export const WhatIsThePurposeOfThisApplication$inboundSchema: z.ZodNativeEnum<
+  typeof WhatIsThePurposeOfThisApplication
+> = z.nativeEnum(WhatIsThePurposeOfThisApplication);
+
+/** @internal */
+export const WhatIsThePurposeOfThisApplication$outboundSchema: z.ZodNativeEnum<
+  typeof WhatIsThePurposeOfThisApplication
+> = WhatIsThePurposeOfThisApplication$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WhatIsThePurposeOfThisApplication$ {
+  /** @deprecated use `WhatIsThePurposeOfThisApplication$inboundSchema` instead. */
+  export const inboundSchema = WhatIsThePurposeOfThisApplication$inboundSchema;
+  /** @deprecated use `WhatIsThePurposeOfThisApplication$outboundSchema` instead. */
+  export const outboundSchema =
+    WhatIsThePurposeOfThisApplication$outboundSchema;
+}

package/src/models/components/whattodowithballoonpaymentattheendoftheloanterm.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * What to do with balloon payment at the end of the loan term enumeration
+ */
+export const WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm = {
+  Payout: "Payout",
+  RefinanceTheLoanPayout: "Refinance the loanPayout",
+  SellTheAsset: "Sell the asset",
+  TradeInForANewVehicle: "Trade in for a new vehicle",
+} as const;
+/**
+ * What to do with balloon payment at the end of the loan term enumeration
+ */
+export type WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm = ClosedEnum<
+  typeof WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm
+>;
+
+/** @internal */
+export const WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$inboundSchema:
+  z.ZodNativeEnum<typeof WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm> = z
+    .nativeEnum(WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm);
+
+/** @internal */
+export const WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$outboundSchema:
+  z.ZodNativeEnum<typeof WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm> =
+    WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$ {
+  /** @deprecated use `WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$inboundSchema` instead. */
+  export const inboundSchema =
+    WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$inboundSchema;
+  /** @deprecated use `WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$outboundSchema` instead. */
+  export const outboundSchema =
+    WhatToDoWithBalloonPaymentAtTheEndOfTheLoanTerm$outboundSchema;
+}

package/src/models/components/whydoesthisloantermsuityourrequirements.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Why does this loan term suit your requirements enumeration
+ */
+export const WhyDoesThisLoanTermSuitYourRequirements = {
+  WantTheMaximumAmountOfTimeWithTheMinimumRepayment:
+    "Want the maximum amount of time with the minimum repayment",
+  WantToBeAbleToPayOffTheLoanOverTheSelectedTermAsItSuitsMyBudget:
+    "Want to be able to pay off the loan over the selected term as it suits my budget",
+  IWantToPayOffTheLoanAsQuicklyAsPossibleAndAcknowledgeThatFeesAndChargesApplyForEarlyPayoutOfTheLoan:
+    "I want to pay off the loan as quickly as possible (and acknowledge that fees and charges apply for early payout of the loan)",
+  IWillBeLookingToSellTheCarTradeInAtTheEndOfTheLoanTerm:
+    "I will be looking to sell the car/ trade in at the end of the loan term",
+  Other: "Other",
+} as const;
+/**
+ * Why does this loan term suit your requirements enumeration
+ */
+export type WhyDoesThisLoanTermSuitYourRequirements = ClosedEnum<
+  typeof WhyDoesThisLoanTermSuitYourRequirements
+>;
+
+/** @internal */
+export const WhyDoesThisLoanTermSuitYourRequirements$inboundSchema:
+  z.ZodNativeEnum<typeof WhyDoesThisLoanTermSuitYourRequirements> = z
+    .nativeEnum(WhyDoesThisLoanTermSuitYourRequirements);
+
+/** @internal */
+export const WhyDoesThisLoanTermSuitYourRequirements$outboundSchema:
+  z.ZodNativeEnum<typeof WhyDoesThisLoanTermSuitYourRequirements> =
+    WhyDoesThisLoanTermSuitYourRequirements$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WhyDoesThisLoanTermSuitYourRequirements$ {
+  /** @deprecated use `WhyDoesThisLoanTermSuitYourRequirements$inboundSchema` instead. */
+  export const inboundSchema =
+    WhyDoesThisLoanTermSuitYourRequirements$inboundSchema;
+  /** @deprecated use `WhyDoesThisLoanTermSuitYourRequirements$outboundSchema` instead. */
+  export const outboundSchema =
+    WhyDoesThisLoanTermSuitYourRequirements$outboundSchema;
+}

package/src/models/components/yesorno.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Yes or No enumeration
+ */
+export const YesOrNo = {
+  Yes: "Yes",
+  No: "No",
+} as const;
+/**
+ * Yes or No enumeration
+ */
+export type YesOrNo = ClosedEnum<typeof YesOrNo>;
+
+/** @internal */
+export const YesOrNo$inboundSchema: z.ZodNativeEnum<typeof YesOrNo> = z
+  .nativeEnum(YesOrNo);
+
+/** @internal */
+export const YesOrNo$outboundSchema: z.ZodNativeEnum<typeof YesOrNo> =
+  YesOrNo$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace YesOrNo$ {
+  /** @deprecated use `YesOrNo$inboundSchema` instead. */
+  export const inboundSchema = YesOrNo$inboundSchema;
+  /** @deprecated use `YesOrNo$outboundSchema` instead. */
+  export const outboundSchema = YesOrNo$outboundSchema;
+}