@oatfi/oatfi-sdk-ts 0.12.2 → 0.12.4

package/src/models/cancelrequestdto.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";
+
+/**
+ * Cancellation reason (closed enum).
+ */
+export const CancelRequestDtoReason = {
+  IppCancelled: "ipp_cancelled",
+} as const;
+/**
+ * Cancellation reason (closed enum).
+ */
+export type CancelRequestDtoReason = ClosedEnum<typeof CancelRequestDtoReason>;
+
+export type CancelRequestDto = {
+  /**
+   * lms_program_id — the buyer's active LMS program (cancel is buyer-role / LMS-only). Supports multi-program routing on the LMS side.
+   */
+  programId: string;
+  /**
+   * The buyer's partner-assigned external id — lets the LMS link the cancellation to its onboarded business record.
+   */
+  businessExternalId: string;
+  /**
+   * Cancellation reason (closed enum).
+   */
+  reason: CancelRequestDtoReason;
+  /**
+   * Unix milliseconds when IPP originated the cancellation.
+   */
+  cancelledAt: number;
+};
+
+/** @internal */
+export const CancelRequestDtoReason$outboundSchema: z.ZodNativeEnum<
+  typeof CancelRequestDtoReason
+> = z.nativeEnum(CancelRequestDtoReason);
+
+/** @internal */
+export type CancelRequestDto$Outbound = {
+  program_id: string;
+  business_external_id: string;
+  reason: string;
+  cancelled_at: number;
+};
+
+/** @internal */
+export const CancelRequestDto$outboundSchema: z.ZodType<
+  CancelRequestDto$Outbound,
+  z.ZodTypeDef,
+  CancelRequestDto
+> = z.object({
+  programId: z.string(),
+  businessExternalId: z.string(),
+  reason: CancelRequestDtoReason$outboundSchema,
+  cancelledAt: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    programId: "program_id",
+    businessExternalId: "business_external_id",
+    cancelledAt: "cancelled_at",
+  });
+});
+
+export function cancelRequestDtoToJSON(
+  cancelRequestDto: CancelRequestDto,
+): string {
+  return JSON.stringify(
+    CancelRequestDto$outboundSchema.parse(cancelRequestDto),
+  );
+}

package/src/models/confirmedenvelopedto.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 ConfirmedEnvelopeDto = {
+  /**
+   * Always true on success.
+   */
+  confirmed: boolean;
+};
+
+/** @internal */
+export const ConfirmedEnvelopeDto$inboundSchema: z.ZodType<
+  ConfirmedEnvelopeDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confirmed: types.boolean().default(true),
+});
+
+export function confirmedEnvelopeDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ConfirmedEnvelopeDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConfirmedEnvelopeDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConfirmedEnvelopeDto' from JSON`,
+  );
+}

package/src/models/createadjustmentdto.ts

@@ -6,6 +6,9 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
 import { ClosedEnum } from "../types/enums.js";
 
+/**
+ * Adjustment classification. Mirrors the partner-side CreateAdjustmentDto.type enum.
+ */
 export const CreateAdjustmentDtoType = {
   Reward: "REWARD",
   Return: "RETURN",
@@ -18,6 +21,9 @@ export const CreateAdjustmentDtoType = {
   FeeOther: "FEE_OTHER",
   Other: "OTHER",
 } as const;
+/**
+ * Adjustment classification. Mirrors the partner-side CreateAdjustmentDto.type enum.
+ */
 export type CreateAdjustmentDtoType = ClosedEnum<
   typeof CreateAdjustmentDtoType
 >;

package/src/models/createagreementassignmentdto.ts

@@ -56,9 +56,9 @@ export type CreateAgreementAssignmentDto = {
    */
   acceptedVia: CreateAgreementAssignmentDtoAcceptedVia;
   /**
-   * Whether the end user actually accepted the agreement. HOSTED and COMPONENT flows always send true; AUTO assignments are always false.
+   * Whether the end user actually accepted the agreement. HOSTED and COMPONENT flows always send true; AUTO assignments are always false. Defaults to true when omitted.
    */
-  userAccepted: boolean;
+  userAccepted?: boolean | undefined;
   /**
    * ID of the entity that accepted the terms (application, business, or person)
    */
@@ -96,7 +96,7 @@ export const CreateAgreementAssignmentDtoType$outboundSchema: z.ZodNativeEnum<
 export type CreateAgreementAssignmentDto$Outbound = {
   terms_file_url?: string | undefined;
   accepted_via: string;
-  user_accepted: boolean;
+  user_accepted?: boolean | undefined;
   entity_id: string;
   entity_collection_name: string;
   loan_program: string;
@@ -111,7 +111,7 @@ export const CreateAgreementAssignmentDto$outboundSchema: z.ZodType<
 > = z.object({
   termsFileUrl: z.string().optional(),
   acceptedVia: CreateAgreementAssignmentDtoAcceptedVia$outboundSchema,
-  userAccepted: z.boolean(),
+  userAccepted: z.boolean().optional(),
   entityId: z.string(),
   entityCollectionName:
     CreateAgreementAssignmentDtoEntityCollectionName$outboundSchema,

package/src/models/createdailyreportdto.ts

@@ -30,6 +30,10 @@ export type CreateDailyReportDto = {
    * The repayment amount in cents. Must be >= 0.
    */
   repaymentAmount: number;
+  /**
+   * The refund amount in cents. Optional, defaults to 0. Must be a non-negative integer.
+   */
+  refund?: number | undefined;
   /**
    * The date of the daily report in YYYY-MM-DD format.
    */
@@ -44,6 +48,7 @@ export type CreateDailyReportDto$Outbound = {
   billing_cycle_outstanding_balance?: number | undefined;
   late_fees?: number | undefined;
   repayment_amount: number;
+  refund?: number | undefined;
   date: string;
 };
 
@@ -59,6 +64,7 @@ export const CreateDailyReportDto$outboundSchema: z.ZodType<
   billingCycleOutstandingBalance: z.number().optional(),
   lateFees: z.number().optional(),
   repaymentAmount: z.number(),
+  refund: z.number().optional(),
   date: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/createfinancialaccountdto.ts

@@ -38,6 +38,7 @@ export const CreateFinancialAccountDtoType = {
   UnitCm: "UNIT_CM",
   NonCash: "NON_CASH",
   IncreaseIntWire: "INCREASE_INT_WIRE",
+  IncreaseAch: "INCREASE_ACH",
 } as const;
 /**
  * Type

package/src/models/createholddto.ts

@@ -7,9 +7,9 @@ import { remap as remap$ } from "../lib/primitives.js";
 
 export type CreateHoldDto = {
   /**
-   * The Product Id
+   * Reference to the loan program (Mongo ObjectId of the partner product) that owns the hold.
    */
-  productUuid: string;
+  program: string;
   /**
    * Holding amount
    */
@@ -26,7 +26,7 @@ export type CreateHoldDto = {
 
 /** @internal */
 export type CreateHoldDto$Outbound = {
-  product_uuid: string;
+  program: string;
   amount: number;
   description: string;
   expiration_date?: string | undefined;
@@ -38,13 +38,12 @@ export const CreateHoldDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateHoldDto
 > = z.object({
-  productUuid: z.string(),
+  program: z.string(),
   amount: z.number(),
   description: z.string(),
   expirationDate: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
   return remap$(v, {
-    productUuid: "product_uuid",
     expirationDate: "expiration_date",
   });
 });

package/src/models/createledgerentrydto.ts

@@ -0,0 +1,124 @@
+/*
+ * 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";
+
+/**
+ * Type of the ledger entry.
+ */
+export const CreateLedgerEntryDtoType = {
+  Invoice: "INVOICE",
+  CardReceivable: "CARD_RECEIVABLE",
+} as const;
+/**
+ * Type of the ledger entry.
+ */
+export type CreateLedgerEntryDtoType = ClosedEnum<
+  typeof CreateLedgerEntryDtoType
+>;
+
+export type CreateLedgerEntryDto = {
+  /**
+   * External identifier for the ledger entry.
+   */
+  externalId: string;
+  /**
+   * Type of the ledger entry.
+   */
+  type: CreateLedgerEntryDtoType;
+  /**
+   * Amount of the ledger entry, in cents (e.g., 1000 for $10.00). Must be a positive integer.
+   */
+  amount: number;
+  /**
+   * Amount that has been paid for this ledger entry, in cents. Must be a positive integer.
+   */
+  paidAmount?: number | undefined;
+  /**
+   * Date when the ledger entry was created or issued (ISO 8601 format).
+   */
+  createdDate?: string | undefined;
+  /**
+   * Date when the ledger entry is due (ISO 8601 format).
+   */
+  dueDate?: string | undefined;
+  /**
+   * Date when the ledger entry was paid (ISO 8601 format).
+   */
+  paymentDate?: string | undefined;
+  /**
+   * A textual description of the ledger entry.
+   */
+  description?: string | undefined;
+  /**
+   * Ledger entry approved by Payor.
+   */
+  approvedByPayor?: boolean | undefined;
+  /**
+   * Mongo ID of the payor organization.
+   */
+  payor?: string | undefined;
+  /**
+   * Mongo ID of the payee organization.
+   */
+  payee?: string | undefined;
+};
+
+/** @internal */
+export const CreateLedgerEntryDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof CreateLedgerEntryDtoType
+> = z.nativeEnum(CreateLedgerEntryDtoType);
+
+/** @internal */
+export type CreateLedgerEntryDto$Outbound = {
+  external_id: string;
+  type: string;
+  amount: number;
+  paid_amount?: number | undefined;
+  created_date?: string | undefined;
+  due_date?: string | undefined;
+  payment_date?: string | undefined;
+  description?: string | undefined;
+  approved_by_payor?: boolean | undefined;
+  payor?: string | undefined;
+  payee?: string | undefined;
+};
+
+/** @internal */
+export const CreateLedgerEntryDto$outboundSchema: z.ZodType<
+  CreateLedgerEntryDto$Outbound,
+  z.ZodTypeDef,
+  CreateLedgerEntryDto
+> = z.object({
+  externalId: z.string(),
+  type: CreateLedgerEntryDtoType$outboundSchema,
+  amount: z.number(),
+  paidAmount: z.number().optional(),
+  createdDate: z.string().optional(),
+  dueDate: z.string().optional(),
+  paymentDate: z.string().optional(),
+  description: z.string().optional(),
+  approvedByPayor: z.boolean().optional(),
+  payor: z.string().optional(),
+  payee: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    paidAmount: "paid_amount",
+    createdDate: "created_date",
+    dueDate: "due_date",
+    paymentDate: "payment_date",
+    approvedByPayor: "approved_by_payor",
+  });
+});
+
+export function createLedgerEntryDtoToJSON(
+  createLedgerEntryDto: CreateLedgerEntryDto,
+): string {
+  return JSON.stringify(
+    CreateLedgerEntryDto$outboundSchema.parse(createLedgerEntryDto),
+  );
+}

package/src/models/createpartneragreementassignmentdto.ts

@@ -11,15 +11,15 @@ export type CreatePartnerAgreementAssignmentDto = {
    */
   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.
+   * 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. Defaults to true when omitted.
    */
-  userAccepted: boolean;
+  userAccepted?: boolean | undefined;
 };
 
 /** @internal */
 export type CreatePartnerAgreementAssignmentDto$Outbound = {
   loan_program: string;
-  user_accepted: boolean;
+  user_accepted?: boolean | undefined;
 };
 
 /** @internal */
@@ -29,7 +29,7 @@ export const CreatePartnerAgreementAssignmentDto$outboundSchema: z.ZodType<
   CreatePartnerAgreementAssignmentDto
 > = z.object({
   loanProgram: z.string(),
-  userAccepted: z.boolean(),
+  userAccepted: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     loanProgram: "loan_program",

package/src/models/createpaymentreversaldto.ts

@@ -9,7 +9,7 @@ import { ClosedEnum } from "../types/enums.js";
 /**
  * Reason for the reversal
  */
-export const Reason = {
+export const CreatePaymentReversalDtoReason = {
   InsufficientFunds: "Insufficient_Funds",
   TransferFailed: "Transfer_Failed",
   DuplicateEntry: "Duplicate_Entry",
@@ -20,7 +20,9 @@ export const Reason = {
 /**
  * Reason for the reversal
  */
-export type Reason = ClosedEnum<typeof Reason>;
+export type CreatePaymentReversalDtoReason = ClosedEnum<
+  typeof CreatePaymentReversalDtoReason
+>;
 
 export type CreatePaymentReversalDto = {
   /**
@@ -30,7 +32,7 @@ export type CreatePaymentReversalDto = {
   /**
    * Reason for the reversal
    */
-  reason?: Reason | undefined;
+  reason?: CreatePaymentReversalDtoReason | undefined;
   /**
    * Description of the reversal
    */
@@ -42,8 +44,9 @@ export type CreatePaymentReversalDto = {
 };
 
 /** @internal */
-export const Reason$outboundSchema: z.ZodNativeEnum<typeof Reason> = z
-  .nativeEnum(Reason);
+export const CreatePaymentReversalDtoReason$outboundSchema: z.ZodNativeEnum<
+  typeof CreatePaymentReversalDtoReason
+> = z.nativeEnum(CreatePaymentReversalDtoReason);
 
 /** @internal */
 export type CreatePaymentReversalDto$Outbound = {
@@ -60,7 +63,7 @@ export const CreatePaymentReversalDto$outboundSchema: z.ZodType<
   CreatePaymentReversalDto
 > = z.object({
   program: z.string(),
-  reason: Reason$outboundSchema.optional(),
+  reason: CreatePaymentReversalDtoReason$outboundSchema.optional(),
   description: z.string().optional(),
   revertTransfer: z.boolean().default(false),
 }).transform((v) => {

package/src/models/createplatformfinancialaccountdto.ts

@@ -38,6 +38,7 @@ export const CreatePlatformFinancialAccountDtoType = {
   UnitCm: "UNIT_CM",
   NonCash: "NON_CASH",
   IncreaseIntWire: "INCREASE_INT_WIRE",
+  IncreaseAch: "INCREASE_ACH",
 } as const;
 /**
  * Type

package/src/models/createplatformsettingsdto.ts

@@ -36,18 +36,6 @@ import {
 } from "./platformproductsettingsdto.js";
 
 export type CreatePlatformSettingsDto = {
-  /**
-   * Primary brand color
-   */
-  primaryColor?: string | undefined;
-  /**
-   * Secondary brand color
-   */
-  secondaryColor?: string | undefined;
-  /**
-   * Logo URL
-   */
-  logoUrl?: string | undefined;
   /**
    * Webhook URL for notifications
    */
@@ -216,9 +204,6 @@ export type CreatePlatformSettingsDto = {
 
 /** @internal */
 export type CreatePlatformSettingsDto$Outbound = {
-  primary_color?: string | undefined;
-  secondary_color?: string | undefined;
-  logo_url?: string | undefined;
   webhook_url?: string | undefined;
   stripe_account?: string | undefined;
   stripe_api_key?: string | undefined;
@@ -270,9 +255,6 @@ export const CreatePlatformSettingsDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreatePlatformSettingsDto
 > = z.object({
-  primaryColor: z.string().optional(),
-  secondaryColor: z.string().optional(),
-  logoUrl: z.string().optional(),
   webhookUrl: z.string().optional(),
   stripeAccount: z.string().optional(),
   stripeApiKey: z.string().optional(),
@@ -319,9 +301,6 @@ export const CreatePlatformSettingsDto$outboundSchema: z.ZodType<
   metadata: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
-    primaryColor: "primary_color",
-    secondaryColor: "secondary_color",
-    logoUrl: "logo_url",
     webhookUrl: "webhook_url",
     stripeAccount: "stripe_account",
     stripeApiKey: "stripe_api_key",

package/src/models/createportfoliodto.ts

@@ -33,6 +33,14 @@ export type CreatePortfolioDto = {
    * Stripe ProviderAccount ID para funding source
    */
   stripeFundingSource: string;
+  /**
+   * Increase ProviderAccount ID for repayment destination
+   */
+  increaseRepaymentDestination: string;
+  /**
+   * Increase ProviderAccount ID for funding source
+   */
+  increaseFundingSource: string;
   /**
    * Increase account ID for DIRECT approval flows
    */
@@ -52,6 +60,8 @@ export type CreatePortfolioDto$Outbound = {
   svbFundingSource: string;
   stripeRepaymentDestination: string;
   stripeFundingSource: string;
+  increaseRepaymentDestination: string;
+  increaseFundingSource: string;
   increaseAccountId: string;
   isDefault: boolean;
 };
@@ -69,6 +79,8 @@ export const CreatePortfolioDto$outboundSchema: z.ZodType<
   svbFundingSource: z.string(),
   stripeRepaymentDestination: z.string(),
   stripeFundingSource: z.string(),
+  increaseRepaymentDestination: z.string(),
+  increaseFundingSource: z.string(),
   increaseAccountId: z.string(),
   isDefault: z.boolean(),
 });

package/src/models/createtradingrelationshipdto.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 CreateTradingRelationshipDto = {
+  /**
+   * The OatFi internal business id (Mongo _id) that owns the Increase account on which the VAN is minted (the payee / account holder).
+   */
+  accountHolderBusiness: string;
+  /**
+   * The OatFi internal business id (Mongo _id) of the counterparty (the payor).
+   */
+  counterpartyBusiness: string;
+};
+
+/** @internal */
+export type CreateTradingRelationshipDto$Outbound = {
+  account_holder_business: string;
+  counterparty_business: string;
+};
+
+/** @internal */
+export const CreateTradingRelationshipDto$outboundSchema: z.ZodType<
+  CreateTradingRelationshipDto$Outbound,
+  z.ZodTypeDef,
+  CreateTradingRelationshipDto
+> = z.object({
+  accountHolderBusiness: z.string(),
+  counterpartyBusiness: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    accountHolderBusiness: "account_holder_business",
+    counterpartyBusiness: "counterparty_business",
+  });
+});
+
+export function createTradingRelationshipDtoToJSON(
+  createTradingRelationshipDto: CreateTradingRelationshipDto,
+): string {
+  return JSON.stringify(
+    CreateTradingRelationshipDto$outboundSchema.parse(
+      createTradingRelationshipDto,
+    ),
+  );
+}

package/src/models/dailyreportdto.ts

@@ -42,6 +42,10 @@ export type DailyReportDto = {
    * The repayment amount in cents.
    */
   repaymentAmount?: number | undefined;
+  /**
+   * The refund amount in cents.
+   */
+  refund?: number | undefined;
   /**
    * The date of the daily report in YYYY-MM-DD format.
    */
@@ -78,6 +82,7 @@ export const DailyReportDto$inboundSchema: z.ZodType<
   billing_cycle_outstanding_balance: types.optional(types.number()),
   late_fees: types.optional(types.number()),
   repayment_amount: types.optional(types.number()),
+  refund: types.optional(types.number()),
   date: types.string(),
   origination: types.optional(types.string()),
   payment_intent: types.optional(types.string()),

package/src/models/filereferencerequestdto.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 FileReferenceRequestDto = {
+  fileId: string;
+  fileName: string;
+  /**
+   * Presigned S3 URL the lender must fetch within the window.
+   */
+  presignedUrl: string;
+  /**
+   * Unix milliseconds when the presigned URL expires.
+   */
+  presignedUrlExpiresAt: number;
+};
+
+/** @internal */
+export type FileReferenceRequestDto$Outbound = {
+  file_id: string;
+  file_name: string;
+  presigned_url: string;
+  presigned_url_expires_at: number;
+};
+
+/** @internal */
+export const FileReferenceRequestDto$outboundSchema: z.ZodType<
+  FileReferenceRequestDto$Outbound,
+  z.ZodTypeDef,
+  FileReferenceRequestDto
+> = z.object({
+  fileId: z.string(),
+  fileName: z.string(),
+  presignedUrl: z.string(),
+  presignedUrlExpiresAt: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    fileId: "file_id",
+    fileName: "file_name",
+    presignedUrl: "presigned_url",
+    presignedUrlExpiresAt: "presigned_url_expires_at",
+  });
+});
+
+export function fileReferenceRequestDtoToJSON(
+  fileReferenceRequestDto: FileReferenceRequestDto,
+): string {
+  return JSON.stringify(
+    FileReferenceRequestDto$outboundSchema.parse(fileReferenceRequestDto),
+  );
+}

package/src/models/fileresponsedto.ts

@@ -39,7 +39,8 @@ export const FileResponseDtoFileType = {
   BusinessLicense: "business_license",
   ArticlesOfIncorporation: "articles_of_incorporation",
   EinLetter: "ein_letter",
-  FinancialStatement: "financial_statement",
+  AccountingData: "accounting_data",
+  FinancialStatements: "financial_statements",
   CorporateFormationDocument: "corporate_formation_document",
   CertificateOfGoodStanding: "certificate_of_good_standing",
   DriversLicense: "drivers_license",

package/src/models/filetype.ts

@@ -14,7 +14,8 @@ export const FileType = {
   BusinessLicense: "business_license",
   ArticlesOfIncorporation: "articles_of_incorporation",
   EinLetter: "ein_letter",
-  FinancialStatement: "financial_statement",
+  AccountingData: "accounting_data",
+  FinancialStatements: "financial_statements",
   CorporateFormationDocument: "corporate_formation_document",
   CertificateOfGoodStanding: "certificate_of_good_standing",
   DriversLicense: "drivers_license",

package/src/models/financialaccountresponsedto.ts

@@ -35,6 +35,7 @@ export const FinancialAccountResponseDtoType = {
   UnitCm: "UNIT_CM",
   NonCash: "NON_CASH",
   IncreaseIntWire: "INCREASE_INT_WIRE",
+  IncreaseAch: "INCREASE_ACH",
 } as const;
 /**
  * Payment Method Type