@financeable/aggregation 0.2.0

package/financeable-typescript/src/models/components/applicationstatus.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ApplicationStatus = {
+  Workshop: "workshop",
+  Calculator: "calculator",
+  Quote: "quote",
+  Declined: "declined",
+  Approved: "approved",
+  Settled: "settled",
+  Deleted: "deleted",
+  Archive: "archive",
+} as const;
+export type ApplicationStatus = ClosedEnum<typeof ApplicationStatus>;
+
+/** @internal */
+export const ApplicationStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ApplicationStatus
+> = z.nativeEnum(ApplicationStatus);
+
+/** @internal */
+export const ApplicationStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ApplicationStatus
+> = ApplicationStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ApplicationStatus$ {
+  /** @deprecated use `ApplicationStatus$inboundSchema` instead. */
+  export const inboundSchema = ApplicationStatus$inboundSchema;
+  /** @deprecated use `ApplicationStatus$outboundSchema` instead. */
+  export const outboundSchema = ApplicationStatus$outboundSchema;
+}

package/financeable-typescript/src/models/components/applicationtype.ts

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

package/financeable-typescript/src/models/components/assetattributes.ts

@@ -0,0 +1,400 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Condition of asset
+ */
+export const Condition = {
+  New: "NEW",
+  Demo: "DEMO",
+  Used: "USED",
+} as const;
+/**
+ * Condition of asset
+ */
+export type Condition = ClosedEnum<typeof Condition>;
+
+/**
+ * Type of asset
+ */
+export const AssetType = {
+  MOTORVEHICLELessThan45TONNES: "MOTOR_VEHICLE_(<4.5_TONNES)",
+  ELECTRICMOTORVEHICLELessThan45TONNES: "ELECTRIC_MOTOR_VEHICLE_(<4.5_TONNES)",
+  COMMERCIALSMALLTOMEDIUMVEHICLESLessThan12TONNES:
+    "COMMERCIAL_(SMALL_TO_MEDIUM)_VEHICLES_(<12_TONNES)",
+  COMMERCIALHEAVYVEHICLESGreaterThan12TONNES:
+    "COMMERCIAL_(HEAVY)_VEHICLES_(>12_TONNES)",
+  WarehouseEquipmentWheeledOrTracked:
+    "WAREHOUSE_EQUIPMENT_(WHEELED_OR_TRACKED)",
+  EARTHMOVINGAndCONSTRUCTIONWHEELEDORTRACKED:
+    "EARTH_MOVING_&_CONSTRUCTION_(WHEELED_OR_TRACKED)",
+  AGRICULTURALAndLANDSCAPINGEQUIPMENTWHEELEDORTRACKED:
+    "AGRICULTURAL_&_LANDSCAPING_EQUIPMENT_(WHEELED_OR_TRACKED)",
+  MINIBUSESAndROUTEBUSESLessThan25SEATS: "MINI_BUSES_&_ROUTE_BUSES_(<25_SEATS)",
+  TrailersAndCaravans: "TRAILERS_AND_CARAVANS",
+  INDUSTRIALPLANTAndPRINTING: "INDUSTRIAL_PLANT_&_PRINTING",
+  ManufacturingEquipment: "MANUFACTURING_EQUIPMENT",
+  MedicalEquipment: "MEDICAL_EQUIPMENT",
+  ITCOMPUTERAndAUDIOEQUIPMENT: "IT_COMPUTER_&_AUDIO_EQUIPMENT",
+  HEALTHAndBEAUTYEQUIPMENT: "HEALTH_&_BEAUTY_EQUIPMENT",
+  OfficeEquipment: "OFFICE_EQUIPMENT",
+  OfficeFitout: "OFFICE_FITOUT",
+  RESTAURANTAndCATERINGEQUIPMENT: "RESTAURANT_&_CATERING_EQUIPMENT",
+  OfficeFurniture: "OFFICE_FURNITURE",
+  Solar: "SOLAR",
+  MotorbikesAtvs: "MOTORBIKES_ATVS",
+  ClassicCar: "CLASSIC_CAR",
+  TraileredBoats: "TRAILERED_BOATS",
+  Jetskis: "JETSKIS",
+  RideOnMowers: "RIDE_ON_MOWERS",
+  GolfCarts: "GOLF_CARTS",
+  Other: "OTHER",
+} as const;
+/**
+ * Type of asset
+ */
+export type AssetType = ClosedEnum<typeof AssetType>;
+
+export const Purpose = {
+  Vehicle: "VEHICLE",
+  DebtConsolidation: "DEBT_CONSOLIDATION",
+  HomeImprovements: "HOME_IMPROVEMENTS",
+  MEDICALAndDENTAL: "MEDICAL_&_DENTAL",
+  HouseholdFurnishings: "HOUSEHOLD_FURNISHINGS",
+  Education: "EDUCATION",
+  Travel: "TRAVEL",
+  Wedding: "WEDDING",
+  MortgageCostFunding: "MORTGAGE_COST_FUNDING",
+  OtherPersonalUse: "OTHER_PERSONAL_USE",
+} as const;
+export type Purpose = ClosedEnum<typeof Purpose>;
+
+/**
+ * Registration state (or territory) of asset
+ */
+export const RegistrationState = {
+  Vic: "VIC",
+  Nsw: "NSW",
+  Qld: "QLD",
+  Sa: "SA",
+  Wa: "WA",
+  Tas: "TAS",
+  Nt: "NT",
+  Act: "ACT",
+} as const;
+/**
+ * Registration state (or territory) of asset
+ */
+export type RegistrationState = ClosedEnum<typeof RegistrationState>;
+
+/**
+ * The asset to be obtained by the customer, using the proposed loan financing.
+ */
+export type AssetAttributes = {
+  /**
+   * Current age of asset as number (integer) of years
+   */
+  ageOfAsset: number;
+  /**
+   * Age of asset at the end of the loan term, in years
+   */
+  ageOfAssetAtEnd: number;
+  /**
+   * Condition of asset
+   */
+  condition: Condition;
+  /**
+   * Type of asset
+   */
+  assetType: AssetType;
+  purpose: Purpose;
+  /**
+   * Value of asset
+   */
+  assetValue: string;
+  /**
+   * Make of asset
+   */
+  make: string;
+  /**
+   * Model of asset
+   */
+  assetModel: string;
+  /**
+   * Registration number of asset
+   */
+  registrationNumber: string;
+  /**
+   * Registration state (or territory) of asset
+   */
+  registrationState?: RegistrationState | undefined;
+  /**
+   * VIN of asset
+   */
+  vin?: string | undefined;
+  /**
+   * Name of asset supplier
+   */
+  supplierName?: string | undefined;
+  /**
+   * ABN of asset supplier
+   */
+  supplierABN?: string | undefined;
+  /**
+   * Address of asset supplier
+   */
+  supplierAddress?: string | undefined;
+  /**
+   * Phone number of asset supplier
+   */
+  supplierPhone?: string | undefined;
+  /**
+   * Contact name of the asset supplier
+   */
+  supplierContactName?: string | undefined;
+  /**
+   * Email address of the asset supplier
+   */
+  supplierEmail?: string | undefined;
+  /**
+   * Is this asset obtained via private sale?
+   */
+  privateSale: boolean;
+  /**
+   * Type of sale
+   */
+  typeOfSale: string;
+  /**
+   * Description of asset
+   */
+  description: string;
+  /**
+   * Net asset value of asset, floating point value as string
+   */
+  netAssetValue: string;
+  /**
+   * Is this asset a luxury asset?
+   */
+  isLuxury: boolean;
+  /**
+   * Luxury GST, floating point value as string
+   */
+  luxuryGst?: string | undefined;
+  /**
+   * Additional fees concerning the asset, floating point value as string
+   */
+  additionalFees?: string | undefined;
+  /**
+   * Additional taxes concerning the asset, floating point value as string
+   */
+  additionalTaxes?: string | undefined;
+};
+
+/** @internal */
+export const Condition$inboundSchema: z.ZodNativeEnum<typeof Condition> = z
+  .nativeEnum(Condition);
+
+/** @internal */
+export const Condition$outboundSchema: z.ZodNativeEnum<typeof Condition> =
+  Condition$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Condition$ {
+  /** @deprecated use `Condition$inboundSchema` instead. */
+  export const inboundSchema = Condition$inboundSchema;
+  /** @deprecated use `Condition$outboundSchema` instead. */
+  export const outboundSchema = Condition$outboundSchema;
+}
+
+/** @internal */
+export const AssetType$inboundSchema: z.ZodNativeEnum<typeof AssetType> = z
+  .nativeEnum(AssetType);
+
+/** @internal */
+export const AssetType$outboundSchema: z.ZodNativeEnum<typeof AssetType> =
+  AssetType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AssetType$ {
+  /** @deprecated use `AssetType$inboundSchema` instead. */
+  export const inboundSchema = AssetType$inboundSchema;
+  /** @deprecated use `AssetType$outboundSchema` instead. */
+  export const outboundSchema = AssetType$outboundSchema;
+}
+
+/** @internal */
+export const Purpose$inboundSchema: z.ZodNativeEnum<typeof Purpose> = z
+  .nativeEnum(Purpose);
+
+/** @internal */
+export const Purpose$outboundSchema: z.ZodNativeEnum<typeof Purpose> =
+  Purpose$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Purpose$ {
+  /** @deprecated use `Purpose$inboundSchema` instead. */
+  export const inboundSchema = Purpose$inboundSchema;
+  /** @deprecated use `Purpose$outboundSchema` instead. */
+  export const outboundSchema = Purpose$outboundSchema;
+}
+
+/** @internal */
+export const RegistrationState$inboundSchema: z.ZodNativeEnum<
+  typeof RegistrationState
+> = z.nativeEnum(RegistrationState);
+
+/** @internal */
+export const RegistrationState$outboundSchema: z.ZodNativeEnum<
+  typeof RegistrationState
+> = RegistrationState$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RegistrationState$ {
+  /** @deprecated use `RegistrationState$inboundSchema` instead. */
+  export const inboundSchema = RegistrationState$inboundSchema;
+  /** @deprecated use `RegistrationState$outboundSchema` instead. */
+  export const outboundSchema = RegistrationState$outboundSchema;
+}
+
+/** @internal */
+export const AssetAttributes$inboundSchema: z.ZodType<
+  AssetAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ageOfAsset: z.number().int(),
+  ageOfAssetAtEnd: z.number().int(),
+  condition: Condition$inboundSchema,
+  assetType: AssetType$inboundSchema,
+  purpose: Purpose$inboundSchema,
+  assetValue: z.string(),
+  make: z.string(),
+  assetModel: z.string(),
+  registrationNumber: z.string(),
+  registrationState: RegistrationState$inboundSchema.optional(),
+  vin: z.string().optional(),
+  supplierName: z.string().optional(),
+  supplierABN: z.string().optional(),
+  supplierAddress: z.string().optional(),
+  supplierPhone: z.string().optional(),
+  supplierContactName: z.string().optional(),
+  supplierEmail: z.string().optional(),
+  privateSale: z.boolean(),
+  typeOfSale: z.string(),
+  description: z.string(),
+  netAssetValue: z.string(),
+  isLuxury: z.boolean(),
+  luxuryGst: z.string().optional(),
+  additionalFees: z.string().optional(),
+  additionalTaxes: z.string().optional(),
+});
+
+/** @internal */
+export type AssetAttributes$Outbound = {
+  ageOfAsset: number;
+  ageOfAssetAtEnd: number;
+  condition: string;
+  assetType: string;
+  purpose: string;
+  assetValue: string;
+  make: string;
+  assetModel: string;
+  registrationNumber: string;
+  registrationState?: string | undefined;
+  vin?: string | undefined;
+  supplierName?: string | undefined;
+  supplierABN?: string | undefined;
+  supplierAddress?: string | undefined;
+  supplierPhone?: string | undefined;
+  supplierContactName?: string | undefined;
+  supplierEmail?: string | undefined;
+  privateSale: boolean;
+  typeOfSale: string;
+  description: string;
+  netAssetValue: string;
+  isLuxury: boolean;
+  luxuryGst?: string | undefined;
+  additionalFees?: string | undefined;
+  additionalTaxes?: string | undefined;
+};
+
+/** @internal */
+export const AssetAttributes$outboundSchema: z.ZodType<
+  AssetAttributes$Outbound,
+  z.ZodTypeDef,
+  AssetAttributes
+> = z.object({
+  ageOfAsset: z.number().int(),
+  ageOfAssetAtEnd: z.number().int(),
+  condition: Condition$outboundSchema,
+  assetType: AssetType$outboundSchema,
+  purpose: Purpose$outboundSchema,
+  assetValue: z.string(),
+  make: z.string(),
+  assetModel: z.string(),
+  registrationNumber: z.string(),
+  registrationState: RegistrationState$outboundSchema.optional(),
+  vin: z.string().optional(),
+  supplierName: z.string().optional(),
+  supplierABN: z.string().optional(),
+  supplierAddress: z.string().optional(),
+  supplierPhone: z.string().optional(),
+  supplierContactName: z.string().optional(),
+  supplierEmail: z.string().optional(),
+  privateSale: z.boolean(),
+  typeOfSale: z.string(),
+  description: z.string(),
+  netAssetValue: z.string(),
+  isLuxury: z.boolean(),
+  luxuryGst: z.string().optional(),
+  additionalFees: z.string().optional(),
+  additionalTaxes: 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 AssetAttributes$ {
+  /** @deprecated use `AssetAttributes$inboundSchema` instead. */
+  export const inboundSchema = AssetAttributes$inboundSchema;
+  /** @deprecated use `AssetAttributes$outboundSchema` instead. */
+  export const outboundSchema = AssetAttributes$outboundSchema;
+  /** @deprecated use `AssetAttributes$Outbound` instead. */
+  export type Outbound = AssetAttributes$Outbound;
+}
+
+export function assetAttributesToJSON(
+  assetAttributes: AssetAttributes,
+): string {
+  return JSON.stringify(AssetAttributes$outboundSchema.parse(assetAttributes));
+}
+
+export function assetAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<AssetAttributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssetAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssetAttributes' from JSON`,
+  );
+}

package/financeable-typescript/src/models/components/customerattributes.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomerTitle,
+  CustomerTitle$inboundSchema,
+  CustomerTitle$outboundSchema,
+} from "./customertitle.js";
+
+/**
+ * Type of ID, either drivers' license or passport
+ */
+export const IDType = {
+  Licence: "licence",
+  Passport: "passport",
+} as const;
+/**
+ * Type of ID, either drivers' license or passport
+ */
+export type IDType = ClosedEnum<typeof IDType>;
+
+/**
+ * A customer of the proposed financing
+ */
+export type CustomerAttributes = {
+  /**
+   * Title of the customer
+   */
+  title: CustomerTitle;
+  /**
+   * First name of the customer
+   */
+  firstName: string;
+  /**
+   * Middle names of the customer
+   */
+  middleNames?: string | undefined;
+  /**
+   * Last name of the customer
+   */
+  lastName: string;
+  /**
+   * Date of birth in format DD-MM-YYYY
+   */
+  dateOfBirth: string;
+  /**
+   * Date of expiry of the ID in format DD-MM-YYYY
+   */
+  idExpiryDate: string;
+  /**
+   * Type of ID, either drivers' license or passport
+   */
+  idType?: IDType | undefined;
+  /**
+   * Number of the ID
+   */
+  idNumber?: string | undefined;
+};
+
+/** @internal */
+export const IDType$inboundSchema: z.ZodNativeEnum<typeof IDType> = z
+  .nativeEnum(IDType);
+
+/** @internal */
+export const IDType$outboundSchema: z.ZodNativeEnum<typeof IDType> =
+  IDType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace IDType$ {
+  /** @deprecated use `IDType$inboundSchema` instead. */
+  export const inboundSchema = IDType$inboundSchema;
+  /** @deprecated use `IDType$outboundSchema` instead. */
+  export const outboundSchema = IDType$outboundSchema;
+}
+
+/** @internal */
+export const CustomerAttributes$inboundSchema: z.ZodType<
+  CustomerAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: CustomerTitle$inboundSchema,
+  firstName: z.string(),
+  middleNames: z.string().optional(),
+  lastName: z.string(),
+  dateOfBirth: z.string(),
+  IDExpiryDate: z.string(),
+  IDType: IDType$inboundSchema.optional(),
+  IDNumber: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "IDExpiryDate": "idExpiryDate",
+    "IDType": "idType",
+    "IDNumber": "idNumber",
+  });
+});
+
+/** @internal */
+export type CustomerAttributes$Outbound = {
+  title: string;
+  firstName: string;
+  middleNames?: string | undefined;
+  lastName: string;
+  dateOfBirth: string;
+  IDExpiryDate: string;
+  IDType?: string | undefined;
+  IDNumber?: string | undefined;
+};
+
+/** @internal */
+export const CustomerAttributes$outboundSchema: z.ZodType<
+  CustomerAttributes$Outbound,
+  z.ZodTypeDef,
+  CustomerAttributes
+> = z.object({
+  title: CustomerTitle$outboundSchema,
+  firstName: z.string(),
+  middleNames: z.string().optional(),
+  lastName: z.string(),
+  dateOfBirth: z.string(),
+  idExpiryDate: z.string(),
+  idType: IDType$outboundSchema.optional(),
+  idNumber: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idExpiryDate: "IDExpiryDate",
+    idType: "IDType",
+    idNumber: "IDNumber",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerAttributes$ {
+  /** @deprecated use `CustomerAttributes$inboundSchema` instead. */
+  export const inboundSchema = CustomerAttributes$inboundSchema;
+  /** @deprecated use `CustomerAttributes$outboundSchema` instead. */
+  export const outboundSchema = CustomerAttributes$outboundSchema;
+  /** @deprecated use `CustomerAttributes$Outbound` instead. */
+  export type Outbound = CustomerAttributes$Outbound;
+}
+
+export function customerAttributesToJSON(
+  customerAttributes: CustomerAttributes,
+): string {
+  return JSON.stringify(
+    CustomerAttributes$outboundSchema.parse(customerAttributes),
+  );
+}
+
+export function customerAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerAttributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerAttributes' from JSON`,
+  );
+}

package/financeable-typescript/src/models/components/customertitle.ts

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