@financeable/aggregation 0.12.0 → 0.13.0

package/src/models/components/businessapplicationpayload.ts

@@ -3,19 +3,14 @@
  */
 
 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";
 import {
   BusinessLoanBusinessApplicationRelationships,
-  BusinessLoanBusinessApplicationRelationships$inboundSchema,
   BusinessLoanBusinessApplicationRelationships$Outbound,
   BusinessLoanBusinessApplicationRelationships$outboundSchema,
 } from "./businessloanbusinessapplicationrelationships.js";
 import {
   LinkObject,
-  LinkObject$inboundSchema,
   LinkObject$Outbound,
   LinkObject$outboundSchema,
 } from "./linkobject.js";
@@ -65,60 +60,16 @@ export type BusinessApplicationPayload = {
   meta?: { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export const BusinessApplicationPayloadType$inboundSchema: z.ZodNativeEnum<
-  typeof BusinessApplicationPayloadType
-> = z.nativeEnum(BusinessApplicationPayloadType);
-
 /** @internal */
 export const BusinessApplicationPayloadType$outboundSchema: z.ZodNativeEnum<
   typeof BusinessApplicationPayloadType
-> = BusinessApplicationPayloadType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace BusinessApplicationPayloadType$ {
-  /** @deprecated use `BusinessApplicationPayloadType$inboundSchema` instead. */
-  export const inboundSchema = BusinessApplicationPayloadType$inboundSchema;
-  /** @deprecated use `BusinessApplicationPayloadType$outboundSchema` instead. */
-  export const outboundSchema = BusinessApplicationPayloadType$outboundSchema;
-}
+> = z.nativeEnum(BusinessApplicationPayloadType);
 
 /** @internal */
-export const BusinessApplicationPayloadApplicationType$inboundSchema:
+export const BusinessApplicationPayloadApplicationType$outboundSchema:
   z.ZodNativeEnum<typeof BusinessApplicationPayloadApplicationType> = z
     .nativeEnum(BusinessApplicationPayloadApplicationType);
 
-/** @internal */
-export const BusinessApplicationPayloadApplicationType$outboundSchema:
-  z.ZodNativeEnum<typeof BusinessApplicationPayloadApplicationType> =
-    BusinessApplicationPayloadApplicationType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace BusinessApplicationPayloadApplicationType$ {
-  /** @deprecated use `BusinessApplicationPayloadApplicationType$inboundSchema` instead. */
-  export const inboundSchema =
-    BusinessApplicationPayloadApplicationType$inboundSchema;
-  /** @deprecated use `BusinessApplicationPayloadApplicationType$outboundSchema` instead. */
-  export const outboundSchema =
-    BusinessApplicationPayloadApplicationType$outboundSchema;
-}
-
-/** @internal */
-export const BusinessApplicationPayloadAttributes$inboundSchema: z.ZodType<
-  BusinessApplicationPayloadAttributes,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  applicationType: BusinessApplicationPayloadApplicationType$inboundSchema,
-  associatedBrokerEmail: z.string(),
-});
-
 /** @internal */
 export type BusinessApplicationPayloadAttributes$Outbound = {
   applicationType: string;
@@ -135,21 +86,6 @@ export const BusinessApplicationPayloadAttributes$outboundSchema: z.ZodType<
   associatedBrokerEmail: 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 BusinessApplicationPayloadAttributes$ {
-  /** @deprecated use `BusinessApplicationPayloadAttributes$inboundSchema` instead. */
-  export const inboundSchema =
-    BusinessApplicationPayloadAttributes$inboundSchema;
-  /** @deprecated use `BusinessApplicationPayloadAttributes$outboundSchema` instead. */
-  export const outboundSchema =
-    BusinessApplicationPayloadAttributes$outboundSchema;
-  /** @deprecated use `BusinessApplicationPayloadAttributes$Outbound` instead. */
-  export type Outbound = BusinessApplicationPayloadAttributes$Outbound;
-}
-
 export function businessApplicationPayloadAttributesToJSON(
   businessApplicationPayloadAttributes: BusinessApplicationPayloadAttributes,
 ): string {
@@ -160,31 +96,6 @@ export function businessApplicationPayloadAttributesToJSON(
   );
 }
 
-export function businessApplicationPayloadAttributesFromJSON(
-  jsonString: string,
-): SafeParseResult<BusinessApplicationPayloadAttributes, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) =>
-      BusinessApplicationPayloadAttributes$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'BusinessApplicationPayloadAttributes' from JSON`,
-  );
-}
-
-/** @internal */
-export const BusinessApplicationPayload$inboundSchema: z.ZodType<
-  BusinessApplicationPayload,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  type: BusinessApplicationPayloadType$inboundSchema,
-  attributes: z.lazy(() => BusinessApplicationPayloadAttributes$inboundSchema),
-  relationships: BusinessLoanBusinessApplicationRelationships$inboundSchema
-    .optional(),
-  links: z.record(LinkObject$inboundSchema).optional(),
-  meta: z.record(z.any()).optional(),
-});
-
 /** @internal */
 export type BusinessApplicationPayload$Outbound = {
   type: string;
@@ -210,19 +121,6 @@ export const BusinessApplicationPayload$outboundSchema: z.ZodType<
   meta: z.record(z.any()).optional(),
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace BusinessApplicationPayload$ {
-  /** @deprecated use `BusinessApplicationPayload$inboundSchema` instead. */
-  export const inboundSchema = BusinessApplicationPayload$inboundSchema;
-  /** @deprecated use `BusinessApplicationPayload$outboundSchema` instead. */
-  export const outboundSchema = BusinessApplicationPayload$outboundSchema;
-  /** @deprecated use `BusinessApplicationPayload$Outbound` instead. */
-  export type Outbound = BusinessApplicationPayload$Outbound;
-}
-
 export function businessApplicationPayloadToJSON(
   businessApplicationPayload: BusinessApplicationPayload,
 ): string {
@@ -230,13 +128,3 @@ export function businessApplicationPayloadToJSON(
     BusinessApplicationPayload$outboundSchema.parse(businessApplicationPayload),
   );
 }
-
-export function businessApplicationPayloadFromJSON(
-  jsonString: string,
-): SafeParseResult<BusinessApplicationPayload, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => BusinessApplicationPayload$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'BusinessApplicationPayload' from JSON`,
-  );
-}

package/src/models/components/businessapplicationresource.ts

@@ -10,27 +10,12 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
   ApplicationStatus,
   ApplicationStatus$inboundSchema,
-  ApplicationStatus$outboundSchema,
 } from "./applicationstatus.js";
 import {
   BusinessApplicationJsonApiRelationships,
   BusinessApplicationJsonApiRelationships$inboundSchema,
-  BusinessApplicationJsonApiRelationships$Outbound,
-  BusinessApplicationJsonApiRelationships$outboundSchema,
 } from "./businessapplicationjsonapirelationships.js";
-import {
-  LinkObject,
-  LinkObject$inboundSchema,
-  LinkObject$Outbound,
-  LinkObject$outboundSchema,
-} from "./linkobject.js";
-
-export const BusinessApplicationResourceType = {
-  BusinessApplications: "business-applications",
-} as const;
-export type BusinessApplicationResourceType = ClosedEnum<
-  typeof BusinessApplicationResourceType
->;
+import { LinkObject, LinkObject$inboundSchema } from "./linkobject.js";
 
 /**
  * Type of the loan application
@@ -50,7 +35,7 @@ export type BusinessApplicationResourceApplicationType = ClosedEnum<
  */
 export type BusinessApplicationResourceAttributes = {
   /**
-   * Full identifier of the application. Not visible within the web application.
+   * Full identifier of the application. Not visible within the web application (except via URL).
    */
   id?: string | undefined;
   /**
@@ -65,6 +50,14 @@ export type BusinessApplicationResourceAttributes = {
    * Current status, must be 'workshop' for new applications
    */
   status: ApplicationStatus;
+  /**
+   * If the application has settled with a lender, the date of the settlement, in DD/MM/YYYY format
+   */
+  settlementDate?: string | undefined;
+  /**
+   * If the application has settled with a lender, the lender's identifier of the application, distinct from Financeable's
+   */
+  lenderApplicationReference?: string | undefined;
   /**
    * Creation timestamp
    */
@@ -79,7 +72,7 @@ export type BusinessApplicationResourceAttributes = {
  * A Business Application resource following JSON:API structure
  */
 export type BusinessApplicationResource = {
-  type: BusinessApplicationResourceType;
+  type: "business-applications";
   id?: string | undefined;
   /**
    * Application resource attributes
@@ -93,50 +86,11 @@ export type BusinessApplicationResource = {
   meta?: { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export const BusinessApplicationResourceType$inboundSchema: z.ZodNativeEnum<
-  typeof BusinessApplicationResourceType
-> = z.nativeEnum(BusinessApplicationResourceType);
-
-/** @internal */
-export const BusinessApplicationResourceType$outboundSchema: z.ZodNativeEnum<
-  typeof BusinessApplicationResourceType
-> = BusinessApplicationResourceType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace BusinessApplicationResourceType$ {
-  /** @deprecated use `BusinessApplicationResourceType$inboundSchema` instead. */
-  export const inboundSchema = BusinessApplicationResourceType$inboundSchema;
-  /** @deprecated use `BusinessApplicationResourceType$outboundSchema` instead. */
-  export const outboundSchema = BusinessApplicationResourceType$outboundSchema;
-}
-
 /** @internal */
 export const BusinessApplicationResourceApplicationType$inboundSchema:
   z.ZodNativeEnum<typeof BusinessApplicationResourceApplicationType> = z
     .nativeEnum(BusinessApplicationResourceApplicationType);
 
-/** @internal */
-export const BusinessApplicationResourceApplicationType$outboundSchema:
-  z.ZodNativeEnum<typeof BusinessApplicationResourceApplicationType> =
-    BusinessApplicationResourceApplicationType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace BusinessApplicationResourceApplicationType$ {
-  /** @deprecated use `BusinessApplicationResourceApplicationType$inboundSchema` instead. */
-  export const inboundSchema =
-    BusinessApplicationResourceApplicationType$inboundSchema;
-  /** @deprecated use `BusinessApplicationResourceApplicationType$outboundSchema` instead. */
-  export const outboundSchema =
-    BusinessApplicationResourceApplicationType$outboundSchema;
-}
-
 /** @internal */
 export const BusinessApplicationResourceAttributes$inboundSchema: z.ZodType<
   BusinessApplicationResourceAttributes,
@@ -147,59 +101,12 @@ export const BusinessApplicationResourceAttributes$inboundSchema: z.ZodType<
   humanId: z.string(),
   applicationType: BusinessApplicationResourceApplicationType$inboundSchema,
   status: ApplicationStatus$inboundSchema,
+  settlementDate: z.string().optional(),
+  lenderApplicationReference: z.string().optional(),
   createdAt: z.string().optional(),
   updatedAt: z.string().optional(),
 });
 
-/** @internal */
-export type BusinessApplicationResourceAttributes$Outbound = {
-  id?: string | undefined;
-  humanId: string;
-  applicationType: string;
-  status: string;
-  createdAt?: string | undefined;
-  updatedAt?: string | undefined;
-};
-
-/** @internal */
-export const BusinessApplicationResourceAttributes$outboundSchema: z.ZodType<
-  BusinessApplicationResourceAttributes$Outbound,
-  z.ZodTypeDef,
-  BusinessApplicationResourceAttributes
-> = z.object({
-  id: z.string().optional(),
-  humanId: z.string(),
-  applicationType: BusinessApplicationResourceApplicationType$outboundSchema,
-  status: ApplicationStatus$outboundSchema,
-  createdAt: z.string().optional(),
-  updatedAt: 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 BusinessApplicationResourceAttributes$ {
-  /** @deprecated use `BusinessApplicationResourceAttributes$inboundSchema` instead. */
-  export const inboundSchema =
-    BusinessApplicationResourceAttributes$inboundSchema;
-  /** @deprecated use `BusinessApplicationResourceAttributes$outboundSchema` instead. */
-  export const outboundSchema =
-    BusinessApplicationResourceAttributes$outboundSchema;
-  /** @deprecated use `BusinessApplicationResourceAttributes$Outbound` instead. */
-  export type Outbound = BusinessApplicationResourceAttributes$Outbound;
-}
-
-export function businessApplicationResourceAttributesToJSON(
-  businessApplicationResourceAttributes: BusinessApplicationResourceAttributes,
-): string {
-  return JSON.stringify(
-    BusinessApplicationResourceAttributes$outboundSchema.parse(
-      businessApplicationResourceAttributes,
-    ),
-  );
-}
-
 export function businessApplicationResourceAttributesFromJSON(
   jsonString: string,
 ): SafeParseResult<BusinessApplicationResourceAttributes, SDKValidationError> {
@@ -217,7 +124,7 @@ export const BusinessApplicationResource$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: BusinessApplicationResourceType$inboundSchema,
+  type: z.literal("business-applications"),
   id: z.string().optional(),
   attributes: z.lazy(() => BusinessApplicationResourceAttributes$inboundSchema),
   relationships: BusinessApplicationJsonApiRelationships$inboundSchema,
@@ -225,55 +132,6 @@ export const BusinessApplicationResource$inboundSchema: z.ZodType<
   meta: z.record(z.any()).optional(),
 });
 
-/** @internal */
-export type BusinessApplicationResource$Outbound = {
-  type: string;
-  id?: string | undefined;
-  attributes: BusinessApplicationResourceAttributes$Outbound;
-  relationships: BusinessApplicationJsonApiRelationships$Outbound;
-  links?: { [k: string]: LinkObject$Outbound } | undefined;
-  meta?: { [k: string]: any } | undefined;
-};
-
-/** @internal */
-export const BusinessApplicationResource$outboundSchema: z.ZodType<
-  BusinessApplicationResource$Outbound,
-  z.ZodTypeDef,
-  BusinessApplicationResource
-> = z.object({
-  type: BusinessApplicationResourceType$outboundSchema,
-  id: z.string().optional(),
-  attributes: z.lazy(() =>
-    BusinessApplicationResourceAttributes$outboundSchema
-  ),
-  relationships: BusinessApplicationJsonApiRelationships$outboundSchema,
-  links: z.record(LinkObject$outboundSchema).optional(),
-  meta: z.record(z.any()).optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace BusinessApplicationResource$ {
-  /** @deprecated use `BusinessApplicationResource$inboundSchema` instead. */
-  export const inboundSchema = BusinessApplicationResource$inboundSchema;
-  /** @deprecated use `BusinessApplicationResource$outboundSchema` instead. */
-  export const outboundSchema = BusinessApplicationResource$outboundSchema;
-  /** @deprecated use `BusinessApplicationResource$Outbound` instead. */
-  export type Outbound = BusinessApplicationResource$Outbound;
-}
-
-export function businessApplicationResourceToJSON(
-  businessApplicationResource: BusinessApplicationResource,
-): string {
-  return JSON.stringify(
-    BusinessApplicationResource$outboundSchema.parse(
-      businessApplicationResource,
-    ),
-  );
-}
-
 export function businessApplicationResourceFromJSON(
   jsonString: string,
 ): SafeParseResult<BusinessApplicationResource, SDKValidationError> {