@financeable/aggregation 0.8.0 → 0.8.3

package/src/models/components/commercialsecuredloanassetattributes.ts

@@ -12,6 +12,17 @@ import {
   CommercialSecuredLoanAssetType$inboundSchema,
   CommercialSecuredLoanAssetType$outboundSchema,
 } from "./commercialsecuredloanassettype.js";
+import {
+  CommercialSecuredLoanTypeOfSale,
+  CommercialSecuredLoanTypeOfSale$inboundSchema,
+  CommercialSecuredLoanTypeOfSale$outboundSchema,
+} from "./commercialsecuredloantypeofsale.js";
+import {
+  MonetaryQuantity,
+  MonetaryQuantity$inboundSchema,
+  MonetaryQuantity$Outbound,
+  MonetaryQuantity$outboundSchema,
+} from "./monetaryquantity.js";
 
 /**
  * Condition of asset
@@ -26,6 +37,11 @@ export const Condition = {
  */
 export type Condition = ClosedEnum<typeof Condition>;
 
+/**
+ * Value of asset as either MonetaryQuantity model (preferred) or floating point AUD dollars as string. The latter will be deprecated.
+ */
+export type AssetValue = MonetaryQuantity | string;
+
 /**
  * Registration state (or territory) of asset
  */
@@ -44,6 +60,31 @@ export const RegistrationState = {
  */
 export type RegistrationState = ClosedEnum<typeof RegistrationState>;
 
+/**
+ * Type of sale. Must be a member of CommercialSecuredLoan.TypeOfSale, but will not throw for invalid string values (backwards-compatibility).
+ */
+export type TypeOfSale = string | CommercialSecuredLoanTypeOfSale;
+
+/**
+ * Net asset value of asset, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
+ */
+export type NetAssetValue = MonetaryQuantity | string;
+
+/**
+ * Luxury GST, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
+ */
+export type LuxuryGst = MonetaryQuantity | string;
+
+/**
+ * Additional fees concerning the asset, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
+ */
+export type AdditionalFees = MonetaryQuantity | string;
+
+/**
+ * Additional taxes concerning the asset, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
+ */
+export type AdditionalTaxes = MonetaryQuantity | string;
+
 /**
  * Type of asset for secured commercial loans
  */
@@ -66,9 +107,9 @@ export type CommercialSecuredLoanAssetAttributes = {
    */
   assetType: CommercialSecuredLoanAssetType;
   /**
-   * Value of asset
+   * Value of asset as either MonetaryQuantity model (preferred) or floating point AUD dollars as string. The latter will be deprecated.
    */
-  assetValue?: string | undefined;
+  assetValue: MonetaryQuantity | string;
   /**
    * Make of asset
    */
@@ -118,33 +159,33 @@ export type CommercialSecuredLoanAssetAttributes = {
    */
   privateSale?: boolean | undefined;
   /**
-   * Type of sale
+   * Type of sale. Must be a member of CommercialSecuredLoan.TypeOfSale, but will not throw for invalid string values (backwards-compatibility).
    */
-  typeOfSale?: string | undefined;
+  typeOfSale: string | CommercialSecuredLoanTypeOfSale;
   /**
    * Description of asset
    */
   description?: string | undefined;
   /**
-   * Net asset value of asset, floating point value as string
+   * Net asset value of asset, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
    */
-  netAssetValue?: string | undefined;
+  netAssetValue: MonetaryQuantity | string;
   /**
    * Is this asset a luxury asset?
    */
   isLuxury?: boolean | undefined;
   /**
-   * Luxury GST, floating point value as string
+   * Luxury GST, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
    */
-  luxuryGst?: string | undefined;
+  luxuryGst?: MonetaryQuantity | string | undefined;
   /**
-   * Additional fees concerning the asset, floating point value as string
+   * Additional fees concerning the asset, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
    */
-  additionalFees?: string | undefined;
+  additionalFees?: MonetaryQuantity | string | undefined;
   /**
-   * Additional taxes concerning the asset, floating point value as string
+   * Additional taxes concerning the asset, provided as either MonetaryQuantity (preferred) or floating point dollar value as string (latter will be deprecated)
    */
-  additionalTaxes?: string | undefined;
+  additionalTaxes?: MonetaryQuantity | string | undefined;
 };
 
 /** @internal */
@@ -166,6 +207,50 @@ export namespace Condition$ {
   export const outboundSchema = Condition$outboundSchema;
 }
 
+/** @internal */
+export const AssetValue$inboundSchema: z.ZodType<
+  AssetValue,
+  z.ZodTypeDef,
+  unknown
+> = z.union([MonetaryQuantity$inboundSchema, z.string()]);
+
+/** @internal */
+export type AssetValue$Outbound = MonetaryQuantity$Outbound | string;
+
+/** @internal */
+export const AssetValue$outboundSchema: z.ZodType<
+  AssetValue$Outbound,
+  z.ZodTypeDef,
+  AssetValue
+> = z.union([MonetaryQuantity$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AssetValue$ {
+  /** @deprecated use `AssetValue$inboundSchema` instead. */
+  export const inboundSchema = AssetValue$inboundSchema;
+  /** @deprecated use `AssetValue$outboundSchema` instead. */
+  export const outboundSchema = AssetValue$outboundSchema;
+  /** @deprecated use `AssetValue$Outbound` instead. */
+  export type Outbound = AssetValue$Outbound;
+}
+
+export function assetValueToJSON(assetValue: AssetValue): string {
+  return JSON.stringify(AssetValue$outboundSchema.parse(assetValue));
+}
+
+export function assetValueFromJSON(
+  jsonString: string,
+): SafeParseResult<AssetValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssetValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssetValue' from JSON`,
+  );
+}
+
 /** @internal */
 export const RegistrationState$inboundSchema: z.ZodNativeEnum<
   typeof RegistrationState
@@ -187,6 +272,228 @@ export namespace RegistrationState$ {
   export const outboundSchema = RegistrationState$outboundSchema;
 }
 
+/** @internal */
+export const TypeOfSale$inboundSchema: z.ZodType<
+  TypeOfSale,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), CommercialSecuredLoanTypeOfSale$inboundSchema]);
+
+/** @internal */
+export type TypeOfSale$Outbound = string | string;
+
+/** @internal */
+export const TypeOfSale$outboundSchema: z.ZodType<
+  TypeOfSale$Outbound,
+  z.ZodTypeDef,
+  TypeOfSale
+> = z.union([z.string(), CommercialSecuredLoanTypeOfSale$outboundSchema]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TypeOfSale$ {
+  /** @deprecated use `TypeOfSale$inboundSchema` instead. */
+  export const inboundSchema = TypeOfSale$inboundSchema;
+  /** @deprecated use `TypeOfSale$outboundSchema` instead. */
+  export const outboundSchema = TypeOfSale$outboundSchema;
+  /** @deprecated use `TypeOfSale$Outbound` instead. */
+  export type Outbound = TypeOfSale$Outbound;
+}
+
+export function typeOfSaleToJSON(typeOfSale: TypeOfSale): string {
+  return JSON.stringify(TypeOfSale$outboundSchema.parse(typeOfSale));
+}
+
+export function typeOfSaleFromJSON(
+  jsonString: string,
+): SafeParseResult<TypeOfSale, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TypeOfSale$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TypeOfSale' from JSON`,
+  );
+}
+
+/** @internal */
+export const NetAssetValue$inboundSchema: z.ZodType<
+  NetAssetValue,
+  z.ZodTypeDef,
+  unknown
+> = z.union([MonetaryQuantity$inboundSchema, z.string()]);
+
+/** @internal */
+export type NetAssetValue$Outbound = MonetaryQuantity$Outbound | string;
+
+/** @internal */
+export const NetAssetValue$outboundSchema: z.ZodType<
+  NetAssetValue$Outbound,
+  z.ZodTypeDef,
+  NetAssetValue
+> = z.union([MonetaryQuantity$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NetAssetValue$ {
+  /** @deprecated use `NetAssetValue$inboundSchema` instead. */
+  export const inboundSchema = NetAssetValue$inboundSchema;
+  /** @deprecated use `NetAssetValue$outboundSchema` instead. */
+  export const outboundSchema = NetAssetValue$outboundSchema;
+  /** @deprecated use `NetAssetValue$Outbound` instead. */
+  export type Outbound = NetAssetValue$Outbound;
+}
+
+export function netAssetValueToJSON(netAssetValue: NetAssetValue): string {
+  return JSON.stringify(NetAssetValue$outboundSchema.parse(netAssetValue));
+}
+
+export function netAssetValueFromJSON(
+  jsonString: string,
+): SafeParseResult<NetAssetValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NetAssetValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NetAssetValue' from JSON`,
+  );
+}
+
+/** @internal */
+export const LuxuryGst$inboundSchema: z.ZodType<
+  LuxuryGst,
+  z.ZodTypeDef,
+  unknown
+> = z.union([MonetaryQuantity$inboundSchema, z.string()]);
+
+/** @internal */
+export type LuxuryGst$Outbound = MonetaryQuantity$Outbound | string;
+
+/** @internal */
+export const LuxuryGst$outboundSchema: z.ZodType<
+  LuxuryGst$Outbound,
+  z.ZodTypeDef,
+  LuxuryGst
+> = z.union([MonetaryQuantity$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LuxuryGst$ {
+  /** @deprecated use `LuxuryGst$inboundSchema` instead. */
+  export const inboundSchema = LuxuryGst$inboundSchema;
+  /** @deprecated use `LuxuryGst$outboundSchema` instead. */
+  export const outboundSchema = LuxuryGst$outboundSchema;
+  /** @deprecated use `LuxuryGst$Outbound` instead. */
+  export type Outbound = LuxuryGst$Outbound;
+}
+
+export function luxuryGstToJSON(luxuryGst: LuxuryGst): string {
+  return JSON.stringify(LuxuryGst$outboundSchema.parse(luxuryGst));
+}
+
+export function luxuryGstFromJSON(
+  jsonString: string,
+): SafeParseResult<LuxuryGst, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LuxuryGst$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LuxuryGst' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdditionalFees$inboundSchema: z.ZodType<
+  AdditionalFees,
+  z.ZodTypeDef,
+  unknown
+> = z.union([MonetaryQuantity$inboundSchema, z.string()]);
+
+/** @internal */
+export type AdditionalFees$Outbound = MonetaryQuantity$Outbound | string;
+
+/** @internal */
+export const AdditionalFees$outboundSchema: z.ZodType<
+  AdditionalFees$Outbound,
+  z.ZodTypeDef,
+  AdditionalFees
+> = z.union([MonetaryQuantity$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AdditionalFees$ {
+  /** @deprecated use `AdditionalFees$inboundSchema` instead. */
+  export const inboundSchema = AdditionalFees$inboundSchema;
+  /** @deprecated use `AdditionalFees$outboundSchema` instead. */
+  export const outboundSchema = AdditionalFees$outboundSchema;
+  /** @deprecated use `AdditionalFees$Outbound` instead. */
+  export type Outbound = AdditionalFees$Outbound;
+}
+
+export function additionalFeesToJSON(additionalFees: AdditionalFees): string {
+  return JSON.stringify(AdditionalFees$outboundSchema.parse(additionalFees));
+}
+
+export function additionalFeesFromJSON(
+  jsonString: string,
+): SafeParseResult<AdditionalFees, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdditionalFees$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdditionalFees' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdditionalTaxes$inboundSchema: z.ZodType<
+  AdditionalTaxes,
+  z.ZodTypeDef,
+  unknown
+> = z.union([MonetaryQuantity$inboundSchema, z.string()]);
+
+/** @internal */
+export type AdditionalTaxes$Outbound = MonetaryQuantity$Outbound | string;
+
+/** @internal */
+export const AdditionalTaxes$outboundSchema: z.ZodType<
+  AdditionalTaxes$Outbound,
+  z.ZodTypeDef,
+  AdditionalTaxes
+> = z.union([MonetaryQuantity$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AdditionalTaxes$ {
+  /** @deprecated use `AdditionalTaxes$inboundSchema` instead. */
+  export const inboundSchema = AdditionalTaxes$inboundSchema;
+  /** @deprecated use `AdditionalTaxes$outboundSchema` instead. */
+  export const outboundSchema = AdditionalTaxes$outboundSchema;
+  /** @deprecated use `AdditionalTaxes$Outbound` instead. */
+  export type Outbound = AdditionalTaxes$Outbound;
+}
+
+export function additionalTaxesToJSON(
+  additionalTaxes: AdditionalTaxes,
+): string {
+  return JSON.stringify(AdditionalTaxes$outboundSchema.parse(additionalTaxes));
+}
+
+export function additionalTaxesFromJSON(
+  jsonString: string,
+): SafeParseResult<AdditionalTaxes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdditionalTaxes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdditionalTaxes' from JSON`,
+  );
+}
+
 /** @internal */
 export const CommercialSecuredLoanAssetAttributes$inboundSchema: z.ZodType<
   CommercialSecuredLoanAssetAttributes,
@@ -198,7 +505,7 @@ export const CommercialSecuredLoanAssetAttributes$inboundSchema: z.ZodType<
   ageOfAssetAtEnd: z.number().int().optional(),
   condition: Condition$inboundSchema.optional(),
   assetType: CommercialSecuredLoanAssetType$inboundSchema,
-  assetValue: z.string().optional(),
+  assetValue: z.union([MonetaryQuantity$inboundSchema, z.string()]),
   make: z.string().optional(),
   assetModel: z.string().optional(),
   registrationNumber: z.string().optional(),
@@ -211,13 +518,18 @@ export const CommercialSecuredLoanAssetAttributes$inboundSchema: z.ZodType<
   supplierContactName: z.string().optional(),
   supplierEmail: z.string().optional(),
   privateSale: z.boolean().optional(),
-  typeOfSale: z.string().optional(),
+  typeOfSale: z.union([
+    z.string(),
+    CommercialSecuredLoanTypeOfSale$inboundSchema,
+  ]),
   description: z.string().optional(),
-  netAssetValue: z.string().optional(),
+  netAssetValue: z.union([MonetaryQuantity$inboundSchema, z.string()]),
   isLuxury: z.boolean().optional(),
-  luxuryGst: z.string().optional(),
-  additionalFees: z.string().optional(),
-  additionalTaxes: z.string().optional(),
+  luxuryGst: z.union([MonetaryQuantity$inboundSchema, z.string()]).optional(),
+  additionalFees: z.union([MonetaryQuantity$inboundSchema, z.string()])
+    .optional(),
+  additionalTaxes: z.union([MonetaryQuantity$inboundSchema, z.string()])
+    .optional(),
 });
 
 /** @internal */
@@ -227,7 +539,7 @@ export type CommercialSecuredLoanAssetAttributes$Outbound = {
   ageOfAssetAtEnd?: number | undefined;
   condition?: string | undefined;
   assetType: string;
-  assetValue?: string | undefined;
+  assetValue: MonetaryQuantity$Outbound | string;
   make?: string | undefined;
   assetModel?: string | undefined;
   registrationNumber?: string | undefined;
@@ -240,13 +552,13 @@ export type CommercialSecuredLoanAssetAttributes$Outbound = {
   supplierContactName?: string | undefined;
   supplierEmail?: string | undefined;
   privateSale?: boolean | undefined;
-  typeOfSale?: string | undefined;
+  typeOfSale: string | string;
   description?: string | undefined;
-  netAssetValue?: string | undefined;
+  netAssetValue: MonetaryQuantity$Outbound | string;
   isLuxury?: boolean | undefined;
-  luxuryGst?: string | undefined;
-  additionalFees?: string | undefined;
-  additionalTaxes?: string | undefined;
+  luxuryGst?: MonetaryQuantity$Outbound | string | undefined;
+  additionalFees?: MonetaryQuantity$Outbound | string | undefined;
+  additionalTaxes?: MonetaryQuantity$Outbound | string | undefined;
 };
 
 /** @internal */
@@ -260,7 +572,7 @@ export const CommercialSecuredLoanAssetAttributes$outboundSchema: z.ZodType<
   ageOfAssetAtEnd: z.number().int().optional(),
   condition: Condition$outboundSchema.optional(),
   assetType: CommercialSecuredLoanAssetType$outboundSchema,
-  assetValue: z.string().optional(),
+  assetValue: z.union([MonetaryQuantity$outboundSchema, z.string()]),
   make: z.string().optional(),
   assetModel: z.string().optional(),
   registrationNumber: z.string().optional(),
@@ -273,13 +585,18 @@ export const CommercialSecuredLoanAssetAttributes$outboundSchema: z.ZodType<
   supplierContactName: z.string().optional(),
   supplierEmail: z.string().optional(),
   privateSale: z.boolean().optional(),
-  typeOfSale: z.string().optional(),
+  typeOfSale: z.union([
+    z.string(),
+    CommercialSecuredLoanTypeOfSale$outboundSchema,
+  ]),
   description: z.string().optional(),
-  netAssetValue: z.string().optional(),
+  netAssetValue: z.union([MonetaryQuantity$outboundSchema, z.string()]),
   isLuxury: z.boolean().optional(),
-  luxuryGst: z.string().optional(),
-  additionalFees: z.string().optional(),
-  additionalTaxes: z.string().optional(),
+  luxuryGst: z.union([MonetaryQuantity$outboundSchema, z.string()]).optional(),
+  additionalFees: z.union([MonetaryQuantity$outboundSchema, z.string()])
+    .optional(),
+  additionalTaxes: z.union([MonetaryQuantity$outboundSchema, z.string()])
+    .optional(),
 });
 
 /**

package/src/models/components/commercialsecuredloantypeofsale.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 CommercialSecuredLoanTypeOfSale = {
+  AuthorisedSeller: "AUTHORISED_SELLER",
+  AuthorisedElectricVehicleSeller: "AUTHORISED_ELECTRIC_VEHICLE_SELLER",
+  PrivateSale: "PRIVATE_SALE",
+  MidTermRefinance: "MID-TERM_REFINANCE",
+  BalloonOrResdiualRefinance: "BALLOON_OR_RESDIUAL_REFINANCE",
+  SaleAndBuybackOrEquity: "SALE_AND_BUYBACK_OR_EQUITY",
+} as const;
+export type CommercialSecuredLoanTypeOfSale = ClosedEnum<
+  typeof CommercialSecuredLoanTypeOfSale
+>;
+
+/** @internal */
+export const CommercialSecuredLoanTypeOfSale$inboundSchema: z.ZodNativeEnum<
+  typeof CommercialSecuredLoanTypeOfSale
+> = z.nativeEnum(CommercialSecuredLoanTypeOfSale);
+
+/** @internal */
+export const CommercialSecuredLoanTypeOfSale$outboundSchema: z.ZodNativeEnum<
+  typeof CommercialSecuredLoanTypeOfSale
+> = CommercialSecuredLoanTypeOfSale$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommercialSecuredLoanTypeOfSale$ {
+  /** @deprecated use `CommercialSecuredLoanTypeOfSale$inboundSchema` instead. */
+  export const inboundSchema = CommercialSecuredLoanTypeOfSale$inboundSchema;
+  /** @deprecated use `CommercialSecuredLoanTypeOfSale$outboundSchema` instead. */
+  export const outboundSchema = CommercialSecuredLoanTypeOfSale$outboundSchema;
+}