@financeable/aggregation 0.11.0 → 0.12.0

package/src/models/components/customerattributescreateitem.ts

@@ -0,0 +1,214 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  AustralianStatesAndTerritories,
+  AustralianStatesAndTerritories$inboundSchema,
+  AustralianStatesAndTerritories$outboundSchema,
+} from "./australianstatesandterritories.js";
+import {
+  CustomerIDType,
+  CustomerIDType$inboundSchema,
+  CustomerIDType$outboundSchema,
+} from "./customeridtype.js";
+import {
+  CustomerTitle,
+  CustomerTitle$inboundSchema,
+  CustomerTitle$outboundSchema,
+} from "./customertitle.js";
+import {
+  LivingArrangements,
+  LivingArrangements$inboundSchema,
+  LivingArrangements$outboundSchema,
+} from "./livingarrangements.js";
+import {
+  MaritalStatus,
+  MaritalStatus$inboundSchema,
+  MaritalStatus$outboundSchema,
+} from "./maritalstatus.js";
+import {
+  PercentageQuantity,
+  PercentageQuantity$inboundSchema,
+  PercentageQuantity$Outbound,
+  PercentageQuantity$outboundSchema,
+} from "./percentagequantity.js";
+import {
+  ResidencyStatus,
+  ResidencyStatus$inboundSchema,
+  ResidencyStatus$outboundSchema,
+} from "./residencystatus.js";
+
+/**
+ * A customer of the proposed financing
+ */
+export type CustomerAttributesCreateItem = {
+  id?: string | undefined;
+  /**
+   * Title of the customer
+   */
+  title?: CustomerTitle | undefined;
+  /**
+   * First name of the customer
+   */
+  firstName?: string | undefined;
+  /**
+   * Middle names of the customer
+   */
+  middleNames?: string | undefined;
+  /**
+   * Last name of the customer
+   */
+  lastName?: string | undefined;
+  /**
+   * Date of birth in format YYYY-MM-DD
+   */
+  dateOfBirth?: string | undefined;
+  /**
+   * Date of expiry of the ID in format YYYY-MM-DD
+   */
+  idExpiryDate?: string | undefined;
+  /**
+   * Type of ID, either drivers' license or passport
+   */
+  idType?: CustomerIDType | undefined;
+  /**
+   * THe state in which the ID was issued, currently limited to AUS states.
+   */
+  idState?: AustralianStatesAndTerritories | undefined;
+  /**
+   * 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
+   */
+  emailAddresses?: Array<string> | undefined;
+  /**
+   * The customer's phone numbers
+   */
+  phoneNumbers?: Array<string> | undefined;
+  /**
+   * The number of financial dependents of the customer
+   */
+  numberOfDependents?: number | undefined;
+  residencyStatus?: ResidencyStatus | undefined;
+  livingArrangements?: LivingArrangements | undefined;
+  maritalStatus?: MaritalStatus | undefined;
+  proportionOfSharedExpenses?: PercentageQuantity | undefined;
+};
+
+/** @internal */
+export const CustomerAttributesCreateItem$inboundSchema: z.ZodType<
+  CustomerAttributesCreateItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  title: CustomerTitle$inboundSchema.optional(),
+  firstName: z.string().optional(),
+  middleNames: z.string().optional(),
+  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(),
+  residencyStatus: ResidencyStatus$inboundSchema.optional(),
+  livingArrangements: LivingArrangements$inboundSchema.optional(),
+  maritalStatus: MaritalStatus$inboundSchema.optional(),
+  proportionOfSharedExpenses: PercentageQuantity$inboundSchema.optional(),
+});
+
+/** @internal */
+export type CustomerAttributesCreateItem$Outbound = {
+  id?: string | undefined;
+  title?: string | undefined;
+  firstName?: string | undefined;
+  middleNames?: string | undefined;
+  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;
+  residencyStatus?: string | undefined;
+  livingArrangements?: string | undefined;
+  maritalStatus?: string | undefined;
+  proportionOfSharedExpenses?: PercentageQuantity$Outbound | undefined;
+};
+
+/** @internal */
+export const CustomerAttributesCreateItem$outboundSchema: z.ZodType<
+  CustomerAttributesCreateItem$Outbound,
+  z.ZodTypeDef,
+  CustomerAttributesCreateItem
+> = z.object({
+  id: z.string().optional(),
+  title: CustomerTitle$outboundSchema.optional(),
+  firstName: z.string().optional(),
+  middleNames: z.string().optional(),
+  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(),
+  residencyStatus: ResidencyStatus$outboundSchema.optional(),
+  livingArrangements: LivingArrangements$outboundSchema.optional(),
+  maritalStatus: MaritalStatus$outboundSchema.optional(),
+  proportionOfSharedExpenses: PercentageQuantity$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerAttributesCreateItem$ {
+  /** @deprecated use `CustomerAttributesCreateItem$inboundSchema` instead. */
+  export const inboundSchema = CustomerAttributesCreateItem$inboundSchema;
+  /** @deprecated use `CustomerAttributesCreateItem$outboundSchema` instead. */
+  export const outboundSchema = CustomerAttributesCreateItem$outboundSchema;
+  /** @deprecated use `CustomerAttributesCreateItem$Outbound` instead. */
+  export type Outbound = CustomerAttributesCreateItem$Outbound;
+}
+
+export function customerAttributesCreateItemToJSON(
+  customerAttributesCreateItem: CustomerAttributesCreateItem,
+): string {
+  return JSON.stringify(
+    CustomerAttributesCreateItem$outboundSchema.parse(
+      customerAttributesCreateItem,
+    ),
+  );
+}
+
+export function customerAttributesCreateItemFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerAttributesCreateItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerAttributesCreateItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerAttributesCreateItem' from JSON`,
+  );
+}

package/src/models/components/entityattributes.ts

@@ -4,19 +4,126 @@
 
 import * as z from "zod/v3";
 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";
 
+/**
+ * Derived from ABR lookup.
+ */
+export const State = {
+  Sa: "SA",
+  Nsw: "NSW",
+  Vic: "VIC",
+  Qld: "QLD",
+  Wa: "WA",
+  Tas: "TAS",
+  Act: "ACT",
+  Nt: "NT",
+} as const;
+/**
+ * Derived from ABR lookup.
+ */
+export type State = ClosedEnum<typeof State>;
+
+/**
+ * Derived from ABR lookup.
+ */
+export const AbnStatus = {
+  Active: "active",
+  Registered: "registered",
+  Cancelled: "cancelled",
+} as const;
+/**
+ * Derived from ABR lookup.
+ */
+export type AbnStatus = ClosedEnum<typeof AbnStatus>;
+
 export type EntityAttributes = {
   id?: string | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  businessNames?: Array<string> | undefined;
   entityName?: string | undefined;
   abn?: string | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  acn?: string | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  state?: State | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  entityType?: string | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  gst?: string | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  abnStatus?: AbnStatus | undefined;
+  /**
+   * Derived from ABR lookup. Format YYYY-MM-DD
+   */
+  abnStatusEffectiveFrom?: string | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  timeInBusiness?: number | undefined;
   turnover?: number | undefined;
   industryType?: string | undefined;
+  /**
+   * Derived from ABR lookup.
+   */
+  ppsr?: string | undefined;
   emails?: Array<string> | undefined;
   phoneNumbers?: Array<string> | undefined;
 };
 
+/** @internal */
+export const State$inboundSchema: z.ZodNativeEnum<typeof State> = z.nativeEnum(
+  State,
+);
+
+/** @internal */
+export const State$outboundSchema: z.ZodNativeEnum<typeof State> =
+  State$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace State$ {
+  /** @deprecated use `State$inboundSchema` instead. */
+  export const inboundSchema = State$inboundSchema;
+  /** @deprecated use `State$outboundSchema` instead. */
+  export const outboundSchema = State$outboundSchema;
+}
+
+/** @internal */
+export const AbnStatus$inboundSchema: z.ZodNativeEnum<typeof AbnStatus> = z
+  .nativeEnum(AbnStatus);
+
+/** @internal */
+export const AbnStatus$outboundSchema: z.ZodNativeEnum<typeof AbnStatus> =
+  AbnStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AbnStatus$ {
+  /** @deprecated use `AbnStatus$inboundSchema` instead. */
+  export const inboundSchema = AbnStatus$inboundSchema;
+  /** @deprecated use `AbnStatus$outboundSchema` instead. */
+  export const outboundSchema = AbnStatus$outboundSchema;
+}
+
 /** @internal */
 export const EntityAttributes$inboundSchema: z.ZodType<
   EntityAttributes,
@@ -24,10 +131,19 @@ export const EntityAttributes$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
+  businessNames: z.array(z.string()).optional(),
   entityName: z.string().optional(),
   abn: z.string().optional(),
+  acn: z.string().optional(),
+  state: State$inboundSchema.optional(),
+  entityType: z.string().optional(),
+  gst: z.string().optional(),
+  abnStatus: AbnStatus$inboundSchema.optional(),
+  abnStatusEffectiveFrom: z.string().optional(),
+  timeInBusiness: z.number().int().optional(),
   turnover: z.number().int().optional(),
   industryType: z.string().optional(),
+  ppsr: z.string().optional(),
   emails: z.array(z.string()).optional(),
   phoneNumbers: z.array(z.string()).optional(),
 });
@@ -35,10 +151,19 @@ export const EntityAttributes$inboundSchema: z.ZodType<
 /** @internal */
 export type EntityAttributes$Outbound = {
   id?: string | undefined;
+  businessNames?: Array<string> | undefined;
   entityName?: string | undefined;
   abn?: string | undefined;
+  acn?: string | undefined;
+  state?: string | undefined;
+  entityType?: string | undefined;
+  gst?: string | undefined;
+  abnStatus?: string | undefined;
+  abnStatusEffectiveFrom?: string | undefined;
+  timeInBusiness?: number | undefined;
   turnover?: number | undefined;
   industryType?: string | undefined;
+  ppsr?: string | undefined;
   emails?: Array<string> | undefined;
   phoneNumbers?: Array<string> | undefined;
 };
@@ -50,10 +175,19 @@ export const EntityAttributes$outboundSchema: z.ZodType<
   EntityAttributes
 > = z.object({
   id: z.string().optional(),
+  businessNames: z.array(z.string()).optional(),
   entityName: z.string().optional(),
   abn: z.string().optional(),
+  acn: z.string().optional(),
+  state: State$outboundSchema.optional(),
+  entityType: z.string().optional(),
+  gst: z.string().optional(),
+  abnStatus: AbnStatus$outboundSchema.optional(),
+  abnStatusEffectiveFrom: z.string().optional(),
+  timeInBusiness: z.number().int().optional(),
   turnover: z.number().int().optional(),
   industryType: z.string().optional(),
+  ppsr: z.string().optional(),
   emails: z.array(z.string()).optional(),
   phoneNumbers: z.array(z.string()).optional(),
 });

package/src/models/components/entityattributesinput.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+export type EntityAttributesInput = {
+  id?: string | undefined;
+  entityName?: string | undefined;
+  abn?: string | undefined;
+  turnover?: number | undefined;
+  industryType?: string | undefined;
+  emails?: Array<string> | undefined;
+  phoneNumbers?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EntityAttributesInput$inboundSchema: z.ZodType<
+  EntityAttributesInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  entityName: z.string().optional(),
+  abn: z.string().optional(),
+  turnover: z.number().int().optional(),
+  industryType: z.string().optional(),
+  emails: z.array(z.string()).optional(),
+  phoneNumbers: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type EntityAttributesInput$Outbound = {
+  id?: string | undefined;
+  entityName?: string | undefined;
+  abn?: string | undefined;
+  turnover?: number | undefined;
+  industryType?: string | undefined;
+  emails?: Array<string> | undefined;
+  phoneNumbers?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EntityAttributesInput$outboundSchema: z.ZodType<
+  EntityAttributesInput$Outbound,
+  z.ZodTypeDef,
+  EntityAttributesInput
+> = z.object({
+  id: z.string().optional(),
+  entityName: z.string().optional(),
+  abn: z.string().optional(),
+  turnover: z.number().int().optional(),
+  industryType: z.string().optional(),
+  emails: z.array(z.string()).optional(),
+  phoneNumbers: z.array(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 EntityAttributesInput$ {
+  /** @deprecated use `EntityAttributesInput$inboundSchema` instead. */
+  export const inboundSchema = EntityAttributesInput$inboundSchema;
+  /** @deprecated use `EntityAttributesInput$outboundSchema` instead. */
+  export const outboundSchema = EntityAttributesInput$outboundSchema;
+  /** @deprecated use `EntityAttributesInput$Outbound` instead. */
+  export type Outbound = EntityAttributesInput$Outbound;
+}
+
+export function entityAttributesInputToJSON(
+  entityAttributesInput: EntityAttributesInput,
+): string {
+  return JSON.stringify(
+    EntityAttributesInput$outboundSchema.parse(entityAttributesInput),
+  );
+}
+
+export function entityAttributesInputFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityAttributesInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityAttributesInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityAttributesInput' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -31,6 +31,7 @@ export * from "./currencycodeiso4217.js";
 export * from "./customerassetattributes.js";
 export * from "./customerassettype.js";
 export * from "./customerattributes.js";
+export * from "./customerattributescreateitem.js";
 export * from "./customeridtype.js";
 export * from "./customerliabilityattributes.js";
 export * from "./customerliabilityrepaymentfrequency.js";
@@ -38,6 +39,7 @@ export * from "./customerliabilitytype.js";
 export * from "./customertitle.js";
 export * from "./documenttype.js";
 export * from "./entityattributes.js";
+export * from "./entityattributesinput.js";
 export * from "./errorsource.js";
 export * from "./expenseattributes.js";
 export * from "./expensefrequency.js";
@@ -52,6 +54,8 @@ export * from "./livingarrangements.js";
 export * from "./loandetailsattributes.js";
 export * from "./maritalstatus.js";
 export * from "./monetaryquantity.js";
+export * from "./paginationlinks.js";
+export * from "./paginationmeta.js";
 export * from "./percentagequantity.js";
 export * from "./personalapplicationjsonapirelationships.js";
 export * from "./personalapplicationpayload.js";

package/src/models/components/paginationlinks.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+export type PaginationLinks = {
+  /**
+   * Link to the first page of data
+   */
+  first?: string | undefined;
+  /**
+   * Link to the last page of data
+   */
+  last?: string | undefined;
+  /**
+   * Link to the next page of data
+   */
+  next?: string | undefined;
+  /**
+   * Link to the previous page of data
+   */
+  prev?: string | undefined;
+};
+
+/** @internal */
+export const PaginationLinks$inboundSchema: z.ZodType<
+  PaginationLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  first: z.string().optional(),
+  last: z.string().optional(),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+});
+
+/** @internal */
+export type PaginationLinks$Outbound = {
+  first?: string | undefined;
+  last?: string | undefined;
+  next?: string | undefined;
+  prev?: string | undefined;
+};
+
+/** @internal */
+export const PaginationLinks$outboundSchema: z.ZodType<
+  PaginationLinks$Outbound,
+  z.ZodTypeDef,
+  PaginationLinks
+> = z.object({
+  first: z.string().optional(),
+  last: z.string().optional(),
+  next: z.string().optional(),
+  prev: 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 PaginationLinks$ {
+  /** @deprecated use `PaginationLinks$inboundSchema` instead. */
+  export const inboundSchema = PaginationLinks$inboundSchema;
+  /** @deprecated use `PaginationLinks$outboundSchema` instead. */
+  export const outboundSchema = PaginationLinks$outboundSchema;
+  /** @deprecated use `PaginationLinks$Outbound` instead. */
+  export type Outbound = PaginationLinks$Outbound;
+}
+
+export function paginationLinksToJSON(
+  paginationLinks: PaginationLinks,
+): string {
+  return JSON.stringify(PaginationLinks$outboundSchema.parse(paginationLinks));
+}
+
+export function paginationLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginationLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginationLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginationLinks' from JSON`,
+  );
+}

package/src/models/components/paginationmeta.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PaginationMeta = {
+  /**
+   * Total number of records available
+   */
+  total?: number | undefined;
+  /**
+   * Number of records per page
+   */
+  perPage?: number | undefined;
+  /**
+   * Current page number
+   */
+  currentPage?: number | undefined;
+  /**
+   * Total number of pages
+   */
+  totalPages?: number | undefined;
+};
+
+/** @internal */
+export const PaginationMeta$inboundSchema: z.ZodType<
+  PaginationMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: z.number().int().optional(),
+  per_page: z.number().int().optional(),
+  current_page: z.number().int().optional(),
+  total_pages: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "per_page": "perPage",
+    "current_page": "currentPage",
+    "total_pages": "totalPages",
+  });
+});
+
+/** @internal */
+export type PaginationMeta$Outbound = {
+  total?: number | undefined;
+  per_page?: number | undefined;
+  current_page?: number | undefined;
+  total_pages?: number | undefined;
+};
+
+/** @internal */
+export const PaginationMeta$outboundSchema: z.ZodType<
+  PaginationMeta$Outbound,
+  z.ZodTypeDef,
+  PaginationMeta
+> = z.object({
+  total: z.number().int().optional(),
+  perPage: z.number().int().optional(),
+  currentPage: z.number().int().optional(),
+  totalPages: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    perPage: "per_page",
+    currentPage: "current_page",
+    totalPages: "total_pages",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaginationMeta$ {
+  /** @deprecated use `PaginationMeta$inboundSchema` instead. */
+  export const inboundSchema = PaginationMeta$inboundSchema;
+  /** @deprecated use `PaginationMeta$outboundSchema` instead. */
+  export const outboundSchema = PaginationMeta$outboundSchema;
+  /** @deprecated use `PaginationMeta$Outbound` instead. */
+  export type Outbound = PaginationMeta$Outbound;
+}
+
+export function paginationMetaToJSON(paginationMeta: PaginationMeta): string {
+  return JSON.stringify(PaginationMeta$outboundSchema.parse(paginationMeta));
+}
+
+export function paginationMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginationMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginationMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginationMeta' from JSON`,
+  );
+}