@financeable/aggregation 0.9.1 → 0.10.1

package/src/models/components/customerattributes.ts

@@ -51,11 +51,11 @@ export type CustomerAttributes = {
   /**
    * Title of the customer
    */
-  title: CustomerTitle;
+  title?: CustomerTitle | undefined;
   /**
    * First name of the customer
    */
-  firstName: string;
+  firstName?: string | undefined;
   /**
    * Middle names of the customer
    */
@@ -63,15 +63,15 @@ export type CustomerAttributes = {
   /**
    * Last name of the customer
    */
-  lastName: string;
+  lastName?: string | undefined;
   /**
    * Date of birth in format YYYY-MM-DD
    */
-  dateOfBirth: string;
+  dateOfBirth?: string | undefined;
   /**
    * Date of expiry of the ID in format YYYY-MM-DD
    */
-  idExpiryDate: string;
+  idExpiryDate?: string | undefined;
   /**
    * Type of ID, either drivers' license or passport
    */
@@ -113,12 +113,12 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
-  title: CustomerTitle$inboundSchema,
-  firstName: z.string(),
+  title: CustomerTitle$inboundSchema.optional(),
+  firstName: z.string().optional(),
   middleNames: z.string().optional(),
-  lastName: z.string(),
-  dateOfBirth: z.string(),
-  idExpiryDate: z.string(),
+  lastName: z.string().optional(),
+  dateOfBirth: z.string().optional(),
+  idExpiryDate: z.string().optional(),
   idType: CustomerIDType$inboundSchema.optional(),
   idState: AustralianStatesAndTerritories$inboundSchema.optional(),
   idNumber: z.string().optional(),
@@ -135,12 +135,12 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type CustomerAttributes$Outbound = {
   id?: string | undefined;
-  title: string;
-  firstName: string;
+  title?: string | undefined;
+  firstName?: string | undefined;
   middleNames?: string | undefined;
-  lastName: string;
-  dateOfBirth: string;
-  idExpiryDate: string;
+  lastName?: string | undefined;
+  dateOfBirth?: string | undefined;
+  idExpiryDate?: string | undefined;
   idType?: string | undefined;
   idState?: string | undefined;
   idNumber?: string | undefined;
@@ -161,12 +161,12 @@ export const CustomerAttributes$outboundSchema: z.ZodType<
   CustomerAttributes
 > = z.object({
   id: z.string().optional(),
-  title: CustomerTitle$outboundSchema,
-  firstName: z.string(),
+  title: CustomerTitle$outboundSchema.optional(),
+  firstName: z.string().optional(),
   middleNames: z.string().optional(),
-  lastName: z.string(),
-  dateOfBirth: z.string(),
-  idExpiryDate: z.string(),
+  lastName: z.string().optional(),
+  dateOfBirth: z.string().optional(),
+  idExpiryDate: z.string().optional(),
   idType: CustomerIDType$outboundSchema.optional(),
   idState: AustralianStatesAndTerritories$outboundSchema.optional(),
   idNumber: z.string().optional(),

package/src/models/components/customerliabilityattributes.ts

@@ -25,7 +25,7 @@ import {
 
 export type CustomerLiabilityAttributes = {
   id?: string | undefined;
-  liabilityType: CustomerLiabilityType;
+  liabilityType?: CustomerLiabilityType | undefined;
   outstandingAmount?: MonetaryQuantity | undefined;
   limit?: MonetaryQuantity | undefined;
   financier?: string | undefined;
@@ -41,7 +41,7 @@ export const CustomerLiabilityAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
-  liabilityType: CustomerLiabilityType$inboundSchema,
+  liabilityType: CustomerLiabilityType$inboundSchema.optional(),
   outstandingAmount: MonetaryQuantity$inboundSchema.optional(),
   limit: MonetaryQuantity$inboundSchema.optional(),
   financier: z.string().optional(),
@@ -54,7 +54,7 @@ export const CustomerLiabilityAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type CustomerLiabilityAttributes$Outbound = {
   id?: string | undefined;
-  liabilityType: string;
+  liabilityType?: string | undefined;
   outstandingAmount?: MonetaryQuantity$Outbound | undefined;
   limit?: MonetaryQuantity$Outbound | undefined;
   financier?: string | undefined;
@@ -70,7 +70,7 @@ export const CustomerLiabilityAttributes$outboundSchema: z.ZodType<
   CustomerLiabilityAttributes
 > = z.object({
   id: z.string().optional(),
-  liabilityType: CustomerLiabilityType$outboundSchema,
+  liabilityType: CustomerLiabilityType$outboundSchema.optional(),
   outstandingAmount: MonetaryQuantity$outboundSchema.optional(),
   limit: MonetaryQuantity$outboundSchema.optional(),
   financier: z.string().optional(),

package/src/models/components/entityattributes.ts

@@ -9,8 +9,8 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EntityAttributes = {
   id?: string | undefined;
-  entityName: string;
-  abn: string;
+  entityName?: string | undefined;
+  abn?: string | undefined;
   turnover?: number | undefined;
   industryType?: string | undefined;
   emails?: Array<string> | undefined;
@@ -24,8 +24,8 @@ export const EntityAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
-  entityName: z.string(),
-  abn: z.string(),
+  entityName: z.string().optional(),
+  abn: z.string().optional(),
   turnover: z.number().int().optional(),
   industryType: z.string().optional(),
   emails: z.array(z.string()).optional(),
@@ -35,8 +35,8 @@ export const EntityAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type EntityAttributes$Outbound = {
   id?: string | undefined;
-  entityName: string;
-  abn: string;
+  entityName?: string | undefined;
+  abn?: string | undefined;
   turnover?: number | undefined;
   industryType?: string | undefined;
   emails?: Array<string> | undefined;
@@ -50,8 +50,8 @@ export const EntityAttributes$outboundSchema: z.ZodType<
   EntityAttributes
 > = z.object({
   id: z.string().optional(),
-  entityName: z.string(),
-  abn: z.string(),
+  entityName: z.string().optional(),
+  abn: z.string().optional(),
   turnover: z.number().int().optional(),
   industryType: z.string().optional(),
   emails: z.array(z.string()).optional(),

package/src/models/components/expenseattributes.ts

@@ -25,7 +25,7 @@ import {
 
 export type ExpenseAttributes = {
   id?: string | undefined;
-  expenseType: ExpenseType;
+  expenseType?: ExpenseType | undefined;
   frequency?: ExpenseFrequency | undefined;
   amount?: MonetaryQuantity | undefined;
 };
@@ -37,7 +37,7 @@ export const ExpenseAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
-  expenseType: ExpenseType$inboundSchema,
+  expenseType: ExpenseType$inboundSchema.optional(),
   frequency: ExpenseFrequency$inboundSchema.optional(),
   amount: MonetaryQuantity$inboundSchema.optional(),
 });
@@ -45,7 +45,7 @@ export const ExpenseAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type ExpenseAttributes$Outbound = {
   id?: string | undefined;
-  expenseType: string;
+  expenseType?: string | undefined;
   frequency?: string | undefined;
   amount?: MonetaryQuantity$Outbound | undefined;
 };
@@ -57,7 +57,7 @@ export const ExpenseAttributes$outboundSchema: z.ZodType<
   ExpenseAttributes
 > = z.object({
   id: z.string().optional(),
-  expenseType: ExpenseType$outboundSchema,
+  expenseType: ExpenseType$outboundSchema.optional(),
   frequency: ExpenseFrequency$outboundSchema.optional(),
   amount: MonetaryQuantity$outboundSchema.optional(),
 });

package/src/models/components/incomeattributes.ts

@@ -25,7 +25,7 @@ import {
 
 export type IncomeAttributes = {
   id?: string | undefined;
-  incomeType: IncomeType;
+  incomeType?: IncomeType | undefined;
   frequency?: IncomeFrequency | undefined;
   amount?: MonetaryQuantity | undefined;
 };
@@ -37,7 +37,7 @@ export const IncomeAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
-  incomeType: IncomeType$inboundSchema,
+  incomeType: IncomeType$inboundSchema.optional(),
   frequency: IncomeFrequency$inboundSchema.optional(),
   amount: MonetaryQuantity$inboundSchema.optional(),
 });
@@ -45,7 +45,7 @@ export const IncomeAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type IncomeAttributes$Outbound = {
   id?: string | undefined;
-  incomeType: string;
+  incomeType?: string | undefined;
   frequency?: string | undefined;
   amount?: MonetaryQuantity$Outbound | undefined;
 };
@@ -57,7 +57,7 @@ export const IncomeAttributes$outboundSchema: z.ZodType<
   IncomeAttributes
 > = z.object({
   id: z.string().optional(),
-  incomeType: IncomeType$outboundSchema,
+  incomeType: IncomeType$outboundSchema.optional(),
   frequency: IncomeFrequency$outboundSchema.optional(),
   amount: MonetaryQuantity$outboundSchema.optional(),
 });

package/src/models/components/loandetailsattributes.ts

@@ -29,6 +29,11 @@ import {
   RepaymentStructure$outboundSchema,
 } from "./repaymentstructure.js";
 
+/**
+ * Repayment amount as either MonetaryQuantity model (preferred) or floating point dollars (string). The latter will be deprecated.
+ */
+export type Repayments = MonetaryQuantity | string;
+
 /**
  * Total loan amount, either MonetaryQuantity model (preferred) or floating point dollars as string. The latter will be deprecated.
  */
@@ -80,9 +85,9 @@ export type RateAdjustment = PercentageQuantity | string;
 export type LoanDetailsAttributes = {
   id?: string | undefined;
   /**
-   * Number of repayments as integer
+   * Repayment amount as either MonetaryQuantity model (preferred) or floating point dollars (string). The latter will be deprecated.
    */
-  repayments?: number | undefined;
+  repayments?: MonetaryQuantity | string | undefined;
   /**
    * Frequency of repayments
    */
@@ -149,6 +154,50 @@ export type LoanDetailsAttributes = {
   rateAdjustment?: PercentageQuantity | string | undefined;
 };
 
+/** @internal */
+export const Repayments$inboundSchema: z.ZodType<
+  Repayments,
+  z.ZodTypeDef,
+  unknown
+> = z.union([MonetaryQuantity$inboundSchema, z.string()]);
+
+/** @internal */
+export type Repayments$Outbound = MonetaryQuantity$Outbound | string;
+
+/** @internal */
+export const Repayments$outboundSchema: z.ZodType<
+  Repayments$Outbound,
+  z.ZodTypeDef,
+  Repayments
+> = 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 Repayments$ {
+  /** @deprecated use `Repayments$inboundSchema` instead. */
+  export const inboundSchema = Repayments$inboundSchema;
+  /** @deprecated use `Repayments$outboundSchema` instead. */
+  export const outboundSchema = Repayments$outboundSchema;
+  /** @deprecated use `Repayments$Outbound` instead. */
+  export type Outbound = Repayments$Outbound;
+}
+
+export function repaymentsToJSON(repayments: Repayments): string {
+  return JSON.stringify(Repayments$outboundSchema.parse(repayments));
+}
+
+export function repaymentsFromJSON(
+  jsonString: string,
+): SafeParseResult<Repayments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Repayments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Repayments' from JSON`,
+  );
+}
+
 /** @internal */
 export const LoanAmount$inboundSchema: z.ZodType<
   LoanAmount,
@@ -556,7 +605,7 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
-  repayments: z.number().int().optional(),
+  repayments: z.union([MonetaryQuantity$inboundSchema, z.string()]).optional(),
   repaymentFrequency: FrequencyType$inboundSchema.optional(),
   repaymentStructure: RepaymentStructure$inboundSchema.optional(),
   loanAmount: z.union([MonetaryQuantity$inboundSchema, z.string()]).optional(),
@@ -587,7 +636,7 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type LoanDetailsAttributes$Outbound = {
   id?: string | undefined;
-  repayments?: number | undefined;
+  repayments?: MonetaryQuantity$Outbound | string | undefined;
   repaymentFrequency?: string | undefined;
   repaymentStructure?: string | undefined;
   loanAmount?: MonetaryQuantity$Outbound | string | undefined;
@@ -620,7 +669,7 @@ export const LoanDetailsAttributes$outboundSchema: z.ZodType<
   LoanDetailsAttributes
 > = z.object({
   id: z.string().optional(),
-  repayments: z.number().int().optional(),
+  repayments: z.union([MonetaryQuantity$outboundSchema, z.string()]).optional(),
   repaymentFrequency: FrequencyType$outboundSchema.optional(),
   repaymentStructure: RepaymentStructure$outboundSchema.optional(),
   loanAmount: z.union([MonetaryQuantity$outboundSchema, z.string()]).optional(),