@financeable/aggregation 0.5.1 → 0.6.1

package/src/models/components/consumersecuredapplicationpayload.ts

@@ -0,0 +1,273 @@
+/*
+ * 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 {
+  ConsumerSecuredLoanConsumerApplicationRelationships,
+  ConsumerSecuredLoanConsumerApplicationRelationships$inboundSchema,
+  ConsumerSecuredLoanConsumerApplicationRelationships$Outbound,
+  ConsumerSecuredLoanConsumerApplicationRelationships$outboundSchema,
+} from "./consumersecuredloanconsumerapplicationrelationships.js";
+import {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
+
+/**
+ * Resource types used in the API
+ */
+export const ConsumerSecuredApplicationPayloadType = {
+  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 ConsumerSecuredApplicationPayloadType = ClosedEnum<
+  typeof ConsumerSecuredApplicationPayloadType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const ConsumerSecuredApplicationPayloadApplicationType = {
+  ConsumerSecured: "consumerSecured",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type ConsumerSecuredApplicationPayloadApplicationType = ClosedEnum<
+  typeof ConsumerSecuredApplicationPayloadApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type ConsumerSecuredApplicationPayloadAttributes = {
+  /**
+   * Type of the loan application
+   */
+  applicationType: ConsumerSecuredApplicationPayloadApplicationType;
+  /**
+   * Email address of the broker to be associated with this application.
+   */
+  associatedBrokerEmail?: string | undefined;
+};
+
+export type ConsumerSecuredApplicationPayload = {
+  type: ConsumerSecuredApplicationPayloadType;
+  /**
+   * Application resource attributes
+   */
+  attributes: ConsumerSecuredApplicationPayloadAttributes;
+  relationships: ConsumerSecuredLoanConsumerApplicationRelationships;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ConsumerSecuredApplicationPayloadType$inboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationPayloadType> = z.nativeEnum(
+    ConsumerSecuredApplicationPayloadType,
+  );
+
+/** @internal */
+export const ConsumerSecuredApplicationPayloadType$outboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationPayloadType> =
+    ConsumerSecuredApplicationPayloadType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConsumerSecuredApplicationPayloadType$ {
+  /** @deprecated use `ConsumerSecuredApplicationPayloadType$inboundSchema` instead. */
+  export const inboundSchema =
+    ConsumerSecuredApplicationPayloadType$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationPayloadType$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationPayloadType$outboundSchema;
+}
+
+/** @internal */
+export const ConsumerSecuredApplicationPayloadApplicationType$inboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationPayloadApplicationType> = z
+    .nativeEnum(ConsumerSecuredApplicationPayloadApplicationType);
+
+/** @internal */
+export const ConsumerSecuredApplicationPayloadApplicationType$outboundSchema:
+  z.ZodNativeEnum<typeof ConsumerSecuredApplicationPayloadApplicationType> =
+    ConsumerSecuredApplicationPayloadApplicationType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConsumerSecuredApplicationPayloadApplicationType$ {
+  /** @deprecated use `ConsumerSecuredApplicationPayloadApplicationType$inboundSchema` instead. */
+  export const inboundSchema =
+    ConsumerSecuredApplicationPayloadApplicationType$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationPayloadApplicationType$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationPayloadApplicationType$outboundSchema;
+}
+
+/** @internal */
+export const ConsumerSecuredApplicationPayloadAttributes$inboundSchema:
+  z.ZodType<
+    ConsumerSecuredApplicationPayloadAttributes,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    applicationType:
+      ConsumerSecuredApplicationPayloadApplicationType$inboundSchema,
+    associatedBrokerEmail: z.string().optional(),
+  });
+
+/** @internal */
+export type ConsumerSecuredApplicationPayloadAttributes$Outbound = {
+  applicationType: string;
+  associatedBrokerEmail?: string | undefined;
+};
+
+/** @internal */
+export const ConsumerSecuredApplicationPayloadAttributes$outboundSchema:
+  z.ZodType<
+    ConsumerSecuredApplicationPayloadAttributes$Outbound,
+    z.ZodTypeDef,
+    ConsumerSecuredApplicationPayloadAttributes
+  > = z.object({
+    applicationType:
+      ConsumerSecuredApplicationPayloadApplicationType$outboundSchema,
+    associatedBrokerEmail: 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 ConsumerSecuredApplicationPayloadAttributes$ {
+  /** @deprecated use `ConsumerSecuredApplicationPayloadAttributes$inboundSchema` instead. */
+  export const inboundSchema =
+    ConsumerSecuredApplicationPayloadAttributes$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationPayloadAttributes$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationPayloadAttributes$outboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationPayloadAttributes$Outbound` instead. */
+  export type Outbound = ConsumerSecuredApplicationPayloadAttributes$Outbound;
+}
+
+export function consumerSecuredApplicationPayloadAttributesToJSON(
+  consumerSecuredApplicationPayloadAttributes:
+    ConsumerSecuredApplicationPayloadAttributes,
+): string {
+  return JSON.stringify(
+    ConsumerSecuredApplicationPayloadAttributes$outboundSchema.parse(
+      consumerSecuredApplicationPayloadAttributes,
+    ),
+  );
+}
+
+export function consumerSecuredApplicationPayloadAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ConsumerSecuredApplicationPayloadAttributes,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ConsumerSecuredApplicationPayloadAttributes$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ConsumerSecuredApplicationPayloadAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConsumerSecuredApplicationPayload$inboundSchema: z.ZodType<
+  ConsumerSecuredApplicationPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: ConsumerSecuredApplicationPayloadType$inboundSchema,
+  attributes: z.lazy(() =>
+    ConsumerSecuredApplicationPayloadAttributes$inboundSchema
+  ),
+  relationships:
+    ConsumerSecuredLoanConsumerApplicationRelationships$inboundSchema,
+  links: z.record(LinkObject$inboundSchema).optional(),
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type ConsumerSecuredApplicationPayload$Outbound = {
+  type: string;
+  attributes: ConsumerSecuredApplicationPayloadAttributes$Outbound;
+  relationships: ConsumerSecuredLoanConsumerApplicationRelationships$Outbound;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ConsumerSecuredApplicationPayload$outboundSchema: z.ZodType<
+  ConsumerSecuredApplicationPayload$Outbound,
+  z.ZodTypeDef,
+  ConsumerSecuredApplicationPayload
+> = z.object({
+  type: ConsumerSecuredApplicationPayloadType$outboundSchema,
+  attributes: z.lazy(() =>
+    ConsumerSecuredApplicationPayloadAttributes$outboundSchema
+  ),
+  relationships:
+    ConsumerSecuredLoanConsumerApplicationRelationships$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 ConsumerSecuredApplicationPayload$ {
+  /** @deprecated use `ConsumerSecuredApplicationPayload$inboundSchema` instead. */
+  export const inboundSchema = ConsumerSecuredApplicationPayload$inboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationPayload$outboundSchema` instead. */
+  export const outboundSchema =
+    ConsumerSecuredApplicationPayload$outboundSchema;
+  /** @deprecated use `ConsumerSecuredApplicationPayload$Outbound` instead. */
+  export type Outbound = ConsumerSecuredApplicationPayload$Outbound;
+}
+
+export function consumerSecuredApplicationPayloadToJSON(
+  consumerSecuredApplicationPayload: ConsumerSecuredApplicationPayload,
+): string {
+  return JSON.stringify(
+    ConsumerSecuredApplicationPayload$outboundSchema.parse(
+      consumerSecuredApplicationPayload,
+    ),
+  );
+}
+
+export function consumerSecuredApplicationPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsumerSecuredApplicationPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConsumerSecuredApplicationPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsumerSecuredApplicationPayload' from JSON`,
+  );
+}

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`,
+  );
+}