@oatfi/oatfi-sdk-ts 0.12.4 → 0.12.5

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/sdk/networkledger.ts

@@ -25,7 +25,7 @@ export class NetworkLedger extends ClientSDK {
     security: operations.NetworkControllerGetBusinessSecurity,
     request: operations.NetworkControllerGetBusinessRequest,
     options?: RequestOptions,
-  ): Promise<models.BusinessResponseDto> {
+  ): Promise<models.BusinessDataResponseDto> {
     return unwrapAsync(networkLedgerGetBusiness(
       this,
       security,

package/src/sdk/sdk.ts

@@ -41,6 +41,7 @@ import { Programs } from "./programs.js";
 import { ProgramSettings } from "./programsettings.js";
 import { StateDisclosures } from "./statedisclosures.js";
 import { TradingRelationships } from "./tradingrelationships.js";
+import { Transactions } from "./transactions.js";
 import { UnderwritingTerms } from "./underwritingterms.js";
 import { Users } from "./users.js";
 // #region imports
@@ -268,6 +269,11 @@ export class OatFiSDK extends ClientSDK {
     ));
   }
 
+  private _transactions?: Transactions;
+  get transactions(): Transactions {
+    return (this._transactions ??= new Transactions(this._options));
+  }
+
   private _ledgerEntries?: LedgerEntries;
   get ledgerEntries(): LedgerEntries {
     return (this._ledgerEntries ??= new LedgerEntries(this._options));

package/src/sdk/transactions.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { transactionsCreateBatch } from "../funcs/transactionsCreateBatch.js";
+import { transactionsGetById } from "../funcs/transactionsGetById.js";
+import { transactionsList } from "../funcs/transactionsList.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Transactions extends ClientSDK {
+  /**
+   * Upload a batch of transactions
+   *
+   * @remarks
+   * Stores up to 100 transactions for a single business and loan program.
+   */
+  async createBatch(
+    request: operations.TransactionsControllerCreateRequest,
+    options?: RequestOptions,
+  ): Promise<models.StoredTransactionListResponseDto> {
+    return unwrapAsync(transactionsCreateBatch(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List stored transactions
+   *
+   * @remarks
+   * Finance-only. Lists partner-uploaded transactions for a business and loan program.
+   */
+  async list(
+    request: operations.TransactionsControllerFindAllRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.TransactionsControllerFindAllResponse,
+      { cursor: string }
+    >
+  > {
+    return unwrapResultIterator(transactionsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a transaction by ID
+   *
+   * @remarks
+   * Retrieves a transaction and its associated loans by the payment rail transfer id.
+   */
+  async getById(
+    request: operations.TransactionsControllerFindOneRequest,
+    options?: RequestOptions,
+  ): Promise<models.TransactionResponseDto> {
+    return unwrapAsync(transactionsGetById(
+      this,
+      request,
+      options,
+    ));
+  }
+}