@financeable/aggregation 0.6.0 → 0.6.1

package/src/models/components/createsupportingdocumentsresponse.ts

@@ -19,17 +19,34 @@ import {
   SupportingDocumentAttributes$Outbound,
   SupportingDocumentAttributes$outboundSchema,
 } from "./supportingdocumentattributes.js";
+import {
+  SupportingDocumentRelationships,
+  SupportingDocumentRelationships$inboundSchema,
+  SupportingDocumentRelationships$Outbound,
+  SupportingDocumentRelationships$outboundSchema,
+} from "./supportingdocumentrelationships.js";
 
+/**
+ * Resource types used in the API
+ */
 export const CreateSupportingDocumentsResponseType = {
+  ConsumerSecuredApplications: "consumer-secured-applications",
+  CommercialSecuredApplications: "commercial-secured-applications",
   SupportingDocuments: "supporting-documents",
+  Customers: "customers",
+  Assets: "assets",
+  Entities: "entities",
+  LoanDetails: "loan-details",
+  Addresses: "addresses",
 } as const;
+/**
+ * Resource types used in the API
+ */
 export type CreateSupportingDocumentsResponseType = ClosedEnum<
   typeof CreateSupportingDocumentsResponseType
 >;
 
-export type Relationships = {};
-
-export type CreateSupportingDocumentsResponseLinks = {
+export type Links = {
   /**
    * Standard link object
    */
@@ -38,10 +55,10 @@ export type CreateSupportingDocumentsResponseLinks = {
 
 export type CreateSupportingDocumentsResponse = {
   type: CreateSupportingDocumentsResponseType;
-  id: string;
-  attributes?: SupportingDocumentAttributes | undefined;
-  relationships: Relationships;
-  links?: { [k: string]: CreateSupportingDocumentsResponseLinks } | undefined;
+  id?: string | undefined;
+  attributes: SupportingDocumentAttributes;
+  relationships: SupportingDocumentRelationships;
+  links?: Links | undefined;
   meta?: { [k: string]: any } | undefined;
 };
 
@@ -70,68 +87,21 @@ export namespace CreateSupportingDocumentsResponseType$ {
 }
 
 /** @internal */
-export const Relationships$inboundSchema: z.ZodType<
-  Relationships,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type Relationships$Outbound = {};
+export const Links$inboundSchema: z.ZodType<Links, z.ZodTypeDef, unknown> = z
+  .object({
+    upload: LinkObject$inboundSchema,
+  });
 
 /** @internal */
-export const Relationships$outboundSchema: z.ZodType<
-  Relationships$Outbound,
-  z.ZodTypeDef,
-  Relationships
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Relationships$ {
-  /** @deprecated use `Relationships$inboundSchema` instead. */
-  export const inboundSchema = Relationships$inboundSchema;
-  /** @deprecated use `Relationships$outboundSchema` instead. */
-  export const outboundSchema = Relationships$outboundSchema;
-  /** @deprecated use `Relationships$Outbound` instead. */
-  export type Outbound = Relationships$Outbound;
-}
-
-export function relationshipsToJSON(relationships: Relationships): string {
-  return JSON.stringify(Relationships$outboundSchema.parse(relationships));
-}
-
-export function relationshipsFromJSON(
-  jsonString: string,
-): SafeParseResult<Relationships, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Relationships$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Relationships' from JSON`,
-  );
-}
-
-/** @internal */
-export const CreateSupportingDocumentsResponseLinks$inboundSchema: z.ZodType<
-  CreateSupportingDocumentsResponseLinks,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  upload: LinkObject$inboundSchema,
-});
-
-/** @internal */
-export type CreateSupportingDocumentsResponseLinks$Outbound = {
+export type Links$Outbound = {
   upload: LinkObject$Outbound;
 };
 
 /** @internal */
-export const CreateSupportingDocumentsResponseLinks$outboundSchema: z.ZodType<
-  CreateSupportingDocumentsResponseLinks$Outbound,
+export const Links$outboundSchema: z.ZodType<
+  Links$Outbound,
   z.ZodTypeDef,
-  CreateSupportingDocumentsResponseLinks
+  Links
 > = z.object({
   upload: LinkObject$outboundSchema,
 });
@@ -140,36 +110,26 @@ export const CreateSupportingDocumentsResponseLinks$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace CreateSupportingDocumentsResponseLinks$ {
-  /** @deprecated use `CreateSupportingDocumentsResponseLinks$inboundSchema` instead. */
-  export const inboundSchema =
-    CreateSupportingDocumentsResponseLinks$inboundSchema;
-  /** @deprecated use `CreateSupportingDocumentsResponseLinks$outboundSchema` instead. */
-  export const outboundSchema =
-    CreateSupportingDocumentsResponseLinks$outboundSchema;
-  /** @deprecated use `CreateSupportingDocumentsResponseLinks$Outbound` instead. */
-  export type Outbound = CreateSupportingDocumentsResponseLinks$Outbound;
+export namespace Links$ {
+  /** @deprecated use `Links$inboundSchema` instead. */
+  export const inboundSchema = Links$inboundSchema;
+  /** @deprecated use `Links$outboundSchema` instead. */
+  export const outboundSchema = Links$outboundSchema;
+  /** @deprecated use `Links$Outbound` instead. */
+  export type Outbound = Links$Outbound;
 }
 
-export function createSupportingDocumentsResponseLinksToJSON(
-  createSupportingDocumentsResponseLinks:
-    CreateSupportingDocumentsResponseLinks,
-): string {
-  return JSON.stringify(
-    CreateSupportingDocumentsResponseLinks$outboundSchema.parse(
-      createSupportingDocumentsResponseLinks,
-    ),
-  );
+export function linksToJSON(links: Links): string {
+  return JSON.stringify(Links$outboundSchema.parse(links));
 }
 
-export function createSupportingDocumentsResponseLinksFromJSON(
+export function linksFromJSON(
   jsonString: string,
-): SafeParseResult<CreateSupportingDocumentsResponseLinks, SDKValidationError> {
+): SafeParseResult<Links, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) =>
-      CreateSupportingDocumentsResponseLinks$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'CreateSupportingDocumentsResponseLinks' from JSON`,
+    (x) => Links$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Links' from JSON`,
   );
 }
 
@@ -180,24 +140,20 @@ export const CreateSupportingDocumentsResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   type: CreateSupportingDocumentsResponseType$inboundSchema,
-  id: z.string(),
-  attributes: SupportingDocumentAttributes$inboundSchema.optional(),
-  relationships: z.lazy(() => Relationships$inboundSchema),
-  links: z.record(
-    z.lazy(() => CreateSupportingDocumentsResponseLinks$inboundSchema),
-  ).optional(),
+  id: z.string().optional(),
+  attributes: SupportingDocumentAttributes$inboundSchema,
+  relationships: SupportingDocumentRelationships$inboundSchema,
+  links: z.lazy(() => Links$inboundSchema).optional(),
   meta: z.record(z.any()).optional(),
 });
 
 /** @internal */
 export type CreateSupportingDocumentsResponse$Outbound = {
   type: string;
-  id: string;
-  attributes?: SupportingDocumentAttributes$Outbound | undefined;
-  relationships: Relationships$Outbound;
-  links?:
-    | { [k: string]: CreateSupportingDocumentsResponseLinks$Outbound }
-    | undefined;
+  id?: string | undefined;
+  attributes: SupportingDocumentAttributes$Outbound;
+  relationships: SupportingDocumentRelationships$Outbound;
+  links?: Links$Outbound | undefined;
   meta?: { [k: string]: any } | undefined;
 };
 
@@ -208,12 +164,10 @@ export const CreateSupportingDocumentsResponse$outboundSchema: z.ZodType<
   CreateSupportingDocumentsResponse
 > = z.object({
   type: CreateSupportingDocumentsResponseType$outboundSchema,
-  id: z.string(),
-  attributes: SupportingDocumentAttributes$outboundSchema.optional(),
-  relationships: z.lazy(() => Relationships$outboundSchema),
-  links: z.record(
-    z.lazy(() => CreateSupportingDocumentsResponseLinks$outboundSchema),
-  ).optional(),
+  id: z.string().optional(),
+  attributes: SupportingDocumentAttributes$outboundSchema,
+  relationships: SupportingDocumentRelationships$outboundSchema,
+  links: z.lazy(() => Links$outboundSchema).optional(),
   meta: z.record(z.any()).optional(),
 });
 

package/src/models/components/customerattributes.ts

@@ -21,6 +21,7 @@ import {
  * A customer of the proposed financing
  */
 export type CustomerAttributes = {
+  id: string;
   /**
    * Title of the customer
    */
@@ -69,6 +70,7 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   title: CustomerTitle$inboundSchema,
   firstName: z.string(),
   middleNames: z.string().optional(),
@@ -83,6 +85,7 @@ export const CustomerAttributes$inboundSchema: z.ZodType<
 
 /** @internal */
 export type CustomerAttributes$Outbound = {
+  id: string;
   title: string;
   firstName: string;
   middleNames?: string | undefined;
@@ -101,6 +104,7 @@ export const CustomerAttributes$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CustomerAttributes
 > = z.object({
+  id: z.string(),
   title: CustomerTitle$outboundSchema,
   firstName: z.string(),
   middleNames: z.string().optional(),

package/src/models/components/entityattributes.ts

@@ -8,6 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EntityAttributes = {
+  id: string;
   entityName: string;
   abn: string;
   turnover?: number | undefined;
@@ -22,6 +23,7 @@ export const EntityAttributes$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   entityName: z.string(),
   abn: z.string(),
   turnover: z.number().int().optional(),
@@ -32,6 +34,7 @@ export const EntityAttributes$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntityAttributes$Outbound = {
+  id: string;
   entityName: string;
   abn: string;
   turnover?: number | undefined;
@@ -46,6 +49,7 @@ export const EntityAttributes$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityAttributes
 > = z.object({
+  id: z.string(),
   entityName: z.string(),
   abn: z.string(),
   turnover: z.number().int().optional(),

package/src/models/components/index.ts

@@ -9,14 +9,14 @@ export * from "./applicationstatus.js";
 export * from "./australianstatesandterritories.js";
 export * from "./badrequesterror.js";
 export * from "./commercialapplicationjsonapirelationships.js";
-export * from "./commercialapplicationresource.js";
-export * from "./commercialsecuredloanapplicationsubmissionpayload.js";
+export * from "./commercialsecuredapplicationpayload.js";
+export * from "./commercialsecuredapplicationresource.js";
 export * from "./commercialsecuredloanassetattributes.js";
 export * from "./commercialsecuredloanassettype.js";
 export * from "./commercialsecuredloancommercialapplicationrelationships.js";
 export * from "./consumerapplicationjsonapirelationships.js";
-export * from "./consumerapplicationresource.js";
-export * from "./consumersecuredloanapplicationsubmissionpayload.js";
+export * from "./consumersecuredapplicationpayload.js";
+export * from "./consumersecuredapplicationresource.js";
 export * from "./consumersecuredloanassetattributes.js";
 export * from "./consumersecuredloanassettype.js";
 export * from "./consumersecuredloanconsumerapplicationrelationships.js";
@@ -34,7 +34,6 @@ export * from "./loandetailsattributes.js";
 export * from "./relationshipresourcenotfound.js";
 export * from "./repaymentstructure.js";
 export * from "./resourcenotfound.js";
-export * from "./resourcetypes.js";
 export * from "./security.js";
 export * from "./supportingdocumentattributes.js";
 export * from "./supportingdocumentattributesinput.js";

package/src/models/components/loandetailsattributes.ts

@@ -21,6 +21,7 @@ import {
  * Loan details model
  */
 export type LoanDetailsAttributes = {
+  id: string;
   /**
    * Number of repayments as integer
    */
@@ -93,6 +94,7 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   repayments: z.number().int().optional(),
   repaymentFrequency: FrequencyType$inboundSchema.optional(),
   repaymentStructure: RepaymentStructure$inboundSchema.optional(),
@@ -113,6 +115,7 @@ export const LoanDetailsAttributes$inboundSchema: z.ZodType<
 
 /** @internal */
 export type LoanDetailsAttributes$Outbound = {
+  id: string;
   repayments?: number | undefined;
   repaymentFrequency?: string | undefined;
   repaymentStructure?: string | undefined;
@@ -137,6 +140,7 @@ export const LoanDetailsAttributes$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   LoanDetailsAttributes
 > = z.object({
+  id: z.string(),
   repayments: z.number().int().optional(),
   repaymentFrequency: FrequencyType$outboundSchema.optional(),
   repaymentStructure: RepaymentStructure$outboundSchema.optional(),

package/src/models/components/supportingdocumentresource.ts

@@ -7,6 +7,12 @@ 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 {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
 import {
   SupportingDocumentAttributesInput,
   SupportingDocumentAttributesInput$inboundSchema,
@@ -25,13 +31,11 @@ export const Type = {
 } as const;
 export type Type = ClosedEnum<typeof Type>;
 
-export type Links = {};
-
 export type SupportingDocumentResource = {
   type: Type;
-  attributes?: SupportingDocumentAttributesInput | undefined;
+  attributes: SupportingDocumentAttributesInput;
   relationships: SupportingDocumentRelationships;
-  links?: { [k: string]: Links } | undefined;
+  links?: { [k: string]: LinkObject } | undefined;
   meta?: { [k: string]: any } | undefined;
 };
 
@@ -55,47 +59,6 @@ export namespace Type$ {
   export const outboundSchema = Type$outboundSchema;
 }
 
-/** @internal */
-export const Links$inboundSchema: z.ZodType<Links, z.ZodTypeDef, unknown> = z
-  .object({});
-
-/** @internal */
-export type Links$Outbound = {};
-
-/** @internal */
-export const Links$outboundSchema: z.ZodType<
-  Links$Outbound,
-  z.ZodTypeDef,
-  Links
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Links$ {
-  /** @deprecated use `Links$inboundSchema` instead. */
-  export const inboundSchema = Links$inboundSchema;
-  /** @deprecated use `Links$outboundSchema` instead. */
-  export const outboundSchema = Links$outboundSchema;
-  /** @deprecated use `Links$Outbound` instead. */
-  export type Outbound = Links$Outbound;
-}
-
-export function linksToJSON(links: Links): string {
-  return JSON.stringify(Links$outboundSchema.parse(links));
-}
-
-export function linksFromJSON(
-  jsonString: string,
-): SafeParseResult<Links, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Links$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Links' from JSON`,
-  );
-}
-
 /** @internal */
 export const SupportingDocumentResource$inboundSchema: z.ZodType<
   SupportingDocumentResource,
@@ -103,18 +66,18 @@ export const SupportingDocumentResource$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   type: Type$inboundSchema,
-  attributes: SupportingDocumentAttributesInput$inboundSchema.optional(),
+  attributes: SupportingDocumentAttributesInput$inboundSchema,
   relationships: SupportingDocumentRelationships$inboundSchema,
-  links: z.record(z.lazy(() => Links$inboundSchema)).optional(),
+  links: z.record(LinkObject$inboundSchema).optional(),
   meta: z.record(z.any()).optional(),
 });
 
 /** @internal */
 export type SupportingDocumentResource$Outbound = {
   type: string;
-  attributes?: SupportingDocumentAttributesInput$Outbound | undefined;
+  attributes: SupportingDocumentAttributesInput$Outbound;
   relationships: SupportingDocumentRelationships$Outbound;
-  links?: { [k: string]: Links$Outbound } | undefined;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
   meta?: { [k: string]: any } | undefined;
 };
 
@@ -125,9 +88,9 @@ export const SupportingDocumentResource$outboundSchema: z.ZodType<
   SupportingDocumentResource
 > = z.object({
   type: Type$outboundSchema,
-  attributes: SupportingDocumentAttributesInput$outboundSchema.optional(),
+  attributes: SupportingDocumentAttributesInput$outboundSchema,
   relationships: SupportingDocumentRelationships$outboundSchema,
-  links: z.record(z.lazy(() => Links$outboundSchema)).optional(),
+  links: z.record(LinkObject$outboundSchema).optional(),
   meta: z.record(z.any()).optional(),
 });
 

package/src/models/errors/createapplication.ts

@@ -5,6 +5,35 @@
 import * as z from "zod";
 import * as components from "../components/index.js";
 
+/**
+ * The server cannot find the requested resource.
+ */
+export type CreateApplicationApplicationsResponseBodyData = {
+  errors: Array<components.ResourceNotFound>;
+};
+
+/**
+ * The server cannot find the requested resource.
+ */
+export class CreateApplicationApplicationsResponseBody extends Error {
+  errors: Array<components.ResourceNotFound>;
+
+  /** The original data that was passed to this error instance. */
+  data$: CreateApplicationApplicationsResponseBodyData;
+
+  constructor(err: CreateApplicationApplicationsResponseBodyData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    this.errors = err.errors;
+
+    this.name = "CreateApplicationApplicationsResponseBody";
+  }
+}
+
 /**
  * Access is forbidden.
  */
@@ -34,6 +63,50 @@ export class CreateApplicationResponseBody extends Error {
   }
 }
 
+/** @internal */
+export const CreateApplicationApplicationsResponseBody$inboundSchema: z.ZodType<
+  CreateApplicationApplicationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  errors: z.array(components.ResourceNotFound$inboundSchema),
+})
+  .transform((v) => {
+    return new CreateApplicationApplicationsResponseBody(v);
+  });
+
+/** @internal */
+export type CreateApplicationApplicationsResponseBody$Outbound = {
+  errors: Array<components.ResourceNotFound$Outbound>;
+};
+
+/** @internal */
+export const CreateApplicationApplicationsResponseBody$outboundSchema:
+  z.ZodType<
+    CreateApplicationApplicationsResponseBody$Outbound,
+    z.ZodTypeDef,
+    CreateApplicationApplicationsResponseBody
+  > = z.instanceof(CreateApplicationApplicationsResponseBody)
+    .transform(v => v.data$)
+    .pipe(z.object({
+      errors: z.array(components.ResourceNotFound$outboundSchema),
+    }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateApplicationApplicationsResponseBody$ {
+  /** @deprecated use `CreateApplicationApplicationsResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    CreateApplicationApplicationsResponseBody$inboundSchema;
+  /** @deprecated use `CreateApplicationApplicationsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateApplicationApplicationsResponseBody$outboundSchema;
+  /** @deprecated use `CreateApplicationApplicationsResponseBody$Outbound` instead. */
+  export type Outbound = CreateApplicationApplicationsResponseBody$Outbound;
+}
+
 /** @internal */
 export const CreateApplicationResponseBody$inboundSchema: z.ZodType<
   CreateApplicationResponseBody,