@financeable/aggregation 0.10.1 → 0.11.0

package/src/models/components/personalapplicationpayload.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 {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
+import {
+  PersonalLoanPersonalApplicationRelationships,
+  PersonalLoanPersonalApplicationRelationships$inboundSchema,
+  PersonalLoanPersonalApplicationRelationships$Outbound,
+  PersonalLoanPersonalApplicationRelationships$outboundSchema,
+} from "./personalloanpersonalapplicationrelationships.js";
+
+export const PersonalApplicationPayloadType = {
+  PersonalApplications: "personal-applications",
+} as const;
+export type PersonalApplicationPayloadType = ClosedEnum<
+  typeof PersonalApplicationPayloadType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const PersonalApplicationPayloadApplicationType = {
+  Personal: "personal",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type PersonalApplicationPayloadApplicationType = ClosedEnum<
+  typeof PersonalApplicationPayloadApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type PersonalApplicationPayloadAttributes = {
+  /**
+   * Type of the loan application
+   */
+  applicationType: PersonalApplicationPayloadApplicationType;
+  /**
+   * Email address of the broker to be associated with this application.
+   */
+  associatedBrokerEmail: string;
+};
+
+export type PersonalApplicationPayload = {
+  type: PersonalApplicationPayloadType;
+  /**
+   * Application resource attributes
+   */
+  attributes: PersonalApplicationPayloadAttributes;
+  relationships?: PersonalLoanPersonalApplicationRelationships | undefined;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PersonalApplicationPayloadType$inboundSchema: z.ZodNativeEnum<
+  typeof PersonalApplicationPayloadType
+> = z.nativeEnum(PersonalApplicationPayloadType);
+
+/** @internal */
+export const PersonalApplicationPayloadType$outboundSchema: z.ZodNativeEnum<
+  typeof PersonalApplicationPayloadType
+> = PersonalApplicationPayloadType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PersonalApplicationPayloadType$ {
+  /** @deprecated use `PersonalApplicationPayloadType$inboundSchema` instead. */
+  export const inboundSchema = PersonalApplicationPayloadType$inboundSchema;
+  /** @deprecated use `PersonalApplicationPayloadType$outboundSchema` instead. */
+  export const outboundSchema = PersonalApplicationPayloadType$outboundSchema;
+}
+
+/** @internal */
+export const PersonalApplicationPayloadApplicationType$inboundSchema:
+  z.ZodNativeEnum<typeof PersonalApplicationPayloadApplicationType> = z
+    .nativeEnum(PersonalApplicationPayloadApplicationType);
+
+/** @internal */
+export const PersonalApplicationPayloadApplicationType$outboundSchema:
+  z.ZodNativeEnum<typeof PersonalApplicationPayloadApplicationType> =
+    PersonalApplicationPayloadApplicationType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PersonalApplicationPayloadApplicationType$ {
+  /** @deprecated use `PersonalApplicationPayloadApplicationType$inboundSchema` instead. */
+  export const inboundSchema =
+    PersonalApplicationPayloadApplicationType$inboundSchema;
+  /** @deprecated use `PersonalApplicationPayloadApplicationType$outboundSchema` instead. */
+  export const outboundSchema =
+    PersonalApplicationPayloadApplicationType$outboundSchema;
+}
+
+/** @internal */
+export const PersonalApplicationPayloadAttributes$inboundSchema: z.ZodType<
+  PersonalApplicationPayloadAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applicationType: PersonalApplicationPayloadApplicationType$inboundSchema,
+  associatedBrokerEmail: z.string(),
+});
+
+/** @internal */
+export type PersonalApplicationPayloadAttributes$Outbound = {
+  applicationType: string;
+  associatedBrokerEmail: string;
+};
+
+/** @internal */
+export const PersonalApplicationPayloadAttributes$outboundSchema: z.ZodType<
+  PersonalApplicationPayloadAttributes$Outbound,
+  z.ZodTypeDef,
+  PersonalApplicationPayloadAttributes
+> = z.object({
+  applicationType: PersonalApplicationPayloadApplicationType$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 PersonalApplicationPayloadAttributes$ {
+  /** @deprecated use `PersonalApplicationPayloadAttributes$inboundSchema` instead. */
+  export const inboundSchema =
+    PersonalApplicationPayloadAttributes$inboundSchema;
+  /** @deprecated use `PersonalApplicationPayloadAttributes$outboundSchema` instead. */
+  export const outboundSchema =
+    PersonalApplicationPayloadAttributes$outboundSchema;
+  /** @deprecated use `PersonalApplicationPayloadAttributes$Outbound` instead. */
+  export type Outbound = PersonalApplicationPayloadAttributes$Outbound;
+}
+
+export function personalApplicationPayloadAttributesToJSON(
+  personalApplicationPayloadAttributes: PersonalApplicationPayloadAttributes,
+): string {
+  return JSON.stringify(
+    PersonalApplicationPayloadAttributes$outboundSchema.parse(
+      personalApplicationPayloadAttributes,
+    ),
+  );
+}
+
+export function personalApplicationPayloadAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonalApplicationPayloadAttributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PersonalApplicationPayloadAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonalApplicationPayloadAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const PersonalApplicationPayload$inboundSchema: z.ZodType<
+  PersonalApplicationPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PersonalApplicationPayloadType$inboundSchema,
+  attributes: z.lazy(() => PersonalApplicationPayloadAttributes$inboundSchema),
+  relationships: PersonalLoanPersonalApplicationRelationships$inboundSchema
+    .optional(),
+  links: z.record(LinkObject$inboundSchema).optional(),
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type PersonalApplicationPayload$Outbound = {
+  type: string;
+  attributes: PersonalApplicationPayloadAttributes$Outbound;
+  relationships?:
+    | PersonalLoanPersonalApplicationRelationships$Outbound
+    | undefined;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PersonalApplicationPayload$outboundSchema: z.ZodType<
+  PersonalApplicationPayload$Outbound,
+  z.ZodTypeDef,
+  PersonalApplicationPayload
+> = z.object({
+  type: PersonalApplicationPayloadType$outboundSchema,
+  attributes: z.lazy(() => PersonalApplicationPayloadAttributes$outboundSchema),
+  relationships: PersonalLoanPersonalApplicationRelationships$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 PersonalApplicationPayload$ {
+  /** @deprecated use `PersonalApplicationPayload$inboundSchema` instead. */
+  export const inboundSchema = PersonalApplicationPayload$inboundSchema;
+  /** @deprecated use `PersonalApplicationPayload$outboundSchema` instead. */
+  export const outboundSchema = PersonalApplicationPayload$outboundSchema;
+  /** @deprecated use `PersonalApplicationPayload$Outbound` instead. */
+  export type Outbound = PersonalApplicationPayload$Outbound;
+}
+
+export function personalApplicationPayloadToJSON(
+  personalApplicationPayload: PersonalApplicationPayload,
+): string {
+  return JSON.stringify(
+    PersonalApplicationPayload$outboundSchema.parse(personalApplicationPayload),
+  );
+}
+
+export function personalApplicationPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonalApplicationPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonalApplicationPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonalApplicationPayload' from JSON`,
+  );
+}

package/src/models/components/personalapplicationresource.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 {
+  LinkObject,
+  LinkObject$inboundSchema,
+  LinkObject$Outbound,
+  LinkObject$outboundSchema,
+} from "./linkobject.js";
+import {
+  PersonalApplicationJsonApiRelationships,
+  PersonalApplicationJsonApiRelationships$inboundSchema,
+  PersonalApplicationJsonApiRelationships$Outbound,
+  PersonalApplicationJsonApiRelationships$outboundSchema,
+} from "./personalapplicationjsonapirelationships.js";
+
+export const PersonalApplicationResourceType = {
+  PersonalApplications: "personal-applications",
+} as const;
+export type PersonalApplicationResourceType = ClosedEnum<
+  typeof PersonalApplicationResourceType
+>;
+
+/**
+ * Type of the loan application
+ */
+export const PersonalApplicationResourceApplicationType = {
+  Personal: "personal",
+} as const;
+/**
+ * Type of the loan application
+ */
+export type PersonalApplicationResourceApplicationType = ClosedEnum<
+  typeof PersonalApplicationResourceApplicationType
+>;
+
+/**
+ * Application resource attributes
+ */
+export type PersonalApplicationResourceAttributes = {
+  /**
+   * 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: PersonalApplicationResourceApplicationType;
+  /**
+   * Current status, must be 'workshop' for new applications
+   */
+  status: ApplicationStatus;
+  /**
+   * Creation timestamp
+   */
+  createdAt?: string | undefined;
+  /**
+   * Last update timestamp
+   */
+  updatedAt?: string | undefined;
+};
+
+/**
+ * A Personal Application resource following JSON:API structure
+ */
+export type PersonalApplicationResource = {
+  type: PersonalApplicationResourceType;
+  id?: string | undefined;
+  /**
+   * Application resource attributes
+   */
+  attributes: PersonalApplicationResourceAttributes;
+  /**
+   * Relationships for a Personal Application Resource
+   */
+  relationships: PersonalApplicationJsonApiRelationships;
+  links?: { [k: string]: LinkObject } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PersonalApplicationResourceType$inboundSchema: z.ZodNativeEnum<
+  typeof PersonalApplicationResourceType
+> = z.nativeEnum(PersonalApplicationResourceType);
+
+/** @internal */
+export const PersonalApplicationResourceType$outboundSchema: z.ZodNativeEnum<
+  typeof PersonalApplicationResourceType
+> = PersonalApplicationResourceType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PersonalApplicationResourceType$ {
+  /** @deprecated use `PersonalApplicationResourceType$inboundSchema` instead. */
+  export const inboundSchema = PersonalApplicationResourceType$inboundSchema;
+  /** @deprecated use `PersonalApplicationResourceType$outboundSchema` instead. */
+  export const outboundSchema = PersonalApplicationResourceType$outboundSchema;
+}
+
+/** @internal */
+export const PersonalApplicationResourceApplicationType$inboundSchema:
+  z.ZodNativeEnum<typeof PersonalApplicationResourceApplicationType> = z
+    .nativeEnum(PersonalApplicationResourceApplicationType);
+
+/** @internal */
+export const PersonalApplicationResourceApplicationType$outboundSchema:
+  z.ZodNativeEnum<typeof PersonalApplicationResourceApplicationType> =
+    PersonalApplicationResourceApplicationType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PersonalApplicationResourceApplicationType$ {
+  /** @deprecated use `PersonalApplicationResourceApplicationType$inboundSchema` instead. */
+  export const inboundSchema =
+    PersonalApplicationResourceApplicationType$inboundSchema;
+  /** @deprecated use `PersonalApplicationResourceApplicationType$outboundSchema` instead. */
+  export const outboundSchema =
+    PersonalApplicationResourceApplicationType$outboundSchema;
+}
+
+/** @internal */
+export const PersonalApplicationResourceAttributes$inboundSchema: z.ZodType<
+  PersonalApplicationResourceAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  humanId: z.string(),
+  applicationType: PersonalApplicationResourceApplicationType$inboundSchema,
+  status: ApplicationStatus$inboundSchema,
+  createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
+});
+
+/** @internal */
+export type PersonalApplicationResourceAttributes$Outbound = {
+  id?: string | undefined;
+  humanId: string;
+  applicationType: string;
+  status: string;
+  createdAt?: string | undefined;
+  updatedAt?: string | undefined;
+};
+
+/** @internal */
+export const PersonalApplicationResourceAttributes$outboundSchema: z.ZodType<
+  PersonalApplicationResourceAttributes$Outbound,
+  z.ZodTypeDef,
+  PersonalApplicationResourceAttributes
+> = z.object({
+  id: z.string().optional(),
+  humanId: z.string(),
+  applicationType: PersonalApplicationResourceApplicationType$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 PersonalApplicationResourceAttributes$ {
+  /** @deprecated use `PersonalApplicationResourceAttributes$inboundSchema` instead. */
+  export const inboundSchema =
+    PersonalApplicationResourceAttributes$inboundSchema;
+  /** @deprecated use `PersonalApplicationResourceAttributes$outboundSchema` instead. */
+  export const outboundSchema =
+    PersonalApplicationResourceAttributes$outboundSchema;
+  /** @deprecated use `PersonalApplicationResourceAttributes$Outbound` instead. */
+  export type Outbound = PersonalApplicationResourceAttributes$Outbound;
+}
+
+export function personalApplicationResourceAttributesToJSON(
+  personalApplicationResourceAttributes: PersonalApplicationResourceAttributes,
+): string {
+  return JSON.stringify(
+    PersonalApplicationResourceAttributes$outboundSchema.parse(
+      personalApplicationResourceAttributes,
+    ),
+  );
+}
+
+export function personalApplicationResourceAttributesFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonalApplicationResourceAttributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PersonalApplicationResourceAttributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonalApplicationResourceAttributes' from JSON`,
+  );
+}
+
+/** @internal */
+export const PersonalApplicationResource$inboundSchema: z.ZodType<
+  PersonalApplicationResource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PersonalApplicationResourceType$inboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() => PersonalApplicationResourceAttributes$inboundSchema),
+  relationships: PersonalApplicationJsonApiRelationships$inboundSchema,
+  links: z.record(LinkObject$inboundSchema).optional(),
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type PersonalApplicationResource$Outbound = {
+  type: string;
+  id?: string | undefined;
+  attributes: PersonalApplicationResourceAttributes$Outbound;
+  relationships: PersonalApplicationJsonApiRelationships$Outbound;
+  links?: { [k: string]: LinkObject$Outbound } | undefined;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PersonalApplicationResource$outboundSchema: z.ZodType<
+  PersonalApplicationResource$Outbound,
+  z.ZodTypeDef,
+  PersonalApplicationResource
+> = z.object({
+  type: PersonalApplicationResourceType$outboundSchema,
+  id: z.string().optional(),
+  attributes: z.lazy(() =>
+    PersonalApplicationResourceAttributes$outboundSchema
+  ),
+  relationships: PersonalApplicationJsonApiRelationships$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 PersonalApplicationResource$ {
+  /** @deprecated use `PersonalApplicationResource$inboundSchema` instead. */
+  export const inboundSchema = PersonalApplicationResource$inboundSchema;
+  /** @deprecated use `PersonalApplicationResource$outboundSchema` instead. */
+  export const outboundSchema = PersonalApplicationResource$outboundSchema;
+  /** @deprecated use `PersonalApplicationResource$Outbound` instead. */
+  export type Outbound = PersonalApplicationResource$Outbound;
+}
+
+export function personalApplicationResourceToJSON(
+  personalApplicationResource: PersonalApplicationResource,
+): string {
+  return JSON.stringify(
+    PersonalApplicationResource$outboundSchema.parse(
+      personalApplicationResource,
+    ),
+  );
+}
+
+export function personalApplicationResourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonalApplicationResource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonalApplicationResource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonalApplicationResource' from JSON`,
+  );
+}