@oatfi/oatfi-sdk-ts 0.11.66 → 0.12.0

package/src/models/originationdto.ts

@@ -8,6 +8,7 @@ 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 { smartUnion } from "../types/smartUnion.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
   InstallmentDto,
@@ -26,6 +27,20 @@ import {
   OriginationRatesDto$inboundSchema,
 } from "./originationratesdto.js";
 
+export type Business = {};
+
+/**
+ * ID of the business associated with the origination. When expanded via the `expand` query parameter, returns the full business object.
+ */
+export type BusinessUnion = string | Business;
+
+export type Program = {};
+
+/**
+ * ID of the loan program associated with the origination. When expanded via the `expand` query parameter, returns the full program object.
+ */
+export type ProgramUnion = string | Program;
+
 /**
  * Current status of the origination.
  */
@@ -97,13 +112,13 @@ export type OriginationDto = {
    */
   id: string;
   /**
-   * ID of the business associated with the origination.
+   * ID of the business associated with the origination. When expanded via the `expand` query parameter, returns the full business object.
    */
-  business: string;
+  business: string | Business;
   /**
-   * ID of the loan program associated with the origination.
+   * ID of the loan program associated with the origination. When expanded via the `expand` query parameter, returns the full program object.
    */
-  program: string;
+  program: string | Program;
   /**
    * ID of the payment intent associated with the origination.
    */
@@ -136,20 +151,16 @@ export type OriginationDto = {
    * Number of installments for the origination.
    */
   numberOfInstallments?: number | undefined;
-  /**
-   * Day of the week for payments.
-   */
-  paymentDayOfWeek?: string | undefined;
   /**
    * List of installments for the origination.
    */
   installments?: Array<InstallmentDto> | undefined;
   /**
-   * Original principal balance of the origination.
+   * Original principal balance of the origination, in cents.
    */
   originalPrincipalBalance?: number | undefined;
   /**
-   * Down payment amount for the origination.
+   * Down payment amount for the origination, in cents.
    */
   downPaymentAmount?: number | undefined;
   /**
@@ -157,31 +168,112 @@ export type OriginationDto = {
    */
   daysPastDue?: number | undefined;
   /**
-   * Link to the terms agreement.
+   * File name of the terms agreement PDF stored for the origination.
    */
-  termsAgreementLink?: string | undefined;
+  termsAgreementFile?: string | undefined;
   /**
-   * File name of the terms agreement.
+   * Short-lived signed URL to download the terms agreement PDF. Expires after the S3 default TTL. Absent on list responses and on originations without a stored terms agreement file.
    */
-  termsAgreementFile?: string | undefined;
+  termsAgreementLink?: string | undefined;
   /**
-   * File name of the payment intent PDF.
+   * File name of the payment intent PDF stored for the origination.
    */
   paymentIntentPdfFile?: string | undefined;
+  /**
+   * ID of the repayment financial account associated with the origination.
+   */
+  repaymentFinancialAccount?: string | undefined;
   /**
    * Additional metadata for the origination.
    */
   metadata?: OriginationDtoMetadata | undefined;
   /**
-   * Creation date of the origination.
+   * Payment cadence for the origination.
+   */
+  cadence?: OriginationDtoCadence | undefined;
+  /**
+   * ID of the offer that was accepted to create this origination.
+   */
+  offer?: string | undefined;
+  /**
+   * Date the origination was sold, if applicable. Absent on originations that have not been sold.
+   */
+  saleDate?: Date | undefined;
+  /**
+   * Timestamp of when the origination was created.
    */
   createdAt: Date;
   /**
-   * Payment cadence for the origination.
+   * Timestamp of when the origination was last updated.
    */
-  cadence: OriginationDtoCadence;
+  updatedAt: Date;
 };
 
+/** @internal */
+export const Business$inboundSchema: z.ZodType<
+  Business,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function businessFromJSON(
+  jsonString: string,
+): SafeParseResult<Business, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Business$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Business' from JSON`,
+  );
+}
+
+/** @internal */
+export const BusinessUnion$inboundSchema: z.ZodType<
+  BusinessUnion,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([types.string(), z.lazy(() => Business$inboundSchema)]);
+
+export function businessUnionFromJSON(
+  jsonString: string,
+): SafeParseResult<BusinessUnion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessUnion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessUnion' from JSON`,
+  );
+}
+
+/** @internal */
+export const Program$inboundSchema: z.ZodType<Program, z.ZodTypeDef, unknown> =
+  z.object({});
+
+export function programFromJSON(
+  jsonString: string,
+): SafeParseResult<Program, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Program$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Program' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProgramUnion$inboundSchema: z.ZodType<
+  ProgramUnion,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([types.string(), z.lazy(() => Program$inboundSchema)]);
+
+export function programUnionFromJSON(
+  jsonString: string,
+): SafeParseResult<ProgramUnion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProgramUnion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProgramUnion' from JSON`,
+  );
+}
+
 /** @internal */
 export const OriginationDtoStatus$inboundSchema: z.ZodNativeEnum<
   typeof OriginationDtoStatus
@@ -222,8 +314,8 @@ export const OriginationDto$inboundSchema: z.ZodType<
 > = z.object({
   object: types.string(),
   id: types.string(),
-  business: types.string(),
-  program: types.string(),
+  business: smartUnion([types.string(), z.lazy(() => Business$inboundSchema)]),
+  program: smartUnion([types.string(), z.lazy(() => Program$inboundSchema)]),
   payment_intent: types.string(),
   status: OriginationDtoStatus$inboundSchema,
   sub_status: types.optional(OriginationDtoSubStatus$inboundSchema),
@@ -232,17 +324,20 @@ export const OriginationDto$inboundSchema: z.ZodType<
   paid_balance: types.optional(OriginationBalancesDto$inboundSchema),
   rates: types.optional(OriginationRatesDto$inboundSchema),
   number_of_installments: types.optional(types.number()),
-  payment_day_of_week: types.optional(types.string()),
   installments: types.optional(z.array(InstallmentDto$inboundSchema)),
   original_principal_balance: types.optional(types.number()),
   down_payment_amount: types.optional(types.number()),
   days_past_due: types.optional(types.number()),
-  terms_agreement_link: types.optional(types.string()),
   terms_agreement_file: types.optional(types.string()),
+  terms_agreement_link: types.optional(types.string()),
   payment_intent_pdf_file: types.optional(types.string()),
+  repayment_financial_account: types.optional(types.string()),
   metadata: types.optional(z.lazy(() => OriginationDtoMetadata$inboundSchema)),
+  cadence: types.optional(OriginationDtoCadence$inboundSchema),
+  offer: types.optional(types.string()),
+  sale_date: types.optional(types.date()),
   created_at: types.date(),
-  cadence: OriginationDtoCadence$inboundSchema,
+  updated_at: types.date(),
 }).transform((v) => {
   return remap$(v, {
     "payment_intent": "paymentIntent",
@@ -250,14 +345,16 @@ export const OriginationDto$inboundSchema: z.ZodType<
     "current_balance": "currentBalance",
     "paid_balance": "paidBalance",
     "number_of_installments": "numberOfInstallments",
-    "payment_day_of_week": "paymentDayOfWeek",
     "original_principal_balance": "originalPrincipalBalance",
     "down_payment_amount": "downPaymentAmount",
     "days_past_due": "daysPastDue",
-    "terms_agreement_link": "termsAgreementLink",
     "terms_agreement_file": "termsAgreementFile",
+    "terms_agreement_link": "termsAgreementLink",
     "payment_intent_pdf_file": "paymentIntentPdfFile",
+    "repayment_financial_account": "repaymentFinancialAccount",
+    "sale_date": "saleDate",
     "created_at": "createdAt",
+    "updated_at": "updatedAt",
   });
 });
 

package/src/models/originationratesdto.ts

@@ -22,6 +22,10 @@ export type OriginationRatesDto = {
    * Interest rate applied to late fees.
    */
   lateFeesInterestRate?: number | undefined;
+  /**
+   * Base fee rate (fee_percentage / 12). Populated on offers.
+   */
+  baseFeeRate?: number | undefined;
 };
 
 /** @internal */
@@ -33,11 +37,13 @@ export const OriginationRatesDto$inboundSchema: z.ZodType<
   interest_rate: types.optional(types.number()),
   fixed_fee_percent: types.optional(types.number()),
   late_fees_interest_rate: types.optional(types.number()),
+  base_fee_rate: types.optional(types.number()),
 }).transform((v) => {
   return remap$(v, {
     "interest_rate": "interestRate",
     "fixed_fee_percent": "fixedFeePercent",
     "late_fees_interest_rate": "lateFeesInterestRate",
+    "base_fee_rate": "baseFeeRate",
   });
 });
 

package/src/models/paymentraildatadto.ts

@@ -57,7 +57,7 @@ export type PaymentRailDataDto = {
   /**
    * Business ID
    */
-  businessId?: string | undefined;
+  business?: string | undefined;
   /**
    * Lockbox Address
    */
@@ -97,7 +97,7 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
   unit_account_id: types.optional(types.string()),
   swift_code: types.optional(types.string()),
   remittance_information: types.optional(types.string()),
-  business_id: types.optional(types.string()),
+  business: types.optional(types.string()),
   lockbox_address: types.optional(types.string()),
   account_number_id: types.optional(types.string()),
   oatfi_account_number: types.optional(types.string()),
@@ -116,7 +116,6 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
     "unit_account_id": "unitAccountId",
     "swift_code": "swiftCode",
     "remittance_information": "remittanceInformation",
-    "business_id": "businessId",
     "lockbox_address": "lockboxAddress",
     "account_number_id": "accountNumberId",
     "oatfi_account_number": "oatfiAccountNumber",
@@ -137,7 +136,7 @@ export type PaymentRailDataDto$Outbound = {
   unit_account_id?: string | undefined;
   swift_code?: string | undefined;
   remittance_information?: string | undefined;
-  business_id?: string | undefined;
+  business?: string | undefined;
   lockbox_address?: string | undefined;
   account_number_id?: string | undefined;
   oatfi_account_number?: string | undefined;
@@ -162,7 +161,7 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
   unitAccountId: z.string().optional(),
   swiftCode: z.string().optional(),
   remittanceInformation: z.string().optional(),
-  businessId: z.string().optional(),
+  business: z.string().optional(),
   lockboxAddress: z.string().optional(),
   accountNumberId: z.string().optional(),
   oatfiAccountNumber: z.string().optional(),
@@ -181,7 +180,6 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
     unitAccountId: "unit_account_id",
     swiftCode: "swift_code",
     remittanceInformation: "remittance_information",
-    businessId: "business_id",
     lockboxAddress: "lockbox_address",
     accountNumberId: "account_number_id",
     oatfiAccountNumber: "oatfi_account_number",

package/src/models/paymentreversaldto.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 PaymentReversalDto = {
+  /**
+   * Object type identifier
+   */
+  object: string;
+  /**
+   * The reversed payment ID
+   */
+  id: string;
+  /**
+   * Reversed amount in cents
+   */
+  amount: number;
+  /**
+   * Outstanding loan balance after reversal in cents
+   */
+  outstandingBalance?: number | undefined;
+};
+
+/** @internal */
+export const PaymentReversalDto$inboundSchema: z.ZodType<
+  PaymentReversalDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string(),
+  id: types.string(),
+  amount: types.number(),
+  outstanding_balance: types.optional(types.number()),
+}).transform((v) => {
+  return remap$(v, {
+    "outstanding_balance": "outstandingBalance",
+  });
+});
+
+export function paymentReversalDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentReversalDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentReversalDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentReversalDto' from JSON`,
+  );
+}

package/src/models/programonboardingsettingsdto.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 ProgramOnboardingSettingsDto = {
+  /**
+   * Allow onboarding
+   */
+  allowOnboarding?: boolean | undefined;
+  /**
+   * Run underwriting during onboarding
+   */
+  runUnderwriting?: boolean | undefined;
+  /**
+   * Enable Plaid integration
+   */
+  plaid?: boolean | undefined;
+  /**
+   * Require bank statements
+   */
+  bankStatements?: boolean | undefined;
+  /**
+   * Require financial statements
+   */
+  financialStatements?: boolean | undefined;
+  /**
+   * Collect self-reported annual revenue
+   */
+  collectSelfReportedAnnualRevenue?: boolean | undefined;
+  /**
+   * Allow user to request credit limit
+   */
+  allowUserRequestCreditLimit?: boolean | undefined;
+  /**
+   * Allow products
+   */
+  allowProducts?: boolean | undefined;
+};
+
+/** @internal */
+export const ProgramOnboardingSettingsDto$inboundSchema: z.ZodType<
+  ProgramOnboardingSettingsDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allow_onboarding: types.optional(types.boolean()),
+  run_underwriting: types.optional(types.boolean()),
+  plaid: types.optional(types.boolean()),
+  bank_statements: types.optional(types.boolean()),
+  financial_statements: types.optional(types.boolean()),
+  collect_self_reported_annual_revenue: types.optional(types.boolean()),
+  allow_user_request_credit_limit: types.optional(types.boolean()),
+  allow_products: types.optional(types.boolean()),
+}).transform((v) => {
+  return remap$(v, {
+    "allow_onboarding": "allowOnboarding",
+    "run_underwriting": "runUnderwriting",
+    "bank_statements": "bankStatements",
+    "financial_statements": "financialStatements",
+    "collect_self_reported_annual_revenue": "collectSelfReportedAnnualRevenue",
+    "allow_user_request_credit_limit": "allowUserRequestCreditLimit",
+    "allow_products": "allowProducts",
+  });
+});
+
+export function programOnboardingSettingsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ProgramOnboardingSettingsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProgramOnboardingSettingsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProgramOnboardingSettingsDto' from JSON`,
+  );
+}

package/src/models/programsettingsresponsedto.ts

@@ -0,0 +1,74 @@
+/*
+ * 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";
+import {
+  ProgramOnboardingSettingsDto,
+  ProgramOnboardingSettingsDto$inboundSchema,
+} from "./programonboardingsettingsdto.js";
+import {
+  ProgramUnderwritingSettingsDto,
+  ProgramUnderwritingSettingsDto$inboundSchema,
+} from "./programunderwritingsettingsdto.js";
+
+export type ProgramSettingsResponseDto = {
+  /**
+   * Resource type
+   */
+  object: string;
+  /**
+   * Loan program ID
+   */
+  id: string;
+  /**
+   * Onboarding settings
+   */
+  onboardingSettings?: ProgramOnboardingSettingsDto | undefined;
+  /**
+   * Underwriting settings
+   */
+  underwritingSettings?: ProgramUnderwritingSettingsDto | undefined;
+  /**
+   * Whether the program has UW terms agreement configured
+   */
+  hasUwTerms: boolean;
+};
+
+/** @internal */
+export const ProgramSettingsResponseDto$inboundSchema: z.ZodType<
+  ProgramSettingsResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string(),
+  id: types.string(),
+  onboarding_settings: types.optional(
+    ProgramOnboardingSettingsDto$inboundSchema,
+  ),
+  underwriting_settings: types.optional(
+    ProgramUnderwritingSettingsDto$inboundSchema,
+  ),
+  has_uw_terms: types.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "onboarding_settings": "onboardingSettings",
+    "underwriting_settings": "underwritingSettings",
+    "has_uw_terms": "hasUwTerms",
+  });
+});
+
+export function programSettingsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ProgramSettingsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProgramSettingsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProgramSettingsResponseDto' from JSON`,
+  );
+}