@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.61

package/src/models/updateaddressdto.ts

@@ -4,6 +4,9 @@
 
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 export type UpdateAddressDto = {
   /**
@@ -32,6 +35,25 @@ export type UpdateAddressDto = {
   country?: string | undefined;
 };
 
+/** @internal */
+export const UpdateAddressDto$inboundSchema: z.ZodType<
+  UpdateAddressDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  line_1: z.string().optional(),
+  line_2: z.string().optional(),
+  city: z.string().optional(),
+  state: z.string().optional(),
+  postal_code: z.string().optional(),
+  country: z.string().default("US"),
+}).transform((v) => {
+  return remap$(v, {
+    "line_1": "line1",
+    "line_2": "line2",
+    "postal_code": "postalCode",
+  });
+});
 /** @internal */
 export type UpdateAddressDto$Outbound = {
   line_1?: string | undefined;
@@ -69,3 +91,12 @@ export function updateAddressDtoToJSON(
     UpdateAddressDto$outboundSchema.parse(updateAddressDto),
   );
 }
+export function updateAddressDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateAddressDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateAddressDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateAddressDto' from JSON`,
+  );
+}

package/src/models/updateapplicationdto.ts

@@ -0,0 +1,136 @@
+/*
+ * 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 {
+  AdverseActionDto,
+  AdverseActionDto$Outbound,
+  AdverseActionDto$outboundSchema,
+} from "./adverseactiondto.js";
+import {
+  AttachmentDto,
+  AttachmentDto$Outbound,
+  AttachmentDto$outboundSchema,
+} from "./attachmentdto.js";
+import {
+  BusinessInformationDto,
+  BusinessInformationDto$Outbound,
+  BusinessInformationDto$outboundSchema,
+} from "./businessinformationdto.js";
+import {
+  ConsentsDto,
+  ConsentsDto$Outbound,
+  ConsentsDto$outboundSchema,
+} from "./consentsdto.js";
+import {
+  ExpectedUsageDto,
+  ExpectedUsageDto$Outbound,
+  ExpectedUsageDto$outboundSchema,
+} from "./expectedusagedto.js";
+import {
+  UpdatePersonInformationDto,
+  UpdatePersonInformationDto$Outbound,
+  UpdatePersonInformationDto$outboundSchema,
+} from "./updatepersoninformationdto.js";
+
+/**
+ * Additional metadata
+ */
+export type UpdateApplicationDtoMetadata = {};
+
+export type UpdateApplicationDto = {
+  /**
+   * Status of the application
+   */
+  status?: string | undefined;
+  /**
+   * KYB status of the application
+   */
+  kybStatus?: string | undefined;
+  businessInformation?: BusinessInformationDto | undefined;
+  personsInformation?: Array<UpdatePersonInformationDto> | undefined;
+  expectedUsage?: ExpectedUsageDto | undefined;
+  consents?: ConsentsDto | undefined;
+  /**
+   * List of adverse actions
+   */
+  adverseActions?: Array<AdverseActionDto> | undefined;
+  /**
+   * Optional list of attachments
+   */
+  attachments?: Array<AttachmentDto> | undefined;
+  /**
+   * Additional metadata
+   */
+  metadata?: UpdateApplicationDtoMetadata | undefined;
+};
+
+/** @internal */
+export type UpdateApplicationDtoMetadata$Outbound = {};
+
+/** @internal */
+export const UpdateApplicationDtoMetadata$outboundSchema: z.ZodType<
+  UpdateApplicationDtoMetadata$Outbound,
+  z.ZodTypeDef,
+  UpdateApplicationDtoMetadata
+> = z.object({});
+
+export function updateApplicationDtoMetadataToJSON(
+  updateApplicationDtoMetadata: UpdateApplicationDtoMetadata,
+): string {
+  return JSON.stringify(
+    UpdateApplicationDtoMetadata$outboundSchema.parse(
+      updateApplicationDtoMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateApplicationDto$Outbound = {
+  status?: string | undefined;
+  kyb_status?: string | undefined;
+  business_information?: BusinessInformationDto$Outbound | undefined;
+  persons_information?: Array<UpdatePersonInformationDto$Outbound> | undefined;
+  expected_usage?: ExpectedUsageDto$Outbound | undefined;
+  consents?: ConsentsDto$Outbound | undefined;
+  adverse_actions?: Array<AdverseActionDto$Outbound> | undefined;
+  attachments?: Array<AttachmentDto$Outbound> | undefined;
+  metadata?: UpdateApplicationDtoMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateApplicationDto$outboundSchema: z.ZodType<
+  UpdateApplicationDto$Outbound,
+  z.ZodTypeDef,
+  UpdateApplicationDto
+> = z.object({
+  status: z.string().optional(),
+  kybStatus: z.string().optional(),
+  businessInformation: BusinessInformationDto$outboundSchema.optional(),
+  personsInformation: z.array(UpdatePersonInformationDto$outboundSchema)
+    .optional(),
+  expectedUsage: ExpectedUsageDto$outboundSchema.optional(),
+  consents: ConsentsDto$outboundSchema.optional(),
+  adverseActions: z.array(AdverseActionDto$outboundSchema).optional(),
+  attachments: z.array(AttachmentDto$outboundSchema).optional(),
+  metadata: z.lazy(() => UpdateApplicationDtoMetadata$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    kybStatus: "kyb_status",
+    businessInformation: "business_information",
+    personsInformation: "persons_information",
+    expectedUsage: "expected_usage",
+    adverseActions: "adverse_actions",
+  });
+});
+
+export function updateApplicationDtoToJSON(
+  updateApplicationDto: UpdateApplicationDto,
+): string {
+  return JSON.stringify(
+    UpdateApplicationDto$outboundSchema.parse(updateApplicationDto),
+  );
+}

package/src/models/updatepersoninformationdto.ts

@@ -0,0 +1,128 @@
+/*
+ * 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 { KycStatus, KycStatus$outboundSchema } from "./kycstatus.js";
+import {
+  PersonBusinessRelationship,
+  PersonBusinessRelationship$outboundSchema,
+} from "./personbusinessrelationship.js";
+import {
+  UpdateAddressDto,
+  UpdateAddressDto$Outbound,
+  UpdateAddressDto$outboundSchema,
+} from "./updateaddressdto.js";
+
+export type UpdatePersonInformationDto = {
+  /**
+   * External ID for the person, if available
+   */
+  externalId?: string | undefined;
+  /**
+   * Person's first name
+   */
+  firstName?: string | undefined;
+  /**
+   * Person's last name
+   */
+  lastName?: string | undefined;
+  /**
+   * Person's title or role in the business
+   */
+  title?: string | undefined;
+  /**
+   * Person's email address
+   */
+  email?: string | undefined;
+  /**
+   * Person's phone number
+   */
+  phone?: string | undefined;
+  /**
+   * Person's date of birth (YYYY-MM-DD)
+   */
+  dateOfBirth?: string | undefined;
+  /**
+   * Person's physical address
+   */
+  address?: UpdateAddressDto | undefined;
+  /**
+   * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+   */
+  relationshipToBusiness?: PersonBusinessRelationship | undefined;
+  /**
+   * Is this person a control person for the business?
+   */
+  isControlPerson?: boolean | undefined;
+  /**
+   * Ownership percentage (0-100). A value greater than 0 implies beneficial ownership.
+   */
+  ownershipPercentage?: number | undefined;
+  /**
+   * Person's KYC status
+   */
+  kycStatus?: KycStatus | undefined;
+  /**
+   * Full SSN (Social Security Number) - for KYC purposes, Application-only field.
+   */
+  ssn?: string | undefined;
+};
+
+/** @internal */
+export type UpdatePersonInformationDto$Outbound = {
+  external_id?: string | undefined;
+  first_name?: string | undefined;
+  last_name?: string | undefined;
+  title?: string | undefined;
+  email?: string | undefined;
+  phone?: string | undefined;
+  date_of_birth?: string | undefined;
+  address?: UpdateAddressDto$Outbound | undefined;
+  relationship_to_business?: string | undefined;
+  is_control_person?: boolean | undefined;
+  ownership_percentage?: number | undefined;
+  kyc_status?: string | undefined;
+  ssn?: string | undefined;
+};
+
+/** @internal */
+export const UpdatePersonInformationDto$outboundSchema: z.ZodType<
+  UpdatePersonInformationDto$Outbound,
+  z.ZodTypeDef,
+  UpdatePersonInformationDto
+> = z.object({
+  externalId: z.string().optional(),
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  title: z.string().optional(),
+  email: z.string().optional(),
+  phone: z.string().optional(),
+  dateOfBirth: z.string().optional(),
+  address: UpdateAddressDto$outboundSchema.optional(),
+  relationshipToBusiness: PersonBusinessRelationship$outboundSchema.optional(),
+  isControlPerson: z.boolean().optional(),
+  ownershipPercentage: z.number().optional(),
+  kycStatus: KycStatus$outboundSchema.optional(),
+  ssn: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    firstName: "first_name",
+    lastName: "last_name",
+    dateOfBirth: "date_of_birth",
+    relationshipToBusiness: "relationship_to_business",
+    isControlPerson: "is_control_person",
+    ownershipPercentage: "ownership_percentage",
+    kycStatus: "kyc_status",
+  });
+});
+
+export function updatePersonInformationDtoToJSON(
+  updatePersonInformationDto: UpdatePersonInformationDto,
+): string {
+  return JSON.stringify(
+    UpdatePersonInformationDto$outboundSchema.parse(updatePersonInformationDto),
+  );
+}

package/src/sdk/acceptanceterms.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { acceptanceTermsCreate } from "../funcs/acceptanceTermsCreate.js";
+import { acceptanceTermsGetAll } from "../funcs/acceptanceTermsGetAll.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 AcceptanceTerms extends ClientSDK {
+  /**
+   * Create a new underwriting terms acceptance record
+   *
+   * @remarks
+   * Creates a new agreement acceptance record. When a business entity accepts underwriting 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.
+   */
+  async create(
+    request: models.CreateAgreementAcceptanceDto,
+    options?: RequestOptions,
+  ): Promise<models.AgreementAcceptanceResponseDto> {
+    return unwrapAsync(acceptanceTermsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get underwriting terms acceptance records
+   */
+  async getAll(
+    request: operations.AcceptanceTermsControllerFindAllRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.AcceptanceTermsControllerFindAllResponse,
+      { cursor: string }
+    >
+  > {
+    return unwrapResultIterator(acceptanceTermsGetAll(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/applications.ts

@@ -0,0 +1,130 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { applicationsApprove } from "../funcs/applicationsApprove.js";
+import { applicationsCreate } from "../funcs/applicationsCreate.js";
+import { applicationsGet } from "../funcs/applicationsGet.js";
+import { applicationsGetTransactionsReportUrl } from "../funcs/applicationsGetTransactionsReportUrl.js";
+import { applicationsList } from "../funcs/applicationsList.js";
+import { applicationsSubmit } from "../funcs/applicationsSubmit.js";
+import { applicationsUpdate } from "../funcs/applicationsUpdate.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 Applications extends ClientSDK {
+  /**
+   * Create a new application
+   */
+  async create(
+    request: operations.ApplicationsControllerCreateRequest,
+    options?: RequestOptions,
+  ): Promise<models.ApplicationResponseDto> {
+    return unwrapAsync(applicationsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all applications
+   */
+  async list(
+    request?: operations.ApplicationsControllerFindAllRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ApplicationsControllerFindAllResponse,
+      { cursor: string }
+    >
+  > {
+    return unwrapResultIterator(applicationsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve an application by ID
+   */
+  async get(
+    request: operations.ApplicationsControllerFindOneRequest,
+    options?: RequestOptions,
+  ): Promise<models.ApplicationResponseDto> {
+    return unwrapAsync(applicationsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update an application by ID
+   */
+  async update(
+    request: operations.ApplicationsControllerUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<models.ApplicationResponseDto> {
+    return unwrapAsync(applicationsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Submit application for processing
+   *
+   * @remarks
+   * Initiates the application submission workflow. This may trigger validations, notifications, and external API calls. The application status will be updated once processing completes.
+   */
+  async submit(
+    request: operations.ApplicationsControllerSubmitApplicationRequest,
+    options?: RequestOptions,
+  ): Promise<models.ApplicationResponseDto> {
+    return unwrapAsync(applicationsSubmit(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Approve application directly
+   *
+   * @remarks
+   * Approves a DRAFT application and queues a direct approval workflow.
+   */
+  async approve(
+    request: operations.ApplicationsControllerApproveApplicationRequest,
+    options?: RequestOptions,
+  ): Promise<models.ApplicationResponseDto> {
+    return unwrapAsync(applicationsApprove(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get transactions report URL for an application
+   *
+   * @remarks
+   * Retrieves the URL to access the transactions report for a specific application.
+   */
+  async getTransactionsReportUrl(
+    request: operations.ApplicationsControllerGetTransactionsReportUrlRequest,
+    options?: RequestOptions,
+  ): Promise<models.TransactionsReportResponseDto> {
+    return unwrapAsync(applicationsGetTransactionsReportUrl(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/businesses.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { businessesBusinessesControllerGetBusinessBalance } from "../funcs/businessesBusinessesControllerGetBusinessBalance.js";
 import { businessesCreate } from "../funcs/businessesCreate.js";
 import { businessesCreateBulk } from "../funcs/businessesCreateBulk.js";
 import { businessesDelete } from "../funcs/businessesDelete.js";
@@ -162,13 +163,30 @@ export class Businesses extends ClientSDK {
     ));
   }
 
+  /**
+   * Get business balance across all programs
+   *
+   * @remarks
+   * Retrieves the current outstanding balance and loan details for a business across all programs associated with the partner.
+   */
+  async getBalance(
+    request: operations.BusinessesControllerGetAllBusinessBalancesRequest,
+    options?: RequestOptions,
+  ): Promise<models.BusinessBalanceSummaryDto> {
+    return unwrapAsync(businessesGetBalance(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get business balance for a specific program
    *
    * @remarks
    * Retrieves the current outstanding balance and loan details for a business under a specific program. This includes principal balance, fees, repayment information, and loan status details.
    */
-  async getBalance(
+  async businessesControllerGetBusinessBalance(
     request: operations.BusinessesControllerGetBusinessBalanceRequest,
     options?: RequestOptions,
   ): Promise<
@@ -177,11 +195,13 @@ export class Businesses extends ClientSDK {
       { cursor: string }
     >
   > {
-    return unwrapResultIterator(businessesGetBalance(
-      this,
-      request,
-      options,
-    ));
+    return unwrapResultIterator(
+      businessesBusinessesControllerGetBusinessBalance(
+        this,
+        request,
+        options,
+      ),
+    );
   }
 
   /**

package/src/sdk/increasetransactions.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { increaseTransactionsList } from "../funcs/increaseTransactionsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class IncreaseTransactions extends ClientSDK {
+  /**
+   * List increase transactions
+   *
+   * @remarks
+   * Retrieve a paginated list of increase transactions for a specific beneficiary with filtering, sorting, and search capabilities.
+   */
+  async list(
+    request:
+      operations.IncreaseTransactionsControllerListIncreaseTransactionsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.IncreaseTransactionsControllerListIncreaseTransactionsResponse,
+      { cursor: string }
+    >
+  > {
+    return unwrapResultIterator(increaseTransactionsList(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -3,7 +3,9 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { AcceptanceTerms } from "./acceptanceterms.js";
 import { ApplicationFiles } from "./applicationfiles.js";
+import { Applications } from "./applications.js";
 import { Authentication } from "./authentication.js";
 import { Businesses } from "./businesses.js";
 import { BusinessFiles } from "./businessfiles.js";
@@ -15,6 +17,7 @@ import { Embed } from "./embed.js";
 import { Files } from "./files.js";
 import { FinancialAccounts } from "./financialaccounts.js";
 import { Holds } from "./holds.js";
+import { IncreaseTransactions } from "./increasetransactions.js";
 import { Originations } from "./originations.js";
 import { PaymentIntents } from "./paymentintents.js";
 import { Payments } from "./payments.js";
@@ -27,6 +30,7 @@ import { Platforms } from "./platforms.js";
 import { PlatformSettings } from "./platformsettings.js";
 import { Programs } from "./programs.js";
 import { ProgramSettings } from "./programsettings.js";
+import { UnderwritingTerms } from "./underwritingterms.js";
 import { Users } from "./users.js";
 // #region imports
 import type { SDKOptions } from "../lib/config.js";
@@ -60,6 +64,11 @@ export class OatFiSDK extends ClientSDK {
     return (this._businessPersons ??= new BusinessPersons(this._options));
   }
 
+  private _applications?: Applications;
+  get applications(): Applications {
+    return (this._applications ??= new Applications(this._options));
+  }
+
   private _embed?: Embed;
   get embed(): Embed {
     return (this._embed ??= new Embed(this._options));
@@ -119,6 +128,13 @@ export class OatFiSDK extends ClientSDK {
     return (this._businessHolds ??= new BusinessHolds(this._options));
   }
 
+  private _increaseTransactions?: IncreaseTransactions;
+  get increaseTransactions(): IncreaseTransactions {
+    return (this._increaseTransactions ??= new IncreaseTransactions(
+      this._options,
+    ));
+  }
+
   private _payments?: Payments;
   get payments(): Payments {
     return (this._payments ??= new Payments(this._options));
@@ -166,11 +182,21 @@ export class OatFiSDK extends ClientSDK {
     return (this._programSettings ??= new ProgramSettings(this._options));
   }
 
+  private _underwritingTerms?: UnderwritingTerms;
+  get underwritingTerms(): UnderwritingTerms {
+    return (this._underwritingTerms ??= new UnderwritingTerms(this._options));
+  }
+
   private _users?: Users;
   get users(): Users {
     return (this._users ??= new Users(this._options));
   }
 
+  private _acceptanceTerms?: AcceptanceTerms;
+  get acceptanceTerms(): AcceptanceTerms {
+    return (this._acceptanceTerms ??= new AcceptanceTerms(this._options));
+  }
+
   // #region sdk-class-body
 
   /**

package/src/sdk/underwritingterms.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { underwritingTermsGetHtml } from "../funcs/underwritingTermsGetHtml.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 UnderwritingTerms extends ClientSDK {
+  /**
+   * Get underwriting terms HTML
+   *
+   * @remarks
+   * Retrieves the rendered HTML content for underwriting terms given a business and loan program.
+   */
+  async getHtml(
+    request:
+      operations.UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest,
+    options?: RequestOptions,
+  ): Promise<models.UnderwritingTermsHtmlResponseDto> {
+    return unwrapAsync(underwritingTermsGetHtml(
+      this,
+      request,
+      options,
+    ));
+  }
+}