@oatfi/oatfi-sdk-ts 0.11.64 → 0.11.66

package/src/models/billingcycleconfigsresponsedto.ts

@@ -0,0 +1,112 @@
+/*
+ * 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";
+
+/**
+ * The billing cycle type.
+ */
+export const BillingCycleConfigsResponseDtoType = {
+  Duration: "DURATION",
+  Monthly: "MONTHLY",
+} as const;
+/**
+ * The billing cycle type.
+ */
+export type BillingCycleConfigsResponseDtoType = ClosedEnum<
+  typeof BillingCycleConfigsResponseDtoType
+>;
+
+export type BillingCycleConfigsResponseDto = {
+  /**
+   * The ID of the business billing cycle.
+   */
+  id: string;
+  /**
+   * The object type.
+   */
+  object: string;
+  /**
+   * The ID of the platform.
+   */
+  platform: string;
+  /**
+   * The ID of the business.
+   */
+  business: string;
+  /**
+   * The ID of the program.
+   */
+  program: string;
+  /**
+   * The billing cycle type.
+   */
+  type: BillingCycleConfigsResponseDtoType;
+  /**
+   * The start day of the billing cycle.
+   */
+  startDay: number;
+  /**
+   * Whether the billing cycle is active.
+   */
+  active: boolean;
+  /**
+   * The APR of the billing cycle.
+   */
+  apr: number;
+  /**
+   * The repayment duration in days.
+   */
+  repaymentDuration: number;
+  /**
+   * The ID of the billing cycle settings.
+   */
+  billingCycleSettings: string;
+};
+
+/** @internal */
+export const BillingCycleConfigsResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof BillingCycleConfigsResponseDtoType
+> = z.nativeEnum(BillingCycleConfigsResponseDtoType);
+
+/** @internal */
+export const BillingCycleConfigsResponseDto$inboundSchema: z.ZodType<
+  BillingCycleConfigsResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  platform: types.string(),
+  business: types.string(),
+  program: types.string(),
+  type: BillingCycleConfigsResponseDtoType$inboundSchema,
+  start_day: types.number(),
+  active: types.boolean(),
+  apr: types.number(),
+  repayment_duration: types.number(),
+  billing_cycle_settings: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "start_day": "startDay",
+    "repayment_duration": "repaymentDuration",
+    "billing_cycle_settings": "billingCycleSettings",
+  });
+});
+
+export function billingCycleConfigsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BillingCycleConfigsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BillingCycleConfigsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingCycleConfigsResponseDto' from JSON`,
+  );
+}

package/src/models/billingcyclesresponsedto.ts

@@ -0,0 +1,146 @@
+/*
+ * 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";
+
+/**
+ * The status of the billing cycle.
+ */
+export const BillingCyclesResponseDtoStatus = {
+  Open: "OPEN",
+  Closed: "CLOSED",
+} as const;
+/**
+ * The status of the billing cycle.
+ */
+export type BillingCyclesResponseDtoStatus = ClosedEnum<
+  typeof BillingCyclesResponseDtoStatus
+>;
+
+export type BillingCyclesResponseDto = {
+  /**
+   * The ID of the billing cycle.
+   */
+  id: string;
+  /**
+   * The object type.
+   */
+  object: string;
+  /**
+   * The start date of the billing cycle.
+   */
+  startDate: Date;
+  /**
+   * The end date of the billing cycle.
+   */
+  endDate: Date;
+  /**
+   * The due date of the billing cycle.
+   */
+  dueDate: Date;
+  /**
+   * The outstanding balance of the billing cycle.
+   */
+  outstandingBalance: number;
+  /**
+   * The opening balance of the billing cycle.
+   */
+  openingBalance: number;
+  /**
+   * The status of the billing cycle.
+   */
+  status: BillingCyclesResponseDtoStatus;
+  /**
+   * The total late fees of the billing cycle.
+   */
+  totalLateFees: number;
+  /**
+   * The cycle number of the billing cycle.
+   */
+  cycleNumber: number;
+  /**
+   * The ID of the business.
+   */
+  business: string;
+  /**
+   * The ID of the billing cycle config.
+   */
+  billingCycleConfig: string;
+  /**
+   * The fee amount of the billing cycle.
+   */
+  feeAmount: number;
+  /**
+   * The principal balance of the billing cycle.
+   */
+  principalBalance: number;
+  /**
+   * The due interest of the billing cycle.
+   */
+  dueInterest: number;
+  /**
+   * The unreported total late fees of the billing cycle.
+   */
+  unreportedTotalLateFees: number;
+};
+
+/** @internal */
+export const BillingCyclesResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof BillingCyclesResponseDtoStatus
+> = z.nativeEnum(BillingCyclesResponseDtoStatus);
+
+/** @internal */
+export const BillingCyclesResponseDto$inboundSchema: z.ZodType<
+  BillingCyclesResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.string(),
+  object: types.string(),
+  start_date: types.date(),
+  end_date: types.date(),
+  due_date: types.date(),
+  outstanding_balance: types.number(),
+  opening_balance: types.number(),
+  status: BillingCyclesResponseDtoStatus$inboundSchema,
+  total_late_fees: types.number(),
+  cycle_number: types.number(),
+  business: types.string(),
+  billing_cycle_config: types.string(),
+  fee_amount: types.number(),
+  principal_balance: types.number(),
+  due_interest: types.number(),
+  unreported_total_late_fees: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "start_date": "startDate",
+    "end_date": "endDate",
+    "due_date": "dueDate",
+    "outstanding_balance": "outstandingBalance",
+    "opening_balance": "openingBalance",
+    "total_late_fees": "totalLateFees",
+    "cycle_number": "cycleNumber",
+    "billing_cycle_config": "billingCycleConfig",
+    "fee_amount": "feeAmount",
+    "principal_balance": "principalBalance",
+    "due_interest": "dueInterest",
+    "unreported_total_late_fees": "unreportedTotalLateFees",
+  });
+});
+
+export function billingCyclesResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BillingCyclesResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BillingCyclesResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingCyclesResponseDto' from JSON`,
+  );
+}

package/src/models/businessbalancedto.ts

@@ -25,11 +25,11 @@ export type BusinessBalanceDto = {
   /**
    * Business identifier
    */
-  business: string;
+  businessId: string;
   /**
    * Program identifier
    */
-  program: string;
+  programId: string;
   /**
    * Total available credit limit in cents
    */
@@ -64,8 +64,8 @@ export const BusinessBalanceDto$inboundSchema: z.ZodType<
 > = z.object({
   object: types.string().default("business_balance"),
   id: types.string(),
-  business: types.string(),
-  program: types.string(),
+  business_id: types.string(),
+  program_id: types.string(),
   total_available_credit_limit: types.number(),
   total_loans: types.number(),
   originations: z.array(OriginationBalanceDto$inboundSchema),
@@ -74,6 +74,8 @@ export const BusinessBalanceDto$inboundSchema: z.ZodType<
   metadata: types.optional(z.record(z.any())),
 }).transform((v) => {
   return remap$(v, {
+    "business_id": "businessId",
+    "program_id": "programId",
     "total_available_credit_limit": "totalAvailableCreditLimit",
     "total_loans": "totalLoans",
     "created_at": "createdAt",

package/src/models/businessbalancesummarydto.ts

@@ -25,7 +25,7 @@ export type BusinessBalanceSummaryDto = {
   /**
    * Business identifier
    */
-  business: string;
+  businessId: string;
   /**
    * Balance breakdown by product type
    */
@@ -48,12 +48,13 @@ export const BusinessBalanceSummaryDto$inboundSchema: z.ZodType<
 > = z.object({
   object: types.string(),
   id: types.string(),
-  business: types.string(),
+  business_id: types.string(),
   balance_by_product: BalanceByProductDto$inboundSchema,
   created_at: types.string(),
   updated_at: types.string(),
 }).transform((v) => {
   return remap$(v, {
+    "business_id": "businessId",
     "balance_by_product": "balanceByProduct",
     "created_at": "createdAt",
     "updated_at": "updatedAt",

package/src/models/createbillingcycleconfigsdto.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 CreateBillingCycleConfigsDto = {
+  /**
+   * The repayment duration of the billing cycle.
+   */
+  repaymentDuration?: number | undefined;
+  /**
+   * The start day of the billing cycle.
+   */
+  startDay?: number | undefined;
+  /**
+   * The ID of the billing cycle configuration.
+   */
+  billingCycleConfig?: string | undefined;
+  /**
+   * The ID of the loan program.
+   */
+  program?: string | undefined;
+};
+
+/** @internal */
+export type CreateBillingCycleConfigsDto$Outbound = {
+  repayment_duration?: number | undefined;
+  start_day?: number | undefined;
+  billing_cycle_config?: string | undefined;
+  program?: string | undefined;
+};
+
+/** @internal */
+export const CreateBillingCycleConfigsDto$outboundSchema: z.ZodType<
+  CreateBillingCycleConfigsDto$Outbound,
+  z.ZodTypeDef,
+  CreateBillingCycleConfigsDto
+> = z.object({
+  repaymentDuration: z.number().optional(),
+  startDay: z.number().optional(),
+  billingCycleConfig: z.string().optional(),
+  program: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    repaymentDuration: "repayment_duration",
+    startDay: "start_day",
+    billingCycleConfig: "billing_cycle_config",
+  });
+});
+
+export function createBillingCycleConfigsDtoToJSON(
+  createBillingCycleConfigsDto: CreateBillingCycleConfigsDto,
+): string {
+  return JSON.stringify(
+    CreateBillingCycleConfigsDto$outboundSchema.parse(
+      createBillingCycleConfigsDto,
+    ),
+  );
+}

package/src/models/createdailyreportdto.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 CreateDailyReportDto = {
+  /**
+   * The program ID.
+   */
+  program: string;
+  /**
+   * The business ID.
+   */
+  business: string;
+  /**
+   * The daily spend amount in cents. Must be >= 0.
+   */
+  dailySpend: number;
+  /**
+   * The billing cycle outstanding balance in cents. Must be >= 0.
+   */
+  billingCycleOutstandingBalance?: number | undefined;
+  /**
+   * The late fees amount in cents. Must be >= 0.
+   */
+  lateFees?: number | undefined;
+  /**
+   * The repayment amount in cents. Must be >= 0.
+   */
+  repaymentAmount: number;
+  /**
+   * The date of the daily report in YYYY-MM-DD format.
+   */
+  date: string;
+};
+
+/** @internal */
+export type CreateDailyReportDto$Outbound = {
+  program: string;
+  business: string;
+  daily_spend: number;
+  billing_cycle_outstanding_balance?: number | undefined;
+  late_fees?: number | undefined;
+  repayment_amount: number;
+  date: string;
+};
+
+/** @internal */
+export const CreateDailyReportDto$outboundSchema: z.ZodType<
+  CreateDailyReportDto$Outbound,
+  z.ZodTypeDef,
+  CreateDailyReportDto
+> = z.object({
+  program: z.string(),
+  business: z.string(),
+  dailySpend: z.number(),
+  billingCycleOutstandingBalance: z.number().optional(),
+  lateFees: z.number().optional(),
+  repaymentAmount: z.number(),
+  date: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    dailySpend: "daily_spend",
+    billingCycleOutstandingBalance: "billing_cycle_outstanding_balance",
+    lateFees: "late_fees",
+    repaymentAmount: "repayment_amount",
+  });
+});
+
+export function createDailyReportDtoToJSON(
+  createDailyReportDto: CreateDailyReportDto,
+): string {
+  return JSON.stringify(
+    CreateDailyReportDto$outboundSchema.parse(createDailyReportDto),
+  );
+}

package/src/models/createoriginationofferdto.ts

@@ -14,15 +14,15 @@ export type CreateOriginationOfferDto = {
   /**
    * The program identifier
    */
-  program: string;
+  programId: string;
   /**
    * The business identifier
    */
-  business: string;
+  businessId: string;
   /**
    * The platform identifier
    */
-  platform?: string | undefined;
+  platformId?: string | undefined;
   /**
    * Down payment due date
    */
@@ -54,7 +54,7 @@ export type CreateOriginationOfferDto = {
   /**
    * ID of the payment intent related to this offer
    */
-  paymentIntent?: string | undefined;
+  paymentIntentId?: string | undefined;
   /**
    * The due date timestamp
    */
@@ -91,9 +91,9 @@ export function createOriginationOfferDtoMetadataToJSON(
 
 /** @internal */
 export type CreateOriginationOfferDto$Outbound = {
-  program: string;
-  business: string;
-  platform?: string | undefined;
+  program_id: string;
+  business_id: string;
+  platform_id?: string | undefined;
   down_payment_due_date?: string | undefined;
   installments_start_date?: string | undefined;
   payment_day_of_week?: string | undefined;
@@ -101,7 +101,7 @@ export type CreateOriginationOfferDto$Outbound = {
   number_of_installments?: number | undefined;
   hold_id?: string | undefined;
   amount?: number | undefined;
-  payment_intent?: string | undefined;
+  payment_intent_id?: string | undefined;
   due_date?: number | undefined;
   repayment_date?: number | undefined;
   metadata?: CreateOriginationOfferDtoMetadata$Outbound | undefined;
@@ -113,9 +113,9 @@ export const CreateOriginationOfferDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateOriginationOfferDto
 > = z.object({
-  program: z.string(),
-  business: z.string(),
-  platform: z.string().optional(),
+  programId: z.string(),
+  businessId: z.string(),
+  platformId: z.string().optional(),
   downPaymentDueDate: z.string().optional(),
   installmentsStartDate: z.string().optional(),
   paymentDayOfWeek: z.string().optional(),
@@ -123,19 +123,22 @@ export const CreateOriginationOfferDto$outboundSchema: z.ZodType<
   numberOfInstallments: z.number().optional(),
   holdId: z.string().optional(),
   amount: z.number().optional(),
-  paymentIntent: z.string().optional(),
+  paymentIntentId: z.string().optional(),
   dueDate: z.number().optional(),
   repaymentDate: z.number().optional(),
   metadata: z.lazy(() => CreateOriginationOfferDtoMetadata$outboundSchema)
     .optional(),
 }).transform((v) => {
   return remap$(v, {
+    programId: "program_id",
+    businessId: "business_id",
+    platformId: "platform_id",
     downPaymentDueDate: "down_payment_due_date",
     installmentsStartDate: "installments_start_date",
     paymentDayOfWeek: "payment_day_of_week",
     numberOfInstallments: "number_of_installments",
     holdId: "hold_id",
-    paymentIntent: "payment_intent",
+    paymentIntentId: "payment_intent_id",
     dueDate: "due_date",
     repaymentDate: "repayment_date",
   });

package/src/models/createpaymentdto.ts

@@ -50,6 +50,10 @@ export type CreatePaymentDto = {
    * External Transfer Id
    */
   thirdPartyTransferId?: string | undefined;
+  /**
+   * Indicates this is a non-cash repayment where the payment was collected outside OatFi. The transaction is recorded in the LMS but no money movement occurs.
+   */
+  nonCash?: boolean | undefined;
 };
 
 /** @internal */
@@ -65,6 +69,7 @@ export type CreatePaymentDto$Outbound = {
   payment_request_id?: string | undefined;
   third_party_payment_status?: string | undefined;
   third_party_transfer_id?: string | undefined;
+  non_cash?: boolean | undefined;
 };
 
 /** @internal */
@@ -84,6 +89,7 @@ export const CreatePaymentDto$outboundSchema: z.ZodType<
   paymentRequestId: z.string().optional(),
   thirdPartyPaymentStatus: z.string().optional(),
   thirdPartyTransferId: z.string().optional(),
+  nonCash: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     paymentIntent: "payment_intent",
@@ -93,6 +99,7 @@ export const CreatePaymentDto$outboundSchema: z.ZodType<
     paymentRequestId: "payment_request_id",
     thirdPartyPaymentStatus: "third_party_payment_status",
     thirdPartyTransferId: "third_party_transfer_id",
+    nonCash: "non_cash",
   });
 });
 

package/src/models/createprogramdto.ts

@@ -15,6 +15,11 @@ import {
   HoldSettingsDto$Outbound,
   HoldSettingsDto$outboundSchema,
 } from "./holdsettingsdto.js";
+import {
+  OnboardingSettingsDto,
+  OnboardingSettingsDto$Outbound,
+  OnboardingSettingsDto$outboundSchema,
+} from "./onboardingsettingsdto.js";
 import {
   TermsSettingsDto,
   TermsSettingsDto$Outbound,
@@ -248,6 +253,10 @@ export type CreateProgramDto = {
    * Whether to deny funding
    */
   denyFunding?: boolean | undefined;
+  /**
+   * Onboarding configuration
+   */
+  onboardingSettings?: OnboardingSettingsDto | undefined;
 };
 
 /** @internal */
@@ -344,6 +353,7 @@ export type CreateProgramDto$Outbound = {
   delay_funding_config?: DelayFundingConfigDto$Outbound | undefined;
   terms_settings?: TermsSettingsDto$Outbound | undefined;
   deny_funding?: boolean | undefined;
+  onboarding_settings?: OnboardingSettingsDto$Outbound | undefined;
 };
 
 /** @internal */
@@ -386,6 +396,7 @@ export const CreateProgramDto$outboundSchema: z.ZodType<
   delayFundingConfig: DelayFundingConfigDto$outboundSchema.optional(),
   termsSettings: TermsSettingsDto$outboundSchema.optional(),
   denyFunding: z.boolean().optional(),
+  onboardingSettings: OnboardingSettingsDto$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     platformProductSettings: "platform_product_settings",
@@ -410,6 +421,7 @@ export const CreateProgramDto$outboundSchema: z.ZodType<
     delayFundingConfig: "delay_funding_config",
     termsSettings: "terms_settings",
     denyFunding: "deny_funding",
+    onboardingSettings: "onboarding_settings",
   });
 });