@oatfi/oatfi-sdk-ts 0.12.6 → 0.12.7

package/src/models/purchaseresponsedto.ts

@@ -0,0 +1,170 @@
+/*
+ * 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 {
+  PreferredDisbursementTime,
+  PreferredDisbursementTime$inboundSchema,
+} from "./preferreddisbursementtime.js";
+import {
+  PurchaseFeeBreakdownDto,
+  PurchaseFeeBreakdownDto$inboundSchema,
+} from "./purchasefeebreakdowndto.js";
+import {
+  PurchaseReversalReason,
+  PurchaseReversalReason$inboundSchema,
+} from "./purchasereversalreason.js";
+import {
+  PurchaseStatus,
+  PurchaseStatus$inboundSchema,
+} from "./purchasestatus.js";
+
+export type PurchaseResponseDto = {
+  /**
+   * Unique purchase identifier.
+   */
+  id: string;
+  /**
+   * String identifier of the object.
+   */
+  object: string;
+  status: PurchaseStatus;
+  /**
+   * Identifier of the payment intent being purchased.
+   */
+  paymentIntent: string;
+  /**
+   * Payment intent amount in cents.
+   */
+  paymentIntentAmount: number;
+  /**
+   * Invoice due date (ISO 8601).
+   */
+  paymentIntentDueDate: string;
+  /**
+   * Purchase amount in cents.
+   */
+  purchaseAmount: number;
+  /**
+   * Resolved preferred disbursement time (fee-range alias selector on the program configuration).
+   */
+  preferredDisbursementTime: PreferredDisbursementTime;
+  /**
+   * Resolved disbursement date (ISO 8601).
+   */
+  disbursementDate: string;
+  /**
+   * Effective disbursement date (disbursement_date + disbursement_timing_days), ISO 8601.
+   */
+  effectiveDisbursementDate: string;
+  /**
+   * Supplier identifier.
+   */
+  supplier: string;
+  /**
+   * Loan program identifier.
+   */
+  program: string;
+  feeBreakdown: PurchaseFeeBreakdownDto;
+  /**
+   * Sum of all fees, excluding reward_amount, in cents.
+   */
+  discountAmount: number;
+  /**
+   * Buyer reward amount in cents.
+   */
+  rewardAmount: number;
+  /**
+   * Identifier of the hold released at purchase creation.
+   */
+  hold?: string | undefined;
+  /**
+   * Underlying rail transfer identifier. Populated after execution (PROCESSING/COMPLETED).
+   */
+  transferId?: string | undefined;
+  /**
+   * Reason recorded at reversal time.
+   */
+  reversalReason?: PurchaseReversalReason | undefined;
+  /**
+   * Reversal timestamp (ISO 8601).
+   */
+  reversalDate?: string | undefined;
+  /**
+   * Reason recorded at cancel time.
+   */
+  cancellationReason?: string | undefined;
+  /**
+   * Cancellation timestamp (ISO 8601).
+   */
+  cancellationDate?: string | undefined;
+  /**
+   * Completion timestamp (ISO 8601).
+   */
+  completionDate?: string | undefined;
+};
+
+/** @internal */
+export const PurchaseResponseDto$inboundSchema: z.ZodType<
+  PurchaseResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  status: PurchaseStatus$inboundSchema,
+  payment_intent: types.string(),
+  payment_intent_amount: types.number(),
+  payment_intent_due_date: types.string(),
+  purchase_amount: types.number(),
+  preferred_disbursement_time: PreferredDisbursementTime$inboundSchema,
+  disbursement_date: types.string(),
+  effective_disbursement_date: types.string(),
+  supplier: types.string(),
+  program: types.string(),
+  fee_breakdown: PurchaseFeeBreakdownDto$inboundSchema,
+  discount_amount: types.number(),
+  reward_amount: types.number(),
+  hold: types.optional(types.string()),
+  transfer_id: types.optional(types.string()),
+  reversal_reason: types.optional(PurchaseReversalReason$inboundSchema),
+  reversal_date: types.optional(types.string()),
+  cancellation_reason: types.optional(types.string()),
+  cancellation_date: types.optional(types.string()),
+  completion_date: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "payment_intent": "paymentIntent",
+    "payment_intent_amount": "paymentIntentAmount",
+    "payment_intent_due_date": "paymentIntentDueDate",
+    "purchase_amount": "purchaseAmount",
+    "preferred_disbursement_time": "preferredDisbursementTime",
+    "disbursement_date": "disbursementDate",
+    "effective_disbursement_date": "effectiveDisbursementDate",
+    "fee_breakdown": "feeBreakdown",
+    "discount_amount": "discountAmount",
+    "reward_amount": "rewardAmount",
+    "transfer_id": "transferId",
+    "reversal_reason": "reversalReason",
+    "reversal_date": "reversalDate",
+    "cancellation_reason": "cancellationReason",
+    "cancellation_date": "cancellationDate",
+    "completion_date": "completionDate",
+  });
+});
+
+export function purchaseResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseResponseDto' from JSON`,
+  );
+}

package/src/models/purchaseretryresponsedto.ts

@@ -0,0 +1,59 @@
+/*
+ * 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 {
+  PurchaseStatus,
+  PurchaseStatus$inboundSchema,
+} from "./purchasestatus.js";
+
+export type PurchaseRetryResponseDto = {
+  /**
+   * Unique purchase identifier.
+   */
+  id: string;
+  /**
+   * String identifier of the object.
+   */
+  object: string;
+  /**
+   * Purchase status after the retry — reset to SCHEDULED so it is re-queued for execution.
+   */
+  status: PurchaseStatus;
+  /**
+   * Underlying rail transfer identifier. Populated after re-execution (PROCESSING/COMPLETED).
+   */
+  transferId?: string | undefined;
+};
+
+/** @internal */
+export const PurchaseRetryResponseDto$inboundSchema: z.ZodType<
+  PurchaseRetryResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  status: PurchaseStatus$inboundSchema,
+  transfer_id: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "transfer_id": "transferId",
+  });
+});
+
+export function purchaseRetryResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseRetryResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseRetryResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseRetryResponseDto' from JSON`,
+  );
+}

package/src/models/purchasereversalreason.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Reason recorded at reversal time.
+ */
+export const PurchaseReversalReason = {
+  DuplicateEntry: "DUPLICATE_ENTRY",
+  IncorrectReceiver: "INCORRECT_RECEIVER",
+  IncorrectDollarAmount: "INCORRECT_DOLLAR_AMOUNT",
+  CreditsSentLaterThanIntended: "CREDITS_SENT_LATER_THAN_INTENDED",
+} as const;
+/**
+ * Reason recorded at reversal time.
+ */
+export type PurchaseReversalReason = ClosedEnum<typeof PurchaseReversalReason>;
+
+/** @internal */
+export const PurchaseReversalReason$inboundSchema: z.ZodNativeEnum<
+  typeof PurchaseReversalReason
+> = z.nativeEnum(PurchaseReversalReason);

package/src/models/purchasereverseresponsedto.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 {
+  PurchaseReversalReason,
+  PurchaseReversalReason$inboundSchema,
+} from "./purchasereversalreason.js";
+import {
+  PurchaseStatus,
+  PurchaseStatus$inboundSchema,
+} from "./purchasestatus.js";
+
+export type PurchaseReverseResponseDto = {
+  /**
+   * Unique purchase identifier.
+   */
+  id: string;
+  /**
+   * String identifier of the object.
+   */
+  object: string;
+  status: PurchaseStatus;
+  /**
+   * Reason recorded at reversal time.
+   */
+  reversalReason?: PurchaseReversalReason | undefined;
+};
+
+/** @internal */
+export const PurchaseReverseResponseDto$inboundSchema: z.ZodType<
+  PurchaseReverseResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  status: PurchaseStatus$inboundSchema,
+  reversal_reason: types.optional(PurchaseReversalReason$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "reversal_reason": "reversalReason",
+  });
+});
+
+export function purchaseReverseResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseReverseResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseReverseResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseReverseResponseDto' from JSON`,
+  );
+}

package/src/models/purchasestatus.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const PurchaseStatus = {
+  Scheduled: "SCHEDULED",
+  Processing: "PROCESSING",
+  Completed: "COMPLETED",
+  Failed: "FAILED",
+  Canceled: "CANCELED",
+  Reversed: "REVERSED",
+} as const;
+export type PurchaseStatus = ClosedEnum<typeof PurchaseStatus>;
+
+/** @internal */
+export const PurchaseStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PurchaseStatus
+> = z.nativeEnum(PurchaseStatus);

package/src/models/purchaseupdatereason.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Reason for the update — recorded on the purchase_histories snapshot.
+ */
+export const PurchaseUpdateReason = {
+  TimeUpdate: "TIME_UPDATE",
+  AmountIncrease: "AMOUNT_INCREASE",
+  AmountDecrease: "AMOUNT_DECREASE",
+  Other: "OTHER",
+} as const;
+/**
+ * Reason for the update — recorded on the purchase_histories snapshot.
+ */
+export type PurchaseUpdateReason = ClosedEnum<typeof PurchaseUpdateReason>;
+
+/** @internal */
+export const PurchaseUpdateReason$outboundSchema: z.ZodNativeEnum<
+  typeof PurchaseUpdateReason
+> = z.nativeEnum(PurchaseUpdateReason);

package/src/models/retrypurchasedto.ts

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

package/src/models/reversepurchasedto.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * NACHA-permitted reversal reason. One of the four categories applicable to buyer-side invoice purchases. Forwarded to SVB on the reversal call.
+ */
+export const ReversePurchaseDtoReason = {
+  DuplicateEntry: "DUPLICATE_ENTRY",
+  IncorrectReceiver: "INCORRECT_RECEIVER",
+  IncorrectDollarAmount: "INCORRECT_DOLLAR_AMOUNT",
+  CreditsSentLaterThanIntended: "CREDITS_SENT_LATER_THAN_INTENDED",
+} as const;
+/**
+ * NACHA-permitted reversal reason. One of the four categories applicable to buyer-side invoice purchases. Forwarded to SVB on the reversal call.
+ */
+export type ReversePurchaseDtoReason = ClosedEnum<
+  typeof ReversePurchaseDtoReason
+>;
+
+export type ReversePurchaseDto = {
+  /**
+   * NACHA-permitted reversal reason. One of the four categories applicable to buyer-side invoice purchases. Forwarded to SVB on the reversal call.
+   */
+  reason: ReversePurchaseDtoReason;
+};
+
+/** @internal */
+export const ReversePurchaseDtoReason$outboundSchema: z.ZodNativeEnum<
+  typeof ReversePurchaseDtoReason
+> = z.nativeEnum(ReversePurchaseDtoReason);
+
+/** @internal */
+export type ReversePurchaseDto$Outbound = {
+  reason: string;
+};
+
+/** @internal */
+export const ReversePurchaseDto$outboundSchema: z.ZodType<
+  ReversePurchaseDto$Outbound,
+  z.ZodTypeDef,
+  ReversePurchaseDto
+> = z.object({
+  reason: ReversePurchaseDtoReason$outboundSchema,
+});
+
+export function reversePurchaseDtoToJSON(
+  reversePurchaseDto: ReversePurchaseDto,
+): string {
+  return JSON.stringify(
+    ReversePurchaseDto$outboundSchema.parse(reversePurchaseDto),
+  );
+}

package/src/models/updatepurchasedto.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";
+import {
+  PreferredDisbursementTime,
+  PreferredDisbursementTime$outboundSchema,
+} from "./preferreddisbursementtime.js";
+import {
+  PurchaseUpdateReason,
+  PurchaseUpdateReason$outboundSchema,
+} from "./purchaseupdatereason.js";
+
+export type UpdatePurchaseDto = {
+  /**
+   * Fee-range alias for the disbursement timing. Triggers a recalculation of fee_breakdown, discount_amount, reward_amount, and disbursement dates.
+   */
+  preferredDisbursementTime?: PreferredDisbursementTime | undefined;
+  /**
+   * Reason for the update — recorded on the purchase_histories snapshot.
+   */
+  reason: PurchaseUpdateReason;
+};
+
+/** @internal */
+export type UpdatePurchaseDto$Outbound = {
+  preferred_disbursement_time?: string | undefined;
+  reason: string;
+};
+
+/** @internal */
+export const UpdatePurchaseDto$outboundSchema: z.ZodType<
+  UpdatePurchaseDto$Outbound,
+  z.ZodTypeDef,
+  UpdatePurchaseDto
+> = z.object({
+  preferredDisbursementTime: PreferredDisbursementTime$outboundSchema
+    .optional(),
+  reason: PurchaseUpdateReason$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    preferredDisbursementTime: "preferred_disbursement_time",
+  });
+});
+
+export function updatePurchaseDtoToJSON(
+  updatePurchaseDto: UpdatePurchaseDto,
+): string {
+  return JSON.stringify(
+    UpdatePurchaseDto$outboundSchema.parse(updatePurchaseDto),
+  );
+}

package/src/sdk/businesses.ts

@@ -3,6 +3,7 @@
  */
 
 import { businessesBusinessesControllerGetBusinessBalance } from "../funcs/businessesBusinessesControllerGetBusinessBalance.js";
+import { businessesCheck } from "../funcs/businessesCheck.js";
 import { businessesCreate } from "../funcs/businessesCreate.js";
 import { businessesCreateBulk } from "../funcs/businessesCreateBulk.js";
 import { businessesDelete } from "../funcs/businessesDelete.js";
@@ -91,6 +92,23 @@ export class Businesses extends ClientSDK {
     ));
   }
 
+  /**
+   * Check whether a returning business exists for the partner
+   *
+   * @remarks
+   * Looks up a business by tax_id and contact_email, scoped to the authenticated partner, and returns whether a match exists along with its program-scoped onboarding-terms acceptance and underwriting status. This is a read-only lookup: it does not mutate state and therefore does NOT require an Idempotency-Key. Always responds with 200 — the `valid` flag carries the result; a business that is not found is a normal outcome (`valid: false`), not a 404.
+   */
+  async check(
+    request: models.CheckBusinessDto,
+    options?: RequestOptions,
+  ): Promise<models.CheckBusinessResponseDto> {
+    return unwrapAsync(businessesCheck(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve a business by ID
    */

package/src/sdk/purchases.ts

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { purchasesPurchasesControllerAcceptOffer } from "../funcs/purchasesPurchasesControllerAcceptOffer.js";
+import { purchasesPurchasesControllerCancel } from "../funcs/purchasesPurchasesControllerCancel.js";
+import { purchasesPurchasesControllerCreateOffer } from "../funcs/purchasesPurchasesControllerCreateOffer.js";
+import { purchasesPurchasesControllerFindOne } from "../funcs/purchasesPurchasesControllerFindOne.js";
+import { purchasesPurchasesControllerRetry } from "../funcs/purchasesPurchasesControllerRetry.js";
+import { purchasesPurchasesControllerReverse } from "../funcs/purchasesPurchasesControllerReverse.js";
+import { purchasesPurchasesControllerUpdate } from "../funcs/purchasesPurchasesControllerUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Purchases extends ClientSDK {
+  /**
+   * Create a purchase offer
+   */
+  async purchasesControllerCreateOffer(
+    request: operations.PurchasesControllerCreateOfferRequest,
+    options?: RequestOptions,
+  ): Promise<models.PurchaseOfferResponseDto> {
+    return unwrapAsync(purchasesPurchasesControllerCreateOffer(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Accept a purchase offer and create the purchase
+   */
+  async purchasesControllerAcceptOffer(
+    request: operations.PurchasesControllerAcceptOfferRequest,
+    options?: RequestOptions,
+  ): Promise<models.PurchaseResponseDto> {
+    return unwrapAsync(purchasesPurchasesControllerAcceptOffer(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a scheduled purchase
+   */
+  async purchasesControllerUpdate(
+    request: operations.PurchasesControllerUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<models.PurchaseResponseDto> {
+    return unwrapAsync(purchasesPurchasesControllerUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a purchase by ID
+   */
+  async purchasesControllerFindOne(
+    request: operations.PurchasesControllerFindOneRequest,
+    options?: RequestOptions,
+  ): Promise<models.PurchaseResponseDto> {
+    return unwrapAsync(purchasesPurchasesControllerFindOne(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Cancel a scheduled purchase
+   */
+  async purchasesControllerCancel(
+    request: operations.PurchasesControllerCancelRequest,
+    options?: RequestOptions,
+  ): Promise<models.PurchaseCancelResponseDto> {
+    return unwrapAsync(purchasesPurchasesControllerCancel(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Reverse a completed purchase
+   */
+  async purchasesControllerReverse(
+    request: operations.PurchasesControllerReverseRequest,
+    options?: RequestOptions,
+  ): Promise<models.PurchaseReverseResponseDto> {
+    return unwrapAsync(purchasesPurchasesControllerReverse(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retry a failed purchase
+   */
+  async purchasesControllerRetry(
+    request: operations.PurchasesControllerRetryRequest,
+    options?: RequestOptions,
+  ): Promise<models.PurchaseRetryResponseDto> {
+    return unwrapAsync(purchasesPurchasesControllerRetry(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -39,6 +39,7 @@ import { PlatformSettings } from "./platformsettings.js";
 import { ProgramBillingCycles } from "./programbillingcycles.js";
 import { Programs } from "./programs.js";
 import { ProgramSettings } from "./programsettings.js";
+import { Purchases } from "./purchases.js";
 import { StateDisclosures } from "./statedisclosures.js";
 import { TradingRelationships } from "./tradingrelationships.js";
 import { Transactions } from "./transactions.js";
@@ -217,6 +218,11 @@ export class OatFiSDK extends ClientSDK {
     ));
   }
 
+  private _purchases?: Purchases;
+  get purchases(): Purchases {
+    return (this._purchases ??= new Purchases(this._options));
+  }
+
   private _stateDisclosures?: StateDisclosures;
   get stateDisclosures(): StateDisclosures {
     return (this._stateDisclosures ??= new StateDisclosures(this._options));