@oatfi/oatfi-sdk-ts 0.11.63 → 0.11.65

package/src/models/increaseaccountstatement.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";
+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 IncreaseAccountStatement = {
+  /**
+   * The ID of the account statement
+   */
+  id: string;
+  /**
+   * Type of the resource
+   */
+  object: string;
+  /**
+   * The ID of the account
+   */
+  accountId: string;
+  /**
+   * The date the account statement was created
+   */
+  createdAt: string;
+  /**
+   * The ID of the file
+   */
+  fileId: string;
+  /**
+   * The start date of the statement period
+   */
+  statementPeriodStart: string;
+  /**
+   * The end date of the statement period
+   */
+  statementPeriodEnd: string;
+  /**
+   * The starting balance of the account statement
+   */
+  startingBalance: number;
+  /**
+   * The ending balance of the account statement
+   */
+  endingBalance: number;
+  /**
+   * The type of the account statement
+   */
+  type: string;
+};
+
+/** @internal */
+export const IncreaseAccountStatement$inboundSchema: z.ZodType<
+  IncreaseAccountStatement,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  account_id: types.string(),
+  created_at: types.string(),
+  file_id: types.string(),
+  statement_period_start: types.string(),
+  statement_period_end: types.string(),
+  starting_balance: types.number(),
+  ending_balance: types.number(),
+  type: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "account_id": "accountId",
+    "created_at": "createdAt",
+    "file_id": "fileId",
+    "statement_period_start": "statementPeriodStart",
+    "statement_period_end": "statementPeriodEnd",
+    "starting_balance": "startingBalance",
+    "ending_balance": "endingBalance",
+  });
+});
+
+export function increaseAccountStatementFromJSON(
+  jsonString: string,
+): SafeParseResult<IncreaseAccountStatement, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IncreaseAccountStatement$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IncreaseAccountStatement' from JSON`,
+  );
+}

package/src/models/increasetransactiondto.ts

@@ -29,7 +29,7 @@ export type IncreaseTransactionDto = {
   /**
    * Transaction ID from Increase
    */
-  transaction: string;
+  transactionId: string;
   /**
    * Current status of the transaction
    */
@@ -96,7 +96,7 @@ export const IncreaseTransactionDto$inboundSchema: z.ZodType<
 > = z.object({
   object: types.string(),
   id: types.string(),
-  transaction: types.string(),
+  transaction_id: types.string(),
   status: types.string(),
   transaction_status: types.string(),
   beneficiary_id: types.string(),
@@ -115,6 +115,7 @@ export const IncreaseTransactionDto$inboundSchema: z.ZodType<
   ),
 }).transform((v) => {
   return remap$(v, {
+    "transaction_id": "transactionId",
     "transaction_status": "transactionStatus",
     "beneficiary_id": "beneficiaryId",
     "originator_id": "originatorId",

package/src/models/index.ts

@@ -49,6 +49,7 @@ export * from "./createplatformsettingsdto.js";
 export * from "./createportfoliodto.js";
 export * from "./createprogramdto.js";
 export * from "./createprogramsettingdto.js";
+export * from "./createsupplementaldatadto.js";
 export * from "./customertype.js";
 export * from "./delaybatchtimeframedto.js";
 export * from "./delayfundingconfigdto.js";
@@ -75,6 +76,7 @@ export * from "./getvirtualaccountinformationresponsedto.js";
 export * from "./holdreleasebalanceupdaterequest.js";
 export * from "./holdresponsedto.js";
 export * from "./holdsettingsdto.js";
+export * from "./increaseaccountstatement.js";
 export * from "./increasedatadto.js";
 export * from "./increasefilelink.js";
 export * from "./increasetransactiondto.js";
@@ -150,6 +152,7 @@ export * from "./spendcapacityenum.js";
 export * from "./startunderwritingdto.js";
 export * from "./statusruledto.js";
 export * from "./statusruleresponsedto.js";
+export * from "./supplementaldataresponsedto.js";
 export * from "./termssettingsdto.js";
 export * from "./termssettingsrecipientdto.js";
 export * from "./transactionsettingsdto.js";

package/src/models/operations/businessescontrollercreatesupplementaldata.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 BusinessesControllerCreateSupplementalDataRequest = {
+  /**
+   * The ID of the business
+   */
+  id: string;
+  /**
+   * Unique key for idempotency
+   */
+  idempotencyKey: string;
+  createSupplementalDataDto: models.CreateSupplementalDataDto;
+};
+
+/** @internal */
+export type BusinessesControllerCreateSupplementalDataRequest$Outbound = {
+  id: string;
+  "Idempotency-Key": string;
+  CreateSupplementalDataDto: models.CreateSupplementalDataDto$Outbound;
+};
+
+/** @internal */
+export const BusinessesControllerCreateSupplementalDataRequest$outboundSchema:
+  z.ZodType<
+    BusinessesControllerCreateSupplementalDataRequest$Outbound,
+    z.ZodTypeDef,
+    BusinessesControllerCreateSupplementalDataRequest
+  > = z.object({
+    id: z.string(),
+    idempotencyKey: z.string(),
+    createSupplementalDataDto: models.CreateSupplementalDataDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "Idempotency-Key",
+      createSupplementalDataDto: "CreateSupplementalDataDto",
+    });
+  });
+
+export function businessesControllerCreateSupplementalDataRequestToJSON(
+  businessesControllerCreateSupplementalDataRequest:
+    BusinessesControllerCreateSupplementalDataRequest,
+): string {
+  return JSON.stringify(
+    BusinessesControllerCreateSupplementalDataRequest$outboundSchema.parse(
+      businessesControllerCreateSupplementalDataRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -17,6 +17,7 @@ export * from "./applicationscontrollersubmitapplication.js";
 export * from "./applicationscontrollerupdate.js";
 export * from "./businessescontrollercreate.js";
 export * from "./businessescontrollercreatebulk.js";
+export * from "./businessescontrollercreatesupplementaldata.js";
 export * from "./businessescontrollerfindall.js";
 export * from "./businessescontrollerfindone.js";
 export * from "./businessescontrollergetaccountholderinformation.js";

package/src/models/originationbalancedto.ts

@@ -41,7 +41,7 @@ export type OriginationBalanceDto = {
   /**
    * Identifier for the associated payment intent
    */
-  paymentIntent?: string | undefined;
+  paymentIntentId?: string | undefined;
   /**
    * Current status of the origination
    */
@@ -72,7 +72,7 @@ export const OriginationBalanceDto$inboundSchema: z.ZodType<
   due_date: types.number(),
   outstanding_balance: OutstandingBalanceDto$inboundSchema,
   repaid_amount: types.number(),
-  payment_intent: types.optional(types.string()),
+  payment_intent_id: types.optional(types.string()),
   status: types.string(),
   sub_status: types.string(),
   next_installment_due_date: types.optional(types.number()),
@@ -83,7 +83,7 @@ export const OriginationBalanceDto$inboundSchema: z.ZodType<
     "due_date": "dueDate",
     "outstanding_balance": "outstandingBalance",
     "repaid_amount": "repaidAmount",
-    "payment_intent": "paymentIntent",
+    "payment_intent_id": "paymentIntentId",
     "sub_status": "subStatus",
     "next_installment_due_date": "nextInstallmentDueDate",
     "next_installment_amount": "nextInstallmentAmount",

package/src/models/paymentintentresponsedto.ts

@@ -44,7 +44,7 @@ export type PaymentIntentResponseDto = {
   /**
    * Identifier of the associated partner (platform in V2).
    */
-  platform?: string | undefined;
+  platformId?: string | undefined;
   /**
    * Type of the payment intent.
    */
@@ -113,7 +113,7 @@ export const PaymentIntentResponseDto$inboundSchema: z.ZodType<
   object: types.string(),
   id: types.string(),
   external_id: types.optional(types.string()),
-  platform: types.optional(types.string()),
+  platform_id: types.optional(types.string()),
   type: types.optional(PaymentIntentResponseDtoType$inboundSchema),
   created_date: types.optional(types.date()),
   due_date: types.optional(types.date()),
@@ -130,6 +130,7 @@ export const PaymentIntentResponseDto$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "external_id": "externalId",
+    "platform_id": "platformId",
     "created_date": "createdDate",
     "due_date": "dueDate",
     "paid_on_date": "paidOnDate",

package/src/models/paymentraildatadto.ts

@@ -57,7 +57,7 @@ export type PaymentRailDataDto = {
   /**
    * Business ID
    */
-  business?: string | undefined;
+  businessId?: string | undefined;
   /**
    * Lockbox Address
    */
@@ -97,7 +97,7 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
   unit_account_id: types.optional(types.string()),
   swift_code: types.optional(types.string()),
   remittance_information: types.optional(types.string()),
-  business: types.optional(types.string()),
+  business_id: types.optional(types.string()),
   lockbox_address: types.optional(types.string()),
   account_number_id: types.optional(types.string()),
   oatfi_account_number: types.optional(types.string()),
@@ -116,6 +116,7 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
     "unit_account_id": "unitAccountId",
     "swift_code": "swiftCode",
     "remittance_information": "remittanceInformation",
+    "business_id": "businessId",
     "lockbox_address": "lockboxAddress",
     "account_number_id": "accountNumberId",
     "oatfi_account_number": "oatfiAccountNumber",
@@ -136,7 +137,7 @@ export type PaymentRailDataDto$Outbound = {
   unit_account_id?: string | undefined;
   swift_code?: string | undefined;
   remittance_information?: string | undefined;
-  business?: string | undefined;
+  business_id?: string | undefined;
   lockbox_address?: string | undefined;
   account_number_id?: string | undefined;
   oatfi_account_number?: string | undefined;
@@ -161,7 +162,7 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
   unitAccountId: z.string().optional(),
   swiftCode: z.string().optional(),
   remittanceInformation: z.string().optional(),
-  business: z.string().optional(),
+  businessId: z.string().optional(),
   lockboxAddress: z.string().optional(),
   accountNumberId: z.string().optional(),
   oatfiAccountNumber: z.string().optional(),
@@ -180,6 +181,7 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
     unitAccountId: "unit_account_id",
     swiftCode: "swift_code",
     remittanceInformation: "remittance_information",
+    businessId: "business_id",
     lockboxAddress: "lockbox_address",
     accountNumberId: "account_number_id",
     oatfiAccountNumber: "oatfi_account_number",

package/src/models/platformcomponentsdto.ts

@@ -3,6 +3,7 @@
  */
 
 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";
@@ -17,7 +18,7 @@ export type PlatformComponentsDto = {
   /**
    * Platform ID
    */
-  platform: string;
+  platformId: string;
   /**
    * Resource type
    */
@@ -55,10 +56,14 @@ export const PlatformComponentsDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  platform: types.string(),
+  platform_id: types.string(),
   object: types.string(),
   id: types.string(),
   data: z.lazy(() => PlatformComponentsDtoData$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "platform_id": "platformId",
+  });
 });
 
 export function platformComponentsDtoFromJSON(

package/src/models/startunderwritingdto.ts

@@ -3,12 +3,13 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
 
 export type StartUnderwritingDto = {
   /**
    * The ID of the program to use for underwriting
    */
-  program: string;
+  programId: string;
   /**
    * Optional source identifier for the underwriting request
    */
@@ -17,7 +18,7 @@ export type StartUnderwritingDto = {
 
 /** @internal */
 export type StartUnderwritingDto$Outbound = {
-  program: string;
+  program_id: string;
   source?: string | undefined;
 };
 
@@ -27,8 +28,12 @@ export const StartUnderwritingDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StartUnderwritingDto
 > = z.object({
-  program: z.string(),
+  programId: z.string(),
   source: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    programId: "program_id",
+  });
 });
 
 export function startUnderwritingDtoToJSON(

package/src/models/supplementaldataresponsedto.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";
+
+/**
+ * Data source
+ */
+export const SupplementalDataResponseDtoSource = {
+  Plaid: "PLAID",
+  Codat: "CODAT",
+  TaktileResponse: "TAKTILE_RESPONSE",
+  TaktileRequest: "TAKTILE_REQUEST",
+  Transcredit: "TRANSCREDIT",
+  TranscreditScores: "TRANSCREDIT_SCORES",
+  Heron: "HERON",
+  HeronPdf: "HERON_PDF",
+  OpenBanking: "OPEN_BANKING",
+  Alloy: "ALLOY",
+  CodatBalanceSheet: "CODAT_BALANCE_SHEET",
+  CodatAccountBalance: "CODAT_ACCOUNT_BALANCE",
+  CodatBankingTransactions: "CODAT_BANKING_TRANSACTIONS",
+  CodatPl: "CODAT_PL",
+  CodatAgedCreditor: "CODAT_AGED_CREDITOR",
+  CodatAgedDebtor: "CODAT_AGED_DEBTOR",
+  QuickbooksBalanceSheet: "QUICKBOOKS_BALANCE_SHEET",
+  QuickbooksPl: "QUICKBOOKS_PL",
+  FinancialStatementMetrics: "FINANCIAL_STATEMENT_METRICS",
+  PdfBalanceSheet: "PDF_BALANCE_SHEET",
+  PdfProfitLoss: "PDF_PROFIT_LOSS",
+  StripeFinancialConnectionsBalance: "STRIPE_FINANCIAL_CONNECTIONS_BALANCE",
+  StripeFinancialConnectionsTransactions:
+    "STRIPE_FINANCIAL_CONNECTIONS_TRANSACTIONS",
+} as const;
+/**
+ * Data source
+ */
+export type SupplementalDataResponseDtoSource = ClosedEnum<
+  typeof SupplementalDataResponseDtoSource
+>;
+
+/**
+ * Processing status
+ */
+export const SupplementalDataResponseDtoStatus = {
+  Pending: "PENDING",
+  Success: "SUCCESS",
+  Error: "ERROR",
+  TimeOut: "TIME_OUT",
+} as const;
+/**
+ * Processing status
+ */
+export type SupplementalDataResponseDtoStatus = ClosedEnum<
+  typeof SupplementalDataResponseDtoStatus
+>;
+
+export type SupplementalDataResponseDto = {
+  /**
+   * Unique identifier
+   */
+  id: string;
+  /**
+   * Object type
+   */
+  object: string;
+  /**
+   * Business ID
+   */
+  business: string;
+  /**
+   * Data source
+   */
+  source: SupplementalDataResponseDtoSource;
+  /**
+   * Processing status
+   */
+  status: SupplementalDataResponseDtoStatus;
+  /**
+   * Creation timestamp
+   */
+  createdAt: Date;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const SupplementalDataResponseDtoSource$inboundSchema: z.ZodNativeEnum<
+  typeof SupplementalDataResponseDtoSource
+> = z.nativeEnum(SupplementalDataResponseDtoSource);
+
+/** @internal */
+export const SupplementalDataResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof SupplementalDataResponseDtoStatus
+> = z.nativeEnum(SupplementalDataResponseDtoStatus);
+
+/** @internal */
+export const SupplementalDataResponseDto$inboundSchema: z.ZodType<
+  SupplementalDataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  business: types.string(),
+  source: SupplementalDataResponseDtoSource$inboundSchema,
+  status: SupplementalDataResponseDtoStatus$inboundSchema,
+  created_at: types.date(),
+  updated_at: types.date(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function supplementalDataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SupplementalDataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SupplementalDataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SupplementalDataResponseDto' from JSON`,
+  );
+}

package/src/models/underwritingresponsedto.ts

@@ -97,11 +97,11 @@ export type UnderwritingResponseDto = {
   /**
    * The ID of the business that was underwritten
    */
-  business?: string | undefined;
+  businessId?: string | undefined;
   /**
    * The ID of the program used for underwriting
    */
-  program?: string | undefined;
+  programId?: string | undefined;
   /**
    * The current status of the underwriting process
    */
@@ -183,8 +183,8 @@ export const UnderwritingResponseDto$inboundSchema: z.ZodType<
 > = z.object({
   object: types.string(),
   id: types.string(),
-  business: types.optional(types.string()),
-  program: types.optional(types.string()),
+  business_id: types.optional(types.string()),
+  program_id: types.optional(types.string()),
   status: types.optional(UnderwritingResponseDtoStatus$inboundSchema),
   message: types.optional(types.string()),
   credit_limit: types.optional(types.number()),
@@ -200,6 +200,8 @@ export const UnderwritingResponseDto$inboundSchema: z.ZodType<
   updated_at: types.optional(types.string()),
 }).transform((v) => {
   return remap$(v, {
+    "business_id": "businessId",
+    "program_id": "programId",
     "credit_limit": "creditLimit",
     "available_to_accelerate": "availableToAccelerate",
     "acceleration_fee": "accelerationFee",

package/src/models/underwritingstatusdto.ts

@@ -55,11 +55,11 @@ export type UnderwritingStatusDto = {
   /**
    * The ID of the business
    */
-  business: string;
+  businessId: string;
   /**
    * The ID of the program
    */
-  program: string;
+  programId: string;
   /**
    * The current underwriting status
    */
@@ -149,8 +149,8 @@ export const UnderwritingStatusDto$inboundSchema: z.ZodType<
 > = z.object({
   id: types.string(),
   object: types.string().default("underwriting_status"),
-  business: types.string(),
-  program: types.string(),
+  business_id: types.string(),
+  program_id: types.string(),
   status: UnderwritingStatusDtoStatus$inboundSchema,
   credit_limit: types.optional(types.number()),
   shared_credit_limit: types.optional(types.number()),
@@ -163,6 +163,8 @@ export const UnderwritingStatusDto$inboundSchema: z.ZodType<
   underwriting_terms_web_url: types.optional(types.string()),
 }).transform((v) => {
   return remap$(v, {
+    "business_id": "businessId",
+    "program_id": "programId",
     "credit_limit": "creditLimit",
     "shared_credit_limit": "sharedCreditLimit",
     "kyb_decision": "kybDecision",

package/src/sdk/businesses.ts

@@ -16,6 +16,7 @@ import { businessesGetVirtualAccountInformation } from "../funcs/businessesGetVi
 import { businessesList } from "../funcs/businessesList.js";
 import { businessesSearch } from "../funcs/businessesSearch.js";
 import { businessesStartUnderwriting } from "../funcs/businessesStartUnderwriting.js";
+import { businessesSubmitSupplementalData } from "../funcs/businessesSubmitSupplementalData.js";
 import { businessesUpdate } from "../funcs/businessesUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
@@ -265,4 +266,21 @@ export class Businesses extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Submit supplemental data for a business
+   *
+   * @remarks
+   * Provides supplemental data used for underwriting a business. Data is processed by source-specific handlers.
+   */
+  async submitSupplementalData(
+    request: operations.BusinessesControllerCreateSupplementalDataRequest,
+    options?: RequestOptions,
+  ): Promise<models.SupplementalDataResponseDto> {
+    return unwrapAsync(businessesSubmitSupplementalData(
+      this,
+      request,
+      options,
+    ));
+  }
 }