@oatfi/oatfi-sdk-ts 0.12.6 → 0.12.7

package/src/models/businesscheckunderwritingdto.ts

@@ -0,0 +1,87 @@
+/*
+ * 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";
+
+/**
+ * The current underwriting status for the business under the program.
+ */
+export const BusinessCheckUnderwritingDtoStatus = {
+  Approved: "APPROVED",
+  ManualReview: "MANUAL_REVIEW",
+  ClosedNoDecision: "CLOSED_NO_DECISION",
+  ManualReviewDeclined: "MANUAL_REVIEW_DECLINED",
+  Rejected: "REJECTED",
+  Declined: "DECLINED",
+  Processing: "PROCESSING",
+  Error: "ERROR",
+  NotExecuted: "NOT_EXECUTED",
+  NA: "N/A",
+  Denied: "DENIED",
+} as const;
+/**
+ * The current underwriting status for the business under the program.
+ */
+export type BusinessCheckUnderwritingDtoStatus = ClosedEnum<
+  typeof BusinessCheckUnderwritingDtoStatus
+>;
+
+export type BusinessCheckUnderwritingDto = {
+  object: string;
+  /**
+   * The current underwriting status for the business under the program.
+   */
+  status: BusinessCheckUnderwritingDtoStatus;
+  /**
+   * Credit limit amount (only present when status is approved).
+   */
+  creditLimit?: number | undefined;
+  /**
+   * Adverse actions (only present for declined status).
+   */
+  adverseAction?: Array<any> | undefined;
+  /**
+   * Additional message from the underwriting process.
+   */
+  message?: string | undefined;
+};
+
+/** @internal */
+export const BusinessCheckUnderwritingDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof BusinessCheckUnderwritingDtoStatus
+> = z.nativeEnum(BusinessCheckUnderwritingDtoStatus);
+
+/** @internal */
+export const BusinessCheckUnderwritingDto$inboundSchema: z.ZodType<
+  BusinessCheckUnderwritingDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string().default("underwriting_status"),
+  status: BusinessCheckUnderwritingDtoStatus$inboundSchema,
+  credit_limit: types.optional(types.number()),
+  adverse_action: types.optional(z.array(z.any())),
+  message: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "credit_limit": "creditLimit",
+    "adverse_action": "adverseAction",
+  });
+});
+
+export function businessCheckUnderwritingDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BusinessCheckUnderwritingDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessCheckUnderwritingDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessCheckUnderwritingDto' from JSON`,
+  );
+}

package/src/models/businessrefdto.ts

@@ -11,15 +11,15 @@ export type BusinessRefDto = {
    */
   externalId: string;
   /**
-   * The program's external_program_id (string, not the Network's internal UUID). Role-scoped: the LMS program external id in a buyer block, the IPP program external id in a vendor block.
+   * The program's id — OatFi's LmsLoanProgram Mongo _id (ObjectId string); the Network sends it as external_program_id, i.e. not the Network's own internal UUID. Role-scoped: the LMS program in a buyer block, the IPP program in a vendor block.
    */
-  programId: string;
+  programExternalId: string;
 };
 
 /** @internal */
 export type BusinessRefDto$Outbound = {
   external_id: string;
-  program_id: string;
+  program_external_id: string;
 };
 
 /** @internal */
@@ -29,11 +29,11 @@ export const BusinessRefDto$outboundSchema: z.ZodType<
   BusinessRefDto
 > = z.object({
   externalId: z.string(),
-  programId: z.string(),
+  programExternalId: z.string(),
 }).transform((v) => {
   return remap$(v, {
     externalId: "external_id",
-    programId: "program_id",
+    programExternalId: "program_external_id",
   });
 });
 

package/src/models/cancelpurchasedto.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type CancelPurchaseDto = {
+  /**
+   * Reason recorded when canceling the purchase.
+   */
+  reason: string;
+};
+
+/** @internal */
+export type CancelPurchaseDto$Outbound = {
+  reason: string;
+};
+
+/** @internal */
+export const CancelPurchaseDto$outboundSchema: z.ZodType<
+  CancelPurchaseDto$Outbound,
+  z.ZodTypeDef,
+  CancelPurchaseDto
+> = z.object({
+  reason: z.string(),
+});
+
+export function cancelPurchaseDtoToJSON(
+  cancelPurchaseDto: CancelPurchaseDto,
+): string {
+  return JSON.stringify(
+    CancelPurchaseDto$outboundSchema.parse(cancelPurchaseDto),
+  );
+}

package/src/models/cancelrequestdto.ts

@@ -19,9 +19,9 @@ 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.
+   * lms_program_id (OatFi program id, Mongo ObjectId) — the buyer's active LMS program (cancel is buyer-role / LMS-only). Supports multi-program routing on the LMS side.
    */
-  programId: string;
+  programExternalId: string;
   /**
    * The buyer's partner-assigned external id — lets the LMS link the cancellation to its onboarded business record.
    */
@@ -43,7 +43,7 @@ export const CancelRequestDtoReason$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type CancelRequestDto$Outbound = {
-  program_id: string;
+  program_external_id: string;
   business_external_id: string;
   reason: string;
   cancelled_at: number;
@@ -55,13 +55,13 @@ export const CancelRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CancelRequestDto
 > = z.object({
-  programId: z.string(),
+  programExternalId: z.string(),
   businessExternalId: z.string(),
   reason: CancelRequestDtoReason$outboundSchema,
   cancelledAt: z.number(),
 }).transform((v) => {
   return remap$(v, {
-    programId: "program_id",
+    programExternalId: "program_external_id",
     businessExternalId: "business_external_id",
     cancelledAt: "cancelled_at",
   });

package/src/models/checkbusinessdto.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 CheckBusinessDto = {
+  /**
+   * Tax identification number (e.g., EIN). Must be exactly 9 numeric characters.
+   */
+  taxId: string;
+  /**
+   * Contact email to match against the business's primary user. Compared case-insensitively.
+   */
+  contactEmail: string;
+  /**
+   * The loan program to scope the acceptance and underwriting status to.
+   */
+  program: string;
+};
+
+/** @internal */
+export type CheckBusinessDto$Outbound = {
+  tax_id: string;
+  contact_email: string;
+  program: string;
+};
+
+/** @internal */
+export const CheckBusinessDto$outboundSchema: z.ZodType<
+  CheckBusinessDto$Outbound,
+  z.ZodTypeDef,
+  CheckBusinessDto
+> = z.object({
+  taxId: z.string(),
+  contactEmail: z.string(),
+  program: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    taxId: "tax_id",
+    contactEmail: "contact_email",
+  });
+});
+
+export function checkBusinessDtoToJSON(
+  checkBusinessDto: CheckBusinessDto,
+): string {
+  return JSON.stringify(
+    CheckBusinessDto$outboundSchema.parse(checkBusinessDto),
+  );
+}

package/src/models/checkbusinessresponsedto.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  BusinessCheckUnderwritingDto,
+  BusinessCheckUnderwritingDto$inboundSchema,
+} from "./businesscheckunderwritingdto.js";
+import {
+  BusinessResponseDto,
+  BusinessResponseDto$inboundSchema,
+} from "./businessresponsedto.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Onboarding-terms acceptance status for the program. Omitted when `valid` is false.
+ */
+export const Signed = {
+  Accepted: "ACCEPTED",
+  Pending: "PENDING",
+  NotAccepted: "NOT_ACCEPTED",
+} as const;
+/**
+ * Onboarding-terms acceptance status for the program. Omitted when `valid` is false.
+ */
+export type Signed = ClosedEnum<typeof Signed>;
+
+export type CheckBusinessResponseDto = {
+  object: string;
+  /**
+   * Whether a business matching both tax_id and contact_email was found for the authenticated partner.
+   */
+  valid: boolean;
+  /**
+   * The matched business. Omitted when `valid` is false.
+   */
+  business?: BusinessResponseDto | undefined;
+  /**
+   * Onboarding-terms acceptance status for the program. Omitted when `valid` is false.
+   */
+  signed?: Signed | undefined;
+  /**
+   * Underwriting snapshot for the program. Omitted when `valid` is false or the business has no underwriting record for the program.
+   */
+  underwriting?: BusinessCheckUnderwritingDto | undefined;
+};
+
+/** @internal */
+export const Signed$inboundSchema: z.ZodNativeEnum<typeof Signed> = z
+  .nativeEnum(Signed);
+
+/** @internal */
+export const CheckBusinessResponseDto$inboundSchema: z.ZodType<
+  CheckBusinessResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string().default("business_check"),
+  valid: types.boolean(),
+  business: types.optional(BusinessResponseDto$inboundSchema),
+  signed: types.optional(Signed$inboundSchema),
+  underwriting: types.optional(BusinessCheckUnderwritingDto$inboundSchema),
+});
+
+export function checkBusinessResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckBusinessResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CheckBusinessResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckBusinessResponseDto' from JSON`,
+  );
+}

package/src/models/createpurchaseofferdto.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 {
+  PreferredDisbursementTime,
+  PreferredDisbursementTime$outboundSchema,
+} from "./preferreddisbursementtime.js";
+
+export type CreatePurchaseOfferDto = {
+  /**
+   * Identifier of the payment intent being offered for purchase.
+   */
+  paymentIntent: string;
+  /**
+   * Identifier of the supplier (payee) for the purchase offer.
+   */
+  supplier: string;
+  /**
+   * Identifier of the loan program (IPP) the supplier is enrolled in.
+   */
+  program: string;
+  /**
+   * Preferred disbursement time. Acts as the fee-range alias selector on the program configuration. If omitted, resolves from the business enrollment, then the program default.
+   */
+  preferredDisbursementTime?: PreferredDisbursementTime | undefined;
+};
+
+/** @internal */
+export type CreatePurchaseOfferDto$Outbound = {
+  payment_intent: string;
+  supplier: string;
+  program: string;
+  preferred_disbursement_time?: string | undefined;
+};
+
+/** @internal */
+export const CreatePurchaseOfferDto$outboundSchema: z.ZodType<
+  CreatePurchaseOfferDto$Outbound,
+  z.ZodTypeDef,
+  CreatePurchaseOfferDto
+> = z.object({
+  paymentIntent: z.string(),
+  supplier: z.string(),
+  program: z.string(),
+  preferredDisbursementTime: PreferredDisbursementTime$outboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    paymentIntent: "payment_intent",
+    preferredDisbursementTime: "preferred_disbursement_time",
+  });
+});
+
+export function createPurchaseOfferDtoToJSON(
+  createPurchaseOfferDto: CreatePurchaseOfferDto,
+): string {
+  return JSON.stringify(
+    CreatePurchaseOfferDto$outboundSchema.parse(createPurchaseOfferDto),
+  );
+}

package/src/models/index.ts

@@ -34,6 +34,7 @@ export * from "./brandingresponsedto.js";
 export * from "./bulkcreatebusinessrequestdto.js";
 export * from "./businessbalancedto.js";
 export * from "./businessbalancesummarydto.js";
+export * from "./businesscheckunderwritingdto.js";
 export * from "./businessdataresponsedto.js";
 export * from "./businessinformationdto.js";
 export * from "./businesslistresponsedto.js";
@@ -45,8 +46,11 @@ export * from "./businessresponsedto.js";
 export * from "./cancelledtransactiondto.js";
 export * from "./canceloriginationdto.js";
 export * from "./canceloriginationresponsedto.js";
+export * from "./cancelpurchasedto.js";
 export * from "./cancelrequestdto.js";
 export * from "./changepassworddto.js";
+export * from "./checkbusinessdto.js";
+export * from "./checkbusinessresponsedto.js";
 export * from "./companynamecandidatedto.js";
 export * from "./confirmedenvelopedto.js";
 export * from "./consentsdto.js";
@@ -74,6 +78,7 @@ export * from "./createportfoliodto.js";
 export * from "./createprogrambillingcycledto.js";
 export * from "./createprogramdto.js";
 export * from "./createprogramsettingdto.js";
+export * from "./createpurchaseofferdto.js";
 export * from "./createsupplementaldatadto.js";
 export * from "./createtradingrelationshipdto.js";
 export * from "./createtransactionsdto.js";
@@ -181,6 +186,7 @@ export * from "./platformresponsedto.js";
 export * from "./platformsettingsdto.js";
 export * from "./pooledardto.js";
 export * from "./pooledarresponsedto.js";
+export * from "./preferreddisbursementtime.js";
 export * from "./productbalancesummarydto.js";
 export * from "./producttype.js";
 export * from "./programbillingcycleresponsedto.js";
@@ -190,8 +196,18 @@ export * from "./programsettingdto.js";
 export * from "./programsettingsfeerangedto.js";
 export * from "./programsettingsresponsedto.js";
 export * from "./programunderwritingsettingsdto.js";
+export * from "./purchasecancelresponsedto.js";
 export * from "./purchaseexecutionrequestdto.js";
+export * from "./purchasefeebreakdowndto.js";
 export * from "./purchasenotconfirmeddto.js";
+export * from "./purchaseofferresponsedto.js";
+export * from "./purchaseofferstatus.js";
+export * from "./purchaseresponsedto.js";
+export * from "./purchaseretryresponsedto.js";
+export * from "./purchasereversalreason.js";
+export * from "./purchasereverseresponsedto.js";
+export * from "./purchasestatus.js";
+export * from "./purchaseupdatereason.js";
 export * from "./refreshtokendto.js";
 export * from "./regenerateapikeydto.js";
 export * from "./releaseippholdrequestdto.js";
@@ -199,6 +215,8 @@ export * from "./repaymentallocation.js";
 export * from "./repaymentbreakdowndto.js";
 export * from "./resetpassworddto.js";
 export * from "./restrictedactivitiesdto.js";
+export * from "./retrypurchasedto.js";
+export * from "./reversepurchasedto.js";
 export * from "./rotateapikeydto.js";
 export * from "./security.js";
 export * from "./simulationoutstandingbalancedto.js";
@@ -250,6 +268,7 @@ export * from "./updateplatformscopesdto.js";
 export * from "./updateprogrambillingcycledto.js";
 export * from "./updateprogramdto.js";
 export * from "./updateprogramsettingdto.js";
+export * from "./updatepurchasedto.js";
 export * from "./updatetransactiondto.js";
 export * from "./uploadfilesdto.js";
 export * from "./uploadfilesmultipartdto.js";

package/src/models/operations/index.ts

@@ -174,6 +174,13 @@ export * from "./programsettingscontrollerfindall.js";
 export * from "./programsettingscontrollerfindone.js";
 export * from "./programsettingscontrollerremove.js";
 export * from "./programsettingscontrollerupdate.js";
+export * from "./purchasescontrolleracceptoffer.js";
+export * from "./purchasescontrollercancel.js";
+export * from "./purchasescontrollercreateoffer.js";
+export * from "./purchasescontrollerfindone.js";
+export * from "./purchasescontrollerretry.js";
+export * from "./purchasescontrollerreverse.js";
+export * from "./purchasescontrollerupdate.js";
 export * from "./releasehold.js";
 export * from "./statedisclosurescontrollergetstatedisclosure.js";
 export * from "./tradingrelationshipscontrollercreate.js";

package/src/models/operations/purchasescontrolleracceptoffer.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 PurchasesControllerAcceptOfferRequest = {
+  /**
+   * Purchase offer id to accept
+   */
+  offerId: string;
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+};
+
+/** @internal */
+export type PurchasesControllerAcceptOfferRequest$Outbound = {
+  offerId: string;
+  "Idempotency-Key": string;
+};
+
+/** @internal */
+export const PurchasesControllerAcceptOfferRequest$outboundSchema: z.ZodType<
+  PurchasesControllerAcceptOfferRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerAcceptOfferRequest
+> = z.object({
+  offerId: z.string(),
+  idempotencyKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+  });
+});
+
+export function purchasesControllerAcceptOfferRequestToJSON(
+  purchasesControllerAcceptOfferRequest: PurchasesControllerAcceptOfferRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerAcceptOfferRequest$outboundSchema.parse(
+      purchasesControllerAcceptOfferRequest,
+    ),
+  );
+}

package/src/models/operations/purchasescontrollercancel.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 PurchasesControllerCancelRequest = {
+  /**
+   * The ID of the purchase to cancel
+   */
+  purchaseId: string;
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  /**
+   * Purchase cancellation data
+   */
+  cancelPurchaseDto: models.CancelPurchaseDto;
+};
+
+/** @internal */
+export type PurchasesControllerCancelRequest$Outbound = {
+  purchaseId: string;
+  "Idempotency-Key": string;
+  CancelPurchaseDto: models.CancelPurchaseDto$Outbound;
+};
+
+/** @internal */
+export const PurchasesControllerCancelRequest$outboundSchema: z.ZodType<
+  PurchasesControllerCancelRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerCancelRequest
+> = z.object({
+  purchaseId: z.string(),
+  idempotencyKey: z.string(),
+  cancelPurchaseDto: models.CancelPurchaseDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+    cancelPurchaseDto: "CancelPurchaseDto",
+  });
+});
+
+export function purchasesControllerCancelRequestToJSON(
+  purchasesControllerCancelRequest: PurchasesControllerCancelRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerCancelRequest$outboundSchema.parse(
+      purchasesControllerCancelRequest,
+    ),
+  );
+}

package/src/models/operations/purchasescontrollercreateoffer.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 PurchasesControllerCreateOfferRequest = {
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  /**
+   * Purchase offer creation data
+   */
+  createPurchaseOfferDto: models.CreatePurchaseOfferDto;
+};
+
+/** @internal */
+export type PurchasesControllerCreateOfferRequest$Outbound = {
+  "Idempotency-Key": string;
+  CreatePurchaseOfferDto: models.CreatePurchaseOfferDto$Outbound;
+};
+
+/** @internal */
+export const PurchasesControllerCreateOfferRequest$outboundSchema: z.ZodType<
+  PurchasesControllerCreateOfferRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerCreateOfferRequest
+> = z.object({
+  idempotencyKey: z.string(),
+  createPurchaseOfferDto: models.CreatePurchaseOfferDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+    createPurchaseOfferDto: "CreatePurchaseOfferDto",
+  });
+});
+
+export function purchasesControllerCreateOfferRequestToJSON(
+  purchasesControllerCreateOfferRequest: PurchasesControllerCreateOfferRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerCreateOfferRequest$outboundSchema.parse(
+      purchasesControllerCreateOfferRequest,
+    ),
+  );
+}

package/src/models/operations/purchasescontrollerfindone.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PurchasesControllerFindOneRequest = {
+  /**
+   * The ID of the purchase to retrieve
+   */
+  id: string;
+};
+
+/** @internal */
+export type PurchasesControllerFindOneRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const PurchasesControllerFindOneRequest$outboundSchema: z.ZodType<
+  PurchasesControllerFindOneRequest$Outbound,
+  z.ZodTypeDef,
+  PurchasesControllerFindOneRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function purchasesControllerFindOneRequestToJSON(
+  purchasesControllerFindOneRequest: PurchasesControllerFindOneRequest,
+): string {
+  return JSON.stringify(
+    PurchasesControllerFindOneRequest$outboundSchema.parse(
+      purchasesControllerFindOneRequest,
+    ),
+  );
+}