@oatfi/oatfi-sdk-ts 0.11.65 → 0.11.67

package/src/models/operations/internalprogramsettingscontrollergetprogramsettings.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type InternalProgramSettingsControllerGetProgramSettingsRequest = {
+  /**
+   * ID of the loan program
+   */
+  id: string;
+};
+
+/** @internal */
+export type InternalProgramSettingsControllerGetProgramSettingsRequest$Outbound =
+  {
+    id: string;
+  };
+
+/** @internal */
+export const InternalProgramSettingsControllerGetProgramSettingsRequest$outboundSchema:
+  z.ZodType<
+    InternalProgramSettingsControllerGetProgramSettingsRequest$Outbound,
+    z.ZodTypeDef,
+    InternalProgramSettingsControllerGetProgramSettingsRequest
+  > = z.object({
+    id: z.string(),
+  });
+
+export function internalProgramSettingsControllerGetProgramSettingsRequestToJSON(
+  internalProgramSettingsControllerGetProgramSettingsRequest:
+    InternalProgramSettingsControllerGetProgramSettingsRequest,
+): string {
+  return JSON.stringify(
+    InternalProgramSettingsControllerGetProgramSettingsRequest$outboundSchema
+      .parse(internalProgramSettingsControllerGetProgramSettingsRequest),
+  );
+}

package/src/models/paymentdto.ts

@@ -95,6 +95,10 @@ export type PaymentDto = {
    * Payment amount in cents
    */
   amount: number;
+  /**
+   * Indicates this is a non-cash repayment where the payment was collected outside OatFi
+   */
+  nonCash?: boolean | undefined;
   /**
    * Payment status
    */
@@ -195,6 +199,7 @@ export const PaymentDto$inboundSchema: z.ZodType<
   transfer_id: types.optional(types.string()),
   external_batch_transfer_id: types.optional(types.string()),
   amount: types.number(),
+  non_cash: types.optional(types.boolean()),
   status: types.optional(types.string()),
   financial_account: types.optional(types.string()),
   payment_request_id: types.optional(types.string()),
@@ -213,6 +218,7 @@ export const PaymentDto$inboundSchema: z.ZodType<
     "payment_intent": "paymentIntent",
     "transfer_id": "transferId",
     "external_batch_transfer_id": "externalBatchTransferId",
+    "non_cash": "nonCash",
     "financial_account": "financialAccount",
     "payment_request_id": "paymentRequestId",
     "third_party_payment_status": "thirdPartyPaymentStatus",

package/src/models/paymentinformationdto.ts

@@ -94,6 +94,10 @@ export type PaymentInformationDto = {
    * Financial account information
    */
   financialAccount: string;
+  /**
+   * Indicates this is a non-cash repayment where the payment was collected outside OatFi
+   */
+  nonCash?: boolean | undefined;
   /**
    * Payment status information
    */
@@ -167,6 +171,7 @@ export const PaymentInformationDto$inboundSchema: z.ZodType<
   amount: types.optional(types.number()),
   payment_date: types.number(),
   financial_account: types.string(),
+  non_cash: types.optional(types.boolean()),
   status: types.optional(LmsPaymentRequestStatus$inboundSchema),
   origination: types.optional(types.string()),
   breakdown: types.optional(RepaymentBreakdownDto$inboundSchema),
@@ -188,6 +193,7 @@ export const PaymentInformationDto$inboundSchema: z.ZodType<
     "external_batch_transfer_id": "externalBatchTransferId",
     "payment_date": "paymentDate",
     "financial_account": "financialAccount",
+    "non_cash": "nonCash",
     "triggered_by": "triggeredBy",
     "settlement_date": "settlementDate",
     "third_party_payment_status": "thirdPartyPaymentStatus",

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/programresponsedto.ts

@@ -18,6 +18,10 @@ import {
   HoldSettingsDto,
   HoldSettingsDto$inboundSchema,
 } from "./holdsettingsdto.js";
+import {
+  OnboardingSettingsDto,
+  OnboardingSettingsDto$inboundSchema,
+} from "./onboardingsettingsdto.js";
 import {
   PlatformProductSettingsDto,
   PlatformProductSettingsDto$inboundSchema,
@@ -277,6 +281,10 @@ export type ProgramResponseDto = {
    * Addendum ID (when not expanded) or full terms template object (when expanded via expand=addendum)
    */
   addendum?: string | { [k: string]: any } | undefined;
+  /**
+   * Onboarding settings
+   */
+  onboardingSettings?: OnboardingSettingsDto | undefined;
   /**
    * Program settings array
    */
@@ -470,6 +478,7 @@ export const ProgramResponseDto$inboundSchema: z.ZodType<
   terms_settings: types.optional(TermsSettingsDto$inboundSchema),
   deny_funding: types.optional(types.boolean()),
   addendum: types.optional(smartUnion([types.string(), z.record(z.any())])),
+  onboarding_settings: types.optional(OnboardingSettingsDto$inboundSchema),
   settings: types.optional(
     z.array(z.lazy(() => ProgramResponseDtoSetting$inboundSchema)),
   ),
@@ -502,6 +511,7 @@ export const ProgramResponseDto$inboundSchema: z.ZodType<
     "delay_funding_config": "delayFundingConfig",
     "terms_settings": "termsSettings",
     "deny_funding": "denyFunding",
+    "onboarding_settings": "onboardingSettings",
     "created_at": "createdAt",
     "updated_at": "updatedAt",
   });

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`,
+  );
+}

package/src/models/programunderwritingsettingsdto.ts

@@ -0,0 +1,236 @@
+/*
+ * 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";
+import {
+  LmsBusinessType,
+  LmsBusinessType$inboundSchema,
+} from "./lmsbusinesstype.js";
+import {
+  UnderwritingFlowDto,
+  UnderwritingFlowDto$inboundSchema,
+} from "./underwritingflowdto.js";
+
+/**
+ * Spend capacity setting
+ */
+export const ProgramUnderwritingSettingsDtoSpendCapacity = {
+  Eighth: "EIGHTH",
+  Quarter: "QUARTER",
+  Half: "HALF",
+  Full: "FULL",
+  Double: "DOUBLE",
+  Triple: "TRIPLE",
+} as const;
+/**
+ * Spend capacity setting
+ */
+export type ProgramUnderwritingSettingsDtoSpendCapacity = ClosedEnum<
+  typeof ProgramUnderwritingSettingsDtoSpendCapacity
+>;
+
+/**
+ * Bureau only underwriting allowed
+ */
+export const ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed = {
+  Yes: "YES",
+  No: "NO",
+  ManualReview: "MANUAL REVIEW",
+} as const;
+/**
+ * Bureau only underwriting allowed
+ */
+export type ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed = ClosedEnum<
+  typeof ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed
+>;
+
+/**
+ * Manual review catch setting
+ */
+export const ProgramUnderwritingSettingsDtoManualReviewCatch = {
+  All: "ALL",
+  AllApproved: "ALL_APPROVED",
+  None: "NONE",
+} as const;
+/**
+ * Manual review catch setting
+ */
+export type ProgramUnderwritingSettingsDtoManualReviewCatch = ClosedEnum<
+  typeof ProgramUnderwritingSettingsDtoManualReviewCatch
+>;
+
+/**
+ * Contractual UCC lien setting
+ */
+export const ProgramUnderwritingSettingsDtoContractualUccLien = {
+  None: "NONE",
+  Upfront: "UPFRONT",
+  Springing: "SPRINGING",
+} as const;
+/**
+ * Contractual UCC lien setting
+ */
+export type ProgramUnderwritingSettingsDtoContractualUccLien = ClosedEnum<
+  typeof ProgramUnderwritingSettingsDtoContractualUccLien
+>;
+
+export type ProgramUnderwritingSettingsDto = {
+  /**
+   * Mandatory underwriting approved business types
+   */
+  mandatoryUwApproved?: Array<LmsBusinessType> | undefined;
+  /**
+   * Spend capacity setting
+   */
+  spendCapacity?: ProgramUnderwritingSettingsDtoSpendCapacity | undefined;
+  /**
+   * Product score (0-5)
+   */
+  productScore?: number | undefined;
+  /**
+   * Bureau only underwriting allowed
+   */
+  bureauOnlyUwAllowed?:
+    | ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed
+    | undefined;
+  /**
+   * Minimum days on platform required
+   */
+  minDaysOnPlatformRequired?: number | undefined;
+  /**
+   * Minimum invoices required
+   */
+  minInvoicesRequired?: number | undefined;
+  /**
+   * Average cash underwriting
+   */
+  avgCashUw?: number | undefined;
+  /**
+   * Manual review catch setting
+   */
+  manualReviewCatch?:
+    | ProgramUnderwritingSettingsDtoManualReviewCatch
+    | undefined;
+  /**
+   * Whether new customer underwriting is allowed
+   */
+  newCustomerUwAllowed?: boolean | undefined;
+  /**
+   * Whether to run underwriting for payee
+   */
+  runUwPayee?: boolean | undefined;
+  /**
+   * Underwriting flow configuration
+   */
+  underwritingFlow?: UnderwritingFlowDto | undefined;
+  /**
+   * Whether to auto decrease limit
+   */
+  autoLimitDecrease?: boolean | undefined;
+  /**
+   * Minimum revenue required
+   */
+  minRevenue?: number | undefined;
+  /**
+   * Contractual UCC lien setting
+   */
+  contractualUccLien?:
+    | ProgramUnderwritingSettingsDtoContractualUccLien
+    | undefined;
+  /**
+   * Onboarding terms agreement ID
+   */
+  onboardingTermsAgreement?: string | undefined;
+  /**
+   * Whether third party underwriting is enabled
+   */
+  thirdPartyUnderwrite?: boolean | undefined;
+};
+
+/** @internal */
+export const ProgramUnderwritingSettingsDtoSpendCapacity$inboundSchema:
+  z.ZodNativeEnum<typeof ProgramUnderwritingSettingsDtoSpendCapacity> = z
+    .nativeEnum(ProgramUnderwritingSettingsDtoSpendCapacity);
+
+/** @internal */
+export const ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed$inboundSchema:
+  z.ZodNativeEnum<typeof ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed> = z
+    .nativeEnum(ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed);
+
+/** @internal */
+export const ProgramUnderwritingSettingsDtoManualReviewCatch$inboundSchema:
+  z.ZodNativeEnum<typeof ProgramUnderwritingSettingsDtoManualReviewCatch> = z
+    .nativeEnum(ProgramUnderwritingSettingsDtoManualReviewCatch);
+
+/** @internal */
+export const ProgramUnderwritingSettingsDtoContractualUccLien$inboundSchema:
+  z.ZodNativeEnum<typeof ProgramUnderwritingSettingsDtoContractualUccLien> = z
+    .nativeEnum(ProgramUnderwritingSettingsDtoContractualUccLien);
+
+/** @internal */
+export const ProgramUnderwritingSettingsDto$inboundSchema: z.ZodType<
+  ProgramUnderwritingSettingsDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mandatory_uw_approved: types.optional(z.array(LmsBusinessType$inboundSchema)),
+  spend_capacity: types.optional(
+    ProgramUnderwritingSettingsDtoSpendCapacity$inboundSchema,
+  ),
+  product_score: types.optional(types.number()),
+  bureau_only_uw_allowed: types.optional(
+    ProgramUnderwritingSettingsDtoBureauOnlyUwAllowed$inboundSchema,
+  ),
+  min_days_on_platform_required: types.optional(types.number()),
+  min_invoices_required: types.optional(types.number()),
+  avg_cash_uw: types.optional(types.number()),
+  manual_review_catch: types.optional(
+    ProgramUnderwritingSettingsDtoManualReviewCatch$inboundSchema,
+  ),
+  new_customer_uw_allowed: types.optional(types.boolean()),
+  run_uw_payee: types.optional(types.boolean()),
+  underwriting_flow: types.optional(UnderwritingFlowDto$inboundSchema),
+  auto_limit_decrease: types.optional(types.boolean()),
+  min_revenue: types.optional(types.number()),
+  contractual_ucc_lien: types.optional(
+    ProgramUnderwritingSettingsDtoContractualUccLien$inboundSchema,
+  ),
+  onboarding_terms_agreement: types.optional(types.string()),
+  third_party_underwrite: types.optional(types.boolean()),
+}).transform((v) => {
+  return remap$(v, {
+    "mandatory_uw_approved": "mandatoryUwApproved",
+    "spend_capacity": "spendCapacity",
+    "product_score": "productScore",
+    "bureau_only_uw_allowed": "bureauOnlyUwAllowed",
+    "min_days_on_platform_required": "minDaysOnPlatformRequired",
+    "min_invoices_required": "minInvoicesRequired",
+    "avg_cash_uw": "avgCashUw",
+    "manual_review_catch": "manualReviewCatch",
+    "new_customer_uw_allowed": "newCustomerUwAllowed",
+    "run_uw_payee": "runUwPayee",
+    "underwriting_flow": "underwritingFlow",
+    "auto_limit_decrease": "autoLimitDecrease",
+    "min_revenue": "minRevenue",
+    "contractual_ucc_lien": "contractualUccLien",
+    "onboarding_terms_agreement": "onboardingTermsAgreement",
+    "third_party_underwrite": "thirdPartyUnderwrite",
+  });
+});
+
+export function programUnderwritingSettingsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ProgramUnderwritingSettingsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProgramUnderwritingSettingsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProgramUnderwritingSettingsDto' from JSON`,
+  );
+}