@oatfi/oatfi-sdk-ts 0.12.4 → 0.12.6

package/src/models/operations/transactionscontrollerupdate.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 TransactionsControllerUpdateRequest = {
+  /**
+   * The stored transaction id
+   */
+  transactionId: string;
+  updateTransactionDto: models.UpdateTransactionDto;
+};
+
+/** @internal */
+export type TransactionsControllerUpdateRequest$Outbound = {
+  transactionId: string;
+  UpdateTransactionDto: models.UpdateTransactionDto$Outbound;
+};
+
+/** @internal */
+export const TransactionsControllerUpdateRequest$outboundSchema: z.ZodType<
+  TransactionsControllerUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  TransactionsControllerUpdateRequest
+> = z.object({
+  transactionId: z.string(),
+  updateTransactionDto: models.UpdateTransactionDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    updateTransactionDto: "UpdateTransactionDto",
+  });
+});
+
+export function transactionsControllerUpdateRequestToJSON(
+  transactionsControllerUpdateRequest: TransactionsControllerUpdateRequest,
+): string {
+  return JSON.stringify(
+    TransactionsControllerUpdateRequest$outboundSchema.parse(
+      transactionsControllerUpdateRequest,
+    ),
+  );
+}

package/src/models/paymentraildatadto.ts

@@ -34,10 +34,6 @@ export type PaymentRailDataDto = {
    * Direct Debit Authorization
    */
   directDebitAuthorization?: string | undefined;
-  /**
-   * Dwolla Funding Source Id
-   */
-  fundingSourceId?: string | undefined;
   /**
    * Moov Payment Method Id
    */
@@ -92,7 +88,6 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
   account_number: types.optional(types.string()),
   routing_number: types.optional(types.string()),
   direct_debit_authorization: types.optional(types.string()),
-  funding_source_id: types.optional(types.string()),
   moov_payment_method_id: types.optional(types.string()),
   unit_account_id: types.optional(types.string()),
   swift_code: types.optional(types.string()),
@@ -111,7 +106,6 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
     "account_number": "accountNumber",
     "routing_number": "routingNumber",
     "direct_debit_authorization": "directDebitAuthorization",
-    "funding_source_id": "fundingSourceId",
     "moov_payment_method_id": "moovPaymentMethodId",
     "unit_account_id": "unitAccountId",
     "swift_code": "swiftCode",
@@ -131,7 +125,6 @@ export type PaymentRailDataDto$Outbound = {
   account_number?: string | undefined;
   routing_number?: string | undefined;
   direct_debit_authorization?: string | undefined;
-  funding_source_id?: string | undefined;
   moov_payment_method_id?: string | undefined;
   unit_account_id?: string | undefined;
   swift_code?: string | undefined;
@@ -156,7 +149,6 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
   accountNumber: z.string().optional(),
   routingNumber: z.string().optional(),
   directDebitAuthorization: z.string().optional(),
-  fundingSourceId: z.string().optional(),
   moovPaymentMethodId: z.string().optional(),
   unitAccountId: z.string().optional(),
   swiftCode: z.string().optional(),
@@ -175,7 +167,6 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
     accountNumber: "account_number",
     routingNumber: "routing_number",
     directDebitAuthorization: "direct_debit_authorization",
-    fundingSourceId: "funding_source_id",
     moovPaymentMethodId: "moov_payment_method_id",
     unitAccountId: "unit_account_id",
     swiftCode: "swift_code",

package/src/models/paymentstatus.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * The status of the transaction (derived from the payment rail status).
+ */
+export const PaymentStatus = {
+  Pending: "PENDING",
+  Processing: "PROCESSING",
+  Processed: "PROCESSED",
+  Succeeded: "SUCCEEDED",
+  Failed: "FAILED",
+  Corrected: "CORRECTED",
+  Canceled: "CANCELED",
+  Error: "ERROR",
+} as const;
+/**
+ * The status of the transaction (derived from the payment rail status).
+ */
+export type PaymentStatus = ClosedEnum<typeof PaymentStatus>;
+
+/** @internal */
+export const PaymentStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentStatus
+> = z.nativeEnum(PaymentStatus);

package/src/models/platformsettingsdto.ts

@@ -70,14 +70,6 @@ export type PlatformSettingsDto = {
    * Plaid client ID
    */
   plaidClientId?: string | undefined;
-  /**
-   * Dwolla client ID
-   */
-  dwollaClientId?: string | undefined;
-  /**
-   * Dwolla client secret
-   */
-  dwollaClientSecret?: string | undefined;
   /**
    * MOOV payment method ID
    */
@@ -166,14 +158,6 @@ export type PlatformSettingsDto = {
    * Codat API key for accounting integration
    */
   codatApiKey?: string | undefined;
-  /**
-   * OatFi Dwolla funding source
-   */
-  oatfiDwollaFundingSource?: string | undefined;
-  /**
-   * OatFi SPV Dwolla funding source
-   */
-  oatfiSpvDwollaFundingSource?: string | undefined;
   /**
    * Enable AAN (Account and Network)
    */
@@ -235,8 +219,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
   stripe_repayment_enabled: types.optional(types.boolean()),
   plaid_api_key: types.optional(types.string()),
   plaid_client_id: types.optional(types.string()),
-  dwolla_client_id: types.optional(types.string()),
-  dwolla_client_secret: types.optional(types.string()),
   moov_payment_method_id: types.optional(types.string()),
   account_number: types.optional(types.string()),
   routing_number: types.optional(types.string()),
@@ -263,8 +245,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
   credit_facility: types.optional(types.string()),
   portfolio: types.optional(types.string()),
   codat_api_key: types.optional(types.string()),
-  oatfi_dwolla_funding_source: types.optional(types.string()),
-  oatfi_spv_dwolla_funding_source: types.optional(types.string()),
   aan_enable: types.optional(types.boolean()),
   aan_configuration: types.optional(AANConfigPartnerSettingsDto$inboundSchema),
   branding_configuration: types.optional(
@@ -290,8 +270,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
     "stripe_repayment_enabled": "stripeRepaymentEnabled",
     "plaid_api_key": "plaidApiKey",
     "plaid_client_id": "plaidClientId",
-    "dwolla_client_id": "dwollaClientId",
-    "dwolla_client_secret": "dwollaClientSecret",
     "moov_payment_method_id": "moovPaymentMethodId",
     "account_number": "accountNumber",
     "routing_number": "routingNumber",
@@ -313,8 +291,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
     "operating_account": "operatingAccount",
     "credit_facility": "creditFacility",
     "codat_api_key": "codatApiKey",
-    "oatfi_dwolla_funding_source": "oatfiDwollaFundingSource",
-    "oatfi_spv_dwolla_funding_source": "oatfiSpvDwollaFundingSource",
     "aan_enable": "aanEnable",
     "aan_configuration": "aanConfiguration",
     "branding_configuration": "brandingConfiguration",

package/src/models/purchasenotconfirmeddto.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 PurchaseNotConfirmedDto = {
+  /**
+   * Not confirmed.
+   */
+  confirmed: boolean;
+};
+
+/** @internal */
+export const PurchaseNotConfirmedDto$inboundSchema: z.ZodType<
+  PurchaseNotConfirmedDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confirmed: types.boolean(),
+});
+
+export function purchaseNotConfirmedDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PurchaseNotConfirmedDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PurchaseNotConfirmedDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PurchaseNotConfirmedDto' from JSON`,
+  );
+}

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

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/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

@@ -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",
   });
 });