@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.62

package/src/models/transactionsreportresponsedto.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 { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type TransactionsReportResponseDto = {
+  /**
+   * The URL to access the transactions report
+   */
+  reportUrl: string;
+  /**
+   * The ID of the application this report belongs to
+   */
+  applicationId: string;
+};
+
+/** @internal */
+export const TransactionsReportResponseDto$inboundSchema: z.ZodType<
+  TransactionsReportResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  report_url: z.string(),
+  application_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "report_url": "reportUrl",
+    "application_id": "applicationId",
+  });
+});
+
+export function transactionsReportResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionsReportResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionsReportResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionsReportResponseDto' from JSON`,
+  );
+}

package/src/models/underwritingresponsedto.ts

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

package/src/models/underwritingsettingsdto.ts

@@ -134,9 +134,9 @@ export type UnderwritingSettingsDto = {
    */
   contractualUccLien?: ContractualUccLien | undefined;
   /**
-   * Underwriting terms agreement ID
+   * Onboarding terms agreement ID
    */
-  uwTermsAgreement?: string | undefined;
+  onboardingTermsAgreement?: string | undefined;
   /**
    * Whether third party underwriting is enabled
    */
@@ -208,7 +208,7 @@ export const UnderwritingSettingsDto$inboundSchema: z.ZodType<
   auto_limit_decrease: z.boolean().optional(),
   min_revenue: z.number().optional(),
   contractual_ucc_lien: ContractualUccLien$inboundSchema.optional(),
-  uw_terms_agreement: z.string().optional(),
+  onboarding_terms_agreement: z.string().optional(),
   third_party_underwrite: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -226,7 +226,7 @@ export const UnderwritingSettingsDto$inboundSchema: z.ZodType<
     "auto_limit_decrease": "autoLimitDecrease",
     "min_revenue": "minRevenue",
     "contractual_ucc_lien": "contractualUccLien",
-    "uw_terms_agreement": "uwTermsAgreement",
+    "onboarding_terms_agreement": "onboardingTermsAgreement",
     "third_party_underwrite": "thirdPartyUnderwrite",
   });
 });
@@ -246,7 +246,7 @@ export type UnderwritingSettingsDto$Outbound = {
   auto_limit_decrease?: boolean | undefined;
   min_revenue?: number | undefined;
   contractual_ucc_lien?: string | undefined;
-  uw_terms_agreement?: string | undefined;
+  onboarding_terms_agreement?: string | undefined;
   third_party_underwrite?: boolean | undefined;
 };
 
@@ -270,7 +270,7 @@ export const UnderwritingSettingsDto$outboundSchema: z.ZodType<
   autoLimitDecrease: z.boolean().optional(),
   minRevenue: z.number().optional(),
   contractualUccLien: ContractualUccLien$outboundSchema.optional(),
-  uwTermsAgreement: z.string().optional(),
+  onboardingTermsAgreement: z.string().optional(),
   thirdPartyUnderwrite: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -288,7 +288,7 @@ export const UnderwritingSettingsDto$outboundSchema: z.ZodType<
     autoLimitDecrease: "auto_limit_decrease",
     minRevenue: "min_revenue",
     contractualUccLien: "contractual_ucc_lien",
-    uwTermsAgreement: "uw_terms_agreement",
+    onboardingTermsAgreement: "onboarding_terms_agreement",
     thirdPartyUnderwrite: "third_party_underwrite",
   });
 });

package/src/models/underwritingstatusdto.ts

@@ -5,12 +5,32 @@
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
-import {
-  UnderwriteStatus,
-  UnderwriteStatus$inboundSchema,
-} from "./underwritestatus.js";
+
+/**
+ * The current underwriting status
+ */
+export const UnderwritingStatusDtoStatus = {
+  Approved: "APPROVED",
+  ManualReview: "MANUAL_REVIEW",
+  ClosedNoDecision: "CLOSED_NO_DECISION",
+  ManualReviewDeclined: "MANUAL_REVIEW_DECLINED",
+  Rejected: "REJECTED",
+  Declined: "DECLINED",
+  Processing: "PROCESSING",
+  Error: "ERROR",
+  NotExecuted: "NOT_EXECUTED",
+  NA: "N/A",
+  Denied: "DENIED",
+} as const;
+/**
+ * The current underwriting status
+ */
+export type UnderwritingStatusDtoStatus = ClosedEnum<
+  typeof UnderwritingStatusDtoStatus
+>;
 
 /**
  * KYB decision details (only present for manual review statuses)
@@ -34,15 +54,15 @@ export type UnderwritingStatusDto = {
   /**
    * The ID of the business
    */
-  businessId: string;
+  business: string;
   /**
    * The ID of the program
    */
-  programId: string;
+  program: string;
   /**
    * The current underwriting status
    */
-  status: UnderwriteStatus;
+  status: UnderwritingStatusDtoStatus;
   /**
    * The credit limit amount (only present when status is approved)
    */
@@ -81,6 +101,11 @@ export type UnderwritingStatusDto = {
   underwritingTermsWebUrl?: string | undefined;
 };
 
+/** @internal */
+export const UnderwritingStatusDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof UnderwritingStatusDtoStatus
+> = z.nativeEnum(UnderwritingStatusDtoStatus);
+
 /** @internal */
 export const KybDecision$inboundSchema: z.ZodType<
   KybDecision,
@@ -123,9 +148,9 @@ export const UnderwritingStatusDto$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   object: z.string().default("underwriting_status"),
-  business_id: z.string(),
-  program_id: z.string(),
-  status: UnderwriteStatus$inboundSchema,
+  business: z.string(),
+  program: z.string(),
+  status: UnderwritingStatusDtoStatus$inboundSchema,
   credit_limit: z.number().optional(),
   shared_credit_limit: z.number().optional(),
   kyb_decision: z.lazy(() => KybDecision$inboundSchema).optional(),
@@ -137,8 +162,6 @@ export const UnderwritingStatusDto$inboundSchema: z.ZodType<
   underwriting_terms_web_url: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "business_id": "businessId",
-    "program_id": "programId",
     "credit_limit": "creditLimit",
     "shared_credit_limit": "sharedCreditLimit",
     "kyb_decision": "kybDecision",

package/src/models/underwritingtermshtmlresponsedto.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type UnderwritingTermsHtmlResponseDto = {
+  object: string;
+  /**
+   * HTML content for the underwriting terms
+   */
+  html: string;
+};
+
+/** @internal */
+export const UnderwritingTermsHtmlResponseDto$inboundSchema: z.ZodType<
+  UnderwritingTermsHtmlResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  html: z.string(),
+});
+
+export function underwritingTermsHtmlResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<UnderwritingTermsHtmlResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UnderwritingTermsHtmlResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnderwritingTermsHtmlResponseDto' from JSON`,
+  );
+}

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/updatebusinessdto.ts

@@ -4,37 +4,22 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
-import {
-  BusinessEntityEnum,
-  BusinessEntityEnum$outboundSchema,
-} from "./businessentityenum.js";
+import { ClosedEnum } from "../types/enums.js";
 import {
   BusinessMetadataDto,
   BusinessMetadataDto$Outbound,
   BusinessMetadataDto$outboundSchema,
 } from "./businessmetadatadto.js";
-import {
-  BusinessMonthEnum,
-  BusinessMonthEnum$outboundSchema,
-} from "./businessmonthenum.js";
 import {
   BusinessPaymentMethodDto,
   BusinessPaymentMethodDto$Outbound,
   BusinessPaymentMethodDto$outboundSchema,
 } from "./businesspaymentmethoddto.js";
-import {
-  OnboardingSource,
-  OnboardingSource$outboundSchema,
-} from "./onboardingsource.js";
 import {
   PlaidTokenDto,
   PlaidTokenDto$Outbound,
   PlaidTokenDto$outboundSchema,
 } from "./plaidtokendto.js";
-import {
-  RequestLimitSource,
-  RequestLimitSource$outboundSchema,
-} from "./requestlimitsource.js";
 
 /**
  * Business address information
@@ -66,6 +51,81 @@ export type UpdateBusinessDtoAddress = {
   country?: string | undefined;
 };
 
+/**
+ * Month the business started (e.g., January, February).
+ */
+export const UpdateBusinessDtoBusinessStartDateMonth = {
+  January: "January",
+  February: "February",
+  March: "March",
+  April: "April",
+  May: "May",
+  June: "June",
+  July: "July",
+  August: "August",
+  September: "September",
+  October: "October",
+  November: "November",
+  December: "December",
+} as const;
+/**
+ * Month the business started (e.g., January, February).
+ */
+export type UpdateBusinessDtoBusinessStartDateMonth = ClosedEnum<
+  typeof UpdateBusinessDtoBusinessStartDateMonth
+>;
+
+/**
+ * Legal entity type.
+ */
+export const UpdateBusinessDtoBusinessEntityType = {
+  Llc: "LLC",
+  SoleProprietor: "SOLE_PROPRIETOR",
+  Partnership: "PARTNERSHIP",
+  Corporation: "CORPORATION",
+  Cooperative: "COOPERATIVE",
+  NonProfit: "NON_PROFIT",
+  NotSure: "NOT_SURE",
+  NotRegisteredYet: "NOT_REGISTERED_YET",
+  Trusts: "TRUSTS",
+  UnincorporatedAssociations: "UNINCORPORATED_ASSOCIATIONS",
+} as const;
+/**
+ * Legal entity type.
+ */
+export type UpdateBusinessDtoBusinessEntityType = ClosedEnum<
+  typeof UpdateBusinessDtoBusinessEntityType
+>;
+
+/**
+ * Onboarding source
+ */
+export const UpdateBusinessDtoOnboardingSource = {
+  Api: "API",
+  Web: "WEB",
+  DropIn: "Drop-in",
+} as const;
+/**
+ * Onboarding source
+ */
+export type UpdateBusinessDtoOnboardingSource = ClosedEnum<
+  typeof UpdateBusinessDtoOnboardingSource
+>;
+
+/**
+ * Requested limit source
+ */
+export const UpdateBusinessDtoRequestedLimitSource = {
+  Partner: "Partner",
+  Customer: "Customer",
+} as const;
+/**
+ * Requested limit source
+ */
+export type UpdateBusinessDtoRequestedLimitSource = ClosedEnum<
+  typeof UpdateBusinessDtoRequestedLimitSource
+>;
+
 export type UpdateBusinessDto = {
   /**
    * External identifier for the business.
@@ -106,7 +166,7 @@ export type UpdateBusinessDto = {
   /**
    * Month the business started (e.g., January, February).
    */
-  businessStartDateMonth?: BusinessMonthEnum | undefined;
+  businessStartDateMonth?: UpdateBusinessDtoBusinessStartDateMonth | undefined;
   /**
    * Year the business started (YYYY).
    */
@@ -114,7 +174,7 @@ export type UpdateBusinessDto = {
   /**
    * Legal entity type.
    */
-  businessEntityType?: BusinessEntityEnum | undefined;
+  businessEntityType?: UpdateBusinessDtoBusinessEntityType | undefined;
   /**
    * Application ID.
    */
@@ -162,11 +222,11 @@ export type UpdateBusinessDto = {
   /**
    * Onboarding source
    */
-  onboardingSource?: OnboardingSource | undefined;
+  onboardingSource?: UpdateBusinessDtoOnboardingSource | undefined;
   /**
    * Requested limit source
    */
-  requestedLimitSource?: RequestLimitSource | undefined;
+  requestedLimitSource?: UpdateBusinessDtoRequestedLimitSource | undefined;
   /**
    * Requested credit limit amount
    */
@@ -219,6 +279,28 @@ export function updateBusinessDtoAddressToJSON(
   );
 }
 
+/** @internal */
+export const UpdateBusinessDtoBusinessStartDateMonth$outboundSchema:
+  z.ZodNativeEnum<typeof UpdateBusinessDtoBusinessStartDateMonth> = z
+    .nativeEnum(UpdateBusinessDtoBusinessStartDateMonth);
+
+/** @internal */
+export const UpdateBusinessDtoBusinessEntityType$outboundSchema:
+  z.ZodNativeEnum<typeof UpdateBusinessDtoBusinessEntityType> = z.nativeEnum(
+    UpdateBusinessDtoBusinessEntityType,
+  );
+
+/** @internal */
+export const UpdateBusinessDtoOnboardingSource$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateBusinessDtoOnboardingSource
+> = z.nativeEnum(UpdateBusinessDtoOnboardingSource);
+
+/** @internal */
+export const UpdateBusinessDtoRequestedLimitSource$outboundSchema:
+  z.ZodNativeEnum<typeof UpdateBusinessDtoRequestedLimitSource> = z.nativeEnum(
+    UpdateBusinessDtoRequestedLimitSource,
+  );
+
 /** @internal */
 export type UpdateBusinessDto$Outbound = {
   external_id?: string | undefined;
@@ -266,9 +348,11 @@ export const UpdateBusinessDto$outboundSchema: z.ZodType<
   contactLastName: z.string().optional(),
   contactEmail: z.string().optional(),
   contactPhone: z.string().optional(),
-  businessStartDateMonth: BusinessMonthEnum$outboundSchema.optional(),
+  businessStartDateMonth: UpdateBusinessDtoBusinessStartDateMonth$outboundSchema
+    .optional(),
   businessStartDateYear: z.string().optional(),
-  businessEntityType: BusinessEntityEnum$outboundSchema.optional(),
+  businessEntityType: UpdateBusinessDtoBusinessEntityType$outboundSchema
+    .optional(),
   application: z.string().optional(),
   users: z.array(z.string()).optional(),
   primaryUser: z.string().optional(),
@@ -280,8 +364,9 @@ export const UpdateBusinessDto$outboundSchema: z.ZodType<
   paymentSettings: z.array(BusinessPaymentMethodDto$outboundSchema).optional(),
   codatCompanyId: z.string().optional(),
   consumerInvoices: z.boolean().optional(),
-  onboardingSource: OnboardingSource$outboundSchema.optional(),
-  requestedLimitSource: RequestLimitSource$outboundSchema.optional(),
+  onboardingSource: UpdateBusinessDtoOnboardingSource$outboundSchema.optional(),
+  requestedLimitSource: UpdateBusinessDtoRequestedLimitSource$outboundSchema
+    .optional(),
   requestedCreditLimit: z.number().optional(),
   metadata: BusinessMetadataDto$outboundSchema.optional(),
   payoutPaymentMethod: z.string().optional(),