@financeable/aggregation 0.11.0-alpha.1 → 0.12.0

package/src/models/components/businessapplicationpayload.ts

@@ -0,0 +1,242 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+export const BusinessApplicationPayloadType = {
+  BusinessApplications: "business-applications",
+} as const;
+export type BusinessApplicationPayloadType = ClosedEnum<
+  typeof BusinessApplicationPayloadType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const BusinessApplicationPayloadApplicationType = {
+  Business: "business",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type BusinessApplicationPayloadApplicationType = ClosedEnum<
+  typeof BusinessApplicationPayloadApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type BusinessApplicationPayloadAttributes = {
+  /**
+   * Type of the loan application
+   */
+  applicationType: BusinessApplicationPayloadApplicationType;
+  /**
+   * Email address of the broker to be associated with this application.
+   */
+  associatedBrokerEmail: string;
+};
+
+export type BusinessApplicationPayload = {
+  type: BusinessApplicationPayloadType;
+  /**
+   * Application resource attributes
+   */
+  attributes: BusinessApplicationPayloadAttributes;
+  relationships?: BusinessLoanBusinessApplicationRelationships | undefined;
+  links?: { [k: string]: LinkObject } | undefined;
+  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;
+}
+
+/** @internal */
+export const BusinessApplicationPayloadApplicationType$inboundSchema:
+  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;
+  associatedBrokerEmail: string;
+};
+
+/** @internal */
+export const BusinessApplicationPayloadAttributes$outboundSchema: z.ZodType<
+  BusinessApplicationPayloadAttributes$Outbound,
+  z.ZodTypeDef,
+  BusinessApplicationPayloadAttributes
+> = z.object({
+  applicationType: BusinessApplicationPayloadApplicationType$outboundSchema,
+  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 {
+  return JSON.stringify(
+    BusinessApplicationPayloadAttributes$outboundSchema.parse(
+      businessApplicationPayloadAttributes,
+    ),
+  );
+}
+
+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;
+  attributes: BusinessApplicationPayloadAttributes$Outbound;
+  relationships?:
+    | BusinessLoanBusinessApplicationRelationships$Outbound
+    | undefined;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const BusinessApplicationPayload$outboundSchema: z.ZodType<
+  BusinessApplicationPayload$Outbound,
+  z.ZodTypeDef,
+  BusinessApplicationPayload
+> = z.object({
+  type: BusinessApplicationPayloadType$outboundSchema,
+  attributes: z.lazy(() => BusinessApplicationPayloadAttributes$outboundSchema),
+  relationships: BusinessLoanBusinessApplicationRelationships$outboundSchema
+    .optional(),
+  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 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 {
+  return JSON.stringify(
+    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

@@ -0,0 +1,285 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  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
+>;
+
+/**
+ * Type of the loan application
+ */
+export const BusinessApplicationResourceApplicationType = {
+  Business: "business",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type BusinessApplicationResourceApplicationType = ClosedEnum<
+  typeof BusinessApplicationResourceApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type BusinessApplicationResourceAttributes = {
+  /**
+   * Full identifier of the application. Not visible within the web application.
+   */
+  id?: string | undefined;
+  /**
+   * Human readable & easily communicated identifier of the application. Visible within the web application.
+   */
+  humanId: string;
+  /**
+   * Type of the loan application
+   */
+  applicationType: BusinessApplicationResourceApplicationType;
+  /**
+   * Current status, must be 'workshop' for new applications
+   */
+  status: ApplicationStatus;
+  /**
+   * Creation timestamp
+   */
+  createdAt?: string | undefined;
+  /**
+   * Last update timestamp
+   */
+  updatedAt?: string | undefined;
+};
+
+/**
+ * A Business Application resource following JSON:API structure
+ */
+export type BusinessApplicationResource = {
+  type: BusinessApplicationResourceType;
+  id?: string | undefined;
+  /**
+   * Application resource attributes
+   */
+  attributes: BusinessApplicationResourceAttributes;
+  /**
+   * Relationships for a Business Application Resource
+   */
+  relationships: BusinessApplicationJsonApiRelationships;
+  links?: { [k: string]: LinkObject } | undefined;
+  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,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  humanId: z.string(),
+  applicationType: BusinessApplicationResourceApplicationType$inboundSchema,
+  status: ApplicationStatus$inboundSchema,
+  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> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BusinessApplicationResourceAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessApplicationResourceAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const BusinessApplicationResource$inboundSchema: z.ZodType<
+  BusinessApplicationResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: BusinessApplicationResourceType$inboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() => BusinessApplicationResourceAttributes$inboundSchema),
+  relationships: BusinessApplicationJsonApiRelationships$inboundSchema,
+  links: z.record(LinkObject$inboundSchema).optional(),
+  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> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessApplicationResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessApplicationResource' from JSON`,
+  );
+}