@financeable/aggregation 0.5.1 → 0.6.1

package/src/models/components/commercialsecuredapplicationpayload.ts

@@ -0,0 +1,248 @@
+/*
+ * 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";
+import {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
+
+/**
+ * Resource types used in the API
+ */
+export const CommercialSecuredApplicationPayloadType = {
+  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 CommercialSecuredApplicationPayloadType = ClosedEnum<
+  typeof CommercialSecuredApplicationPayloadType
+>;
+
+/**
+ * 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 CommercialSecuredApplicationPayload = {
+  type: CommercialSecuredApplicationPayloadType;
+  /**
+   * Application resource attributes
+   */
+  attributes: Attributes;
+  relationships: CommercialSecuredLoanCommercialApplicationRelationships;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CommercialSecuredApplicationPayloadType$inboundSchema:
+  z.ZodNativeEnum<typeof CommercialSecuredApplicationPayloadType> = z
+    .nativeEnum(CommercialSecuredApplicationPayloadType);
+
+/** @internal */
+export const CommercialSecuredApplicationPayloadType$outboundSchema:
+  z.ZodNativeEnum<typeof CommercialSecuredApplicationPayloadType> =
+    CommercialSecuredApplicationPayloadType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommercialSecuredApplicationPayloadType$ {
+  /** @deprecated use `CommercialSecuredApplicationPayloadType$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredApplicationPayloadType$inboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationPayloadType$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredApplicationPayloadType$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 CommercialSecuredApplicationPayload$inboundSchema: z.ZodType<
+  CommercialSecuredApplicationPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: CommercialSecuredApplicationPayloadType$inboundSchema,
+  attributes: z.lazy(() => Attributes$inboundSchema),
+  relationships:
+    CommercialSecuredLoanCommercialApplicationRelationships$inboundSchema,
+  links: z.record(LinkObject$inboundSchema).optional(),
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type CommercialSecuredApplicationPayload$Outbound = {
+  type: string;
+  attributes: Attributes$Outbound;
+  relationships:
+    CommercialSecuredLoanCommercialApplicationRelationships$Outbound;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CommercialSecuredApplicationPayload$outboundSchema: z.ZodType<
+  CommercialSecuredApplicationPayload$Outbound,
+  z.ZodTypeDef,
+  CommercialSecuredApplicationPayload
+> = z.object({
+  type: CommercialSecuredApplicationPayloadType$outboundSchema,
+  attributes: z.lazy(() => Attributes$outboundSchema),
+  relationships:
+    CommercialSecuredLoanCommercialApplicationRelationships$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 CommercialSecuredApplicationPayload$ {
+  /** @deprecated use `CommercialSecuredApplicationPayload$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredApplicationPayload$inboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationPayload$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredApplicationPayload$outboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationPayload$Outbound` instead. */
+  export type Outbound = CommercialSecuredApplicationPayload$Outbound;
+}
+
+export function commercialSecuredApplicationPayloadToJSON(
+  commercialSecuredApplicationPayload: CommercialSecuredApplicationPayload,
+): string {
+  return JSON.stringify(
+    CommercialSecuredApplicationPayload$outboundSchema.parse(
+      commercialSecuredApplicationPayload,
+    ),
+  );
+}
+
+export function commercialSecuredApplicationPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<CommercialSecuredApplicationPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CommercialSecuredApplicationPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommercialSecuredApplicationPayload' from JSON`,
+  );
+}

package/src/models/components/commercialsecuredapplicationresource.ts

@@ -0,0 +1,310 @@
+/*
+ * 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";
+import {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
+
+export const CommercialSecuredApplicationResourceType = {
+  CommercialSecuredApplications: "commercial-secured-applications",
+} as const;
+export type CommercialSecuredApplicationResourceType = ClosedEnum<
+  typeof CommercialSecuredApplicationResourceType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const CommercialSecuredApplicationResourceApplicationType = {
+  CommercialSecured: "commercialSecured",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type CommercialSecuredApplicationResourceApplicationType = ClosedEnum<
+  typeof CommercialSecuredApplicationResourceApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type CommercialSecuredApplicationResourceAttributes = {
+  /**
+   * 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: CommercialSecuredApplicationResourceApplicationType;
+  /**
+   * 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 Commercial Application resource following JSON:API structure
+ */
+export type CommercialSecuredApplicationResource = {
+  type: CommercialSecuredApplicationResourceType;
+  id?: string | undefined;
+  /**
+   * Application resource attributes
+   */
+  attributes: CommercialSecuredApplicationResourceAttributes;
+  /**
+   * Relationships for a Commercial Application Resource
+   */
+  relationships: CommercialApplicationJsonApiRelationships;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CommercialSecuredApplicationResourceType$inboundSchema:
+  z.ZodNativeEnum<typeof CommercialSecuredApplicationResourceType> = z
+    .nativeEnum(CommercialSecuredApplicationResourceType);
+
+/** @internal */
+export const CommercialSecuredApplicationResourceType$outboundSchema:
+  z.ZodNativeEnum<typeof CommercialSecuredApplicationResourceType> =
+    CommercialSecuredApplicationResourceType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommercialSecuredApplicationResourceType$ {
+  /** @deprecated use `CommercialSecuredApplicationResourceType$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredApplicationResourceType$inboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationResourceType$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredApplicationResourceType$outboundSchema;
+}
+
+/** @internal */
+export const CommercialSecuredApplicationResourceApplicationType$inboundSchema:
+  z.ZodNativeEnum<typeof CommercialSecuredApplicationResourceApplicationType> =
+    z.nativeEnum(CommercialSecuredApplicationResourceApplicationType);
+
+/** @internal */
+export const CommercialSecuredApplicationResourceApplicationType$outboundSchema:
+  z.ZodNativeEnum<typeof CommercialSecuredApplicationResourceApplicationType> =
+    CommercialSecuredApplicationResourceApplicationType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CommercialSecuredApplicationResourceApplicationType$ {
+  /** @deprecated use `CommercialSecuredApplicationResourceApplicationType$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredApplicationResourceApplicationType$inboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationResourceApplicationType$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredApplicationResourceApplicationType$outboundSchema;
+}
+
+/** @internal */
+export const CommercialSecuredApplicationResourceAttributes$inboundSchema:
+  z.ZodType<
+    CommercialSecuredApplicationResourceAttributes,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    id: z.string(),
+    humanId: z.string(),
+    applicationType:
+      CommercialSecuredApplicationResourceApplicationType$inboundSchema,
+    status: ApplicationStatus$inboundSchema,
+    associatedBrokerEmail: z.string().optional(),
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
+  });
+
+/** @internal */
+export type CommercialSecuredApplicationResourceAttributes$Outbound = {
+  id: string;
+  humanId: string;
+  applicationType: string;
+  status: string;
+  associatedBrokerEmail?: string | undefined;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const CommercialSecuredApplicationResourceAttributes$outboundSchema:
+  z.ZodType<
+    CommercialSecuredApplicationResourceAttributes$Outbound,
+    z.ZodTypeDef,
+    CommercialSecuredApplicationResourceAttributes
+  > = z.object({
+    id: z.string(),
+    humanId: z.string(),
+    applicationType:
+      CommercialSecuredApplicationResourceApplicationType$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 CommercialSecuredApplicationResourceAttributes$ {
+  /** @deprecated use `CommercialSecuredApplicationResourceAttributes$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredApplicationResourceAttributes$inboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationResourceAttributes$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredApplicationResourceAttributes$outboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationResourceAttributes$Outbound` instead. */
+  export type Outbound =
+    CommercialSecuredApplicationResourceAttributes$Outbound;
+}
+
+export function commercialSecuredApplicationResourceAttributesToJSON(
+  commercialSecuredApplicationResourceAttributes:
+    CommercialSecuredApplicationResourceAttributes,
+): string {
+  return JSON.stringify(
+    CommercialSecuredApplicationResourceAttributes$outboundSchema.parse(
+      commercialSecuredApplicationResourceAttributes,
+    ),
+  );
+}
+
+export function commercialSecuredApplicationResourceAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CommercialSecuredApplicationResourceAttributes,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CommercialSecuredApplicationResourceAttributes$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CommercialSecuredApplicationResourceAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const CommercialSecuredApplicationResource$inboundSchema: z.ZodType<
+  CommercialSecuredApplicationResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: CommercialSecuredApplicationResourceType$inboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() =>
+    CommercialSecuredApplicationResourceAttributes$inboundSchema
+  ),
+  relationships: CommercialApplicationJsonApiRelationships$inboundSchema,
+  links: z.record(LinkObject$inboundSchema).optional(),
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type CommercialSecuredApplicationResource$Outbound = {
+  type: string;
+  id?: string | undefined;
+  attributes: CommercialSecuredApplicationResourceAttributes$Outbound;
+  relationships: CommercialApplicationJsonApiRelationships$Outbound;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CommercialSecuredApplicationResource$outboundSchema: z.ZodType<
+  CommercialSecuredApplicationResource$Outbound,
+  z.ZodTypeDef,
+  CommercialSecuredApplicationResource
+> = z.object({
+  type: CommercialSecuredApplicationResourceType$outboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() =>
+    CommercialSecuredApplicationResourceAttributes$outboundSchema
+  ),
+  relationships: CommercialApplicationJsonApiRelationships$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 CommercialSecuredApplicationResource$ {
+  /** @deprecated use `CommercialSecuredApplicationResource$inboundSchema` instead. */
+  export const inboundSchema =
+    CommercialSecuredApplicationResource$inboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationResource$outboundSchema` instead. */
+  export const outboundSchema =
+    CommercialSecuredApplicationResource$outboundSchema;
+  /** @deprecated use `CommercialSecuredApplicationResource$Outbound` instead. */
+  export type Outbound = CommercialSecuredApplicationResource$Outbound;
+}
+
+export function commercialSecuredApplicationResourceToJSON(
+  commercialSecuredApplicationResource: CommercialSecuredApplicationResource,
+): string {
+  return JSON.stringify(
+    CommercialSecuredApplicationResource$outboundSchema.parse(
+      commercialSecuredApplicationResource,
+    ),
+  );
+}
+
+export function commercialSecuredApplicationResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<CommercialSecuredApplicationResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CommercialSecuredApplicationResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommercialSecuredApplicationResource' from JSON`,
+  );
+}