@financeable/aggregation 0.9.0 → 0.10.0

package/src/models/components/createsupportingdocumentsresponse.ts

@@ -46,22 +46,6 @@ export type CreateSupportingDocumentsResponseType = ClosedEnum<
   typeof CreateSupportingDocumentsResponseType
 >;
 
-export type Links = {
-  /**
-   * Standard link object
-   */
-  upload: LinkObject;
-};
-
-export type CreateSupportingDocumentsResponse = {
-  type: CreateSupportingDocumentsResponseType;
-  id?: string | undefined;
-  attributes: SupportingDocumentAttributes;
-  relationships: SupportingDocumentRelationships;
-  links?: Links | undefined;
-  meta?: { [k: string]: any } | undefined;
-};
-
 /** @internal */
 export const CreateSupportingDocumentsResponseType$inboundSchema:
   z.ZodNativeEnum<typeof CreateSupportingDocumentsResponseType> = z.nativeEnum(
@@ -86,6 +70,22 @@ export namespace CreateSupportingDocumentsResponseType$ {
     CreateSupportingDocumentsResponseType$outboundSchema;
 }
 
+export type Links = {
+  /**
+   * Standard link object
+   */
+  upload: LinkObject;
+};
+
+export type CreateSupportingDocumentsResponse = {
+  type: CreateSupportingDocumentsResponseType;
+  id?: string | undefined;
+  attributes: SupportingDocumentAttributes;
+  relationships: SupportingDocumentRelationships;
+  links?: Links | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
 /** @internal */
 export const Links$inboundSchema: z.ZodType<Links, z.ZodTypeDef, unknown> = z
   .object({

package/src/models/components/customerassetattributes.ts

@@ -20,7 +20,7 @@ import {
 
 export type CustomerAssetAttributes = {
   id?: string | undefined;
-  assetType: CustomerAssetType;
+  assetType?: CustomerAssetType | undefined;
   value?: MonetaryQuantity | undefined;
   description?: string | undefined;
 };
@@ -32,7 +32,7 @@ export const CustomerAssetAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
-  assetType: CustomerAssetType$inboundSchema,
+  assetType: CustomerAssetType$inboundSchema.optional(),
   value: MonetaryQuantity$inboundSchema.optional(),
   description: z.string().optional(),
 });
@@ -40,7 +40,7 @@ export const CustomerAssetAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type CustomerAssetAttributes$Outbound = {
   id?: string | undefined;
-  assetType: string;
+  assetType?: string | undefined;
   value?: MonetaryQuantity$Outbound | undefined;
   description?: string | undefined;
 };
@@ -52,7 +52,7 @@ export const CustomerAssetAttributes$outboundSchema: z.ZodType<
   CustomerAssetAttributes
 > = z.object({
   id: z.string().optional(),
-  assetType: CustomerAssetType$outboundSchema,
+  assetType: CustomerAssetType$outboundSchema.optional(),
   value: MonetaryQuantity$outboundSchema.optional(),
   description: z.string().optional(),
 });

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
    */
@@ -81,9 +81,13 @@ export type CustomerAttributes = {
    */
   idState?: AustralianStatesAndTerritories | undefined;
   /**
-   * Number of the ID
+   * Number of the ID - license number for driver's licence or passport code.
    */
   idNumber?: string | undefined;
+  /**
+   * For driver's licence only - the card number
+   */
+  cardNumber?: string | undefined;
   /**
    * The customer's email addresses
    */
@@ -109,15 +113,16 @@ 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(),
+  cardNumber: z.string().optional(),
   emailAddresses: z.array(z.string()).optional(),
   phoneNumbers: z.array(z.string()).optional(),
   numberOfDependents: z.number().int().optional(),
@@ -130,15 +135,16 @@ 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;
+  cardNumber?: string | undefined;
   emailAddresses?: Array<string> | undefined;
   phoneNumbers?: Array<string> | undefined;
   numberOfDependents?: number | undefined;
@@ -155,15 +161,16 @@ 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(),
+  cardNumber: z.string().optional(),
   emailAddresses: z.array(z.string()).optional(),
   phoneNumbers: z.array(z.string()).optional(),
   numberOfDependents: z.number().int().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/forbiddenerror.ts

@@ -35,20 +35,6 @@ export const Title = {
 } as const;
 export type Title = ClosedEnum<typeof Title>;
 
-export type ForbiddenError = {
-  id?: string | undefined;
-  links?: APIErrorLinks | undefined;
-  status: ForbiddenErrorStatus;
-  code: Code;
-  title: Title;
-  detail: string;
-  /**
-   * An object describing the source of the error from the request
-   */
-  source?: ErrorSource | undefined;
-  meta?: { [k: string]: any } | undefined;
-};
-
 /** @internal */
 export const ForbiddenErrorStatus$inboundSchema: z.ZodNativeEnum<
   typeof ForbiddenErrorStatus
@@ -110,6 +96,20 @@ export namespace Title$ {
   export const outboundSchema = Title$outboundSchema;
 }
 
+export type ForbiddenError = {
+  id?: string | undefined;
+  links?: APIErrorLinks | undefined;
+  status: ForbiddenErrorStatus;
+  code: Code;
+  title: Title;
+  detail: string;
+  /**
+   * An object describing the source of the error from the request
+   */
+  source?: ErrorSource | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
 /** @internal */
 export const ForbiddenError$inboundSchema: z.ZodType<
   ForbiddenError,

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/monetaryquantity.ts

@@ -18,18 +18,6 @@ export const ValueType = {
 } as const;
 export type ValueType = ClosedEnum<typeof ValueType>;
 
-export type MonetaryQuantity = {
-  valueType: ValueType;
-  /**
-   * Monetary quantity, specified in lowest denominator of the provided currency (e.g: cents for AUD). Serialised as a string e.g. for $100 AUD, provide: 10000
-   */
-  value: string;
-  /**
-   * ISO 4217 currency code, currently limited to AUD
-   */
-  currencyCode: CurrencyCodeIso4217;
-};
-
 /** @internal */
 export const ValueType$inboundSchema: z.ZodNativeEnum<typeof ValueType> = z
   .nativeEnum(ValueType);
@@ -49,6 +37,18 @@ export namespace ValueType$ {
   export const outboundSchema = ValueType$outboundSchema;
 }
 
+export type MonetaryQuantity = {
+  valueType: ValueType;
+  /**
+   * Monetary quantity, specified in lowest denominator of the provided currency (e.g: cents for AUD). Serialised as a string e.g. for $100 AUD, provide: 10000
+   */
+  value: string;
+  /**
+   * ISO 4217 currency code, currently limited to AUD
+   */
+  currencyCode: CurrencyCodeIso4217;
+};
+
 /** @internal */
 export const MonetaryQuantity$inboundSchema: z.ZodType<
   MonetaryQuantity,

package/src/models/components/percentagequantity.ts

@@ -15,14 +15,6 @@ export type PercentageQuantityValueType = ClosedEnum<
   typeof PercentageQuantityValueType
 >;
 
-export type PercentageQuantity = {
-  valueType: PercentageQuantityValueType;
-  /**
-   * Percentage quantity, e.g. provide '10' for 10%
-   */
-  value: string;
-};
-
 /** @internal */
 export const PercentageQuantityValueType$inboundSchema: z.ZodNativeEnum<
   typeof PercentageQuantityValueType
@@ -44,6 +36,14 @@ export namespace PercentageQuantityValueType$ {
   export const outboundSchema = PercentageQuantityValueType$outboundSchema;
 }
 
+export type PercentageQuantity = {
+  valueType: PercentageQuantityValueType;
+  /**
+   * Percentage quantity, e.g. provide '10' for 10%
+   */
+  value: string;
+};
+
 /** @internal */
 export const PercentageQuantity$inboundSchema: z.ZodType<
   PercentageQuantity,

package/src/models/components/relationshipresourcenotfound.ts

@@ -41,17 +41,6 @@ export type RelationshipResourceNotFoundTitle = ClosedEnum<
   typeof RelationshipResourceNotFoundTitle
 >;
 
-export type RelationshipResourceNotFound = {
-  id?: string | undefined;
-  links?: APIErrorLinks | undefined;
-  status: RelationshipResourceNotFoundStatus;
-  code: RelationshipResourceNotFoundCode;
-  title: RelationshipResourceNotFoundTitle;
-  detail: string;
-  source: ErrorSource;
-  meta: { [k: string]: any };
-};
-
 /** @internal */
 export const RelationshipResourceNotFoundStatus$inboundSchema: z.ZodNativeEnum<
   typeof RelationshipResourceNotFoundStatus
@@ -117,6 +106,17 @@ export namespace RelationshipResourceNotFoundTitle$ {
     RelationshipResourceNotFoundTitle$outboundSchema;
 }
 
+export type RelationshipResourceNotFound = {
+  id?: string | undefined;
+  links?: APIErrorLinks | undefined;
+  status: RelationshipResourceNotFoundStatus;
+  code: RelationshipResourceNotFoundCode;
+  title: RelationshipResourceNotFoundTitle;
+  detail: string;
+  source: ErrorSource;
+  meta: { [k: string]: any };
+};
+
 /** @internal */
 export const RelationshipResourceNotFound$inboundSchema: z.ZodType<
   RelationshipResourceNotFound,

package/src/models/components/resourcenotfound.ts

@@ -35,20 +35,6 @@ export const ResourceNotFoundTitle = {
 } as const;
 export type ResourceNotFoundTitle = ClosedEnum<typeof ResourceNotFoundTitle>;
 
-export type ResourceNotFound = {
-  id?: string | undefined;
-  links?: APIErrorLinks | undefined;
-  status: ResourceNotFoundStatus;
-  code: ResourceNotFoundCode;
-  title: ResourceNotFoundTitle;
-  detail: string;
-  /**
-   * An object describing the source of the error from the request
-   */
-  source?: ErrorSource | undefined;
-  meta?: { [k: string]: any } | undefined;
-};
-
 /** @internal */
 export const ResourceNotFoundStatus$inboundSchema: z.ZodNativeEnum<
   typeof ResourceNotFoundStatus
@@ -112,6 +98,20 @@ export namespace ResourceNotFoundTitle$ {
   export const outboundSchema = ResourceNotFoundTitle$outboundSchema;
 }
 
+export type ResourceNotFound = {
+  id?: string | undefined;
+  links?: APIErrorLinks | undefined;
+  status: ResourceNotFoundStatus;
+  code: ResourceNotFoundCode;
+  title: ResourceNotFoundTitle;
+  detail: string;
+  /**
+   * An object describing the source of the error from the request
+   */
+  source?: ErrorSource | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
 /** @internal */
 export const ResourceNotFound$inboundSchema: z.ZodType<
   ResourceNotFound,