@oatfi/oatfi-sdk-ts 0.12.3 → 0.12.5

package/src/models/storedtransactionresponsedto.ts

@@ -0,0 +1,89 @@
+/*
+ * 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 {
+  TransactionDirection,
+  TransactionDirection$inboundSchema,
+} from "./transactiondirection.js";
+
+export type StoredTransactionResponseDto = {
+  object: string;
+  /**
+   * Unique identifier of the transaction
+   */
+  id: string;
+  /**
+   * Transaction amount in cents
+   */
+  amount: number;
+  /**
+   * Human-readable description of the transaction
+   */
+  description: string;
+  /**
+   * Partner-defined transaction type
+   */
+  type: string;
+  direction: TransactionDirection;
+  /**
+   * Business the transaction belongs to
+   */
+  business: string;
+  /**
+   * Loan program the transaction belongs to
+   */
+  program: string;
+  /**
+   * Transaction date (ISO 8601)
+   */
+  date: string;
+  /**
+   * Creation timestamp (ISO 8601)
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp (ISO 8601)
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const StoredTransactionResponseDto$inboundSchema: z.ZodType<
+  StoredTransactionResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string().default("transaction"),
+  id: types.string(),
+  amount: types.number(),
+  description: types.string(),
+  type: types.string(),
+  direction: TransactionDirection$inboundSchema,
+  business: types.string(),
+  program: types.string(),
+  date: types.string(),
+  created_at: types.string(),
+  updated_at: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function storedTransactionResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<StoredTransactionResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StoredTransactionResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StoredTransactionResponseDto' from JSON`,
+  );
+}

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

package/src/models/tradingrelationshipresponsedto.ts

@@ -0,0 +1,134 @@
+/*
+ * 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";
+
+/**
+ * Relationship status. `pending` until the account holder is KYC/KYB approved, then `active`.
+ */
+export const TradingRelationshipResponseDtoStatus = {
+  Pending: "pending",
+  Active: "active",
+} as const;
+/**
+ * Relationship status. `pending` until the account holder is KYC/KYB approved, then `active`.
+ */
+export type TradingRelationshipResponseDtoStatus = ClosedEnum<
+  typeof TradingRelationshipResponseDtoStatus
+>;
+
+/**
+ * The provisioned virtual account number. Null while the relationship is pending.
+ */
+export type Van = {
+  /**
+   * The virtual account number.
+   */
+  accountNumber: string;
+  /**
+   * The routing number for the virtual account number.
+   */
+  routingNumber: string;
+};
+
+export type TradingRelationshipResponseDto = {
+  /**
+   * Object type.
+   */
+  object: string;
+  /**
+   * Opaque identifier of the relationship (the backing payment method id). Null while pending.
+   */
+  id?: string | null | undefined;
+  /**
+   * Identifier of the partner (platform) that owns the relationship.
+   */
+  platform?: string | undefined;
+  /**
+   * The OatFi internal business id that owns the Increase account (the payee / account holder).
+   */
+  accountHolderBusiness: string;
+  /**
+   * The OatFi internal business id of the counterparty (the payor).
+   */
+  counterpartyBusiness: string;
+  /**
+   * Relationship status. `pending` until the account holder is KYC/KYB approved, then `active`.
+   */
+  status: TradingRelationshipResponseDtoStatus;
+  /**
+   * The provisioned virtual account number. Null while the relationship is pending.
+   */
+  van?: Van | null | undefined;
+  /**
+   * Timestamp when the relationship was created.
+   */
+  createdAt?: string | undefined;
+};
+
+/** @internal */
+export const TradingRelationshipResponseDtoStatus$inboundSchema:
+  z.ZodNativeEnum<typeof TradingRelationshipResponseDtoStatus> = z.nativeEnum(
+    TradingRelationshipResponseDtoStatus,
+  );
+
+/** @internal */
+export const Van$inboundSchema: z.ZodType<Van, z.ZodTypeDef, unknown> = z
+  .object({
+    account_number: types.string(),
+    routing_number: types.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "account_number": "accountNumber",
+      "routing_number": "routingNumber",
+    });
+  });
+
+export function vanFromJSON(
+  jsonString: string,
+): SafeParseResult<Van, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Van$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Van' from JSON`,
+  );
+}
+
+/** @internal */
+export const TradingRelationshipResponseDto$inboundSchema: z.ZodType<
+  TradingRelationshipResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: types.string(),
+  id: z.nullable(types.string()).optional(),
+  platform: types.optional(types.string()),
+  account_holder_business: types.string(),
+  counterparty_business: types.string(),
+  status: TradingRelationshipResponseDtoStatus$inboundSchema,
+  van: z.nullable(z.lazy(() => Van$inboundSchema)).optional(),
+  created_at: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "account_holder_business": "accountHolderBusiness",
+    "counterparty_business": "counterpartyBusiness",
+    "created_at": "createdAt",
+  });
+});
+
+export function tradingRelationshipResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TradingRelationshipResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TradingRelationshipResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TradingRelationshipResponseDto' from JSON`,
+  );
+}

package/src/models/transactiondirection.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 TransactionDirection = {
+  Credit: "credit",
+  Debit: "debit",
+} as const;
+export type TransactionDirection = ClosedEnum<typeof TransactionDirection>;
+
+/** @internal */
+export const TransactionDirection$inboundSchema: z.ZodNativeEnum<
+  typeof TransactionDirection
+> = z.nativeEnum(TransactionDirection);
+/** @internal */
+export const TransactionDirection$outboundSchema: z.ZodNativeEnum<
+  typeof TransactionDirection
+> = TransactionDirection$inboundSchema;

package/src/models/transactionitemdto.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  TransactionDirection,
+  TransactionDirection$outboundSchema,
+} from "./transactiondirection.js";
+
+export type TransactionItemDto = {
+  /**
+   * Transaction amount in cents
+   */
+  amount: number;
+  /**
+   * Human-readable description of the transaction
+   */
+  description: string;
+  /**
+   * Partner-defined transaction type (free-form)
+   */
+  type: string;
+  /**
+   * credit (refund/return) or debit (purchase/spend)
+   */
+  direction: TransactionDirection;
+  /**
+   * Transaction date (ISO 8601)
+   */
+  date: string;
+};
+
+/** @internal */
+export type TransactionItemDto$Outbound = {
+  amount: number;
+  description: string;
+  type: string;
+  direction: string;
+  date: string;
+};
+
+/** @internal */
+export const TransactionItemDto$outboundSchema: z.ZodType<
+  TransactionItemDto$Outbound,
+  z.ZodTypeDef,
+  TransactionItemDto
+> = z.object({
+  amount: z.number(),
+  description: z.string(),
+  type: z.string(),
+  direction: TransactionDirection$outboundSchema,
+  date: z.string(),
+});
+
+export function transactionItemDtoToJSON(
+  transactionItemDto: TransactionItemDto,
+): string {
+  return JSON.stringify(
+    TransactionItemDto$outboundSchema.parse(transactionItemDto),
+  );
+}

package/src/models/transactionloandto.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 { 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 TransactionLoanDto = {
+  /**
+   * The origination (loan) id the transaction line belongs to.
+   */
+  origination?: string | undefined;
+  /**
+   * The original amount of the loan in cents.
+   */
+  amount?: number | undefined;
+  /**
+   * The payment intent (invoice) id linked to the loan.
+   */
+  paymentIntent?: string | undefined;
+  /**
+   * The business id the loan belongs to.
+   */
+  business?: string | undefined;
+};
+
+/** @internal */
+export const TransactionLoanDto$inboundSchema: z.ZodType<
+  TransactionLoanDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  origination: types.optional(types.string()),
+  amount: types.optional(types.number()),
+  payment_intent: types.optional(types.string()),
+  business: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "payment_intent": "paymentIntent",
+  });
+});
+
+export function transactionLoanDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionLoanDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionLoanDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionLoanDto' from JSON`,
+  );
+}

package/src/models/transactionresponsedto.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 {
+  LmsLoanTransactionType,
+  LmsLoanTransactionType$inboundSchema,
+} from "./lmsloantransactiontype.js";
+import { PaymentStatus, PaymentStatus$inboundSchema } from "./paymentstatus.js";
+import {
+  TransactionLoanDto,
+  TransactionLoanDto$inboundSchema,
+} from "./transactionloandto.js";
+
+export type TransactionResponseDto = {
+  /**
+   * The transaction id (the transfer id that comes from the payment rail).
+   */
+  transaction: string;
+  /**
+   * String identifier of the object.
+   */
+  object: string;
+  /**
+   * The total amount of the transaction in cents.
+   */
+  amount?: number | undefined;
+  /**
+   * The fed trace number of the transfer.
+   */
+  fedTraceNumber?: string | undefined;
+  /**
+   * Unique payment reference number to track the transfer from the initiating bank to the receiving bank.
+   */
+  clearingReference?: string | undefined;
+  /**
+   * The status of the transaction (derived from the payment rail status).
+   */
+  status?: PaymentStatus | undefined;
+  /**
+   * The date of the transaction as an epoch timestamp in milliseconds.
+   */
+  transactionDate?: number | undefined;
+  /**
+   * The financial account (payment method) id used for the transfer.
+   */
+  financialAccount?: string | undefined;
+  /**
+   * The type of the transaction.
+   */
+  transactionType?: LmsLoanTransactionType | undefined;
+  /**
+   * The total number of originations in the transaction (full count, not the size of the returned page).
+   */
+  totalOriginations: number;
+  /**
+   * The originations included in the transaction. This is a paginated subset controlled by pageNumber/pageSize; it may contain fewer items than total_originations.
+   */
+  originations: Array<TransactionLoanDto>;
+};
+
+/** @internal */
+export const TransactionResponseDto$inboundSchema: z.ZodType<
+  TransactionResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: types.string(),
+  object: types.string(),
+  amount: types.optional(types.number()),
+  fed_trace_number: types.optional(types.string()),
+  clearing_reference: types.optional(types.string()),
+  status: types.optional(PaymentStatus$inboundSchema),
+  transaction_date: types.optional(types.number()),
+  financial_account: types.optional(types.string()),
+  transaction_type: types.optional(LmsLoanTransactionType$inboundSchema),
+  total_originations: types.number(),
+  originations: z.array(TransactionLoanDto$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "fed_trace_number": "fedTraceNumber",
+    "clearing_reference": "clearingReference",
+    "transaction_date": "transactionDate",
+    "financial_account": "financialAccount",
+    "transaction_type": "transactionType",
+    "total_originations": "totalOriginations",
+  });
+});
+
+export function transactionResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionResponseDto' from JSON`,
+  );
+}

package/src/models/transfermethodenum.ts

@@ -22,6 +22,7 @@ export const TransferMethodEnum = {
   UnitCm: "UNIT_CM",
   NonCash: "NON_CASH",
   IncreaseIntWire: "INCREASE_INT_WIRE",
+  IncreaseAch: "INCREASE_ACH",
 } as const;
 /**
  * The type of payment method

package/src/models/underwritingdatasource.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Optional override for the underwriting data source. When omitted, the default routing is used.
+ */
+export const UnderwritingDataSource = {
+  BankStatements: "bank_statements",
+  FinancialStatements: "financial_statements",
+} as const;
+/**
+ * Optional override for the underwriting data source. When omitted, the default routing is used.
+ */
+export type UnderwritingDataSource = ClosedEnum<typeof UnderwritingDataSource>;
+
+/** @internal */
+export const UnderwritingDataSource$outboundSchema: z.ZodNativeEnum<
+  typeof UnderwritingDataSource
+> = z.nativeEnum(UnderwritingDataSource);

package/src/models/updatedailyreportdto.ts

@@ -26,6 +26,10 @@ export type UpdateDailyReportDto = {
    * The repayment amount in cents. Must be >= 0.
    */
   repaymentAmount?: number | undefined;
+  /**
+   * 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.
    */
@@ -39,6 +43,7 @@ export type UpdateDailyReportDto$Outbound = {
   billing_cycle_outstanding_balance?: number | undefined;
   late_fees?: number | undefined;
   repayment_amount?: number | undefined;
+  refund?: number | undefined;
   date?: string | undefined;
 };
 
@@ -53,6 +58,7 @@ export const UpdateDailyReportDto$outboundSchema: z.ZodType<
   billingCycleOutstandingBalance: z.number().optional(),
   lateFees: z.number().optional(),
   repaymentAmount: z.number().optional(),
+  refund: z.number().optional(),
   date: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/updatefiledto.ts

@@ -15,7 +15,8 @@ export const UpdateFileDtoFileType = {
   BusinessLicense: "business_license",
   ArticlesOfIncorporation: "articles_of_incorporation",
   EinLetter: "ein_letter",
-  FinancialStatement: "financial_statement",
+  AccountingData: "accounting_data",
+  FinancialStatements: "financial_statements",
   CorporateFormationDocument: "corporate_formation_document",
   CertificateOfGoodStanding: "certificate_of_good_standing",
   DriversLicense: "drivers_license",

package/src/models/uploadfilesdto.ts

@@ -41,7 +41,8 @@ export const UploadFilesDtoFileType = {
   BusinessLicense: "business_license",
   ArticlesOfIncorporation: "articles_of_incorporation",
   EinLetter: "ein_letter",
-  FinancialStatement: "financial_statement",
+  AccountingData: "accounting_data",
+  FinancialStatements: "financial_statements",
   CorporateFormationDocument: "corporate_formation_document",
   CertificateOfGoodStanding: "certificate_of_good_standing",
   DriversLicense: "drivers_license",

package/src/models/uploadfilesmultipartdto.ts

@@ -21,7 +21,8 @@ export const UploadFilesMultipartDtoFileType = {
   BusinessLicense: "business_license",
   ArticlesOfIncorporation: "articles_of_incorporation",
   EinLetter: "ein_letter",
-  FinancialStatement: "financial_statement",
+  AccountingData: "accounting_data",
+  FinancialStatements: "financial_statements",
   CorporateFormationDocument: "corporate_formation_document",
   CertificateOfGoodStanding: "certificate_of_good_standing",
   DriversLicense: "drivers_license",