@financeable/lenders 0.0.1

package/src/models/components/applicantasset.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Applicant asset model
+ */
+export type ApplicantAsset = {
+  id: string;
+  assetType: string;
+  value: string;
+  description?: string | undefined;
+};
+
+/** @internal */
+export const ApplicantAsset$inboundSchema: z.ZodType<
+  ApplicantAsset,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  assetType: z.string(),
+  value: z.string(),
+  description: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type ApplicantAsset$Outbound = {
+  _id: string;
+  assetType: string;
+  value: string;
+  description?: string | undefined;
+};
+
+/** @internal */
+export const ApplicantAsset$outboundSchema: z.ZodType<
+  ApplicantAsset$Outbound,
+  z.ZodTypeDef,
+  ApplicantAsset
+> = z.object({
+  id: z.string(),
+  assetType: z.string(),
+  value: z.string(),
+  description: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ApplicantAsset$ {
+  /** @deprecated use `ApplicantAsset$inboundSchema` instead. */
+  export const inboundSchema = ApplicantAsset$inboundSchema;
+  /** @deprecated use `ApplicantAsset$outboundSchema` instead. */
+  export const outboundSchema = ApplicantAsset$outboundSchema;
+  /** @deprecated use `ApplicantAsset$Outbound` instead. */
+  export type Outbound = ApplicantAsset$Outbound;
+}
+
+export function applicantAssetToJSON(applicantAsset: ApplicantAsset): string {
+  return JSON.stringify(ApplicantAsset$outboundSchema.parse(applicantAsset));
+}
+
+export function applicantAssetFromJSON(
+  jsonString: string,
+): SafeParseResult<ApplicantAsset, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApplicantAsset$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApplicantAsset' from JSON`,
+  );
+}

package/src/models/components/email.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Email model
+ */
+export type Email = {
+  status: string;
+  address: string;
+};
+
+/** @internal */
+export const Email$inboundSchema: z.ZodType<Email, z.ZodTypeDef, unknown> = z
+  .object({
+    status: z.string(),
+    address: z.string(),
+  });
+
+/** @internal */
+export type Email$Outbound = {
+  status: string;
+  address: string;
+};
+
+/** @internal */
+export const Email$outboundSchema: z.ZodType<
+  Email$Outbound,
+  z.ZodTypeDef,
+  Email
+> = z.object({
+  status: z.string(),
+  address: 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 Email$ {
+  /** @deprecated use `Email$inboundSchema` instead. */
+  export const inboundSchema = Email$inboundSchema;
+  /** @deprecated use `Email$outboundSchema` instead. */
+  export const outboundSchema = Email$outboundSchema;
+  /** @deprecated use `Email$Outbound` instead. */
+  export type Outbound = Email$Outbound;
+}
+
+export function emailToJSON(email: Email): string {
+  return JSON.stringify(Email$outboundSchema.parse(email));
+}
+
+export function emailFromJSON(
+  jsonString: string,
+): SafeParseResult<Email, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Email$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Email' from JSON`,
+  );
+}

package/src/models/components/employer.ts

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EmployerAddress = {
+  postcode?: string | undefined;
+};
+
+/**
+ * Employer model
+ */
+export type Employer = {
+  entityName?: string | undefined;
+  phoneNumber?: string | undefined;
+  address?: EmployerAddress | undefined;
+  employerPhoneExtension?: string | undefined;
+  occupation?: string | undefined;
+  industry?: string | undefined;
+  employmentType?: string | undefined;
+  timeOfEmployment?: string | undefined;
+};
+
+/** @internal */
+export const EmployerAddress$inboundSchema: z.ZodType<
+  EmployerAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  postcode: z.string().optional(),
+});
+
+/** @internal */
+export type EmployerAddress$Outbound = {
+  postcode?: string | undefined;
+};
+
+/** @internal */
+export const EmployerAddress$outboundSchema: z.ZodType<
+  EmployerAddress$Outbound,
+  z.ZodTypeDef,
+  EmployerAddress
+> = z.object({
+  postcode: 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 EmployerAddress$ {
+  /** @deprecated use `EmployerAddress$inboundSchema` instead. */
+  export const inboundSchema = EmployerAddress$inboundSchema;
+  /** @deprecated use `EmployerAddress$outboundSchema` instead. */
+  export const outboundSchema = EmployerAddress$outboundSchema;
+  /** @deprecated use `EmployerAddress$Outbound` instead. */
+  export type Outbound = EmployerAddress$Outbound;
+}
+
+export function employerAddressToJSON(
+  employerAddress: EmployerAddress,
+): string {
+  return JSON.stringify(EmployerAddress$outboundSchema.parse(employerAddress));
+}
+
+export function employerAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<EmployerAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmployerAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmployerAddress' from JSON`,
+  );
+}
+
+/** @internal */
+export const Employer$inboundSchema: z.ZodType<
+  Employer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entityName: z.string().optional(),
+  phoneNumber: z.string().optional(),
+  address: z.lazy(() => EmployerAddress$inboundSchema).optional(),
+  employerPhoneExtension: z.string().optional(),
+  occupation: z.string().optional(),
+  industry: z.string().optional(),
+  employmentType: z.string().optional(),
+  timeOfEmployment: z.string().optional(),
+});
+
+/** @internal */
+export type Employer$Outbound = {
+  entityName?: string | undefined;
+  phoneNumber?: string | undefined;
+  address?: EmployerAddress$Outbound | undefined;
+  employerPhoneExtension?: string | undefined;
+  occupation?: string | undefined;
+  industry?: string | undefined;
+  employmentType?: string | undefined;
+  timeOfEmployment?: string | undefined;
+};
+
+/** @internal */
+export const Employer$outboundSchema: z.ZodType<
+  Employer$Outbound,
+  z.ZodTypeDef,
+  Employer
+> = z.object({
+  entityName: z.string().optional(),
+  phoneNumber: z.string().optional(),
+  address: z.lazy(() => EmployerAddress$outboundSchema).optional(),
+  employerPhoneExtension: z.string().optional(),
+  occupation: z.string().optional(),
+  industry: z.string().optional(),
+  employmentType: z.string().optional(),
+  timeOfEmployment: 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 Employer$ {
+  /** @deprecated use `Employer$inboundSchema` instead. */
+  export const inboundSchema = Employer$inboundSchema;
+  /** @deprecated use `Employer$outboundSchema` instead. */
+  export const outboundSchema = Employer$outboundSchema;
+  /** @deprecated use `Employer$Outbound` instead. */
+  export type Outbound = Employer$Outbound;
+}
+
+export function employerToJSON(employer: Employer): string {
+  return JSON.stringify(Employer$outboundSchema.parse(employer));
+}
+
+export function employerFromJSON(
+  jsonString: string,
+): SafeParseResult<Employer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Employer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Employer' from JSON`,
+  );
+}

package/src/models/components/errorsource.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ErrorSource = {
+  /**
+   * A JSON Pointer to the associated entity in the request document.
+   */
+  pointer?: string | undefined;
+  /**
+   * A string indicating which URI query parameter caused the error.
+   */
+  parameter?: string | undefined;
+  /**
+   * A string indicating which HTTP header caused the error.
+   */
+  header?: string | undefined;
+};
+
+/** @internal */
+export const ErrorSource$inboundSchema: z.ZodType<
+  ErrorSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pointer: z.string().optional(),
+  parameter: z.string().optional(),
+  header: z.string().optional(),
+});
+
+/** @internal */
+export type ErrorSource$Outbound = {
+  pointer?: string | undefined;
+  parameter?: string | undefined;
+  header?: string | undefined;
+};
+
+/** @internal */
+export const ErrorSource$outboundSchema: z.ZodType<
+  ErrorSource$Outbound,
+  z.ZodTypeDef,
+  ErrorSource
+> = z.object({
+  pointer: z.string().optional(),
+  parameter: z.string().optional(),
+  header: 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 ErrorSource$ {
+  /** @deprecated use `ErrorSource$inboundSchema` instead. */
+  export const inboundSchema = ErrorSource$inboundSchema;
+  /** @deprecated use `ErrorSource$outboundSchema` instead. */
+  export const outboundSchema = ErrorSource$outboundSchema;
+  /** @deprecated use `ErrorSource$Outbound` instead. */
+  export type Outbound = ErrorSource$Outbound;
+}
+
+export function errorSourceToJSON(errorSource: ErrorSource): string {
+  return JSON.stringify(ErrorSource$outboundSchema.parse(errorSource));
+}
+
+export function errorSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorSource' from JSON`,
+  );
+}

package/src/models/components/fee.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Fee model
+ */
+export type Fee = {
+  name: string;
+  value: string;
+};
+
+/** @internal */
+export const Fee$inboundSchema: z.ZodType<Fee, z.ZodTypeDef, unknown> = z
+  .object({
+    name: z.string(),
+    value: z.string(),
+  });
+
+/** @internal */
+export type Fee$Outbound = {
+  name: string;
+  value: string;
+};
+
+/** @internal */
+export const Fee$outboundSchema: z.ZodType<Fee$Outbound, z.ZodTypeDef, Fee> = z
+  .object({
+    name: z.string(),
+    value: 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 Fee$ {
+  /** @deprecated use `Fee$inboundSchema` instead. */
+  export const inboundSchema = Fee$inboundSchema;
+  /** @deprecated use `Fee$outboundSchema` instead. */
+  export const outboundSchema = Fee$outboundSchema;
+  /** @deprecated use `Fee$Outbound` instead. */
+  export type Outbound = Fee$Outbound;
+}
+
+export function feeToJSON(fee: Fee): string {
+  return JSON.stringify(Fee$outboundSchema.parse(fee));
+}
+
+export function feeFromJSON(
+  jsonString: string,
+): SafeParseResult<Fee, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fee$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fee' from JSON`,
+  );
+}

package/src/models/components/forbiddenerror.ts

@@ -0,0 +1,216 @@
+/*
+ * 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 {
+  APIErrorLinks,
+  APIErrorLinks$inboundSchema,
+  APIErrorLinks$Outbound,
+  APIErrorLinks$outboundSchema,
+} from "./apierrorlinks.js";
+import {
+  ErrorSource,
+  ErrorSource$inboundSchema,
+  ErrorSource$Outbound,
+  ErrorSource$outboundSchema,
+} from "./errorsource.js";
+
+export const ForbiddenErrorCode = {
+  AuthorizationError: "AUTHORIZATION_ERROR",
+} as const;
+export type ForbiddenErrorCode = ClosedEnum<typeof ForbiddenErrorCode>;
+
+export const ForbiddenErrorTitle = {
+  Forbidden: "Forbidden",
+} as const;
+export type ForbiddenErrorTitle = ClosedEnum<typeof ForbiddenErrorTitle>;
+
+export const ForbiddenErrorStatus = {
+  FourHundredAndThree: "403",
+} as const;
+export type ForbiddenErrorStatus = ClosedEnum<typeof ForbiddenErrorStatus>;
+
+export const ForbiddenErrorDetail = {
+  YouDoNotHavePermissionToPerformThisAction:
+    "You do not have permission to perform this action.",
+} as const;
+export type ForbiddenErrorDetail = ClosedEnum<typeof ForbiddenErrorDetail>;
+
+/**
+ * Api Error response
+ */
+export type ForbiddenError = {
+  /**
+   * A URI linking to the Financeable documentation of the error
+   */
+  links?: APIErrorLinks | undefined;
+  code: ForbiddenErrorCode;
+  title: ForbiddenErrorTitle;
+  status: ForbiddenErrorStatus;
+  /**
+   * An object describing the source of the error from the request
+   */
+  source?: ErrorSource | undefined;
+  detail: ForbiddenErrorDetail;
+  /**
+   * Additional information that can not be classified
+   */
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ForbiddenErrorCode$inboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorCode
+> = z.nativeEnum(ForbiddenErrorCode);
+
+/** @internal */
+export const ForbiddenErrorCode$outboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorCode
+> = ForbiddenErrorCode$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ForbiddenErrorCode$ {
+  /** @deprecated use `ForbiddenErrorCode$inboundSchema` instead. */
+  export const inboundSchema = ForbiddenErrorCode$inboundSchema;
+  /** @deprecated use `ForbiddenErrorCode$outboundSchema` instead. */
+  export const outboundSchema = ForbiddenErrorCode$outboundSchema;
+}
+
+/** @internal */
+export const ForbiddenErrorTitle$inboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorTitle
+> = z.nativeEnum(ForbiddenErrorTitle);
+
+/** @internal */
+export const ForbiddenErrorTitle$outboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorTitle
+> = ForbiddenErrorTitle$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ForbiddenErrorTitle$ {
+  /** @deprecated use `ForbiddenErrorTitle$inboundSchema` instead. */
+  export const inboundSchema = ForbiddenErrorTitle$inboundSchema;
+  /** @deprecated use `ForbiddenErrorTitle$outboundSchema` instead. */
+  export const outboundSchema = ForbiddenErrorTitle$outboundSchema;
+}
+
+/** @internal */
+export const ForbiddenErrorStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorStatus
+> = z.nativeEnum(ForbiddenErrorStatus);
+
+/** @internal */
+export const ForbiddenErrorStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorStatus
+> = ForbiddenErrorStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ForbiddenErrorStatus$ {
+  /** @deprecated use `ForbiddenErrorStatus$inboundSchema` instead. */
+  export const inboundSchema = ForbiddenErrorStatus$inboundSchema;
+  /** @deprecated use `ForbiddenErrorStatus$outboundSchema` instead. */
+  export const outboundSchema = ForbiddenErrorStatus$outboundSchema;
+}
+
+/** @internal */
+export const ForbiddenErrorDetail$inboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorDetail
+> = z.nativeEnum(ForbiddenErrorDetail);
+
+/** @internal */
+export const ForbiddenErrorDetail$outboundSchema: z.ZodNativeEnum<
+  typeof ForbiddenErrorDetail
+> = ForbiddenErrorDetail$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ForbiddenErrorDetail$ {
+  /** @deprecated use `ForbiddenErrorDetail$inboundSchema` instead. */
+  export const inboundSchema = ForbiddenErrorDetail$inboundSchema;
+  /** @deprecated use `ForbiddenErrorDetail$outboundSchema` instead. */
+  export const outboundSchema = ForbiddenErrorDetail$outboundSchema;
+}
+
+/** @internal */
+export const ForbiddenError$inboundSchema: z.ZodType<
+  ForbiddenError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  links: APIErrorLinks$inboundSchema.optional(),
+  code: ForbiddenErrorCode$inboundSchema,
+  title: ForbiddenErrorTitle$inboundSchema,
+  status: ForbiddenErrorStatus$inboundSchema,
+  source: ErrorSource$inboundSchema.optional(),
+  detail: ForbiddenErrorDetail$inboundSchema,
+  meta: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type ForbiddenError$Outbound = {
+  links?: APIErrorLinks$Outbound | undefined;
+  code: string;
+  title: string;
+  status: string;
+  source?: ErrorSource$Outbound | undefined;
+  detail: string;
+  meta?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ForbiddenError$outboundSchema: z.ZodType<
+  ForbiddenError$Outbound,
+  z.ZodTypeDef,
+  ForbiddenError
+> = z.object({
+  links: APIErrorLinks$outboundSchema.optional(),
+  code: ForbiddenErrorCode$outboundSchema,
+  title: ForbiddenErrorTitle$outboundSchema,
+  status: ForbiddenErrorStatus$outboundSchema,
+  source: ErrorSource$outboundSchema.optional(),
+  detail: ForbiddenErrorDetail$outboundSchema,
+  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 ForbiddenError$ {
+  /** @deprecated use `ForbiddenError$inboundSchema` instead. */
+  export const inboundSchema = ForbiddenError$inboundSchema;
+  /** @deprecated use `ForbiddenError$outboundSchema` instead. */
+  export const outboundSchema = ForbiddenError$outboundSchema;
+  /** @deprecated use `ForbiddenError$Outbound` instead. */
+  export type Outbound = ForbiddenError$Outbound;
+}
+
+export function forbiddenErrorToJSON(forbiddenError: ForbiddenError): string {
+  return JSON.stringify(ForbiddenError$outboundSchema.parse(forbiddenError));
+}
+
+export function forbiddenErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ForbiddenError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ForbiddenError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ForbiddenError' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./address.js";
+export * from "./apierror.js";
+export * from "./apierrorcodes.js";
+export * from "./apierrorlinks.js";
+export * from "./applicantasset.js";
+export * from "./email.js";
+export * from "./employer.js";
+export * from "./errorsource.js";
+export * from "./fee.js";
+export * from "./forbiddenerror.js";
+export * from "./internalservererror.js";
+export * from "./label.js";
+export * from "./lenders.js";
+export * from "./notfounderror.js";
+export * from "./pepperconsumerasset.js";
+export * from "./pepperconsumercustomer.js";
+export * from "./pepperconsumercustomerprofile.js";
+export * from "./pepperconsumerentity.js";
+export * from "./pepperconsumerincome.js";
+export * from "./pepperconsumerliability.js";
+export * from "./pepperconsumerloandetails.js";
+export * from "./pepperconsumerrequest.js";
+export * from "./pepperlendercredentials.js";
+export * from "./peppersuccessresource.js";
+export * from "./phonenumber.js";
+export * from "./unauthorizederror.js";