@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.62

package/src/models/operations/onboardingtermscontrollerfindall.ts

@@ -0,0 +1,182 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
+
+/**
+ * Type of agreement
+ */
+export const Type = {
+  OnboardingTerms: "ONBOARDING_TERMS",
+} as const;
+/**
+ * Type of agreement
+ */
+export type Type = ClosedEnum<typeof Type>;
+
+export type OnboardingTermsControllerFindAllRequest = {
+  /**
+   * ID of the entity to query acceptances for
+   */
+  entityId: string;
+  /**
+   * ID of the loan program
+   */
+  loanProgramId: string;
+  /**
+   * Type of agreement
+   */
+  type: Type;
+  /**
+   * If true, return only the single latest record
+   */
+  latestOnly?: boolean | undefined;
+  /**
+   * Maximum number of items to return
+   */
+  limit?: number | undefined;
+  /**
+   * Return items after this cursor
+   */
+  startingAfter?: string | undefined;
+  /**
+   * Return items before this cursor
+   */
+  endingBefore?: string | undefined;
+};
+
+/**
+ * Agreement acceptance records retrieved successfully
+ */
+export type OnboardingTermsControllerFindAllResponseBody = {
+  object?: string | undefined;
+  data?: Array<models.OnboardingTermsAcceptanceResponseDto> | undefined;
+  hasMore?: boolean | undefined;
+  total?: number | undefined;
+};
+
+export type OnboardingTermsControllerFindAllResponse = {
+  result: OnboardingTermsControllerFindAllResponseBody;
+};
+
+/** @internal */
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export type OnboardingTermsControllerFindAllRequest$Outbound = {
+  entity_id: string;
+  loan_program_id: string;
+  type: string;
+  latest_only?: boolean | undefined;
+  limit?: number | undefined;
+  starting_after?: string | undefined;
+  ending_before?: string | undefined;
+};
+
+/** @internal */
+export const OnboardingTermsControllerFindAllRequest$outboundSchema: z.ZodType<
+  OnboardingTermsControllerFindAllRequest$Outbound,
+  z.ZodTypeDef,
+  OnboardingTermsControllerFindAllRequest
+> = z.object({
+  entityId: z.string(),
+  loanProgramId: z.string(),
+  type: Type$outboundSchema,
+  latestOnly: z.boolean().optional(),
+  limit: z.number().optional(),
+  startingAfter: z.string().optional(),
+  endingBefore: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    entityId: "entity_id",
+    loanProgramId: "loan_program_id",
+    latestOnly: "latest_only",
+    startingAfter: "starting_after",
+    endingBefore: "ending_before",
+  });
+});
+
+export function onboardingTermsControllerFindAllRequestToJSON(
+  onboardingTermsControllerFindAllRequest:
+    OnboardingTermsControllerFindAllRequest,
+): string {
+  return JSON.stringify(
+    OnboardingTermsControllerFindAllRequest$outboundSchema.parse(
+      onboardingTermsControllerFindAllRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const OnboardingTermsControllerFindAllResponseBody$inboundSchema:
+  z.ZodType<
+    OnboardingTermsControllerFindAllResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    object: z.string().optional(),
+    data: z.array(models.OnboardingTermsAcceptanceResponseDto$inboundSchema)
+      .optional(),
+    has_more: z.boolean().optional(),
+    total: z.number().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "has_more": "hasMore",
+    });
+  });
+
+export function onboardingTermsControllerFindAllResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  OnboardingTermsControllerFindAllResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      OnboardingTermsControllerFindAllResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'OnboardingTermsControllerFindAllResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const OnboardingTermsControllerFindAllResponse$inboundSchema: z.ZodType<
+  OnboardingTermsControllerFindAllResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() =>
+    OnboardingTermsControllerFindAllResponseBody$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function onboardingTermsControllerFindAllResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  OnboardingTermsControllerFindAllResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      OnboardingTermsControllerFindAllResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'OnboardingTermsControllerFindAllResponse' from JSON`,
+  );
+}

package/src/models/operations/underwritingtermscontrollergetunderwritingtermshtml.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest = {
+  /**
+   * Business ID
+   */
+  businessId: string;
+  /**
+   * Loan program ID
+   */
+  loanProgramId: string;
+};
+
+/** @internal */
+export type UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest$Outbound =
+  {
+    business_id: string;
+    loan_program_id: string;
+  };
+
+/** @internal */
+export const UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest$outboundSchema:
+  z.ZodType<
+    UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest$Outbound,
+    z.ZodTypeDef,
+    UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest
+  > = z.object({
+    businessId: z.string(),
+    loanProgramId: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      businessId: "business_id",
+      loanProgramId: "loan_program_id",
+    });
+  });
+
+export function underwritingTermsControllerGetUnderwritingTermsHtmlRequestToJSON(
+  underwritingTermsControllerGetUnderwritingTermsHtmlRequest:
+    UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest,
+): string {
+  return JSON.stringify(
+    UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest$outboundSchema
+      .parse(underwritingTermsControllerGetUnderwritingTermsHtmlRequest),
+  );
+}

package/src/models/originationbalancedto.ts

@@ -40,7 +40,7 @@ export type OriginationBalanceDto = {
   /**
    * Identifier for the associated payment intent
    */
-  paymentIntentId?: string | undefined;
+  paymentIntent?: string | undefined;
   /**
    * Current status of the origination
    */
@@ -71,7 +71,7 @@ export const OriginationBalanceDto$inboundSchema: z.ZodType<
   due_date: z.number(),
   outstanding_balance: OutstandingBalanceDto$inboundSchema,
   repaid_amount: z.number(),
-  payment_intent_id: z.string().optional(),
+  payment_intent: z.string().optional(),
   status: z.string(),
   sub_status: z.string(),
   next_installment_due_date: z.number().optional(),
@@ -82,7 +82,7 @@ export const OriginationBalanceDto$inboundSchema: z.ZodType<
     "due_date": "dueDate",
     "outstanding_balance": "outstandingBalance",
     "repaid_amount": "repaidAmount",
-    "payment_intent_id": "paymentIntentId",
+    "payment_intent": "paymentIntent",
     "sub_status": "subStatus",
     "next_installment_due_date": "nextInstallmentDueDate",
     "next_installment_amount": "nextInstallmentAmount",

package/src/models/originationbalanceresponsedto.ts

@@ -5,9 +5,30 @@
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
-import { LmsLoanStatus, LmsLoanStatus$inboundSchema } from "./lmsloanstatus.js";
+
+/**
+ * Current status of the origination.
+ */
+export const OriginationBalanceResponseDtoStatus = {
+  Active: "ACTIVE",
+  ChargedOff: "CHARGED_OFF",
+  Closed: "CLOSED",
+  Delinquent: "DELINQUENT",
+  PaidOff: "PAID_OFF",
+  Pending: "PENDING",
+  Migrating: "MIGRATING",
+  Cancelled: "CANCELLED",
+  Sold: "SOLD",
+} as const;
+/**
+ * Current status of the origination.
+ */
+export type OriginationBalanceResponseDtoStatus = ClosedEnum<
+  typeof OriginationBalanceResponseDtoStatus
+>;
 
 /**
  * Sale snapshot containing balance values at the time of sale.
@@ -44,9 +65,9 @@ export type OriginationBalanceResponseDto = {
    */
   interestBalance: number;
   /**
-   * Loan status
+   * Current status of the origination.
    */
-  status: LmsLoanStatus;
+  status: OriginationBalanceResponseDtoStatus;
   /**
    * Sale snapshot containing balance values at the time of sale.
    */
@@ -57,6 +78,11 @@ export type OriginationBalanceResponseDto = {
   saleDate?: number | undefined;
 };
 
+/** @internal */
+export const OriginationBalanceResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof OriginationBalanceResponseDtoStatus
+> = z.nativeEnum(OriginationBalanceResponseDtoStatus);
+
 /** @internal */
 export const SaleSnapshot$inboundSchema: z.ZodType<
   SaleSnapshot,
@@ -87,7 +113,7 @@ export const OriginationBalanceResponseDto$inboundSchema: z.ZodType<
   fee_balance: z.number().optional(),
   late_fee_balance: z.number().optional(),
   interest_balance: z.number(),
-  status: LmsLoanStatus$inboundSchema,
+  status: OriginationBalanceResponseDtoStatus$inboundSchema,
   sale_snapshot: z.lazy(() => SaleSnapshot$inboundSchema).optional(),
   sale_date: z.number().optional(),
 }).transform((v) => {

package/src/models/originationdto.ts

@@ -5,21 +5,13 @@
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
   InstallmentDto,
   InstallmentDto$inboundSchema,
 } from "./installmentdto.js";
-import {
-  LmsLoanProgramSettingCadence,
-  LmsLoanProgramSettingCadence$inboundSchema,
-} from "./lmsloanprogramsettingcadence.js";
-import { LmsLoanStatus, LmsLoanStatus$inboundSchema } from "./lmsloanstatus.js";
-import {
-  LmsLoanSubStatus,
-  LmsLoanSubStatus$inboundSchema,
-} from "./lmsloansubstatus.js";
 import {
   OriginationBalancesDto,
   OriginationBalancesDto$inboundSchema,
@@ -33,11 +25,67 @@ import {
   OriginationRatesDto$inboundSchema,
 } from "./originationratesdto.js";
 
+/**
+ * Current status of the origination.
+ */
+export const OriginationDtoStatus = {
+  Active: "ACTIVE",
+  ChargedOff: "CHARGED_OFF",
+  Closed: "CLOSED",
+  Delinquent: "DELINQUENT",
+  PaidOff: "PAID_OFF",
+  Pending: "PENDING",
+  Migrating: "MIGRATING",
+  Cancelled: "CANCELLED",
+  Sold: "SOLD",
+} as const;
+/**
+ * Current status of the origination.
+ */
+export type OriginationDtoStatus = ClosedEnum<typeof OriginationDtoStatus>;
+
+/**
+ * Current sub-status of the origination.
+ */
+export const OriginationDtoSubStatus = {
+  BillingCycle: "BILLING_CYCLE",
+  RepaymentPeriod: "REPAYMENT_PERIOD",
+  ExtendedDelinquency: "EXTENDED_DELINQUENCY",
+  ExtendedRepayment: "EXTENDED_REPAYMENT",
+  GracePeriod: "GRACE_PERIOD",
+  InterestPeriod: "INTEREST_PERIOD",
+  PartnerBilling: "PARTNER_BILLING",
+  RepaymentPlan: "REPAYMENT_PLAN",
+  Delinquent: "DELINQUENT",
+  Bankruptcy: "BANKRUPTCY",
+} as const;
+/**
+ * Current sub-status of the origination.
+ */
+export type OriginationDtoSubStatus = ClosedEnum<
+  typeof OriginationDtoSubStatus
+>;
+
 /**
  * Additional metadata for the origination.
  */
 export type OriginationDtoMetadata = {};
 
+/**
+ * Payment cadence for the origination.
+ */
+export const OriginationDtoCadence = {
+  SinglePayment: "SINGLE_PAYMENT",
+  Weekly: "WEEKLY",
+  BiWeekly: "BI_WEEKLY",
+  SemiMonthly: "SEMI_MONTHLY",
+  Monthly: "MONTHLY",
+} as const;
+/**
+ * Payment cadence for the origination.
+ */
+export type OriginationDtoCadence = ClosedEnum<typeof OriginationDtoCadence>;
+
 export type OriginationDto = {
   /**
    * Type of the object.
@@ -60,13 +108,13 @@ export type OriginationDto = {
    */
   paymentIntent: string;
   /**
-   * Loan status
+   * Current status of the origination.
    */
-  status: LmsLoanStatus;
+  status: OriginationDtoStatus;
   /**
-   * Loan sub-status
+   * Current sub-status of the origination.
    */
-  subStatus?: LmsLoanSubStatus | undefined;
+  subStatus?: OriginationDtoSubStatus | undefined;
   /**
    * Dates associated with the origination.
    */
@@ -128,11 +176,21 @@ export type OriginationDto = {
    */
   createdAt: Date;
   /**
-   * Payment cadence
+   * Payment cadence for the origination.
    */
-  cadence: LmsLoanProgramSettingCadence;
+  cadence: OriginationDtoCadence;
 };
 
+/** @internal */
+export const OriginationDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof OriginationDtoStatus
+> = z.nativeEnum(OriginationDtoStatus);
+
+/** @internal */
+export const OriginationDtoSubStatus$inboundSchema: z.ZodNativeEnum<
+  typeof OriginationDtoSubStatus
+> = z.nativeEnum(OriginationDtoSubStatus);
+
 /** @internal */
 export const OriginationDtoMetadata$inboundSchema: z.ZodType<
   OriginationDtoMetadata,
@@ -150,6 +208,11 @@ export function originationDtoMetadataFromJSON(
   );
 }
 
+/** @internal */
+export const OriginationDtoCadence$inboundSchema: z.ZodNativeEnum<
+  typeof OriginationDtoCadence
+> = z.nativeEnum(OriginationDtoCadence);
+
 /** @internal */
 export const OriginationDto$inboundSchema: z.ZodType<
   OriginationDto,
@@ -161,8 +224,8 @@ export const OriginationDto$inboundSchema: z.ZodType<
   business: z.string(),
   program: z.string(),
   payment_intent: z.string(),
-  status: LmsLoanStatus$inboundSchema,
-  sub_status: LmsLoanSubStatus$inboundSchema.optional(),
+  status: OriginationDtoStatus$inboundSchema,
+  sub_status: OriginationDtoSubStatus$inboundSchema.optional(),
   dates: OriginationDatesDto$inboundSchema.optional(),
   current_balance: OriginationBalancesDto$inboundSchema.optional(),
   paid_balance: OriginationBalancesDto$inboundSchema.optional(),
@@ -178,7 +241,7 @@ export const OriginationDto$inboundSchema: z.ZodType<
   payment_intent_pdf_file: z.string().optional(),
   metadata: z.lazy(() => OriginationDtoMetadata$inboundSchema).optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  cadence: LmsLoanProgramSettingCadence$inboundSchema,
+  cadence: OriginationDtoCadence$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "payment_intent": "paymentIntent",

package/src/models/originationsimulationresponsedto.ts

@@ -5,14 +5,35 @@
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
-import { LmsLoanStatus, LmsLoanStatus$inboundSchema } from "./lmsloanstatus.js";
 import {
   SimulationOutstandingBalanceDto,
   SimulationOutstandingBalanceDto$inboundSchema,
 } from "./simulationoutstandingbalancedto.js";
 
+/**
+ * Status of the loan in the simulation.
+ */
+export const OriginationSimulationResponseDtoStatus = {
+  Active: "ACTIVE",
+  ChargedOff: "CHARGED_OFF",
+  Closed: "CLOSED",
+  Delinquent: "DELINQUENT",
+  PaidOff: "PAID_OFF",
+  Pending: "PENDING",
+  Migrating: "MIGRATING",
+  Cancelled: "CANCELLED",
+  Sold: "SOLD",
+} as const;
+/**
+ * Status of the loan in the simulation.
+ */
+export type OriginationSimulationResponseDtoStatus = ClosedEnum<
+  typeof OriginationSimulationResponseDtoStatus
+>;
+
 export type OriginationSimulationResponseDto = {
   /**
    * Type of the object.
@@ -35,9 +56,9 @@ export type OriginationSimulationResponseDto = {
    */
   invoiceExternalId?: string | undefined;
   /**
-   * Loan status
+   * Status of the loan in the simulation.
    */
-  status: LmsLoanStatus;
+  status: OriginationSimulationResponseDtoStatus;
   /**
    * Sub-status of the loan in the simulation.
    */
@@ -60,6 +81,12 @@ export type OriginationSimulationResponseDto = {
   outstandingBalance: SimulationOutstandingBalanceDto;
 };
 
+/** @internal */
+export const OriginationSimulationResponseDtoStatus$inboundSchema:
+  z.ZodNativeEnum<typeof OriginationSimulationResponseDtoStatus> = z.nativeEnum(
+    OriginationSimulationResponseDtoStatus,
+  );
+
 /** @internal */
 export const OriginationSimulationResponseDto$inboundSchema: z.ZodType<
   OriginationSimulationResponseDto,
@@ -71,7 +98,7 @@ export const OriginationSimulationResponseDto$inboundSchema: z.ZodType<
   simulation_date: z.number(),
   business_external_id: z.string(),
   invoice_external_id: z.string().optional(),
-  status: LmsLoanStatus$inboundSchema,
+  status: OriginationSimulationResponseDtoStatus$inboundSchema,
   sub_status: z.string().optional(),
   due_date: z.number(),
   days_past_due: z.number(),

package/src/models/paymentdto.ts

@@ -5,16 +5,9 @@
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
-import {
-  LmsPaymentRequestTriggeredBy,
-  LmsPaymentRequestTriggeredBy$inboundSchema,
-} from "./lmspaymentrequesttriggeredby.js";
-import {
-  LmsReconciliation,
-  LmsReconciliation$inboundSchema,
-} from "./lmsreconciliation.js";
 
 /**
  * Breakdown of payment components
@@ -38,6 +31,32 @@ export type Breakdown = {
   totalLateFees: number;
 };
 
+/**
+ * Indicates how the payment was triggered
+ */
+export const TriggeredBy = {
+  Api: "API",
+  Job: "JOB",
+} as const;
+/**
+ * Indicates how the payment was triggered
+ */
+export type TriggeredBy = ClosedEnum<typeof TriggeredBy>;
+
+/**
+ * Reconciliation type
+ */
+export const PaymentDtoReconciliation = {
+  Automatic: "AUTOMATIC",
+  Manual: "MANUAL",
+} as const;
+/**
+ * Reconciliation type
+ */
+export type PaymentDtoReconciliation = ClosedEnum<
+  typeof PaymentDtoReconciliation
+>;
+
 export type PaymentDto = {
   /**
    * The object type
@@ -116,9 +135,9 @@ export type PaymentDto = {
    */
   breakdown?: Breakdown | undefined;
   /**
-   * Payment trigger information
+   * Indicates how the payment was triggered
    */
-  triggeredBy?: LmsPaymentRequestTriggeredBy | undefined;
+  triggeredBy?: TriggeredBy | undefined;
   /**
    * Settlement Date
    */
@@ -126,7 +145,7 @@ export type PaymentDto = {
   /**
    * Reconciliation type
    */
-  reconciliation?: LmsReconciliation | undefined;
+  reconciliation?: PaymentDtoReconciliation | undefined;
 };
 
 /** @internal */
@@ -151,6 +170,15 @@ export function breakdownFromJSON(
   );
 }
 
+/** @internal */
+export const TriggeredBy$inboundSchema: z.ZodNativeEnum<typeof TriggeredBy> = z
+  .nativeEnum(TriggeredBy);
+
+/** @internal */
+export const PaymentDtoReconciliation$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentDtoReconciliation
+> = z.nativeEnum(PaymentDtoReconciliation);
+
 /** @internal */
 export const PaymentDto$inboundSchema: z.ZodType<
   PaymentDto,
@@ -176,9 +204,9 @@ export const PaymentDto$inboundSchema: z.ZodType<
   payment_method_id: z.string().optional(),
   payment_date: z.number().optional(),
   breakdown: z.lazy(() => Breakdown$inboundSchema).optional(),
-  triggered_by: LmsPaymentRequestTriggeredBy$inboundSchema.optional(),
+  triggered_by: TriggeredBy$inboundSchema.optional(),
   settlement_date: z.number().optional(),
-  reconciliation: LmsReconciliation$inboundSchema.optional(),
+  reconciliation: PaymentDtoReconciliation$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "payment_intent": "paymentIntent",