@oatfi/oatfi-sdk-ts 0.12.3 → 0.12.4

package/src/models/operations/releasehold.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type ReleaseHoldSecurity = {
+  username: string;
+  password: string;
+};
+
+export type ReleaseHoldRequest = {
+  /**
+   * Lender hold id (ipp_hold_id for IPP, lms_hold_id for LMS).
+   */
+  holdId: string;
+  /**
+   * UUID idempotency key (lender dedupes for >= 24h).
+   */
+  idempotencyKey: string;
+  /**
+   * Log-correlation id; new value per attempt.
+   */
+  xNetworkRequestId: string;
+  /**
+   * Format OatFi-Network-Ledger/{semver}.
+   */
+  userAgent: string;
+  /**
+   * Lender role for this call: `buyer` (LMS) or `vendor` (IPP). Validated by NetworkRoleGuard.
+   */
+  xNetworkRole: string;
+  releaseIppHoldRequestDto: models.ReleaseIppHoldRequestDto;
+};
+
+/** @internal */
+export type ReleaseHoldSecurity$Outbound = {
+  username: string;
+  password: string;
+};
+
+/** @internal */
+export const ReleaseHoldSecurity$outboundSchema: z.ZodType<
+  ReleaseHoldSecurity$Outbound,
+  z.ZodTypeDef,
+  ReleaseHoldSecurity
+> = z.object({
+  username: z.string(),
+  password: z.string(),
+});
+
+export function releaseHoldSecurityToJSON(
+  releaseHoldSecurity: ReleaseHoldSecurity,
+): string {
+  return JSON.stringify(
+    ReleaseHoldSecurity$outboundSchema.parse(releaseHoldSecurity),
+  );
+}
+
+/** @internal */
+export type ReleaseHoldRequest$Outbound = {
+  hold_id: string;
+  "Idempotency-Key": string;
+  "X-Network-Request-Id": string;
+  "User-Agent": string;
+  "X-Network-Role": string;
+  ReleaseIppHoldRequestDto: models.ReleaseIppHoldRequestDto$Outbound;
+};
+
+/** @internal */
+export const ReleaseHoldRequest$outboundSchema: z.ZodType<
+  ReleaseHoldRequest$Outbound,
+  z.ZodTypeDef,
+  ReleaseHoldRequest
+> = z.object({
+  holdId: z.string(),
+  idempotencyKey: z.string(),
+  xNetworkRequestId: z.string(),
+  userAgent: z.string(),
+  xNetworkRole: z.string(),
+  releaseIppHoldRequestDto: models.ReleaseIppHoldRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    holdId: "hold_id",
+    idempotencyKey: "Idempotency-Key",
+    xNetworkRequestId: "X-Network-Request-Id",
+    userAgent: "User-Agent",
+    xNetworkRole: "X-Network-Role",
+    releaseIppHoldRequestDto: "ReleaseIppHoldRequestDto",
+  });
+});
+
+export function releaseHoldRequestToJSON(
+  releaseHoldRequest: ReleaseHoldRequest,
+): string {
+  return JSON.stringify(
+    ReleaseHoldRequest$outboundSchema.parse(releaseHoldRequest),
+  );
+}

package/src/models/operations/tradingrelationshipscontrollercreate.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 * as models from "../index.js";
+
+export type TradingRelationshipsControllerCreateRequest = {
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  createTradingRelationshipDto: models.CreateTradingRelationshipDto;
+};
+
+/** @internal */
+export type TradingRelationshipsControllerCreateRequest$Outbound = {
+  "Idempotency-Key": string;
+  CreateTradingRelationshipDto: models.CreateTradingRelationshipDto$Outbound;
+};
+
+/** @internal */
+export const TradingRelationshipsControllerCreateRequest$outboundSchema:
+  z.ZodType<
+    TradingRelationshipsControllerCreateRequest$Outbound,
+    z.ZodTypeDef,
+    TradingRelationshipsControllerCreateRequest
+  > = z.object({
+    idempotencyKey: z.string(),
+    createTradingRelationshipDto:
+      models.CreateTradingRelationshipDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "Idempotency-Key",
+      createTradingRelationshipDto: "CreateTradingRelationshipDto",
+    });
+  });
+
+export function tradingRelationshipsControllerCreateRequestToJSON(
+  tradingRelationshipsControllerCreateRequest:
+    TradingRelationshipsControllerCreateRequest,
+): string {
+  return JSON.stringify(
+    TradingRelationshipsControllerCreateRequest$outboundSchema.parse(
+      tradingRelationshipsControllerCreateRequest,
+    ),
+  );
+}

package/src/models/operations/tradingrelationshipscontrollerfind.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 TradingRelationshipsControllerFindRequest = {
+  /**
+   * The relationship id (the backing payment-method id).
+   */
+  id?: string | undefined;
+  /**
+   * The virtual account number (VAN).
+   */
+  vanAccountNumber?: string | undefined;
+};
+
+/** @internal */
+export type TradingRelationshipsControllerFindRequest$Outbound = {
+  id?: string | undefined;
+  van_account_number?: string | undefined;
+};
+
+/** @internal */
+export const TradingRelationshipsControllerFindRequest$outboundSchema:
+  z.ZodType<
+    TradingRelationshipsControllerFindRequest$Outbound,
+    z.ZodTypeDef,
+    TradingRelationshipsControllerFindRequest
+  > = z.object({
+    id: z.string().optional(),
+    vanAccountNumber: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      vanAccountNumber: "van_account_number",
+    });
+  });
+
+export function tradingRelationshipsControllerFindRequestToJSON(
+  tradingRelationshipsControllerFindRequest:
+    TradingRelationshipsControllerFindRequest,
+): string {
+  return JSON.stringify(
+    TradingRelationshipsControllerFindRequest$outboundSchema.parse(
+      tradingRelationshipsControllerFindRequest,
+    ),
+  );
+}

package/src/models/originationbalanceresponsedto.ts

@@ -9,6 +9,10 @@ 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 {
+  NetworkPurchaseBalanceDto,
+  NetworkPurchaseBalanceDto$inboundSchema,
+} from "./networkpurchasebalancedto.js";
 
 /**
  * Current status of the origination.
@@ -77,6 +81,10 @@ export type OriginationBalanceResponseDto = {
    * Timestamp when the origination was sold.
    */
   saleDate?: number | undefined;
+  /**
+   * Reward details for network program loans. Present only when the loan carries a reward_amount.
+   */
+  networkPurchase?: NetworkPurchaseBalanceDto | undefined;
 };
 
 /** @internal */
@@ -117,6 +125,7 @@ export const OriginationBalanceResponseDto$inboundSchema: z.ZodType<
   status: OriginationBalanceResponseDtoStatus$inboundSchema,
   sale_snapshot: types.optional(z.lazy(() => SaleSnapshot$inboundSchema)),
   sale_date: types.optional(types.number()),
+  network_purchase: types.optional(NetworkPurchaseBalanceDto$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "outstanding_balance": "outstandingBalance",
@@ -126,6 +135,7 @@ export const OriginationBalanceResponseDto$inboundSchema: z.ZodType<
     "interest_balance": "interestBalance",
     "sale_snapshot": "saleSnapshot",
     "sale_date": "saleDate",
+    "network_purchase": "networkPurchase",
   });
 });
 

package/src/models/originationdto.ts

@@ -135,6 +135,10 @@ export type OriginationDto = {
    * Current sub-status of the origination.
    */
   subStatus?: OriginationDtoSubStatus | undefined;
+  /**
+   * Reason the origination was cancelled, if applicable.
+   */
+  cancelReason?: string | undefined;
   /**
    * Dates associated with the origination.
    */
@@ -327,6 +331,7 @@ export const OriginationDto$inboundSchema: z.ZodType<
   payment_intent: types.string(),
   status: OriginationDtoStatus$inboundSchema,
   sub_status: types.optional(OriginationDtoSubStatus$inboundSchema),
+  cancel_reason: types.optional(types.string()),
   dates: types.optional(OriginationDatesDto$inboundSchema),
   current_balance: types.optional(OriginationBalancesDto$inboundSchema),
   paid_balance: types.optional(OriginationBalancesDto$inboundSchema),
@@ -351,6 +356,7 @@ export const OriginationDto$inboundSchema: z.ZodType<
   return remap$(v, {
     "payment_intent": "paymentIntent",
     "sub_status": "subStatus",
+    "cancel_reason": "cancelReason",
     "current_balance": "currentBalance",
     "paid_balance": "paidBalance",
     "number_of_installments": "numberOfInstallments",

package/src/models/patchholdrequestdto.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 PatchHoldRequestDto = {
+  /**
+   * Partner-assigned external id of the ledger entry whose hold is being amended (cross-check against the lender ledger).
+   */
+  ledgerEntryExternalId: string;
+  /**
+   * Partner-assigned external id of the role-relevant counterparty (vendor for IPP, buyer for LMS) so the lender can link the amended hold to its onboarded business.
+   */
+  businessExternalId: string;
+  /**
+   * New outstanding amount in cents after the negative adjustment. Must be lower than the original hold amount.
+   */
+  outstandingAmount: number;
+};
+
+/** @internal */
+export type PatchHoldRequestDto$Outbound = {
+  ledger_entry_external_id: string;
+  business_external_id: string;
+  outstanding_amount: number;
+};
+
+/** @internal */
+export const PatchHoldRequestDto$outboundSchema: z.ZodType<
+  PatchHoldRequestDto$Outbound,
+  z.ZodTypeDef,
+  PatchHoldRequestDto
+> = z.object({
+  ledgerEntryExternalId: z.string(),
+  businessExternalId: z.string(),
+  outstandingAmount: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    ledgerEntryExternalId: "ledger_entry_external_id",
+    businessExternalId: "business_external_id",
+    outstandingAmount: "outstanding_amount",
+  });
+});
+
+export function patchHoldRequestDtoToJSON(
+  patchHoldRequestDto: PatchHoldRequestDto,
+): string {
+  return JSON.stringify(
+    PatchHoldRequestDto$outboundSchema.parse(patchHoldRequestDto),
+  );
+}

package/src/models/paymentintentresponsedto.ts

@@ -44,7 +44,7 @@ export type PaymentIntentResponseDto = {
   /**
    * Identifier of the associated partner (platform in V2).
    */
-  platformId?: string | undefined;
+  platform?: string | undefined;
   /**
    * Type of the payment intent.
    */
@@ -113,7 +113,7 @@ export const PaymentIntentResponseDto$inboundSchema: z.ZodType<
   object: types.string(),
   id: types.string(),
   external_id: types.optional(types.string()),
-  platform_id: types.optional(types.string()),
+  platform: types.optional(types.string()),
   type: types.optional(PaymentIntentResponseDtoType$inboundSchema),
   created_date: types.optional(types.date()),
   due_date: types.optional(types.date()),
@@ -130,7 +130,6 @@ export const PaymentIntentResponseDto$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "external_id": "externalId",
-    "platform_id": "platformId",
     "created_date": "createdDate",
     "due_date": "dueDate",
     "paid_on_date": "paidOnDate",

package/src/models/purchaseexecutionrequestdto.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";
+
+export type PurchaseExecutionRequestDto = {
+  /**
+   * lms_program_id.
+   */
+  programId: string;
+  originalAmount: number;
+  discountAmount: number;
+  /**
+   * original_amount - discount_amount.
+   */
+  purchaseAmount: number;
+  /**
+   * Disbursement date (YYYY-MM-DD).
+   */
+  disbursementDate: string;
+  rewardAmount: number;
+  /**
+   * LMS's offer id.
+   */
+  lmsOfferId: string;
+  /**
+   * IPP's offer id (audit trail).
+   */
+  ippOfferId: string;
+};
+
+/** @internal */
+export type PurchaseExecutionRequestDto$Outbound = {
+  program_id: string;
+  original_amount: number;
+  discount_amount: number;
+  purchase_amount: number;
+  disbursement_date: string;
+  reward_amount: number;
+  lms_offer_id: string;
+  ipp_offer_id: string;
+};
+
+/** @internal */
+export const PurchaseExecutionRequestDto$outboundSchema: z.ZodType<
+  PurchaseExecutionRequestDto$Outbound,
+  z.ZodTypeDef,
+  PurchaseExecutionRequestDto
+> = z.object({
+  programId: z.string(),
+  originalAmount: z.number(),
+  discountAmount: z.number(),
+  purchaseAmount: z.number(),
+  disbursementDate: z.string(),
+  rewardAmount: z.number(),
+  lmsOfferId: z.string(),
+  ippOfferId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    programId: "program_id",
+    originalAmount: "original_amount",
+    discountAmount: "discount_amount",
+    purchaseAmount: "purchase_amount",
+    disbursementDate: "disbursement_date",
+    rewardAmount: "reward_amount",
+    lmsOfferId: "lms_offer_id",
+    ippOfferId: "ipp_offer_id",
+  });
+});
+
+export function purchaseExecutionRequestDtoToJSON(
+  purchaseExecutionRequestDto: PurchaseExecutionRequestDto,
+): string {
+  return JSON.stringify(
+    PurchaseExecutionRequestDto$outboundSchema.parse(
+      purchaseExecutionRequestDto,
+    ),
+  );
+}

package/src/models/recordadjustmentrequestdto.ts

@@ -0,0 +1,105 @@
+/*
+ * 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";
+
+/**
+ * Adjustment classification. Mirrors the partner-side CreateAdjustmentDto.type enum.
+ */
+export const RecordAdjustmentRequestDtoType = {
+  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;
+/**
+ * Adjustment classification. Mirrors the partner-side CreateAdjustmentDto.type enum.
+ */
+export type RecordAdjustmentRequestDtoType = ClosedEnum<
+  typeof RecordAdjustmentRequestDtoType
+>;
+
+export type RecordAdjustmentRequestDto = {
+  /**
+   * Network's UUID for the adjustment record (lender SHOULD persist for cross-reference/dedup).
+   */
+  adjustmentId: string;
+  /**
+   * Partner-assigned external id of the role-relevant counterparty (vendor for IPP, buyer for LMS) so the lender can link the adjustment to its onboarded business.
+   */
+  businessExternalId: string;
+  /**
+   * Signed adjustment amount in cents. Positive grows outstanding_amount, negative shrinks it. Never zero.
+   */
+  amount: number;
+  /**
+   * Adjustment classification. Mirrors the partner-side CreateAdjustmentDto.type enum.
+   */
+  type: RecordAdjustmentRequestDtoType;
+  /**
+   * Optional free-text description provided by the partner at adjustment creation.
+   */
+  description?: string | undefined;
+  /**
+   * New outstanding_amount on the ledger entry after this adjustment is applied (lender cross-check).
+   */
+  outstandingAmount: number;
+  /**
+   * Optional free-form metadata.
+   */
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const RecordAdjustmentRequestDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof RecordAdjustmentRequestDtoType
+> = z.nativeEnum(RecordAdjustmentRequestDtoType);
+
+/** @internal */
+export type RecordAdjustmentRequestDto$Outbound = {
+  adjustment_id: string;
+  business_external_id: string;
+  amount: number;
+  type: string;
+  description?: string | undefined;
+  outstanding_amount: number;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const RecordAdjustmentRequestDto$outboundSchema: z.ZodType<
+  RecordAdjustmentRequestDto$Outbound,
+  z.ZodTypeDef,
+  RecordAdjustmentRequestDto
+> = z.object({
+  adjustmentId: z.string(),
+  businessExternalId: z.string(),
+  amount: z.number(),
+  type: RecordAdjustmentRequestDtoType$outboundSchema,
+  description: z.string().optional(),
+  outstandingAmount: z.number(),
+  metadata: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    adjustmentId: "adjustment_id",
+    businessExternalId: "business_external_id",
+    outstandingAmount: "outstanding_amount",
+  });
+});
+
+export function recordAdjustmentRequestDtoToJSON(
+  recordAdjustmentRequestDto: RecordAdjustmentRequestDto,
+): string {
+  return JSON.stringify(
+    RecordAdjustmentRequestDto$outboundSchema.parse(recordAdjustmentRequestDto),
+  );
+}

package/src/models/releaseippholdrequestdto.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 ReleaseIppHoldRequestDto = {
+  /**
+   * Partner-assigned external id of the ledger entry whose hold should be released (cross-check against the lender record).
+   */
+  ledgerEntryExternalId: string;
+  /**
+   * Partner-assigned external id of the role-relevant counterparty (vendor for IPP, buyer for LMS) so the lender can link the released hold to its onboarded business.
+   */
+  businessExternalId: string;
+};
+
+/** @internal */
+export type ReleaseIppHoldRequestDto$Outbound = {
+  ledger_entry_external_id: string;
+  business_external_id: string;
+};
+
+/** @internal */
+export const ReleaseIppHoldRequestDto$outboundSchema: z.ZodType<
+  ReleaseIppHoldRequestDto$Outbound,
+  z.ZodTypeDef,
+  ReleaseIppHoldRequestDto
+> = z.object({
+  ledgerEntryExternalId: z.string(),
+  businessExternalId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    ledgerEntryExternalId: "ledger_entry_external_id",
+    businessExternalId: "business_external_id",
+  });
+});
+
+export function releaseIppHoldRequestDtoToJSON(
+  releaseIppHoldRequestDto: ReleaseIppHoldRequestDto,
+): string {
+  return JSON.stringify(
+    ReleaseIppHoldRequestDto$outboundSchema.parse(releaseIppHoldRequestDto),
+  );
+}

package/src/models/startunderwritingdto.ts

@@ -4,6 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import {
+  UnderwritingDataSource,
+  UnderwritingDataSource$outboundSchema,
+} from "./underwritingdatasource.js";
 
 export type StartUnderwritingDto = {
   /**
@@ -14,12 +18,17 @@ export type StartUnderwritingDto = {
    * Optional source identifier for the underwriting request
    */
   source?: string | undefined;
+  /**
+   * Optional override for the underwriting data source. When omitted, the default routing is used.
+   */
+  dataSource?: UnderwritingDataSource | undefined;
 };
 
 /** @internal */
 export type StartUnderwritingDto$Outbound = {
   program_id: string;
   source?: string | undefined;
+  data_source?: string | undefined;
 };
 
 /** @internal */
@@ -30,9 +39,11 @@ export const StartUnderwritingDto$outboundSchema: z.ZodType<
 > = z.object({
   programId: z.string(),
   source: z.string().optional(),
+  dataSource: UnderwritingDataSource$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     programId: "program_id",
+    dataSource: "data_source",
   });
 });
 

package/src/models/tradingrelationshiplistresponsedto.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 {
+  TradingRelationshipResponseDto,
+  TradingRelationshipResponseDto$inboundSchema,
+} from "./tradingrelationshipresponsedto.js";
+
+export type TradingRelationshipListResponseDto = {
+  /**
+   * Type of the response
+   */
+  object: string;
+  /**
+   * Array of items
+   */
+  data: Array<TradingRelationshipResponseDto>;
+  /**
+   * Whether there are more items to fetch
+   */
+  hasMore: boolean;
+  /**
+   * Total number of items
+   */
+  total: number;
+};
+
+/** @internal */
+export const TradingRelationshipListResponseDto$inboundSchema: z.ZodType<
+  TradingRelationshipListResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string().default("list"),
+  data: z.array(TradingRelationshipResponseDto$inboundSchema),
+  has_more: types.boolean(),
+  total: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function tradingRelationshipListResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TradingRelationshipListResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TradingRelationshipListResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradingRelationshipListResponseDto' from JSON`,
+  );
+}