@oatfi/oatfi-sdk-ts 0.12.3 → 0.12.5

package/src/models/authorizenotauthorizeddto.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 AuthorizeNotAuthorizedDto = {
+  /**
+   * Not authorized.
+   */
+  authorized: boolean;
+};
+
+/** @internal */
+export const AuthorizeNotAuthorizedDto$inboundSchema: z.ZodType<
+  AuthorizeNotAuthorizedDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  authorized: types.boolean(),
+});
+
+export function authorizeNotAuthorizedDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthorizeNotAuthorizedDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthorizeNotAuthorizedDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthorizeNotAuthorizedDto' from JSON`,
+  );
+}

package/src/models/authorizerequestdto.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 AuthorizeRequestDto = {
+  /**
+   * Role-specific program id (lms_program_id when called on LMS, ipp_program_id when called on IPP).
+   */
+  programId: string;
+  /**
+   * The counterparty's partner-assigned external id — buyer.external_id when calling LMS, vendor.external_id when calling IPP. Lets the lender correlate the request to its own onboarded-business record.
+   */
+  businessExternalId: string;
+  /**
+   * Amount being authorized, in cents.
+   */
+  amount: number;
+};
+
+/** @internal */
+export type AuthorizeRequestDto$Outbound = {
+  program_id: string;
+  business_external_id: string;
+  amount: number;
+};
+
+/** @internal */
+export const AuthorizeRequestDto$outboundSchema: z.ZodType<
+  AuthorizeRequestDto$Outbound,
+  z.ZodTypeDef,
+  AuthorizeRequestDto
+> = z.object({
+  programId: z.string(),
+  businessExternalId: z.string(),
+  amount: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    programId: "program_id",
+    businessExternalId: "business_external_id",
+  });
+});
+
+export function authorizeRequestDtoToJSON(
+  authorizeRequestDto: AuthorizeRequestDto,
+): string {
+  return JSON.stringify(
+    AuthorizeRequestDto$outboundSchema.parse(authorizeRequestDto),
+  );
+}

package/src/models/authorizevendorauthorizeddto.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 AuthorizeVendorAuthorizedDto = {
+  /**
+   * Authorized.
+   */
+  authorized: boolean;
+  /**
+   * IPP's offer reference. Stored on the ledger entry as ipp_offer_id and used by Step 2 (auto-triggered purchase execution).
+   */
+  offerId: string;
+  /**
+   * Unix milliseconds when the offer reservation expires.
+   */
+  offerExpiresAt: number;
+  /**
+   * IPP-side identifier for the credit reservation backing this offer. Stored on the ledger entry as ipp_hold_id.
+   */
+  holdId: string;
+  /**
+   * In cents. IPP's discount on the receivable purchase.
+   */
+  discountAmount: number;
+  /**
+   * In cents. original_amount - discount_amount. Returned for explicit cross-check.
+   */
+  purchaseAmount: number;
+  /**
+   * Date IPP will disburse to the vendor (YYYY-MM-DD).
+   */
+  disbursementDate: string;
+  /**
+   * In cents. Reward amount calculated by IPP.
+   */
+  rewardAmount: number;
+};
+
+/** @internal */
+export const AuthorizeVendorAuthorizedDto$inboundSchema: z.ZodType<
+  AuthorizeVendorAuthorizedDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  authorized: types.boolean(),
+  offer_id: types.string(),
+  offer_expires_at: types.number(),
+  hold_id: types.string(),
+  discount_amount: types.number(),
+  purchase_amount: types.number(),
+  disbursement_date: types.string(),
+  reward_amount: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "offer_id": "offerId",
+    "offer_expires_at": "offerExpiresAt",
+    "hold_id": "holdId",
+    "discount_amount": "discountAmount",
+    "purchase_amount": "purchaseAmount",
+    "disbursement_date": "disbursementDate",
+    "reward_amount": "rewardAmount",
+  });
+});
+
+export function authorizeVendorAuthorizedDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthorizeVendorAuthorizedDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthorizeVendorAuthorizedDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthorizeVendorAuthorizedDto' from JSON`,
+  );
+}

package/src/models/billingcyclesresponsedto.ts

@@ -14,6 +14,7 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
  * The status of the billing cycle.
  */
 export const BillingCyclesResponseDtoStatus = {
+  Scheduled: "SCHEDULED",
   Open: "OPEN",
   Closed: "CLOSED",
 } as const;

package/src/models/businessdataresponsedto.ts

@@ -0,0 +1,94 @@
+/*
+ * 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";
+
+/**
+ * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+ */
+export const BusinessDataResponseDtoStatus = {
+  Active: "active",
+  Inactive: "inactive",
+} as const;
+/**
+ * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+ */
+export type BusinessDataResponseDtoStatus = ClosedEnum<
+  typeof BusinessDataResponseDtoStatus
+>;
+
+export type BusinessDataResponseDto = {
+  /**
+   * Partner-assigned external id (the path key).
+   */
+  externalId: string;
+  /**
+   * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+   */
+  status: BusinessDataResponseDtoStatus;
+  /**
+   * Legal business name.
+   */
+  name?: string | null | undefined;
+  /**
+   * Tax id (e.g. EIN).
+   */
+  taxId?: string | null | undefined;
+  /**
+   * Legal entity type.
+   */
+  businessEntityType?: string | null | undefined;
+  /**
+   * Unix ms when the lender created its record.
+   */
+  createdAt?: number | undefined;
+  /**
+   * Unix ms of the last update.
+   */
+  updatedAt?: number | undefined;
+};
+
+/** @internal */
+export const BusinessDataResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof BusinessDataResponseDtoStatus
+> = z.nativeEnum(BusinessDataResponseDtoStatus);
+
+/** @internal */
+export const BusinessDataResponseDto$inboundSchema: z.ZodType<
+  BusinessDataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  external_id: types.string(),
+  status: BusinessDataResponseDtoStatus$inboundSchema,
+  name: z.nullable(types.string()).optional(),
+  tax_id: z.nullable(types.string()).optional(),
+  business_entity_type: z.nullable(types.string()).optional(),
+  created_at: types.optional(types.number()),
+  updated_at: types.optional(types.number()),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+    "tax_id": "taxId",
+    "business_entity_type": "businessEntityType",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function businessDataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BusinessDataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessDataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessDataResponseDto' from JSON`,
+  );
+}

package/src/models/businessrefdto.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 BusinessRefDto = {
+  /**
+   * Partner-assigned external id — the lender's natural key for the business.
+   */
+  externalId: string;
+};
+
+/** @internal */
+export type BusinessRefDto$Outbound = {
+  external_id: string;
+};
+
+/** @internal */
+export const BusinessRefDto$outboundSchema: z.ZodType<
+  BusinessRefDto$Outbound,
+  z.ZodTypeDef,
+  BusinessRefDto
+> = z.object({
+  externalId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+  });
+});
+
+export function businessRefDtoToJSON(businessRefDto: BusinessRefDto): string {
+  return JSON.stringify(BusinessRefDto$outboundSchema.parse(businessRefDto));
+}

package/src/models/canceloriginationdto.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type CancelOriginationDto = {
+  /**
+   * Reason for the cancellation, stored on the loan record.
+   */
+  reason: string;
+};
+
+/** @internal */
+export type CancelOriginationDto$Outbound = {
+  reason: string;
+};
+
+/** @internal */
+export const CancelOriginationDto$outboundSchema: z.ZodType<
+  CancelOriginationDto$Outbound,
+  z.ZodTypeDef,
+  CancelOriginationDto
+> = z.object({
+  reason: z.string(),
+});
+
+export function cancelOriginationDtoToJSON(
+  cancelOriginationDto: CancelOriginationDto,
+): string {
+  return JSON.stringify(
+    CancelOriginationDto$outboundSchema.parse(cancelOriginationDto),
+  );
+}

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