@financeable/aggregation 0.6.0 → 0.6.12

package/src/models/components/consumersecuredapplicationresource.ts

@@ -0,0 +1,309 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  ApplicationStatus,
+  ApplicationStatus$inboundSchema,
+  ApplicationStatus$outboundSchema,
+} from "./applicationstatus.js";
+import {
+  ConsumerApplicationJsonApiRelationships,
+  ConsumerApplicationJsonApiRelationships$inboundSchema,
+  ConsumerApplicationJsonApiRelationships$Outbound,
+  ConsumerApplicationJsonApiRelationships$outboundSchema,
+} from "./consumerapplicationjsonapirelationships.js";
+import {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
+
+export const ConsumerSecuredApplicationResourceType = {
+  ConsumerSecuredApplications: "consumer-secured-applications",
+} as const;
+export type ConsumerSecuredApplicationResourceType = ClosedEnum<
+  typeof ConsumerSecuredApplicationResourceType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const ConsumerSecuredApplicationResourceApplicationType = {
+  ConsumerSecured: "consumerSecured",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type ConsumerSecuredApplicationResourceApplicationType = ClosedEnum<
+  typeof ConsumerSecuredApplicationResourceApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type ConsumerSecuredApplicationResourceAttributes = {
+  /**
+   * Full identifier of the application. Not visible within the web application.
+   */
+  id: string;
+  /**
+   * Human readable & easily communicated identifier of the application. Visible within the web application.
+   */
+  humanId: string;
+  /**
+   * Type of the loan application
+   */
+  applicationType: ConsumerSecuredApplicationResourceApplicationType;
+  /**
+   * Current status, must be 'workshop' for new applications
+   */
+  status: ApplicationStatus;
+  /**
+   * Email address of the broker to be associated with this application.
+   */
+  associatedBrokerEmail?: string | undefined;
+  /**
+   * Creation timestamp
+   */
+  createdAt?: string | undefined;
+  /**
+   * Last update timestamp
+   */
+  updatedAt?: string | undefined;
+};
+
+/**
+ * A Consumer Application resource following JSON:API structure
+ */
+export type ConsumerSecuredApplicationResource = {
+  type: ConsumerSecuredApplicationResourceType;
+  id?: string | undefined;
+  /**
+   * Application resource attributes
+   */
+  attributes: ConsumerSecuredApplicationResourceAttributes;
+  /**
+   * Relationships for a Consumer Application Resource
+   */
+  relationships: ConsumerApplicationJsonApiRelationships;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ConsumerSecuredApplicationResourceType$inboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationResourceType> = z.nativeEnum(
+    ConsumerSecuredApplicationResourceType,
+  );
+
+/** @internal */
+export const ConsumerSecuredApplicationResourceType$outboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationResourceType> =
+    ConsumerSecuredApplicationResourceType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConsumerSecuredApplicationResourceType$ {
+  /** @deprecated use `ConsumerSecuredApplicationResourceType$inboundSchema` instead. */
+  export const inboundSchema =
+    ConsumerSecuredApplicationResourceType$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationResourceType$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationResourceType$outboundSchema;
+}
+
+/** @internal */
+export const ConsumerSecuredApplicationResourceApplicationType$inboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationResourceApplicationType> = z
+    .nativeEnum(ConsumerSecuredApplicationResourceApplicationType);
+
+/** @internal */
+export const ConsumerSecuredApplicationResourceApplicationType$outboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationResourceApplicationType> =
+    ConsumerSecuredApplicationResourceApplicationType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConsumerSecuredApplicationResourceApplicationType$ {
+  /** @deprecated use `ConsumerSecuredApplicationResourceApplicationType$inboundSchema` instead. */
+  export const inboundSchema =
+    ConsumerSecuredApplicationResourceApplicationType$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationResourceApplicationType$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationResourceApplicationType$outboundSchema;
+}
+
+/** @internal */
+export const ConsumerSecuredApplicationResourceAttributes$inboundSchema:
+  z.ZodType<
+    ConsumerSecuredApplicationResourceAttributes,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    id: z.string(),
+    humanId: z.string(),
+    applicationType:
+      ConsumerSecuredApplicationResourceApplicationType$inboundSchema,
+    status: ApplicationStatus$inboundSchema,
+    associatedBrokerEmail: z.string().optional(),
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
+  });
+
+/** @internal */
+export type ConsumerSecuredApplicationResourceAttributes$Outbound = {
+  id: string;
+  humanId: string;
+  applicationType: string;
+  status: string;
+  associatedBrokerEmail?: string | undefined;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const ConsumerSecuredApplicationResourceAttributes$outboundSchema:
+  z.ZodType<
+    ConsumerSecuredApplicationResourceAttributes$Outbound,
+    z.ZodTypeDef,
+    ConsumerSecuredApplicationResourceAttributes
+  > = z.object({
+    id: z.string(),
+    humanId: z.string(),
+    applicationType:
+      ConsumerSecuredApplicationResourceApplicationType$outboundSchema,
+    status: ApplicationStatus$outboundSchema,
+    associatedBrokerEmail: z.string().optional(),
+    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 ConsumerSecuredApplicationResourceAttributes$ {
+  /** @deprecated use `ConsumerSecuredApplicationResourceAttributes$inboundSchema` instead. */
+  export const inboundSchema =
+    ConsumerSecuredApplicationResourceAttributes$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationResourceAttributes$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationResourceAttributes$outboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationResourceAttributes$Outbound` instead. */
+  export type Outbound = ConsumerSecuredApplicationResourceAttributes$Outbound;
+}
+
+export function consumerSecuredApplicationResourceAttributesToJSON(
+  consumerSecuredApplicationResourceAttributes:
+    ConsumerSecuredApplicationResourceAttributes,
+): string {
+  return JSON.stringify(
+    ConsumerSecuredApplicationResourceAttributes$outboundSchema.parse(
+      consumerSecuredApplicationResourceAttributes,
+    ),
+  );
+}
+
+export function consumerSecuredApplicationResourceAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ConsumerSecuredApplicationResourceAttributes,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ConsumerSecuredApplicationResourceAttributes$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ConsumerSecuredApplicationResourceAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConsumerSecuredApplicationResource$inboundSchema: z.ZodType<
+  ConsumerSecuredApplicationResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: ConsumerSecuredApplicationResourceType$inboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() =>
+    ConsumerSecuredApplicationResourceAttributes$inboundSchema
+  ),
+  relationships: ConsumerApplicationJsonApiRelationships$inboundSchema,
+  links: z.record(LinkObject$inboundSchema).optional(),
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type ConsumerSecuredApplicationResource$Outbound = {
+  type: string;
+  id?: string | undefined;
+  attributes: ConsumerSecuredApplicationResourceAttributes$Outbound;
+  relationships: ConsumerApplicationJsonApiRelationships$Outbound;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ConsumerSecuredApplicationResource$outboundSchema: z.ZodType<
+  ConsumerSecuredApplicationResource$Outbound,
+  z.ZodTypeDef,
+  ConsumerSecuredApplicationResource
+> = z.object({
+  type: ConsumerSecuredApplicationResourceType$outboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() =>
+    ConsumerSecuredApplicationResourceAttributes$outboundSchema
+  ),
+  relationships: ConsumerApplicationJsonApiRelationships$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 ConsumerSecuredApplicationResource$ {
+  /** @deprecated use `ConsumerSecuredApplicationResource$inboundSchema` instead. */
+  export const inboundSchema = ConsumerSecuredApplicationResource$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationResource$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationResource$outboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationResource$Outbound` instead. */
+  export type Outbound = ConsumerSecuredApplicationResource$Outbound;
+}
+
+export function consumerSecuredApplicationResourceToJSON(
+  consumerSecuredApplicationResource: ConsumerSecuredApplicationResource,
+): string {
+  return JSON.stringify(
+    ConsumerSecuredApplicationResource$outboundSchema.parse(
+      consumerSecuredApplicationResource,
+    ),
+  );
+}
+
+export function consumerSecuredApplicationResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsumerSecuredApplicationResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ConsumerSecuredApplicationResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsumerSecuredApplicationResource' from JSON`,
+  );
+}

package/src/models/components/consumersecuredloanassetattributes.ts

@@ -52,6 +52,7 @@ export type ConsumerSecuredLoanAssetAttributesRegistrationState = ClosedEnum<
  * The asset to be obtained by the customer, using the proposed loan financing.
  */
 export type ConsumerSecuredLoanAssetAttributes = {
+  id: string;
   /**
    * Current age of asset as number (integer) of years
    */
@@ -204,6 +205,7 @@ export const ConsumerSecuredLoanAssetAttributes$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   ageOfAsset: z.number().int(),
   ageOfAssetAtEnd: z.number().int(),
   condition: ConsumerSecuredLoanAssetAttributesCondition$inboundSchema,
@@ -234,6 +236,7 @@ export const ConsumerSecuredLoanAssetAttributes$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ConsumerSecuredLoanAssetAttributes$Outbound = {
+  id: string;
   ageOfAsset: number;
   ageOfAssetAtEnd: number;
   condition: string;
@@ -266,6 +269,7 @@ export const ConsumerSecuredLoanAssetAttributes$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ConsumerSecuredLoanAssetAttributes
 > = z.object({
+  id: z.string(),
   ageOfAsset: z.number().int(),
   ageOfAssetAtEnd: z.number().int(),
   condition: ConsumerSecuredLoanAssetAttributesCondition$outboundSchema,

package/src/models/components/consumersecuredloanconsumerapplicationrelationships.ts

@@ -25,6 +25,12 @@ import {
   CustomerAttributes$Outbound,
   CustomerAttributes$outboundSchema,
 } from "./customerattributes.js";
+import {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
 import {
   LoanDetailsAttributes,
   LoanDetailsAttributes$inboundSchema,
@@ -45,6 +51,8 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsData = {
    */
   attributes: LoanDetailsAttributes;
   relationships?: any | null | undefined;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
 };
 
 export type ConsumerSecuredLoanConsumerApplicationRelationshipsLoanDetails = {
@@ -74,6 +82,8 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersDataData
     type: ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersDataType;
     attributes: AddressAttributes;
     relationships?: any | null | undefined;
+    links?: { [k: string]: LinkObject } | undefined;
+    meta?: { [k: string]: any } | undefined;
   };
 
 export type ConsumerSecuredLoanConsumerApplicationRelationshipsAddresses = {
@@ -94,9 +104,10 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersData = {
    * A customer of the proposed financing
    */
   attributes: CustomerAttributes;
-  relationships?:
-    | ConsumerSecuredLoanConsumerApplicationRelationshipsRelationships
-    | undefined;
+  relationships:
+    ConsumerSecuredLoanConsumerApplicationRelationshipsRelationships;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
 };
 
 export type ConsumerSecuredLoanConsumerApplicationRelationshipsCustomers = {
@@ -118,6 +129,8 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsAssetData = {
    */
   attributes: ConsumerSecuredLoanAssetAttributes;
   relationships?: any | null | undefined;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
 };
 
 export type ConsumerSecuredLoanConsumerApplicationRelationshipsAsset = {
@@ -169,6 +182,8 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsData$inboundSche
     type: ConsumerSecuredLoanConsumerApplicationRelationshipsType$inboundSchema,
     attributes: LoanDetailsAttributes$inboundSchema,
     relationships: z.nullable(z.any()).optional(),
+    links: z.record(LinkObject$inboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /** @internal */
@@ -176,6 +191,8 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsData$Outbound = {
   type: string;
   attributes: LoanDetailsAttributes$Outbound;
   relationships?: any | null | undefined;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -189,6 +206,8 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsData$outboundSch
       ConsumerSecuredLoanConsumerApplicationRelationshipsType$outboundSchema,
     attributes: LoanDetailsAttributes$outboundSchema,
     relationships: z.nullable(z.any()).optional(),
+    links: z.record(LinkObject$outboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /**
@@ -370,6 +389,8 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersDataDat
       ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersDataType$inboundSchema,
     attributes: AddressAttributes$inboundSchema,
     relationships: z.nullable(z.any()).optional(),
+    links: z.record(LinkObject$inboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /** @internal */
@@ -378,6 +399,8 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersDataData
     type: string;
     attributes: AddressAttributes$Outbound;
     relationships?: any | null | undefined;
+    links?: { [k: string]: LinkObject$Outbound } | undefined;
+    meta?: { [k: string]: any } | undefined;
   };
 
 /** @internal */
@@ -391,6 +414,8 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersDataDat
       ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersDataType$outboundSchema,
     attributes: AddressAttributes$outboundSchema,
     relationships: z.nullable(z.any()).optional(),
+    links: z.record(LinkObject$outboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /**
@@ -598,7 +623,9 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersData$in
     attributes: CustomerAttributes$inboundSchema,
     relationships: z.lazy(() =>
       ConsumerSecuredLoanConsumerApplicationRelationshipsRelationships$inboundSchema
-    ).optional(),
+    ),
+    links: z.record(LinkObject$inboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /** @internal */
@@ -606,9 +633,10 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersData$Out
   {
     type: string;
     attributes: CustomerAttributes$Outbound;
-    relationships?:
-      | ConsumerSecuredLoanConsumerApplicationRelationshipsRelationships$Outbound
-      | undefined;
+    relationships:
+      ConsumerSecuredLoanConsumerApplicationRelationshipsRelationships$Outbound;
+    links?: { [k: string]: LinkObject$Outbound } | undefined;
+    meta?: { [k: string]: any } | undefined;
   };
 
 /** @internal */
@@ -623,7 +651,9 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsCustomersData$ou
     attributes: CustomerAttributes$outboundSchema,
     relationships: z.lazy(() =>
       ConsumerSecuredLoanConsumerApplicationRelationshipsRelationships$outboundSchema
-    ).optional(),
+    ),
+    links: z.record(LinkObject$outboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /**
@@ -783,6 +813,8 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsAssetData$inboun
       ConsumerSecuredLoanConsumerApplicationRelationshipsAssetType$inboundSchema,
     attributes: ConsumerSecuredLoanAssetAttributes$inboundSchema,
     relationships: z.nullable(z.any()).optional(),
+    links: z.record(LinkObject$inboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /** @internal */
@@ -791,6 +823,8 @@ export type ConsumerSecuredLoanConsumerApplicationRelationshipsAssetData$Outboun
     type: string;
     attributes: ConsumerSecuredLoanAssetAttributes$Outbound;
     relationships?: any | null | undefined;
+    links?: { [k: string]: LinkObject$Outbound } | undefined;
+    meta?: { [k: string]: any } | undefined;
   };
 
 /** @internal */
@@ -804,6 +838,8 @@ export const ConsumerSecuredLoanConsumerApplicationRelationshipsAssetData$outbou
       ConsumerSecuredLoanConsumerApplicationRelationshipsAssetType$outboundSchema,
     attributes: ConsumerSecuredLoanAssetAttributes$outboundSchema,
     relationships: z.nullable(z.any()).optional(),
+    links: z.record(LinkObject$outboundSchema).optional(),
+    meta: z.record(z.any()).optional(),
   });
 
 /**