@oatfi/oatfi-sdk-ts 0.12.0 → 0.12.3

package/src/models/brandingconfigdto.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type BrandingConfigDto = {
+  primaryColor: string | null;
+  secondaryColor: string | null;
+  logoUrl: string | null;
+  primaryButtonColor: string | null;
+  secondaryButtonColor: string | null;
+  borderRadius: number | null;
+  borderWidth: number | null;
+  fontFamily: string | null;
+};
+
+/** @internal */
+export const BrandingConfigDto$inboundSchema: z.ZodType<
+  BrandingConfigDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  primary_color: types.nullable(types.string()),
+  secondary_color: types.nullable(types.string()),
+  logo_url: types.nullable(types.string()),
+  primary_button_color: types.nullable(types.string()),
+  secondary_button_color: types.nullable(types.string()),
+  border_radius: types.nullable(types.number()),
+  border_width: types.nullable(types.number()),
+  font_family: types.nullable(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "primary_color": "primaryColor",
+    "secondary_color": "secondaryColor",
+    "logo_url": "logoUrl",
+    "primary_button_color": "primaryButtonColor",
+    "secondary_button_color": "secondaryButtonColor",
+    "border_radius": "borderRadius",
+    "border_width": "borderWidth",
+    "font_family": "fontFamily",
+  });
+});
+
+export function brandingConfigDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BrandingConfigDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BrandingConfigDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BrandingConfigDto' from JSON`,
+  );
+}

package/src/models/brandingconfigurationdto.ts

@@ -0,0 +1,127 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type BrandingConfigurationDto = {
+  /**
+   * Primary brand color
+   */
+  primaryColor?: string | null | undefined;
+  /**
+   * Secondary brand color
+   */
+  secondaryColor?: string | null | undefined;
+  /**
+   * Logo URL
+   */
+  logoUrl?: string | null | undefined;
+  /**
+   * Primary button color
+   */
+  primaryButtonColor?: string | null | undefined;
+  /**
+   * Secondary button color
+   */
+  secondaryButtonColor?: string | null | undefined;
+  /**
+   * Border radius in pixels
+   */
+  borderRadius?: number | null | undefined;
+  /**
+   * Border width in pixels
+   */
+  borderWidth?: number | null | undefined;
+  /**
+   * Font family
+   */
+  fontFamily?: string | null | undefined;
+};
+
+/** @internal */
+export const BrandingConfigurationDto$inboundSchema: z.ZodType<
+  BrandingConfigurationDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  primary_color: z.nullable(types.string()).optional(),
+  secondary_color: z.nullable(types.string()).optional(),
+  logo_url: z.nullable(types.string()).optional(),
+  primary_button_color: z.nullable(types.string()).optional(),
+  secondary_button_color: z.nullable(types.string()).optional(),
+  border_radius: z.nullable(types.number()).optional(),
+  border_width: z.nullable(types.number()).optional(),
+  font_family: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "primary_color": "primaryColor",
+    "secondary_color": "secondaryColor",
+    "logo_url": "logoUrl",
+    "primary_button_color": "primaryButtonColor",
+    "secondary_button_color": "secondaryButtonColor",
+    "border_radius": "borderRadius",
+    "border_width": "borderWidth",
+    "font_family": "fontFamily",
+  });
+});
+/** @internal */
+export type BrandingConfigurationDto$Outbound = {
+  primary_color?: string | null | undefined;
+  secondary_color?: string | null | undefined;
+  logo_url?: string | null | undefined;
+  primary_button_color?: string | null | undefined;
+  secondary_button_color?: string | null | undefined;
+  border_radius?: number | null | undefined;
+  border_width?: number | null | undefined;
+  font_family?: string | null | undefined;
+};
+
+/** @internal */
+export const BrandingConfigurationDto$outboundSchema: z.ZodType<
+  BrandingConfigurationDto$Outbound,
+  z.ZodTypeDef,
+  BrandingConfigurationDto
+> = z.object({
+  primaryColor: z.nullable(z.string()).optional(),
+  secondaryColor: z.nullable(z.string()).optional(),
+  logoUrl: z.nullable(z.string()).optional(),
+  primaryButtonColor: z.nullable(z.string()).optional(),
+  secondaryButtonColor: z.nullable(z.string()).optional(),
+  borderRadius: z.nullable(z.number()).optional(),
+  borderWidth: z.nullable(z.number()).optional(),
+  fontFamily: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    primaryColor: "primary_color",
+    secondaryColor: "secondary_color",
+    logoUrl: "logo_url",
+    primaryButtonColor: "primary_button_color",
+    secondaryButtonColor: "secondary_button_color",
+    borderRadius: "border_radius",
+    borderWidth: "border_width",
+    fontFamily: "font_family",
+  });
+});
+
+export function brandingConfigurationDtoToJSON(
+  brandingConfigurationDto: BrandingConfigurationDto,
+): string {
+  return JSON.stringify(
+    BrandingConfigurationDto$outboundSchema.parse(brandingConfigurationDto),
+  );
+}
+export function brandingConfigurationDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BrandingConfigurationDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BrandingConfigurationDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BrandingConfigurationDto' from JSON`,
+  );
+}

package/src/models/brandingresponsedto.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  BrandingConfigDto,
+  BrandingConfigDto$inboundSchema,
+} from "./brandingconfigdto.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type BrandingResponseDto = {
+  brandingConfiguration: BrandingConfigDto;
+};
+
+/** @internal */
+export const BrandingResponseDto$inboundSchema: z.ZodType<
+  BrandingResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  branding_configuration: BrandingConfigDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "branding_configuration": "brandingConfiguration",
+  });
+});
+
+export function brandingResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BrandingResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BrandingResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BrandingResponseDto' from JSON`,
+  );
+}

package/src/models/businessloanprogramenrollmentresponsedto.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Category of the fee range
+ */
+export const BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime =
+  {
+    OnTime: "ON_TIME",
+    EarlyPay: "EARLY_PAY",
+    Custom: "CUSTOM",
+  } as const;
+/**
+ * Category of the fee range
+ */
+export type BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime =
+  ClosedEnum<
+    typeof BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime
+  >;
+
+export type BusinessLoanProgramEnrollmentResponseDto = {
+  object: string;
+  id: string;
+  business: string;
+  program: string;
+  preferredDisbursementTime?:
+    | BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime
+    | null
+    | undefined;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime$inboundSchema:
+  z.ZodNativeEnum<
+    typeof BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime
+  > = z.nativeEnum(
+    BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime,
+  );
+
+/** @internal */
+export const BusinessLoanProgramEnrollmentResponseDto$inboundSchema: z.ZodType<
+  BusinessLoanProgramEnrollmentResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string(),
+  id: types.string(),
+  business: types.string(),
+  program: types.string(),
+  preferred_disbursement_time: z.nullable(
+    BusinessLoanProgramEnrollmentResponseDtoPreferredDisbursementTime$inboundSchema,
+  ).optional(),
+  created_at: types.date(),
+  updated_at: types.date(),
+}).transform((v) => {
+  return remap$(v, {
+    "preferred_disbursement_time": "preferredDisbursementTime",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function businessLoanProgramEnrollmentResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  BusinessLoanProgramEnrollmentResponseDto,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BusinessLoanProgramEnrollmentResponseDto$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'BusinessLoanProgramEnrollmentResponseDto' from JSON`,
+  );
+}

package/src/models/companynamecandidatedto.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type CompanyNameCandidateDto = {
+  /**
+   * Candidate text extracted from the PDF
+   */
+  text: string;
+  /**
+   * Heuristic score used for ranking (higher = better)
+   */
+  score: number;
+  /**
+   * Breakdown of the score contributions
+   */
+  reasons: Array<string>;
+  /**
+   * Y position as a fraction of the page height (1 = top, 0 = bottom)
+   */
+  yPositionPct: number;
+  /**
+   * Font size (in PDF units) of the dominant text in the line
+   */
+  fontSize: number;
+  /**
+   * Whether the line uses a bold font variant
+   */
+  isBold: boolean;
+  /**
+   * Whether the line is written in ALL CAPS
+   */
+  isAllCaps: boolean;
+  /**
+   * Page number where the candidate was found
+   */
+  page: number;
+};
+
+/** @internal */
+export const CompanyNameCandidateDto$inboundSchema: z.ZodType<
+  CompanyNameCandidateDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  text: types.string(),
+  score: types.number(),
+  reasons: z.array(types.string()),
+  y_position_pct: types.number(),
+  font_size: types.number(),
+  is_bold: types.boolean(),
+  is_all_caps: types.boolean(),
+  page: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "y_position_pct": "yPositionPct",
+    "font_size": "fontSize",
+    "is_bold": "isBold",
+    "is_all_caps": "isAllCaps",
+  });
+});
+
+export function companyNameCandidateDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyNameCandidateDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyNameCandidateDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyNameCandidateDto' from JSON`,
+  );
+}

package/src/models/createagreementassignmentdto.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * How the terms were accepted. The internal endpoint only accepts HOSTED or COMPONENT — PARTNER_API and AUTO are rejected.
+ */
+export const CreateAgreementAssignmentDtoAcceptedVia = {
+  Hosted: "HOSTED",
+  Component: "COMPONENT",
+} as const;
+/**
+ * How the terms were accepted. The internal endpoint only accepts HOSTED or COMPONENT — PARTNER_API and AUTO are rejected.
+ */
+export type CreateAgreementAssignmentDtoAcceptedVia = ClosedEnum<
+  typeof CreateAgreementAssignmentDtoAcceptedVia
+>;
+
+/**
+ * Collection name of the entity
+ */
+export const CreateAgreementAssignmentDtoEntityCollectionName = {
+  Businesses: "businesses",
+} as const;
+/**
+ * Collection name of the entity
+ */
+export type CreateAgreementAssignmentDtoEntityCollectionName = ClosedEnum<
+  typeof CreateAgreementAssignmentDtoEntityCollectionName
+>;
+
+/**
+ * Type of agreement
+ */
+export const CreateAgreementAssignmentDtoType = {
+  OnboardingTerms: "ONBOARDING_TERMS",
+} as const;
+/**
+ * Type of agreement
+ */
+export type CreateAgreementAssignmentDtoType = ClosedEnum<
+  typeof CreateAgreementAssignmentDtoType
+>;
+
+export type CreateAgreementAssignmentDto = {
+  /**
+   * URL to the exact PDF/HTML artifact accepted
+   */
+  termsFileUrl?: string | undefined;
+  /**
+   * How the terms were accepted. The internal endpoint only accepts HOSTED or COMPONENT — PARTNER_API and AUTO are rejected.
+   */
+  acceptedVia: CreateAgreementAssignmentDtoAcceptedVia;
+  /**
+   * Whether the end user actually accepted the agreement. HOSTED and COMPONENT flows always send true; AUTO assignments are always false. Defaults to true when omitted.
+   */
+  userAccepted?: boolean | undefined;
+  /**
+   * ID of the entity that accepted the terms (application, business, or person)
+   */
+  entityId: string;
+  /**
+   * Collection name of the entity
+   */
+  entityCollectionName: CreateAgreementAssignmentDtoEntityCollectionName;
+  /**
+   * ID of the loan program
+   */
+  loanProgram: string;
+  /**
+   * Type of agreement
+   */
+  type: CreateAgreementAssignmentDtoType;
+};
+
+/** @internal */
+export const CreateAgreementAssignmentDtoAcceptedVia$outboundSchema:
+  z.ZodNativeEnum<typeof CreateAgreementAssignmentDtoAcceptedVia> = z
+    .nativeEnum(CreateAgreementAssignmentDtoAcceptedVia);
+
+/** @internal */
+export const CreateAgreementAssignmentDtoEntityCollectionName$outboundSchema:
+  z.ZodNativeEnum<typeof CreateAgreementAssignmentDtoEntityCollectionName> = z
+    .nativeEnum(CreateAgreementAssignmentDtoEntityCollectionName);
+
+/** @internal */
+export const CreateAgreementAssignmentDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof CreateAgreementAssignmentDtoType
+> = z.nativeEnum(CreateAgreementAssignmentDtoType);
+
+/** @internal */
+export type CreateAgreementAssignmentDto$Outbound = {
+  terms_file_url?: string | undefined;
+  accepted_via: string;
+  user_accepted?: boolean | undefined;
+  entity_id: string;
+  entity_collection_name: string;
+  loan_program: string;
+  type: string;
+};
+
+/** @internal */
+export const CreateAgreementAssignmentDto$outboundSchema: z.ZodType<
+  CreateAgreementAssignmentDto$Outbound,
+  z.ZodTypeDef,
+  CreateAgreementAssignmentDto
+> = z.object({
+  termsFileUrl: z.string().optional(),
+  acceptedVia: CreateAgreementAssignmentDtoAcceptedVia$outboundSchema,
+  userAccepted: z.boolean().optional(),
+  entityId: z.string(),
+  entityCollectionName:
+    CreateAgreementAssignmentDtoEntityCollectionName$outboundSchema,
+  loanProgram: z.string(),
+  type: CreateAgreementAssignmentDtoType$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    termsFileUrl: "terms_file_url",
+    acceptedVia: "accepted_via",
+    userAccepted: "user_accepted",
+    entityId: "entity_id",
+    entityCollectionName: "entity_collection_name",
+    loanProgram: "loan_program",
+  });
+});
+
+export function createAgreementAssignmentDtoToJSON(
+  createAgreementAssignmentDto: CreateAgreementAssignmentDto,
+): string {
+  return JSON.stringify(
+    CreateAgreementAssignmentDto$outboundSchema.parse(
+      createAgreementAssignmentDto,
+    ),
+  );
+}

package/src/models/createholddto.ts

@@ -10,10 +10,6 @@ export type CreateHoldDto = {
    * The Product Id
    */
   productUuid: string;
-  /**
-   * The Business External Id
-   */
-  businessExternalId: string;
   /**
    * Holding amount
    */
@@ -31,7 +27,6 @@ export type CreateHoldDto = {
 /** @internal */
 export type CreateHoldDto$Outbound = {
   product_uuid: string;
-  business_external_id: string;
   amount: number;
   description: string;
   expiration_date?: string | undefined;
@@ -44,14 +39,12 @@ export const CreateHoldDto$outboundSchema: z.ZodType<
   CreateHoldDto
 > = z.object({
   productUuid: z.string(),
-  businessExternalId: z.string(),
   amount: z.number(),
   description: z.string(),
   expirationDate: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
   return remap$(v, {
     productUuid: "product_uuid",
-    businessExternalId: "business_external_id",
     expirationDate: "expiration_date",
   });
 });

package/src/models/createledgerentrydto.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Type of the ledger entry.
+ */
+export const CreateLedgerEntryDtoType = {
+  Invoice: "INVOICE",
+  CardReceivable: "CARD_RECEIVABLE",
+} as const;
+/**
+ * Type of the ledger entry.
+ */
+export type CreateLedgerEntryDtoType = ClosedEnum<
+  typeof CreateLedgerEntryDtoType
+>;
+
+export type CreateLedgerEntryDto = {
+  /**
+   * External identifier for the ledger entry.
+   */
+  externalId: string;
+  /**
+   * Type of the ledger entry.
+   */
+  type: CreateLedgerEntryDtoType;
+  /**
+   * Amount of the ledger entry, in cents (e.g., 1000 for $10.00). Must be a positive integer.
+   */
+  amount: number;
+  /**
+   * Amount that has been paid for this ledger entry, in cents. Must be a positive integer.
+   */
+  paidAmount?: number | undefined;
+  /**
+   * Date when the ledger entry was created or issued (ISO 8601 format).
+   */
+  createdDate?: string | undefined;
+  /**
+   * Date when the ledger entry is due (ISO 8601 format).
+   */
+  dueDate?: string | undefined;
+  /**
+   * Date when the ledger entry was paid (ISO 8601 format).
+   */
+  paymentDate?: string | undefined;
+  /**
+   * A textual description of the ledger entry.
+   */
+  description?: string | undefined;
+  /**
+   * Ledger entry approved by Payor.
+   */
+  approvedByPayor?: boolean | undefined;
+  /**
+   * Mongo ID of the payor organization.
+   */
+  payor?: string | undefined;
+  /**
+   * Mongo ID of the payee organization.
+   */
+  payee?: string | undefined;
+};
+
+/** @internal */
+export const CreateLedgerEntryDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof CreateLedgerEntryDtoType
+> = z.nativeEnum(CreateLedgerEntryDtoType);
+
+/** @internal */
+export type CreateLedgerEntryDto$Outbound = {
+  external_id: string;
+  type: string;
+  amount: number;
+  paid_amount?: number | undefined;
+  created_date?: string | undefined;
+  due_date?: string | undefined;
+  payment_date?: string | undefined;
+  description?: string | undefined;
+  approved_by_payor?: boolean | undefined;
+  payor?: string | undefined;
+  payee?: string | undefined;
+};
+
+/** @internal */
+export const CreateLedgerEntryDto$outboundSchema: z.ZodType<
+  CreateLedgerEntryDto$Outbound,
+  z.ZodTypeDef,
+  CreateLedgerEntryDto
+> = z.object({
+  externalId: z.string(),
+  type: CreateLedgerEntryDtoType$outboundSchema,
+  amount: z.number(),
+  paidAmount: z.number().optional(),
+  createdDate: z.string().optional(),
+  dueDate: z.string().optional(),
+  paymentDate: z.string().optional(),
+  description: z.string().optional(),
+  approvedByPayor: z.boolean().optional(),
+  payor: z.string().optional(),
+  payee: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    paidAmount: "paid_amount",
+    createdDate: "created_date",
+    dueDate: "due_date",
+    paymentDate: "payment_date",
+    approvedByPayor: "approved_by_payor",
+  });
+});
+
+export function createLedgerEntryDtoToJSON(
+  createLedgerEntryDto: CreateLedgerEntryDto,
+): string {
+  return JSON.stringify(
+    CreateLedgerEntryDto$outboundSchema.parse(createLedgerEntryDto),
+  );
+}