@financeable/aggregation 0.5.0 → 0.6.0

package/src/models/components/commercialapplicationresource.ts

@@ -0,0 +1,355 @@
+/*
+ * 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 {
+  CommercialApplicationJsonApiRelationships,
+  CommercialApplicationJsonApiRelationships$inboundSchema,
+  CommercialApplicationJsonApiRelationships$Outbound,
+  CommercialApplicationJsonApiRelationships$outboundSchema,
+} from "./commercialapplicationjsonapirelationships.js";
+
+export const CommercialApplicationResourceType = {
+  CommercialSecuredApplications: "commercial-secured-applications",
+} as const;
+export type CommercialApplicationResourceType = ClosedEnum<
+  typeof CommercialApplicationResourceType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const CommercialApplicationResourceApplicationType = {
+  CommercialSecured: "commercialSecured",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type CommercialApplicationResourceApplicationType = ClosedEnum<
+  typeof CommercialApplicationResourceApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type CommercialApplicationResourceAttributes = {
+  /**
+   * 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: CommercialApplicationResourceApplicationType;
+  /**
+   * 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;
+};
+
+export type CommercialApplicationResourceLinks = {};
+
+/**
+ * A Commercial Application resource following JSON:API structure
+ */
+export type CommercialApplicationResource = {
+  type: CommercialApplicationResourceType;
+  id: string;
+  /**
+   * Application resource attributes
+   */
+  attributes?: CommercialApplicationResourceAttributes | undefined;
+  /**
+   * Relationships for a Commercial Application Resource
+   */
+  relationships: CommercialApplicationJsonApiRelationships;
+  links?: { [k: string]: CommercialApplicationResourceLinks } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CommercialApplicationResourceType$inboundSchema: z.ZodNativeEnum<
+  typeof CommercialApplicationResourceType
+> = z.nativeEnum(CommercialApplicationResourceType);
+
+/** @internal */
+export const CommercialApplicationResourceType$outboundSchema: z.ZodNativeEnum<
+  typeof CommercialApplicationResourceType
+> = CommercialApplicationResourceType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommercialApplicationResourceType$ {
+  /** @deprecated use `CommercialApplicationResourceType$inboundSchema` instead. */
+  export const inboundSchema = CommercialApplicationResourceType$inboundSchema;
+  /** @deprecated use `CommercialApplicationResourceType$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialApplicationResourceType$outboundSchema;
+}
+
+/** @internal */
+export const CommercialApplicationResourceApplicationType$inboundSchema:
+  z.ZodNativeEnum<typeof CommercialApplicationResourceApplicationType> = z
+    .nativeEnum(CommercialApplicationResourceApplicationType);
+
+/** @internal */
+export const CommercialApplicationResourceApplicationType$outboundSchema:
+  z.ZodNativeEnum<typeof CommercialApplicationResourceApplicationType> =
+    CommercialApplicationResourceApplicationType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommercialApplicationResourceApplicationType$ {
+  /** @deprecated use `CommercialApplicationResourceApplicationType$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialApplicationResourceApplicationType$inboundSchema;
+  /** @deprecated use `CommercialApplicationResourceApplicationType$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialApplicationResourceApplicationType$outboundSchema;
+}
+
+/** @internal */
+export const CommercialApplicationResourceAttributes$inboundSchema: z.ZodType<
+  CommercialApplicationResourceAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  humanId: z.string(),
+  applicationType: CommercialApplicationResourceApplicationType$inboundSchema,
+  status: ApplicationStatus$inboundSchema,
+  associatedBrokerEmail: z.string().optional(),
+  createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
+});
+
+/** @internal */
+export type CommercialApplicationResourceAttributes$Outbound = {
+  id: string;
+  humanId: string;
+  applicationType: string;
+  status: string;
+  associatedBrokerEmail?: string | undefined;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const CommercialApplicationResourceAttributes$outboundSchema: z.ZodType<
+  CommercialApplicationResourceAttributes$Outbound,
+  z.ZodTypeDef,
+  CommercialApplicationResourceAttributes
+> = z.object({
+  id: z.string(),
+  humanId: z.string(),
+  applicationType: CommercialApplicationResourceApplicationType$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 CommercialApplicationResourceAttributes$ {
+  /** @deprecated use `CommercialApplicationResourceAttributes$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialApplicationResourceAttributes$inboundSchema;
+  /** @deprecated use `CommercialApplicationResourceAttributes$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialApplicationResourceAttributes$outboundSchema;
+  /** @deprecated use `CommercialApplicationResourceAttributes$Outbound` instead. */
+  export type Outbound = CommercialApplicationResourceAttributes$Outbound;
+}
+
+export function commercialApplicationResourceAttributesToJSON(
+  commercialApplicationResourceAttributes:
+    CommercialApplicationResourceAttributes,
+): string {
+  return JSON.stringify(
+    CommercialApplicationResourceAttributes$outboundSchema.parse(
+      commercialApplicationResourceAttributes,
+    ),
+  );
+}
+
+export function commercialApplicationResourceAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CommercialApplicationResourceAttributes,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CommercialApplicationResourceAttributes$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CommercialApplicationResourceAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommercialApplicationResourceLinks$inboundSchema: z.ZodType<
+  CommercialApplicationResourceLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type CommercialApplicationResourceLinks$Outbound = {};
+
+/** @internal */
+export const CommercialApplicationResourceLinks$outboundSchema: z.ZodType<
+  CommercialApplicationResourceLinks$Outbound,
+  z.ZodTypeDef,
+  CommercialApplicationResourceLinks
+> = 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 CommercialApplicationResourceLinks$ {
+  /** @deprecated use `CommercialApplicationResourceLinks$inboundSchema` instead. */
+  export const inboundSchema = CommercialApplicationResourceLinks$inboundSchema;
+  /** @deprecated use `CommercialApplicationResourceLinks$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialApplicationResourceLinks$outboundSchema;
+  /** @deprecated use `CommercialApplicationResourceLinks$Outbound` instead. */
+  export type Outbound = CommercialApplicationResourceLinks$Outbound;
+}
+
+export function commercialApplicationResourceLinksToJSON(
+  commercialApplicationResourceLinks: CommercialApplicationResourceLinks,
+): string {
+  return JSON.stringify(
+    CommercialApplicationResourceLinks$outboundSchema.parse(
+      commercialApplicationResourceLinks,
+    ),
+  );
+}
+
+export function commercialApplicationResourceLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<CommercialApplicationResourceLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CommercialApplicationResourceLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommercialApplicationResourceLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommercialApplicationResource$inboundSchema: z.ZodType<
+  CommercialApplicationResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: CommercialApplicationResourceType$inboundSchema,
+  id: z.string(),
+  attributes: z.lazy(() =>
+    CommercialApplicationResourceAttributes$inboundSchema
+  ).optional(),
+  relationships: CommercialApplicationJsonApiRelationships$inboundSchema,
+  links: z.record(
+    z.lazy(() => CommercialApplicationResourceLinks$inboundSchema),
+  ).optional(),
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type CommercialApplicationResource$Outbound = {
+  type: string;
+  id: string;
+  attributes?: CommercialApplicationResourceAttributes$Outbound | undefined;
+  relationships: CommercialApplicationJsonApiRelationships$Outbound;
+  links?:
+    | { [k: string]: CommercialApplicationResourceLinks$Outbound }
+    | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CommercialApplicationResource$outboundSchema: z.ZodType<
+  CommercialApplicationResource$Outbound,
+  z.ZodTypeDef,
+  CommercialApplicationResource
+> = z.object({
+  type: CommercialApplicationResourceType$outboundSchema,
+  id: z.string(),
+  attributes: z.lazy(() =>
+    CommercialApplicationResourceAttributes$outboundSchema
+  ).optional(),
+  relationships: CommercialApplicationJsonApiRelationships$outboundSchema,
+  links: z.record(
+    z.lazy(() => CommercialApplicationResourceLinks$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 CommercialApplicationResource$ {
+  /** @deprecated use `CommercialApplicationResource$inboundSchema` instead. */
+  export const inboundSchema = CommercialApplicationResource$inboundSchema;
+  /** @deprecated use `CommercialApplicationResource$outboundSchema` instead. */
+  export const outboundSchema = CommercialApplicationResource$outboundSchema;
+  /** @deprecated use `CommercialApplicationResource$Outbound` instead. */
+  export type Outbound = CommercialApplicationResource$Outbound;
+}
+
+export function commercialApplicationResourceToJSON(
+  commercialApplicationResource: CommercialApplicationResource,
+): string {
+  return JSON.stringify(
+    CommercialApplicationResource$outboundSchema.parse(
+      commercialApplicationResource,
+    ),
+  );
+}
+
+export function commercialApplicationResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<CommercialApplicationResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommercialApplicationResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommercialApplicationResource' from JSON`,
+  );
+}

package/src/models/components/commercialsecuredloanapplicationsubmissionpayload.ts

@@ -0,0 +1,237 @@
+/*
+ * 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 {
+  CommercialSecuredLoanCommercialApplicationRelationships,
+  CommercialSecuredLoanCommercialApplicationRelationships$inboundSchema,
+  CommercialSecuredLoanCommercialApplicationRelationships$Outbound,
+  CommercialSecuredLoanCommercialApplicationRelationships$outboundSchema,
+} from "./commercialsecuredloancommercialapplicationrelationships.js";
+
+export const CommercialSecuredLoanApplicationSubmissionPayloadType = {
+  CommercialSecuredApplications: "commercial-secured-applications",
+} as const;
+export type CommercialSecuredLoanApplicationSubmissionPayloadType = ClosedEnum<
+  typeof CommercialSecuredLoanApplicationSubmissionPayloadType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const ApplicationType = {
+  CommercialSecured: "commercialSecured",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type ApplicationType = ClosedEnum<typeof ApplicationType>;
+
+/**
+ * Application resource attributes
+ */
+export type Attributes = {
+  /**
+   * Type of the loan application
+   */
+  applicationType: ApplicationType;
+  /**
+   * Email address of the broker to be associated with this application.
+   */
+  associatedBrokerEmail?: string | undefined;
+};
+
+export type CommercialSecuredLoanApplicationSubmissionPayload = {
+  type: CommercialSecuredLoanApplicationSubmissionPayloadType;
+  /**
+   * Application resource attributes
+   */
+  attributes: Attributes;
+  relationships?:
+    | CommercialSecuredLoanCommercialApplicationRelationships
+    | undefined;
+};
+
+/** @internal */
+export const CommercialSecuredLoanApplicationSubmissionPayloadType$inboundSchema:
+  z.ZodNativeEnum<
+    typeof CommercialSecuredLoanApplicationSubmissionPayloadType
+  > = z.nativeEnum(CommercialSecuredLoanApplicationSubmissionPayloadType);
+
+/** @internal */
+export const CommercialSecuredLoanApplicationSubmissionPayloadType$outboundSchema:
+  z.ZodNativeEnum<
+    typeof CommercialSecuredLoanApplicationSubmissionPayloadType
+  > = CommercialSecuredLoanApplicationSubmissionPayloadType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommercialSecuredLoanApplicationSubmissionPayloadType$ {
+  /** @deprecated use `CommercialSecuredLoanApplicationSubmissionPayloadType$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredLoanApplicationSubmissionPayloadType$inboundSchema;
+  /** @deprecated use `CommercialSecuredLoanApplicationSubmissionPayloadType$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredLoanApplicationSubmissionPayloadType$outboundSchema;
+}
+
+/** @internal */
+export const ApplicationType$inboundSchema: z.ZodNativeEnum<
+  typeof ApplicationType
+> = z.nativeEnum(ApplicationType);
+
+/** @internal */
+export const ApplicationType$outboundSchema: z.ZodNativeEnum<
+  typeof ApplicationType
+> = ApplicationType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ApplicationType$ {
+  /** @deprecated use `ApplicationType$inboundSchema` instead. */
+  export const inboundSchema = ApplicationType$inboundSchema;
+  /** @deprecated use `ApplicationType$outboundSchema` instead. */
+  export const outboundSchema = ApplicationType$outboundSchema;
+}
+
+/** @internal */
+export const Attributes$inboundSchema: z.ZodType<
+  Attributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applicationType: ApplicationType$inboundSchema,
+  associatedBrokerEmail: z.string().optional(),
+});
+
+/** @internal */
+export type Attributes$Outbound = {
+  applicationType: string;
+  associatedBrokerEmail?: string | undefined;
+};
+
+/** @internal */
+export const Attributes$outboundSchema: z.ZodType<
+  Attributes$Outbound,
+  z.ZodTypeDef,
+  Attributes
+> = z.object({
+  applicationType: ApplicationType$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 Attributes$ {
+  /** @deprecated use `Attributes$inboundSchema` instead. */
+  export const inboundSchema = Attributes$inboundSchema;
+  /** @deprecated use `Attributes$outboundSchema` instead. */
+  export const outboundSchema = Attributes$outboundSchema;
+  /** @deprecated use `Attributes$Outbound` instead. */
+  export type Outbound = Attributes$Outbound;
+}
+
+export function attributesToJSON(attributes: Attributes): string {
+  return JSON.stringify(Attributes$outboundSchema.parse(attributes));
+}
+
+export function attributesFromJSON(
+  jsonString: string,
+): SafeParseResult<Attributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Attributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Attributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommercialSecuredLoanApplicationSubmissionPayload$inboundSchema:
+  z.ZodType<
+    CommercialSecuredLoanApplicationSubmissionPayload,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    type: CommercialSecuredLoanApplicationSubmissionPayloadType$inboundSchema,
+    attributes: z.lazy(() => Attributes$inboundSchema),
+    relationships:
+      CommercialSecuredLoanCommercialApplicationRelationships$inboundSchema
+        .optional(),
+  });
+
+/** @internal */
+export type CommercialSecuredLoanApplicationSubmissionPayload$Outbound = {
+  type: string;
+  attributes: Attributes$Outbound;
+  relationships?:
+    | CommercialSecuredLoanCommercialApplicationRelationships$Outbound
+    | undefined;
+};
+
+/** @internal */
+export const CommercialSecuredLoanApplicationSubmissionPayload$outboundSchema:
+  z.ZodType<
+    CommercialSecuredLoanApplicationSubmissionPayload$Outbound,
+    z.ZodTypeDef,
+    CommercialSecuredLoanApplicationSubmissionPayload
+  > = z.object({
+    type: CommercialSecuredLoanApplicationSubmissionPayloadType$outboundSchema,
+    attributes: z.lazy(() => Attributes$outboundSchema),
+    relationships:
+      CommercialSecuredLoanCommercialApplicationRelationships$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 CommercialSecuredLoanApplicationSubmissionPayload$ {
+  /** @deprecated use `CommercialSecuredLoanApplicationSubmissionPayload$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredLoanApplicationSubmissionPayload$inboundSchema;
+  /** @deprecated use `CommercialSecuredLoanApplicationSubmissionPayload$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredLoanApplicationSubmissionPayload$outboundSchema;
+  /** @deprecated use `CommercialSecuredLoanApplicationSubmissionPayload$Outbound` instead. */
+  export type Outbound =
+    CommercialSecuredLoanApplicationSubmissionPayload$Outbound;
+}
+
+export function commercialSecuredLoanApplicationSubmissionPayloadToJSON(
+  commercialSecuredLoanApplicationSubmissionPayload:
+    CommercialSecuredLoanApplicationSubmissionPayload,
+): string {
+  return JSON.stringify(
+    CommercialSecuredLoanApplicationSubmissionPayload$outboundSchema.parse(
+      commercialSecuredLoanApplicationSubmissionPayload,
+    ),
+  );
+}
+
+export function commercialSecuredLoanApplicationSubmissionPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CommercialSecuredLoanApplicationSubmissionPayload,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CommercialSecuredLoanApplicationSubmissionPayload$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CommercialSecuredLoanApplicationSubmissionPayload' from JSON`,
+  );
+}