@oatfi/oatfi-sdk-ts 0.12.5 → 0.12.7

package/src/models/purchaseofferresponsedto.ts

@@ -0,0 +1,165 @@
+/*
+ * 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 {
+  PurchaseOfferStatus,
+  PurchaseOfferStatus$inboundSchema,
+} from "./purchaseofferstatus.js";
+
+export type PurchaseOfferResponseDto = {
+  /**
+   * Unique purchase offer identifier.
+   */
+  id: string;
+  /**
+   * String identifier of the object.
+   */
+  object: string;
+  /**
+   * Public-facing offer ID used to identify this offer attempt.
+   */
+  offer: string;
+  status: PurchaseOfferStatus;
+  /**
+   * Identifier of the payment intent the offer is reserved against.
+   */
+  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 (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 reserving credit for this offer.
+   */
+  hold?: string | undefined;
+  /**
+   * Offer expiration timestamp — equals the invoice due date (ISO 8601).
+   */
+  expirationDate: string;
+  /**
+   * Timestamp the offer was accepted (ISO 8601).
+   */
+  acceptedAt?: string | undefined;
+  /**
+   * Identifier of the Purchase created from this offer once accepted.
+   */
+  acceptedPurchase?: string | undefined;
+  /**
+   * Creation timestamp (ISO 8601).
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp (ISO 8601).
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const PurchaseOfferResponseDto$inboundSchema: z.ZodType<
+  PurchaseOfferResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  offer: types.string(),
+  status: PurchaseOfferStatus$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()),
+  expiration_date: types.string(),
+  accepted_at: types.optional(types.string()),
+  accepted_purchase: types.optional(types.string()),
+  created_at: types.string(),
+  updated_at: 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",
+    "expiration_date": "expirationDate",
+    "accepted_at": "acceptedAt",
+    "accepted_purchase": "acceptedPurchase",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function purchaseOfferResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseOfferResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseOfferResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseOfferResponseDto' from JSON`,
+  );
+}

package/src/models/purchaseofferstatus.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+export const PurchaseOfferStatus = {
+  Active: "ACTIVE",
+  Accepted: "ACCEPTED",
+  Expired: "EXPIRED",
+} as const;
+export type PurchaseOfferStatus = ClosedEnum<typeof PurchaseOfferStatus>;
+
+/** @internal */
+export const PurchaseOfferStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PurchaseOfferStatus
+> = z.nativeEnum(PurchaseOfferStatus);

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/transfermethodenum.ts

@@ -10,7 +10,6 @@ import { ClosedEnum } from "../types/enums.js";
  */
 export const TransferMethodEnum = {
   Ach: "ACH",
-  Dwolla: "DWOLLA",
   Stripe: "STRIPE",
   Moov: "MOOV",
   Unit: "UNIT",

package/src/models/updatefiledto.ts

@@ -17,6 +17,9 @@ export const UpdateFileDtoFileType = {
   EinLetter: "ein_letter",
   AccountingData: "accounting_data",
   FinancialStatements: "financial_statements",
+  BalanceSheet: "balance_sheet",
+  ProfitLoss: "profit_loss",
+  TermsDoc: "terms_doc",
   CorporateFormationDocument: "corporate_formation_document",
   CertificateOfGoodStanding: "certificate_of_good_standing",
   DriversLicense: "drivers_license",
@@ -53,6 +56,10 @@ export type UpdateFileDto = {
    * Optional description of the file
    */
   description: string;
+  /**
+   * Optional calendar date associated with the document (e.g. the statement or invoice date). Format: YYYY-MM-DD.
+   */
+  documentDate?: string | undefined;
   /**
    * Additional metadata about the file
    */
@@ -68,6 +75,7 @@ export const UpdateFileDtoFileType$outboundSchema: z.ZodNativeEnum<
 export type UpdateFileDto$Outbound = {
   file_type: string;
   description: string;
+  document_date?: string | undefined;
   metadata: { [k: string]: any };
 };
 
@@ -79,10 +87,12 @@ export const UpdateFileDto$outboundSchema: z.ZodType<
 > = z.object({
   fileType: UpdateFileDtoFileType$outboundSchema,
   description: z.string(),
+  documentDate: z.string().optional(),
   metadata: z.record(z.any()),
 }).transform((v) => {
   return remap$(v, {
     fileType: "file_type",
+    documentDate: "document_date",
   });
 });