@oatfi/oatfi-sdk-ts 0.11.67 → 0.12.2

package/src/models/createadjustmentdto.ts

@@ -0,0 +1,76 @@
+/*
+ * 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";
+
+export const CreateAdjustmentDtoType = {
+  Reward: "REWARD",
+  Return: "RETURN",
+  SaasPartnerFee: "SAAS_PARTNER_FEE",
+  Correction: "CORRECTION",
+  Discount: "DISCOUNT",
+  Allowance: "ALLOWANCE",
+  Damaged: "DAMAGED",
+  LateFee: "LATE_FEE",
+  FeeOther: "FEE_OTHER",
+  Other: "OTHER",
+} as const;
+export type CreateAdjustmentDtoType = ClosedEnum<
+  typeof CreateAdjustmentDtoType
+>;
+
+export type CreateAdjustmentDto = {
+  /**
+   * Adjustment amount in smallest currency unit (cents). Positive or negative.
+   */
+  amount: number;
+  type: CreateAdjustmentDtoType;
+  /**
+   * Optional notes for the adjustment
+   */
+  description?: string | undefined;
+  /**
+   * Payment method ID required when shortfall is detected on asset payment intent
+   */
+  paymentMethodId?: string | undefined;
+};
+
+/** @internal */
+export const CreateAdjustmentDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof CreateAdjustmentDtoType
+> = z.nativeEnum(CreateAdjustmentDtoType);
+
+/** @internal */
+export type CreateAdjustmentDto$Outbound = {
+  amount: number;
+  type: string;
+  description?: string | undefined;
+  payment_method_id?: string | undefined;
+};
+
+/** @internal */
+export const CreateAdjustmentDto$outboundSchema: z.ZodType<
+  CreateAdjustmentDto$Outbound,
+  z.ZodTypeDef,
+  CreateAdjustmentDto
+> = z.object({
+  amount: z.number(),
+  type: CreateAdjustmentDtoType$outboundSchema,
+  description: z.string().optional(),
+  paymentMethodId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    paymentMethodId: "payment_method_id",
+  });
+});
+
+export function createAdjustmentDtoToJSON(
+  createAdjustmentDto: CreateAdjustmentDto,
+): string {
+  return JSON.stringify(
+    CreateAdjustmentDto$outboundSchema.parse(createAdjustmentDto),
+  );
+}

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.
+   */
+  userAccepted: boolean;
+  /**
+   * 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;
+  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(),
+  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
    */
@@ -23,23 +19,17 @@ export type CreateHoldDto = {
    */
   description: string;
   /**
-   * Resource type
-   */
-  object: string;
-  /**
-   * Resource ID
+   * Custom expiration date for the hold. Must be in the future and within the maximum hold duration configured for the program. Defaults to the program maximum when omitted.
    */
-  id: string;
+  expirationDate?: Date | undefined;
 };
 
 /** @internal */
 export type CreateHoldDto$Outbound = {
   product_uuid: string;
-  business_external_id: string;
   amount: number;
   description: string;
-  object: string;
-  id: string;
+  expiration_date?: string | undefined;
 };
 
 /** @internal */
@@ -49,15 +39,13 @@ export const CreateHoldDto$outboundSchema: z.ZodType<
   CreateHoldDto
 > = z.object({
   productUuid: z.string(),
-  businessExternalId: z.string(),
   amount: z.number(),
   description: z.string(),
-  object: z.string(),
-  id: 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/createoriginationofferdto.ts

@@ -4,6 +4,11 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import {
+  NetworkPurchaseInfo,
+  NetworkPurchaseInfo$Outbound,
+  NetworkPurchaseInfo$outboundSchema,
+} from "./networkpurchaseinfo.js";
 
 /**
  * Metadata to associate with the offer request
@@ -14,15 +19,15 @@ export type CreateOriginationOfferDto = {
   /**
    * The program identifier
    */
-  programId: string;
+  program: string;
   /**
    * The business identifier
    */
-  businessId: string;
+  business: string;
   /**
    * The platform identifier
    */
-  platformId?: string | undefined;
+  platform?: string | undefined;
   /**
    * Down payment due date
    */
@@ -44,9 +49,13 @@ export type CreateOriginationOfferDto = {
    */
   numberOfInstallments?: number | undefined;
   /**
-   * Hold Id
+   * The hold identifier
    */
-  holdId?: string | undefined;
+  hold?: string | undefined;
+  /**
+   * Network purchase details (only consumed by Net Terms programs).
+   */
+  networkPurchase?: NetworkPurchaseInfo | undefined;
   /**
    * Requested principal amount for the origination in cents
    */
@@ -54,7 +63,7 @@ export type CreateOriginationOfferDto = {
   /**
    * ID of the payment intent related to this offer
    */
-  paymentIntentId?: string | undefined;
+  paymentIntent?: string | undefined;
   /**
    * The due date timestamp
    */
@@ -67,6 +76,22 @@ export type CreateOriginationOfferDto = {
    * Metadata to associate with the offer request
    */
   metadata?: CreateOriginationOfferDtoMetadata | undefined;
+  /**
+   * Override base fee rate for this offer. Must be between 0 and 100. Rejected by the loan program if base fee override is not enabled.
+   */
+  baseFeeRate?: number | undefined;
+  /**
+   * MongoDB ID of the funding financial account. Overrides the default funding payment method from the program configuration.
+   */
+  fundingFinancialAccount?: string | undefined;
+  /**
+   * MongoDB ID of the repayment financial account. Overrides the default repayment method from the program configuration.
+   */
+  repaymentFinancialAccount?: string | undefined;
+  /**
+   * Scheduled repayment date as a timestamp in milliseconds. Must be between today and the maturity date. Only valid for non-installment loans.
+   */
+  scheduledRepaymentDate?: number | undefined;
 };
 
 /** @internal */
@@ -91,20 +116,25 @@ export function createOriginationOfferDtoMetadataToJSON(
 
 /** @internal */
 export type CreateOriginationOfferDto$Outbound = {
-  program_id: string;
-  business_id: string;
-  platform_id?: string | undefined;
+  program: string;
+  business: string;
+  platform?: string | undefined;
   down_payment_due_date?: string | undefined;
   installments_start_date?: string | undefined;
   payment_day_of_week?: string | undefined;
   cadence?: string | undefined;
   number_of_installments?: number | undefined;
-  hold_id?: string | undefined;
+  hold?: string | undefined;
+  network_purchase?: NetworkPurchaseInfo$Outbound | undefined;
   amount?: number | undefined;
-  payment_intent_id?: string | undefined;
+  payment_intent?: string | undefined;
   due_date?: number | undefined;
   repayment_date?: number | undefined;
   metadata?: CreateOriginationOfferDtoMetadata$Outbound | undefined;
+  base_fee_rate?: number | undefined;
+  funding_financial_account?: string | undefined;
+  repayment_financial_account?: string | undefined;
+  scheduled_repayment_date?: number | undefined;
 };
 
 /** @internal */
@@ -113,34 +143,40 @@ export const CreateOriginationOfferDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateOriginationOfferDto
 > = z.object({
-  programId: z.string(),
-  businessId: z.string(),
-  platformId: z.string().optional(),
+  program: z.string(),
+  business: z.string(),
+  platform: z.string().optional(),
   downPaymentDueDate: z.string().optional(),
   installmentsStartDate: z.string().optional(),
   paymentDayOfWeek: z.string().optional(),
   cadence: z.string().optional(),
   numberOfInstallments: z.number().optional(),
-  holdId: z.string().optional(),
+  hold: z.string().optional(),
+  networkPurchase: NetworkPurchaseInfo$outboundSchema.optional(),
   amount: z.number().optional(),
-  paymentIntentId: z.string().optional(),
+  paymentIntent: z.string().optional(),
   dueDate: z.number().optional(),
   repaymentDate: z.number().optional(),
   metadata: z.lazy(() => CreateOriginationOfferDtoMetadata$outboundSchema)
     .optional(),
+  baseFeeRate: z.number().optional(),
+  fundingFinancialAccount: z.string().optional(),
+  repaymentFinancialAccount: z.string().optional(),
+  scheduledRepaymentDate: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
-    programId: "program_id",
-    businessId: "business_id",
-    platformId: "platform_id",
     downPaymentDueDate: "down_payment_due_date",
     installmentsStartDate: "installments_start_date",
     paymentDayOfWeek: "payment_day_of_week",
     numberOfInstallments: "number_of_installments",
-    holdId: "hold_id",
-    paymentIntentId: "payment_intent_id",
+    networkPurchase: "network_purchase",
+    paymentIntent: "payment_intent",
     dueDate: "due_date",
     repaymentDate: "repayment_date",
+    baseFeeRate: "base_fee_rate",
+    fundingFinancialAccount: "funding_financial_account",
+    repaymentFinancialAccount: "repayment_financial_account",
+    scheduledRepaymentDate: "scheduled_repayment_date",
   });
 });
 

package/src/models/createpartneragreementassignmentdto.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 CreatePartnerAgreementAssignmentDto = {
+  /**
+   * ID of the loan program
+   */
+  loanProgram: string;
+  /**
+   * Whether the end user actually accepted the agreement. The partner attests this value: pass true when the borrower has explicitly accepted the terms, false when the partner is recording the assignment without a user action.
+   */
+  userAccepted: boolean;
+};
+
+/** @internal */
+export type CreatePartnerAgreementAssignmentDto$Outbound = {
+  loan_program: string;
+  user_accepted: boolean;
+};
+
+/** @internal */
+export const CreatePartnerAgreementAssignmentDto$outboundSchema: z.ZodType<
+  CreatePartnerAgreementAssignmentDto$Outbound,
+  z.ZodTypeDef,
+  CreatePartnerAgreementAssignmentDto
+> = z.object({
+  loanProgram: z.string(),
+  userAccepted: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    loanProgram: "loan_program",
+    userAccepted: "user_accepted",
+  });
+});
+
+export function createPartnerAgreementAssignmentDtoToJSON(
+  createPartnerAgreementAssignmentDto: CreatePartnerAgreementAssignmentDto,
+): string {
+  return JSON.stringify(
+    CreatePartnerAgreementAssignmentDto$outboundSchema.parse(
+      createPartnerAgreementAssignmentDto,
+    ),
+  );
+}

package/src/models/createpaymentreversaldto.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 { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Reason for the reversal
+ */
+export const Reason = {
+  InsufficientFunds: "Insufficient_Funds",
+  TransferFailed: "Transfer_Failed",
+  DuplicateEntry: "Duplicate_Entry",
+  IncorrectReceiverNotFraudRelated: "Incorrect_Receiver_(Not_Fraud_Related)",
+  IncorrectDollarAmountNotFraudRelated:
+    "Incorrect_Dollar_Amount_(Not_Fraud_Related)",
+} as const;
+/**
+ * Reason for the reversal
+ */
+export type Reason = ClosedEnum<typeof Reason>;
+
+export type CreatePaymentReversalDto = {
+  /**
+   * Loan program ID
+   */
+  program: string;
+  /**
+   * Reason for the reversal
+   */
+  reason?: Reason | undefined;
+  /**
+   * Description of the reversal
+   */
+  description?: string | undefined;
+  /**
+   * Whether to revert the transfer via the payment rail
+   */
+  revertTransfer?: boolean | undefined;
+};
+
+/** @internal */
+export const Reason$outboundSchema: z.ZodNativeEnum<typeof Reason> = z
+  .nativeEnum(Reason);
+
+/** @internal */
+export type CreatePaymentReversalDto$Outbound = {
+  program: string;
+  reason?: string | undefined;
+  description?: string | undefined;
+  revert_transfer: boolean;
+};
+
+/** @internal */
+export const CreatePaymentReversalDto$outboundSchema: z.ZodType<
+  CreatePaymentReversalDto$Outbound,
+  z.ZodTypeDef,
+  CreatePaymentReversalDto
+> = z.object({
+  program: z.string(),
+  reason: Reason$outboundSchema.optional(),
+  description: z.string().optional(),
+  revertTransfer: z.boolean().default(false),
+}).transform((v) => {
+  return remap$(v, {
+    revertTransfer: "revert_transfer",
+  });
+});
+
+export function createPaymentReversalDtoToJSON(
+  createPaymentReversalDto: CreatePaymentReversalDto,
+): string {
+  return JSON.stringify(
+    CreatePaymentReversalDto$outboundSchema.parse(createPaymentReversalDto),
+  );
+}

package/src/models/createplatformsettingsdto.ts

@@ -9,6 +9,11 @@ import {
   AANConfigPartnerSettingsDto$Outbound,
   AANConfigPartnerSettingsDto$outboundSchema,
 } from "./aanconfigpartnersettingsdto.js";
+import {
+  BrandingConfigurationDto,
+  BrandingConfigurationDto$Outbound,
+  BrandingConfigurationDto$outboundSchema,
+} from "./brandingconfigurationdto.js";
 import {
   DirectDebitAuthorizationSettingDto,
   DirectDebitAuthorizationSettingDto$Outbound,
@@ -127,10 +132,6 @@ export type CreatePlatformSettingsDto = {
    * Enable VAN creation
    */
   vanCreation?: boolean | undefined;
-  /**
-   * Enable shared credit limit
-   */
-  sharedCreditLimitEnabled?: boolean | undefined;
   /**
    * Underwriting expiration days
    */
@@ -183,6 +184,10 @@ export type CreatePlatformSettingsDto = {
    * AAN configuration settings
    */
   aanConfiguration?: AANConfigPartnerSettingsDto | undefined;
+  /**
+   * Branding configuration settings
+   */
+  brandingConfiguration?: BrandingConfigurationDto | undefined;
   /**
    * Enable repayment settlement
    */
@@ -235,7 +240,6 @@ export type CreatePlatformSettingsDto$Outbound = {
   autodecline?: boolean | undefined;
   bypass_underwriting?: boolean | undefined;
   van_creation?: boolean | undefined;
-  shared_credit_limit_enabled?: boolean | undefined;
   underwriting_expiration_days?: number | undefined;
   max_delinquency_days?: number | undefined;
   cap_utilization_notification_triggers?: Array<string> | undefined;
@@ -249,6 +253,7 @@ export type CreatePlatformSettingsDto$Outbound = {
   unit_org_api_token?: string | undefined;
   aan_enable?: boolean | undefined;
   aan_configuration?: AANConfigPartnerSettingsDto$Outbound | undefined;
+  branding_configuration?: BrandingConfigurationDto$Outbound | undefined;
   repayment_settlement?: boolean | undefined;
   new_kyb_flow?: boolean | undefined;
   notification_channels?: Array<NotificationChannelDto$Outbound> | undefined;
@@ -289,7 +294,6 @@ export const CreatePlatformSettingsDto$outboundSchema: z.ZodType<
   autodecline: z.boolean().optional(),
   bypassUnderwriting: z.boolean().optional(),
   vanCreation: z.boolean().optional(),
-  sharedCreditLimitEnabled: z.boolean().optional(),
   underwritingExpirationDays: z.number().optional(),
   maxDelinquencyDays: z.number().optional(),
   capUtilizationNotificationTriggers: z.array(z.string()).optional(),
@@ -304,6 +308,7 @@ export const CreatePlatformSettingsDto$outboundSchema: z.ZodType<
   unitOrgApiToken: z.string().optional(),
   aanEnable: z.boolean().optional(),
   aanConfiguration: AANConfigPartnerSettingsDto$outboundSchema.optional(),
+  brandingConfiguration: BrandingConfigurationDto$outboundSchema.optional(),
   repaymentSettlement: z.boolean().optional(),
   newKybFlow: z.boolean().optional(),
   notificationChannels: z.array(NotificationChannelDto$outboundSchema)
@@ -337,7 +342,6 @@ export const CreatePlatformSettingsDto$outboundSchema: z.ZodType<
     runAlloyOnPayors: "run_alloy_on_payors",
     bypassUnderwriting: "bypass_underwriting",
     vanCreation: "van_creation",
-    sharedCreditLimitEnabled: "shared_credit_limit_enabled",
     underwritingExpirationDays: "underwriting_expiration_days",
     maxDelinquencyDays: "max_delinquency_days",
     capUtilizationNotificationTriggers: "cap_utilization_notification_triggers",
@@ -350,6 +354,7 @@ export const CreatePlatformSettingsDto$outboundSchema: z.ZodType<
     unitOrgApiToken: "unit_org_api_token",
     aanEnable: "aan_enable",
     aanConfiguration: "aan_configuration",
+    brandingConfiguration: "branding_configuration",
     repaymentSettlement: "repayment_settlement",
     newKybFlow: "new_kyb_flow",
     notificationChannels: "notification_channels",