@financeable/aggregation 0.14.0 → 0.15.0

package/src/models/components/loandetailsattributes.ts

@@ -6,6 +6,11 @@ import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BusinessLoanPurpose,
+  BusinessLoanPurpose$inboundSchema,
+  BusinessLoanPurpose$outboundSchema,
+} from "./businessloanpurpose.js";
 import {
   FrequencyType,
   FrequencyType$inboundSchema,
@@ -23,6 +28,11 @@ import {
   PercentageQuantity$Outbound,
   PercentageQuantity$outboundSchema,
 } from "./percentagequantity.js";
+import {
+  PersonalLoanPurpose,
+  PersonalLoanPurpose$inboundSchema,
+  PersonalLoanPurpose$outboundSchema,
+} from "./personalloanpurpose.js";
 import {
   RepaymentStructure,
   RepaymentStructure$inboundSchema,
@@ -40,7 +50,12 @@ export type Repayments = MonetaryQuantity | string;
 export type LoanAmount = MonetaryQuantity | string;
 
 /**
- * Brokerage quantity as either BrokerageQuantity model (preferred) or floating point dollars as string. The latter will be deprecated. Only applicable to commercialSecured loans.
+ * Loan purpose must correspond to application type. For Personal loans, use PersonalLoanPurpose. For Business loans, use BusinessLoanPurpose. For ConsumerSecured and CommercialSecured, any string can be provided.
+ */
+export type Purpose = PersonalLoanPurpose | BusinessLoanPurpose | string;
+
+/**
+ * Applicable for Commercial Secured Loans Only. Brokerage quantity as either MonetaryQuantity or PercentageQuantity model. For all other loan types, use 'commission' instead.
  */
 export type Brokerage = MonetaryQuantity | PercentageQuantity | string;
 
@@ -105,15 +120,15 @@ export type LoanDetailsAttributes = {
    */
   requestedLoanAmount?: MonetaryQuantity | undefined;
   /**
-   * Loan purpose
+   * Loan purpose must correspond to application type. For Personal loans, use PersonalLoanPurpose. For Business loans, use BusinessLoanPurpose. For ConsumerSecured and CommercialSecured, any string can be provided.
    */
-  purpose?: string | undefined;
+  purpose?: PersonalLoanPurpose | BusinessLoanPurpose | string | undefined;
   /**
    * Loan term in integer months
    */
   term?: number | undefined;
   /**
-   * Brokerage quantity as either BrokerageQuantity model (preferred) or floating point dollars as string. The latter will be deprecated. Only applicable to commercialSecured loans.
+   * Applicable for Commercial Secured Loans Only. Brokerage quantity as either MonetaryQuantity or PercentageQuantity model. For all other loan types, use 'commission' instead.
    */
   brokerage?: MonetaryQuantity | PercentageQuantity | string | undefined;
   /**
@@ -145,7 +160,7 @@ export type LoanDetailsAttributes = {
    */
   originationFee?: MonetaryQuantity | number | undefined;
   /**
-   * Commission amount as MonetaryQuantity.
+   * Applicable to Consumer Secured, Personal & Business loans. Commission amount (paid from lender to aggregator/broker) as MonetaryQuantity. See `brokerage` for Commercial Secured loans.
    */
   commission?: MonetaryQuantity | undefined;
   /**
@@ -220,6 +235,40 @@ export function loanAmountFromJSON(
   );
 }
 
+/** @internal */
+export const Purpose$inboundSchema: z.ZodType<Purpose, z.ZodTypeDef, unknown> =
+  z.union([
+    PersonalLoanPurpose$inboundSchema,
+    BusinessLoanPurpose$inboundSchema,
+    z.string(),
+  ]);
+/** @internal */
+export type Purpose$Outbound = string | string | string;
+
+/** @internal */
+export const Purpose$outboundSchema: z.ZodType<
+  Purpose$Outbound,
+  z.ZodTypeDef,
+  Purpose
+> = z.union([
+  PersonalLoanPurpose$outboundSchema,
+  BusinessLoanPurpose$outboundSchema,
+  z.string(),
+]);
+
+export function purposeToJSON(purpose: Purpose): string {
+  return JSON.stringify(Purpose$outboundSchema.parse(purpose));
+}
+export function purposeFromJSON(
+  jsonString: string,
+): SafeParseResult<Purpose, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Purpose$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Purpose' from JSON`,
+  );
+}
+
 /** @internal */
 export const Brokerage$inboundSchema: z.ZodType<
   Brokerage,
@@ -468,7 +517,11 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
   repaymentStructure: RepaymentStructure$inboundSchema.optional(),
   loanAmount: z.union([MonetaryQuantity$inboundSchema, z.string()]).optional(),
   requestedLoanAmount: MonetaryQuantity$inboundSchema.optional(),
-  purpose: z.string().optional(),
+  purpose: z.union([
+    PersonalLoanPurpose$inboundSchema,
+    BusinessLoanPurpose$inboundSchema,
+    z.string(),
+  ]).optional(),
   term: z.number().int().optional(),
   brokerage: z.union([
     MonetaryQuantity$inboundSchema,
@@ -500,7 +553,7 @@ export type LoanDetailsAttributes$Outbound = {
   repaymentStructure?: string | undefined;
   loanAmount?: MonetaryQuantity$Outbound | string | undefined;
   requestedLoanAmount?: MonetaryQuantity$Outbound | undefined;
-  purpose?: string | undefined;
+  purpose?: string | string | string | undefined;
   term?: number | undefined;
   brokerage?:
     | MonetaryQuantity$Outbound
@@ -535,7 +588,11 @@ export const LoanDetailsAttributes$outboundSchema: z.ZodType<
   repaymentStructure: RepaymentStructure$outboundSchema.optional(),
   loanAmount: z.union([MonetaryQuantity$outboundSchema, z.string()]).optional(),
   requestedLoanAmount: MonetaryQuantity$outboundSchema.optional(),
-  purpose: z.string().optional(),
+  purpose: z.union([
+    PersonalLoanPurpose$outboundSchema,
+    BusinessLoanPurpose$outboundSchema,
+    z.string(),
+  ]).optional(),
   term: z.number().int().optional(),
   brokerage: z.union([
     MonetaryQuantity$outboundSchema,

package/src/models/components/personalapplicationresource.ts

@@ -30,6 +30,42 @@ export type PersonalApplicationResourceApplicationType = ClosedEnum<
   typeof PersonalApplicationResourceApplicationType
 >;
 
+/**
+ * The lender with whom the application has settled
+ */
+export const PersonalApplicationResourceLender = {
+  Metro: "metro",
+  Pepper: "pepper",
+  Flexi: "flexi",
+  Angle: "angle",
+  Resimac: "resimac",
+  Scotpac: "scotpac",
+  Grow: "grow",
+  Macquarie: "macquarie",
+  Plenti: "plenti",
+  AzoraAssetFinance: "azora_asset_finance",
+  Moneyplace: "moneyplace",
+  Wisr: "wisr",
+  Money3: "money3",
+  FinanceOne: "finance_one",
+  Now: "now",
+  Afs: "afs",
+  Autopay: "autopay",
+  Ammf: "ammf",
+  Dynamoney: "dynamoney",
+  Firstmac: "firstmac",
+  Latitude: "latitude",
+  Branded: "branded",
+  Liberty: "liberty",
+  Westpac: "westpac",
+} as const;
+/**
+ * The lender with whom the application has settled
+ */
+export type PersonalApplicationResourceLender = ClosedEnum<
+  typeof PersonalApplicationResourceLender
+>;
+
 /**
  * Application resource attributes
  */
@@ -58,6 +94,10 @@ export type PersonalApplicationResourceAttributes = {
    * If the application has settled with a lender, the lender's identifier of the application, distinct from Financeable's
    */
   lenderApplicationReference?: string | undefined;
+  /**
+   * The lender with whom the application has settled
+   */
+  lender?: PersonalApplicationResourceLender | undefined;
   /**
    * Creation timestamp
    */
@@ -91,6 +131,11 @@ export const PersonalApplicationResourceApplicationType$inboundSchema:
   z.ZodNativeEnum<typeof PersonalApplicationResourceApplicationType> = z
     .nativeEnum(PersonalApplicationResourceApplicationType);
 
+/** @internal */
+export const PersonalApplicationResourceLender$inboundSchema: z.ZodNativeEnum<
+  typeof PersonalApplicationResourceLender
+> = z.nativeEnum(PersonalApplicationResourceLender);
+
 /** @internal */
 export const PersonalApplicationResourceAttributes$inboundSchema: z.ZodType<
   PersonalApplicationResourceAttributes,
@@ -103,6 +148,7 @@ export const PersonalApplicationResourceAttributes$inboundSchema: z.ZodType<
   status: ApplicationStatus$inboundSchema,
   settlementDate: z.string().optional(),
   lenderApplicationReference: z.string().optional(),
+  lender: PersonalApplicationResourceLender$inboundSchema.optional(),
   createdAt: z.string().optional(),
   updatedAt: z.string().optional(),
 });

package/src/models/components/personalloanpurpose.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const PersonalLoanPurpose = {
+  Vehicle: "VEHICLE",
+  DebtConsolidation: "DEBT_CONSOLIDATION",
+  HomeImprovements: "HOME_IMPROVEMENTS",
+  MedicalAndDental: "MEDICAL_AND_DENTAL",
+  HouseholdFurnishings: "HOUSEHOLD_FURNISHINGS",
+  Education: "EDUCATION",
+  Travel: "TRAVEL",
+  Wedding: "WEDDING",
+  MortgageCostFunding: "MORTGAGE_COST_FUNDING",
+  OtherPersonalUse: "OTHER_PERSONAL_USE",
+} as const;
+export type PersonalLoanPurpose = ClosedEnum<typeof PersonalLoanPurpose>;
+
+/** @internal */
+export const PersonalLoanPurpose$inboundSchema: z.ZodNativeEnum<
+  typeof PersonalLoanPurpose
+> = z.nativeEnum(PersonalLoanPurpose);
+/** @internal */
+export const PersonalLoanPurpose$outboundSchema: z.ZodNativeEnum<
+  typeof PersonalLoanPurpose
+> = PersonalLoanPurpose$inboundSchema;