@oatfi/oatfi-sdk-ts 0.11.61 → 0.11.62

package/src/models/updatepaymentdto.ts

@@ -4,10 +4,28 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
-import {
-  LmsPaymentRequestStatus,
-  LmsPaymentRequestStatus$outboundSchema,
-} from "./lmspaymentrequeststatus.js";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Third party payment status update
+ */
+export const UpdatePaymentDtoThirdPartyPaymentStatus = {
+  Processing: "PROCESSING",
+  ProcessingFees: "PROCESSING_FEES",
+  ProcessingInterest: "PROCESSING_INTEREST",
+  Processed: "PROCESSED",
+  Succeeded: "SUCCEEDED",
+  Error: "ERROR",
+  Failed: "FAILED",
+  Pending: "PENDING",
+  Reversed: "REVERSED",
+} as const;
+/**
+ * Third party payment status update
+ */
+export type UpdatePaymentDtoThirdPartyPaymentStatus = ClosedEnum<
+  typeof UpdatePaymentDtoThirdPartyPaymentStatus
+>;
 
 export type UpdatePaymentDto = {
   /**
@@ -15,11 +33,16 @@ export type UpdatePaymentDto = {
    */
   financialAccount?: string | undefined;
   /**
-   * Third Party Payment Status
+   * Third party payment status update
    */
-  thirdPartyPaymentStatus: LmsPaymentRequestStatus;
+  thirdPartyPaymentStatus: UpdatePaymentDtoThirdPartyPaymentStatus;
 };
 
+/** @internal */
+export const UpdatePaymentDtoThirdPartyPaymentStatus$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePaymentDtoThirdPartyPaymentStatus> = z
+    .nativeEnum(UpdatePaymentDtoThirdPartyPaymentStatus);
+
 /** @internal */
 export type UpdatePaymentDto$Outbound = {
   financial_account?: string | undefined;
@@ -33,7 +56,8 @@ export const UpdatePaymentDto$outboundSchema: z.ZodType<
   UpdatePaymentDto
 > = z.object({
   financialAccount: z.string().optional(),
-  thirdPartyPaymentStatus: LmsPaymentRequestStatus$outboundSchema,
+  thirdPartyPaymentStatus:
+    UpdatePaymentDtoThirdPartyPaymentStatus$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     financialAccount: "financial_account",

package/src/models/updatepersoninformationdto.ts

@@ -4,17 +4,49 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
-import { KycStatus, KycStatus$outboundSchema } from "./kycstatus.js";
-import {
-  PersonBusinessRelationship,
-  PersonBusinessRelationship$outboundSchema,
-} from "./personbusinessrelationship.js";
+import { ClosedEnum } from "../types/enums.js";
 import {
   UpdateAddressDto,
   UpdateAddressDto$Outbound,
   UpdateAddressDto$outboundSchema,
 } from "./updateaddressdto.js";
 
+/**
+ * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+ */
+export const UpdatePersonInformationDtoRelationshipToBusiness = {
+  Owner: "Owner",
+  Director: "Director",
+  Officer: "Officer",
+  BeneficialOwner: "Beneficial Owner",
+  AuthorizedRepresentative: "Authorized Representative",
+  Other: "Other",
+} as const;
+/**
+ * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+ */
+export type UpdatePersonInformationDtoRelationshipToBusiness = ClosedEnum<
+  typeof UpdatePersonInformationDtoRelationshipToBusiness
+>;
+
+/**
+ * Person's KYC status
+ */
+export const UpdatePersonInformationDtoKycStatus = {
+  NotStarted: "NOT_STARTED",
+  Started: "STARTED",
+  Failed: "FAILED",
+  ActionRequired: "ACTION_REQUIRED",
+  ManualReview: "MANUAL_REVIEW",
+  Approved: "APPROVED",
+} as const;
+/**
+ * Person's KYC status
+ */
+export type UpdatePersonInformationDtoKycStatus = ClosedEnum<
+  typeof UpdatePersonInformationDtoKycStatus
+>;
+
 export type UpdatePersonInformationDto = {
   /**
    * External ID for the person, if available
@@ -51,7 +83,9 @@ export type UpdatePersonInformationDto = {
   /**
    * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
    */
-  relationshipToBusiness?: PersonBusinessRelationship | undefined;
+  relationshipToBusiness?:
+    | UpdatePersonInformationDtoRelationshipToBusiness
+    | undefined;
   /**
    * Is this person a control person for the business?
    */
@@ -63,13 +97,24 @@ export type UpdatePersonInformationDto = {
   /**
    * Person's KYC status
    */
-  kycStatus?: KycStatus | undefined;
+  kycStatus?: UpdatePersonInformationDtoKycStatus | undefined;
   /**
    * Full SSN (Social Security Number) - for KYC purposes, Application-only field.
    */
   ssn?: string | undefined;
 };
 
+/** @internal */
+export const UpdatePersonInformationDtoRelationshipToBusiness$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePersonInformationDtoRelationshipToBusiness> = z
+    .nativeEnum(UpdatePersonInformationDtoRelationshipToBusiness);
+
+/** @internal */
+export const UpdatePersonInformationDtoKycStatus$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePersonInformationDtoKycStatus> = z.nativeEnum(
+    UpdatePersonInformationDtoKycStatus,
+  );
+
 /** @internal */
 export type UpdatePersonInformationDto$Outbound = {
   external_id?: string | undefined;
@@ -101,10 +146,11 @@ export const UpdatePersonInformationDto$outboundSchema: z.ZodType<
   phone: z.string().optional(),
   dateOfBirth: z.string().optional(),
   address: UpdateAddressDto$outboundSchema.optional(),
-  relationshipToBusiness: PersonBusinessRelationship$outboundSchema.optional(),
+  relationshipToBusiness:
+    UpdatePersonInformationDtoRelationshipToBusiness$outboundSchema.optional(),
   isControlPerson: z.boolean().optional(),
   ownershipPercentage: z.number().optional(),
-  kycStatus: KycStatus$outboundSchema.optional(),
+  kycStatus: UpdatePersonInformationDtoKycStatus$outboundSchema.optional(),
   ssn: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/updateplatformfinancialaccountdto.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
 import {
   FinancialAccountDataDto,
   FinancialAccountDataDto$Outbound,
@@ -14,14 +15,36 @@ import {
   FinancialAccountVerificationDto$Outbound,
   FinancialAccountVerificationDto$outboundSchema,
 } from "./financialaccountverificationdto.js";
-import {
-  PaymentMethodSourceEnum,
-  PaymentMethodSourceEnum$outboundSchema,
-} from "./paymentmethodsourceenum.js";
-import {
-  TransferTypeEnum,
-  TransferTypeEnum$outboundSchema,
-} from "./transfertypeenum.js";
+
+/**
+ * Transaction Type
+ */
+export const UpdatePlatformFinancialAccountDtoTransactionType = {
+  Funding: "FUNDING",
+  Repayment: "REPAYMENT",
+  Bidirectional: "BIDIRECTIONAL",
+  Reversal: "REVERSAL",
+} as const;
+/**
+ * Transaction Type
+ */
+export type UpdatePlatformFinancialAccountDtoTransactionType = ClosedEnum<
+  typeof UpdatePlatformFinancialAccountDtoTransactionType
+>;
+
+/**
+ * Source
+ */
+export const UpdatePlatformFinancialAccountDtoSource = {
+  Partner: "PARTNER",
+  Business: "BUSINESS",
+} as const;
+/**
+ * Source
+ */
+export type UpdatePlatformFinancialAccountDtoSource = ClosedEnum<
+  typeof UpdatePlatformFinancialAccountDtoSource
+>;
 
 /**
  * Payment rail data
@@ -30,9 +53,11 @@ export type UpdatePlatformFinancialAccountDtoData = FinancialAccountDataDto;
 
 export type UpdatePlatformFinancialAccountDto = {
   /**
-   * Transaction type
+   * Transaction Type
    */
-  transactionType?: TransferTypeEnum | undefined;
+  transactionType?:
+    | UpdatePlatformFinancialAccountDtoTransactionType
+    | undefined;
   /**
    * External Id
    */
@@ -44,7 +69,7 @@ export type UpdatePlatformFinancialAccountDto = {
   /**
    * Source
    */
-  source?: PaymentMethodSourceEnum | undefined;
+  source?: UpdatePlatformFinancialAccountDtoSource | undefined;
   /**
    * Payment rail data
    */
@@ -71,6 +96,16 @@ export type UpdatePlatformFinancialAccountDto = {
   verification?: FinancialAccountVerificationDto | undefined;
 };
 
+/** @internal */
+export const UpdatePlatformFinancialAccountDtoTransactionType$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePlatformFinancialAccountDtoTransactionType> = z
+    .nativeEnum(UpdatePlatformFinancialAccountDtoTransactionType);
+
+/** @internal */
+export const UpdatePlatformFinancialAccountDtoSource$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePlatformFinancialAccountDtoSource> = z
+    .nativeEnum(UpdatePlatformFinancialAccountDtoSource);
+
 /** @internal */
 export type UpdatePlatformFinancialAccountDtoData$Outbound =
   FinancialAccountDataDto$Outbound;
@@ -112,10 +147,11 @@ export const UpdatePlatformFinancialAccountDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdatePlatformFinancialAccountDto
 > = z.object({
-  transactionType: TransferTypeEnum$outboundSchema.optional(),
+  transactionType:
+    UpdatePlatformFinancialAccountDtoTransactionType$outboundSchema.optional(),
   externalId: z.string().optional(),
   alias: z.string().optional(),
-  source: PaymentMethodSourceEnum$outboundSchema.optional(),
+  source: UpdatePlatformFinancialAccountDtoSource$outboundSchema.optional(),
   data: FinancialAccountDataDto$outboundSchema.optional(),
   enabled: z.boolean().optional(),
   debitAllowed: z.boolean().optional(),

package/src/models/updateplatformscopesdto.ts

@@ -6,6 +6,9 @@ import * as z from "zod/v3";
 import { AppScope, AppScope$outboundSchema } from "./appscope.js";
 
 export type UpdatePlatformScopesDto = {
+  /**
+   * The complete list of scopes to assign to the platform.
+   */
   scopes: Array<AppScope>;
 };
 

package/src/models/updateprogramdto.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
 import {
   DelayFundingConfigDto,
   DelayFundingConfigDto$Outbound,
@@ -14,26 +15,6 @@ import {
   HoldSettingsDto$Outbound,
   HoldSettingsDto$outboundSchema,
 } from "./holdsettingsdto.js";
-import {
-  LmsBusinessType,
-  LmsBusinessType$outboundSchema,
-} from "./lmsbusinesstype.js";
-import {
-  LmsFixedFeeCalculationType,
-  LmsFixedFeeCalculationType$outboundSchema,
-} from "./lmsfixedfeecalculationtype.js";
-import {
-  LmsLoanDelayTypeEnum,
-  LmsLoanDelayTypeEnum$outboundSchema,
-} from "./lmsloandelaytypeenum.js";
-import {
-  LmsLoanProgramType,
-  LmsLoanProgramType$outboundSchema,
-} from "./lmsloanprogramtype.js";
-import {
-  LmsLoanStatus,
-  LmsLoanStatus$outboundSchema,
-} from "./lmsloanstatus.js";
 import {
   TermsSettingsDto,
   TermsSettingsDto$Outbound,
@@ -55,10 +36,97 @@ import {
   VolumeCapConfigDto$outboundSchema,
 } from "./volumecapconfigdto.js";
 
+/**
+ * Loan ownership type
+ */
+export const UpdateProgramDtoLoanOwnership = {
+  Payee: "PAYEE",
+  Payor: "PAYOR",
+} as const;
+/**
+ * Loan ownership type
+ */
+export type UpdateProgramDtoLoanOwnership = ClosedEnum<
+  typeof UpdateProgramDtoLoanOwnership
+>;
+
+/**
+ * Program type
+ */
+export const UpdateProgramDtoType = {
+  ChargeCard: "CHARGE_CARD",
+  EarlyPayLoan: "EARLY_PAY_LOAN",
+  ExtendedRepaymentLoan: "EXTENDED_REPAYMENT_LOAN",
+  ExtendedRepaymentMmf: "EXTENDED_REPAYMENT_MMF",
+  Factoring: "FACTORING",
+  InvoiceFinancing: "INVOICE_FINANCING",
+  MerchantCreditLoan: "MERCHANT_CREDIT_LOAN",
+  MmExtendedRepayment: "MM_EXTENDED_REPAYMENT",
+  MmNetTerms: "MM_NET_TERMS",
+  Tcrc: "TCRC",
+  DrawBased: "DRAW_BASED",
+  PooledAr: "POOLED_AR",
+} as const;
+/**
+ * Program type
+ */
+export type UpdateProgramDtoType = ClosedEnum<typeof UpdateProgramDtoType>;
+
 export type UpdateProgramDtoSetting = {};
 
 export type UpdateProgramDtoMetadatum = {};
 
+/**
+ * Delay funding type
+ */
+export const UpdateProgramDtoDelayFundingType = {
+  Time: "TIME",
+  None: "NONE",
+  Pause: "PAUSE",
+  Batch: "BATCH",
+} as const;
+/**
+ * Delay funding type
+ */
+export type UpdateProgramDtoDelayFundingType = ClosedEnum<
+  typeof UpdateProgramDtoDelayFundingType
+>;
+
+/**
+ * Fixed fee calculation type
+ */
+export const UpdateProgramDtoFixedFeeCalculationType = {
+  RequestedAmount: "REQUESTED_AMOUNT",
+  InvoiceAmount: "INVOICE_AMOUNT",
+} as const;
+/**
+ * Fixed fee calculation type
+ */
+export type UpdateProgramDtoFixedFeeCalculationType = ClosedEnum<
+  typeof UpdateProgramDtoFixedFeeCalculationType
+>;
+
+/**
+ * Delay funding loan default status
+ */
+export const UpdateProgramDtoDelayFundingLoanStatus = {
+  Active: "ACTIVE",
+  ChargedOff: "CHARGED_OFF",
+  Closed: "CLOSED",
+  Delinquent: "DELINQUENT",
+  PaidOff: "PAID_OFF",
+  Pending: "PENDING",
+  Migrating: "MIGRATING",
+  Cancelled: "CANCELLED",
+  Sold: "SOLD",
+} as const;
+/**
+ * Delay funding loan default status
+ */
+export type UpdateProgramDtoDelayFundingLoanStatus = ClosedEnum<
+  typeof UpdateProgramDtoDelayFundingLoanStatus
+>;
+
 export type UpdateProgramDto = {
   /**
    * Platform ID
@@ -91,11 +159,11 @@ export type UpdateProgramDto = {
   /**
    * Loan ownership type
    */
-  loanOwnership?: LmsBusinessType | undefined;
+  loanOwnership?: UpdateProgramDtoLoanOwnership | undefined;
   /**
    * Program type
    */
-  type?: LmsLoanProgramType | undefined;
+  type?: UpdateProgramDtoType | undefined;
   /**
    * Whether funding PDF invoice is required
    */
@@ -147,11 +215,11 @@ export type UpdateProgramDto = {
   /**
    * Delay funding type
    */
-  delayFundingType?: LmsLoanDelayTypeEnum | undefined;
+  delayFundingType?: UpdateProgramDtoDelayFundingType | undefined;
   /**
    * Fixed fee calculation type
    */
-  fixedFeeCalculationType?: LmsFixedFeeCalculationType | undefined;
+  fixedFeeCalculationType?: UpdateProgramDtoFixedFeeCalculationType | undefined;
   /**
    * Delay funding time in hours (required when delay_funding_type is TIME)
    */
@@ -161,9 +229,9 @@ export type UpdateProgramDto = {
    */
   delayBatchCronjob?: string | undefined;
   /**
-   * Loan status
+   * Delay funding loan default status
    */
-  delayFundingLoanStatus?: LmsLoanStatus | undefined;
+  delayFundingLoanStatus?: UpdateProgramDtoDelayFundingLoanStatus | undefined;
   /**
    * Volume cap configurations
    */
@@ -182,6 +250,16 @@ export type UpdateProgramDto = {
   denyFunding?: boolean | undefined;
 };
 
+/** @internal */
+export const UpdateProgramDtoLoanOwnership$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateProgramDtoLoanOwnership
+> = z.nativeEnum(UpdateProgramDtoLoanOwnership);
+
+/** @internal */
+export const UpdateProgramDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateProgramDtoType
+> = z.nativeEnum(UpdateProgramDtoType);
+
 /** @internal */
 export type UpdateProgramDtoSetting$Outbound = {};
 
@@ -218,6 +296,22 @@ export function updateProgramDtoMetadatumToJSON(
   );
 }
 
+/** @internal */
+export const UpdateProgramDtoDelayFundingType$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateProgramDtoDelayFundingType
+> = z.nativeEnum(UpdateProgramDtoDelayFundingType);
+
+/** @internal */
+export const UpdateProgramDtoFixedFeeCalculationType$outboundSchema:
+  z.ZodNativeEnum<typeof UpdateProgramDtoFixedFeeCalculationType> = z
+    .nativeEnum(UpdateProgramDtoFixedFeeCalculationType);
+
+/** @internal */
+export const UpdateProgramDtoDelayFundingLoanStatus$outboundSchema:
+  z.ZodNativeEnum<typeof UpdateProgramDtoDelayFundingLoanStatus> = z.nativeEnum(
+    UpdateProgramDtoDelayFundingLoanStatus,
+  );
+
 /** @internal */
 export type UpdateProgramDto$Outbound = {
   platform?: string | undefined;
@@ -265,8 +359,8 @@ export const UpdateProgramDto$outboundSchema: z.ZodType<
   active: z.boolean().optional(),
   isFixedFee: z.boolean().optional(),
   invoiceBased: z.boolean().optional(),
-  loanOwnership: LmsBusinessType$outboundSchema.optional(),
-  type: LmsLoanProgramType$outboundSchema.optional(),
+  loanOwnership: UpdateProgramDtoLoanOwnership$outboundSchema.optional(),
+  type: UpdateProgramDtoType$outboundSchema.optional(),
   fundingPdfInvoiceRequired: z.boolean().optional(),
   advancedRate: z.number().optional(),
   allowOfferNewInvoices: z.boolean().optional(),
@@ -281,11 +375,13 @@ export const UpdateProgramDto$outboundSchema: z.ZodType<
     .optional(),
   metadata: z.array(z.lazy(() => UpdateProgramDtoMetadatum$outboundSchema))
     .optional(),
-  delayFundingType: LmsLoanDelayTypeEnum$outboundSchema.optional(),
-  fixedFeeCalculationType: LmsFixedFeeCalculationType$outboundSchema.optional(),
+  delayFundingType: UpdateProgramDtoDelayFundingType$outboundSchema.optional(),
+  fixedFeeCalculationType:
+    UpdateProgramDtoFixedFeeCalculationType$outboundSchema.optional(),
   delayFundingTime: z.number().optional(),
   delayBatchCronjob: z.string().optional(),
-  delayFundingLoanStatus: LmsLoanStatus$outboundSchema.optional(),
+  delayFundingLoanStatus: UpdateProgramDtoDelayFundingLoanStatus$outboundSchema
+    .optional(),
   volumeCapConfigs: z.array(VolumeCapConfigDto$outboundSchema).optional(),
   delayFundingConfig: DelayFundingConfigDto$outboundSchema.optional(),
   termsSettings: TermsSettingsDto$outboundSchema.optional(),

package/src/models/updateprogramsettingdto.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
 import {
   DownPaymentDto,
   DownPaymentDto$Outbound,
@@ -18,10 +19,6 @@ import {
   LmsLoanProgramConfigRiskTier,
   LmsLoanProgramConfigRiskTier$outboundSchema,
 } from "./lmsloanprogramconfigrisktier.js";
-import {
-  LmsLoanProgramSettingCadence,
-  LmsLoanProgramSettingCadence$outboundSchema,
-} from "./lmsloanprogramsettingcadence.js";
 import {
   MinFeeDto,
   MinFeeDto$Outbound,
@@ -42,6 +39,23 @@ import {
   StatusRuleDto$outboundSchema,
 } from "./statusruledto.js";
 
+/**
+ * Payment cadence
+ */
+export const UpdateProgramSettingDtoCadence = {
+  SinglePayment: "SINGLE_PAYMENT",
+  Weekly: "WEEKLY",
+  BiWeekly: "BI_WEEKLY",
+  SemiMonthly: "SEMI_MONTHLY",
+  Monthly: "MONTHLY",
+} as const;
+/**
+ * Payment cadence
+ */
+export type UpdateProgramSettingDtoCadence = ClosedEnum<
+  typeof UpdateProgramSettingDtoCadence
+>;
+
 export type UpdateProgramSettingDto = {
   /**
    * Whether the setting is active
@@ -54,7 +68,7 @@ export type UpdateProgramSettingDto = {
   /**
    * Payment cadence
    */
-  cadence?: LmsLoanProgramSettingCadence | undefined;
+  cadence?: UpdateProgramSettingDtoCadence | undefined;
   /**
    * Down payment configuration
    */
@@ -115,11 +129,17 @@ export type UpdateProgramSettingDto = {
    * Status rules
    */
   statusRules?: Array<StatusRuleDto> | undefined;
+  /**
+   * Repayment allocation order
+   */
   repaymentOrder?: Array<RepaymentAllocation> | undefined;
   /**
    * Pooled AR configuration
    */
   pooledAr?: PooledARDto | undefined;
+  /**
+   * Risk tiers for this setting
+   */
   riskTier?: Array<LmsLoanProgramConfigRiskTier> | undefined;
   /**
    * Advanced rate percentage
@@ -135,6 +155,11 @@ export type UpdateProgramSettingDto = {
   deactivatedAt?: Date | undefined;
 };
 
+/** @internal */
+export const UpdateProgramSettingDtoCadence$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateProgramSettingDtoCadence
+> = z.nativeEnum(UpdateProgramSettingDtoCadence);
+
 /** @internal */
 export type UpdateProgramSettingDto$Outbound = {
   active?: boolean | undefined;
@@ -171,7 +196,7 @@ export const UpdateProgramSettingDto$outboundSchema: z.ZodType<
 > = z.object({
   active: z.boolean().optional(),
   type: z.string().optional(),
-  cadence: LmsLoanProgramSettingCadence$outboundSchema.optional(),
+  cadence: UpdateProgramSettingDtoCadence$outboundSchema.optional(),
   downPayment: DownPaymentDto$outboundSchema.optional(),
   minDeferrableDays: z.number().optional(),
   maxDeferrableDays: z.number().optional(),