@oatfi/oatfi-sdk-ts 0.12.2 → 0.12.3

package/src/models/originationdto.ts

@@ -14,6 +14,10 @@ import {
   InstallmentDto,
   InstallmentDto$inboundSchema,
 } from "./installmentdto.js";
+import {
+  NetworkPurchaseInfo,
+  NetworkPurchaseInfo$inboundSchema,
+} from "./networkpurchaseinfo.js";
 import {
   OriginationBalancesDto,
   OriginationBalancesDto$inboundSchema,
@@ -199,6 +203,10 @@ export type OriginationDto = {
    * Date the origination was sold, if applicable. Absent on originations that have not been sold.
    */
   saleDate?: Date | undefined;
+  /**
+   * Net Terms network purchase details. Present only on loans from network programs.
+   */
+  networkPurchase?: NetworkPurchaseInfo | undefined;
   /**
    * Timestamp of when the origination was created.
    */
@@ -336,6 +344,7 @@ export const OriginationDto$inboundSchema: z.ZodType<
   cadence: types.optional(OriginationDtoCadence$inboundSchema),
   offer: types.optional(types.string()),
   sale_date: types.optional(types.date()),
+  network_purchase: types.optional(NetworkPurchaseInfo$inboundSchema),
   created_at: types.date(),
   updated_at: types.date(),
 }).transform((v) => {
@@ -353,6 +362,7 @@ export const OriginationDto$inboundSchema: z.ZodType<
     "payment_intent_pdf_file": "paymentIntentPdfFile",
     "repayment_financial_account": "repaymentFinancialAccount",
     "sale_date": "saleDate",
+    "network_purchase": "networkPurchase",
     "created_at": "createdAt",
     "updated_at": "updatedAt",
   });

package/src/models/paymentinformationdto.ts

@@ -139,11 +139,11 @@ export type PaymentInformationDto = {
   /**
    * The date when the payment information was created
    */
-  createdAt: Date;
+  createdAt?: Date | undefined;
   /**
    * The date when the payment information was last updated
    */
-  updatedAt: Date;
+  updatedAt?: Date | undefined;
 };
 
 /** @internal */
@@ -185,8 +185,8 @@ export const PaymentInformationDto$inboundSchema: z.ZodType<
   ),
   third_party_transfer_id: types.optional(types.string()),
   error_message: types.optional(types.string()),
-  created_at: types.date(),
-  updated_at: types.date(),
+  created_at: types.optional(types.date()),
+  updated_at: types.optional(types.date()),
 }).transform((v) => {
   return remap$(v, {
     "payment_intent": "paymentIntent",

package/src/models/platformcomponentsdto.ts

@@ -10,7 +10,7 @@ import * as types from "../types/primitives.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 /**
- * Additional data
+ * Component bundle and branding data. Includes a `branding_configuration` object with the partner branding.
  */
 export type PlatformComponentsDtoData = {};
 
@@ -28,7 +28,7 @@ export type PlatformComponentsDto = {
    */
   id: string;
   /**
-   * Additional data
+   * Component bundle and branding data. Includes a `branding_configuration` object with the partner branding.
    */
   data: PlatformComponentsDtoData;
 };

package/src/models/platformsettingsdto.ts

@@ -46,18 +46,6 @@ export type PlatformSettingsDto = {
    * Platform ID associated with these settings
    */
   platform: string;
-  /**
-   * Primary brand color
-   */
-  primaryColor?: string | undefined;
-  /**
-   * Secondary brand color
-   */
-  secondaryColor?: string | undefined;
-  /**
-   * Logo URL
-   */
-  logoUrl?: string | undefined;
   /**
    * Webhook URL for notifications
    */
@@ -241,9 +229,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
   object: types.string(),
   id: types.string(),
   platform: types.string(),
-  primary_color: types.optional(types.string()),
-  secondary_color: types.optional(types.string()),
-  logo_url: types.optional(types.string()),
   webhook_url: types.optional(types.string()),
   stripe_account: types.optional(types.string()),
   stripe_api_key: types.optional(types.string()),
@@ -299,9 +284,6 @@ export const PlatformSettingsDto$inboundSchema: z.ZodType<
   updated_at: types.optional(types.date()),
 }).transform((v) => {
   return remap$(v, {
-    "primary_color": "primaryColor",
-    "secondary_color": "secondaryColor",
-    "logo_url": "logoUrl",
     "webhook_url": "webhookUrl",
     "stripe_account": "stripeAccount",
     "stripe_api_key": "stripeApiKey",

package/src/models/updateledgerentrydto.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+
+export type UpdateLedgerEntryDto = {
+  /**
+   * Updated amount of the ledger entry, in cents. Must be a positive integer.
+   */
+  amount?: number | undefined;
+  /**
+   * Amount that has been paid for this ledger entry, in cents. Must be a positive integer.
+   */
+  paidAmount?: number | undefined;
+  /**
+   * Updated date when the ledger entry is due (ISO 8601 format).
+   */
+  dueDate?: string | undefined;
+  /**
+   * Date when the ledger entry was paid (ISO 8601 format).
+   */
+  paymentDate?: string | undefined;
+  /**
+   * Date when the ledger entry was created (ISO 8601 format).
+   */
+  createdDate?: string | undefined;
+  /**
+   * Ledger entry approved by Payor.
+   */
+  approvedByPayor?: boolean | undefined;
+  /**
+   * Updated textual description of the ledger entry.
+   */
+  description?: string | undefined;
+  /**
+   * Updated Mongo ID of the payor organization.
+   */
+  payor?: string | undefined;
+  /**
+   * Updated Mongo ID of the payee organization.
+   */
+  payee?: string | undefined;
+};
+
+/** @internal */
+export type UpdateLedgerEntryDto$Outbound = {
+  amount?: number | undefined;
+  paid_amount?: number | undefined;
+  due_date?: string | undefined;
+  payment_date?: string | undefined;
+  created_date?: string | undefined;
+  approved_by_payor?: boolean | undefined;
+  description?: string | undefined;
+  payor?: string | undefined;
+  payee?: string | undefined;
+};
+
+/** @internal */
+export const UpdateLedgerEntryDto$outboundSchema: z.ZodType<
+  UpdateLedgerEntryDto$Outbound,
+  z.ZodTypeDef,
+  UpdateLedgerEntryDto
+> = z.object({
+  amount: z.number().optional(),
+  paidAmount: z.number().optional(),
+  dueDate: z.string().optional(),
+  paymentDate: z.string().optional(),
+  createdDate: z.string().optional(),
+  approvedByPayor: z.boolean().optional(),
+  description: z.string().optional(),
+  payor: z.string().optional(),
+  payee: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    paidAmount: "paid_amount",
+    dueDate: "due_date",
+    paymentDate: "payment_date",
+    createdDate: "created_date",
+    approvedByPayor: "approved_by_payor",
+  });
+});
+
+export function updateLedgerEntryDtoToJSON(
+  updateLedgerEntryDto: UpdateLedgerEntryDto,
+): string {
+  return JSON.stringify(
+    UpdateLedgerEntryDto$outboundSchema.parse(updateLedgerEntryDto),
+  );
+}

package/src/models/updateoriginationdto.ts

@@ -4,6 +4,11 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import {
+  NetworkPurchaseInfo,
+  NetworkPurchaseInfo$Outbound,
+  NetworkPurchaseInfo$outboundSchema,
+} from "./networkpurchaseinfo.js";
 
 export type UpdateOriginationDto = {
   /**
@@ -22,6 +27,10 @@ export type UpdateOriginationDto = {
    * URL to an invoice PDF
    */
   invoicePdfUrl?: string | undefined;
+  /**
+   * Net Terms network purchase details. Updatable by INTERNAL scopes only, and only before funding (or for non-cash funded loans, before the first payment is received).
+   */
+  networkPurchase?: NetworkPurchaseInfo | undefined;
 };
 
 /** @internal */
@@ -30,6 +39,7 @@ export type UpdateOriginationDto$Outbound = {
   repayment_financial_account?: string | undefined;
   scheduled_repayment_date?: number | undefined;
   invoice_pdf_url?: string | undefined;
+  network_purchase?: NetworkPurchaseInfo$Outbound | undefined;
 };
 
 /** @internal */
@@ -42,12 +52,14 @@ export const UpdateOriginationDto$outboundSchema: z.ZodType<
   repaymentFinancialAccount: z.string().optional(),
   scheduledRepaymentDate: z.number().optional(),
   invoicePdfUrl: z.string().optional(),
+  networkPurchase: NetworkPurchaseInfo$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     fundingFinancialAccount: "funding_financial_account",
     repaymentFinancialAccount: "repayment_financial_account",
     scheduledRepaymentDate: "scheduled_repayment_date",
     invoicePdfUrl: "invoice_pdf_url",
+    networkPurchase: "network_purchase",
   });
 });
 

package/src/sdk/ledgerentries.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ledgerEntriesCreate } from "../funcs/ledgerEntriesCreate.js";
+import { ledgerEntriesGet } from "../funcs/ledgerEntriesGet.js";
+import { ledgerEntriesUpdate } from "../funcs/ledgerEntriesUpdate.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 LedgerEntries extends ClientSDK {
+  /**
+   * Create a new Ledger Entry
+   */
+  async create(
+    request: operations.LedgerEntriesControllerCreateRequest,
+    options?: RequestOptions,
+  ): Promise<models.LedgerEntryResponseDto> {
+    return unwrapAsync(ledgerEntriesCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a Ledger Entry by ID
+   */
+  async get(
+    request: operations.LedgerEntriesControllerFindOneRequest,
+    options?: RequestOptions,
+  ): Promise<models.LedgerEntryResponseDto> {
+    return unwrapAsync(ledgerEntriesGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a Ledger Entry by ID
+   */
+  async update(
+    request: operations.LedgerEntriesControllerUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<models.LedgerEntryResponseDto> {
+    return unwrapAsync(ledgerEntriesUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/onboardingterms.ts

@@ -18,7 +18,7 @@ export class OnboardingTerms extends ClientSDK {
    * Create an onboarding terms acceptance for a business
    *
    * @remarks
-   * Creates a new agreement assignment record for the given business. The acceptance source is always recorded as `PARTNER_API`. The caller MUST send `user_accepted` to attest whether the borrower actually accepted the terms. A webhook event `agreement_acceptance.created` is emitted to the partner's configured webhook endpoint.
+   * Creates a new agreement assignment record for the given business. The acceptance source is always recorded as `PARTNER_API`. The caller MAY send `user_accepted` to attest whether the borrower actually accepted the terms; it defaults to true when omitted. A webhook event `agreement_acceptance.created` is emitted to the partner's configured webhook endpoint.
    */
   async create(
     request: operations.BusinessAgreementAssignmentsControllerCreateRequest,
@@ -72,7 +72,7 @@ export class OnboardingTerms extends ClientSDK {
    * Create a new onboarding terms assignment record
    *
    * @remarks
-   * Creates a new agreement assignment record. When a business entity accepts onboarding terms (via hosted flow or embedded component), a webhook event `agreement_acceptance.created` is automatically emitted to the partner's configured webhook endpoint. The event payload includes the business external ID, timestamp of acceptance, terms version identifier, and terms file URL.
+   * Creates a new agreement assignment record. When a business entity accepts onboarding terms (via hosted flow or embedded component), a webhook event `agreement_acceptance.created` is automatically emitted to the partner's configured webhook endpoint. The event payload includes the business Mongo id, timestamp of acceptance, and terms version identifier.
    */
   async agreementAssignmentInternalControllerCreate(
     request: models.CreateAgreementAssignmentDto,

package/src/sdk/sdk.ts

@@ -23,6 +23,7 @@ import { FinancialAccounts } from "./financialaccounts.js";
 import { Holds } from "./holds.js";
 import { IncreaseTransactions } from "./increasetransactions.js";
 import { InternalProgramSettings } from "./internalprogramsettings.js";
+import { LedgerEntries } from "./ledgerentries.js";
 import { OnboardingTerms } from "./onboardingterms.js";
 import { Originations } from "./originations.js";
 import { PaymentIntents } from "./paymentintents.js";
@@ -53,6 +54,11 @@ import {
 // #endregion imports
 
 export class OatFiSDK extends ClientSDK {
+  private _onboardingTerms?: OnboardingTerms;
+  get onboardingTerms(): OnboardingTerms {
+    return (this._onboardingTerms ??= new OnboardingTerms(this._options));
+  }
+
   private _businesses?: Businesses;
   get businesses(): Businesses {
     return (this._businesses ??= new Businesses(this._options));
@@ -198,11 +204,6 @@ export class OatFiSDK extends ClientSDK {
     ));
   }
 
-  private _onboardingTerms?: OnboardingTerms;
-  get onboardingTerms(): OnboardingTerms {
-    return (this._onboardingTerms ??= new OnboardingTerms(this._options));
-  }
-
   private _stateDisclosures?: StateDisclosures;
   get stateDisclosures(): StateDisclosures {
     return (this._stateDisclosures ??= new StateDisclosures(this._options));
@@ -253,6 +254,11 @@ export class OatFiSDK extends ClientSDK {
     ));
   }
 
+  private _ledgerEntries?: LedgerEntries;
+  get ledgerEntries(): LedgerEntries {
+    return (this._ledgerEntries ??= new LedgerEntries(this._options));
+  }
+
   // #region sdk-class-body
 
   /**

package/examples/businessesCreate.example.ts

@@ -1,105 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import dotenv from "dotenv";
-dotenv.config();
-/**
- * Example usage of the @oatfi/oatfi-sdk-ts SDK
- *
- * To run this example from the examples directory:
- * npm run build && npx tsx businessesCreate.example.ts
- */
-
-import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";
-
-const oatFiSDK = new OatFiSDK({
-  bearer: process.env["OATFISDK_BEARER"] ?? "",
-});
-
-async function main() {
-  const result = await oatFiSDK.businesses.create({
-    idempotencyKey: "<value>",
-    createBusinessDto: {
-      externalId: "ext_123456",
-      name: "Acme Corporation",
-      dbaName: "Acme",
-      taxId: "123456789",
-      address: {
-        line1: "123 Main St",
-        line2: "Suite 100",
-        city: "San Francisco",
-        state: "CA",
-        postalCode: "94105",
-      },
-      contactFirstName: "John",
-      contactLastName: "Doe",
-      contactEmail: "john.doe@acme.com",
-      contactPhone: "+14155552671",
-      businessStartDateMonth: "January",
-      businessStartDateYear: "2020",
-      businessEntityType: "LLC",
-      application: "507f1f77bcf86cd799439011",
-      users: [
-        "507f1f77bcf86cd799439011",
-        "507f1f77bcf86cd799439012",
-      ],
-      primaryUser: "507f1f77bcf86cd799439011",
-      achToken: "ACH20c64a3d71cb-4400-8225-6d19918aa183",
-      webhookUrl: "https://my.webhook.com/post",
-      plaidToken: "20c64a3d-71cb-4400-8225-6d19918aa183",
-      plaidTokens: [
-        {
-          alias: "Default Token",
-          token: "access-sandbox-43bb37eb-954c-45e8-b0be-391b1d2c06fc",
-        },
-      ],
-      heronId: "heron_123456",
-      paymentSettings: [
-        {
-          partner: "62eaf2133147bd1b70da07d2",
-          business: "62eaf2133147bd1b70da07d2",
-          data: {
-            accountId: "acct_1J876rQjaww8b42s",
-            customerId: "cus_sdfsdfsd1J876rQjawghghw8b42s",
-            paymentMethodId: "pm_ssej45jawghghw8b42s",
-            accountNumber: "21565234545",
-            routingNumber: "1572515454",
-            directDebitAuthorization:
-              "{\"authorized\": true, \"type\": \"PLAID\", \"account_id\": \"000123456789\", \"owner\": \"Business Owner\", \"created_at\": \"2023-01-01T00:00:00.000Z\"}",
-            fundingSourceId:
-              "H6U1rvcYcDybNwKykiyM28of0mPdOnh9yCJPIa5MJEdSRD5846",
-            moovPaymentMethodId: "0ff91950-3333-4444-5555-b071f5550795",
-            unitAccountId: "21565234545",
-            swiftCode: "1572515454",
-            remittanceInformation: "Payment for {year}-{month}-{day}",
-            lockboxAddress: "123 Main St",
-            accountNumberId: "account_number_i6kffj1pvwhmhi7okasb",
-            oatfiAccountNumber: "21565234545",
-            oatfiRoutingNumber: "21565234545",
-          },
-          scheduledRepayment: false,
-          isDefault: true,
-          type: "UNIT",
-        },
-      ],
-      codatCompanyId: "20c64a3d-71cb-4400-8225-6d19918aa183",
-      consumerInvoices: false,
-      onboardingSource: "API",
-      requestedLimitSource: "Customer",
-      requestedCreditLimit: 10000,
-      metadata: {
-        mcNumber: "20c64a3d-71cb-4400-8225-6d19918aa183",
-        avgMonthlySpend: "10000",
-        orderProductSelection: "20c64a3d-71cb-4400-8225-6d19918aa183",
-        requestedCreditLimit: 10000,
-        plaidData: "{\"accounts\":[...],\"institution\":{...}}",
-        annualRevenue: 100000000,
-      },
-    },
-  });
-
-  console.log(result);
-}
-
-main().catch(console.error);