@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.62

package/src/models/paymentinformationdto.ts

@@ -5,6 +5,7 @@
 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 {
@@ -15,15 +16,46 @@ import {
   LmsPaymentRequestTriggeredBy,
   LmsPaymentRequestTriggeredBy$inboundSchema,
 } from "./lmspaymentrequesttriggeredby.js";
-import {
-  LmsReconciliation,
-  LmsReconciliation$inboundSchema,
-} from "./lmsreconciliation.js";
 import {
   RepaymentBreakdownDto,
   RepaymentBreakdownDto$inboundSchema,
 } from "./repaymentbreakdowndto.js";
 
+/**
+ * Reconciliation type
+ */
+export const PaymentInformationDtoReconciliation = {
+  Automatic: "AUTOMATIC",
+  Manual: "MANUAL",
+} as const;
+/**
+ * Reconciliation type
+ */
+export type PaymentInformationDtoReconciliation = ClosedEnum<
+  typeof PaymentInformationDtoReconciliation
+>;
+
+/**
+ * Third Party Payment Status
+ */
+export const PaymentInformationDtoThirdPartyPaymentStatus = {
+  Processing: "PROCESSING",
+  ProcessingFees: "PROCESSING_FEES",
+  ProcessingInterest: "PROCESSING_INTEREST",
+  Processed: "PROCESSED",
+  Succeeded: "SUCCEEDED",
+  Error: "ERROR",
+  Failed: "FAILED",
+  Pending: "PENDING",
+  Reversed: "REVERSED",
+} as const;
+/**
+ * Third Party Payment Status
+ */
+export type PaymentInformationDtoThirdPartyPaymentStatus = ClosedEnum<
+  typeof PaymentInformationDtoThirdPartyPaymentStatus
+>;
+
 export type PaymentInformationDto = {
   /**
    * The unique identifier for the payment information
@@ -62,7 +94,7 @@ export type PaymentInformationDto = {
    */
   financialAccount: string;
   /**
-   * Third Party Payment Status
+   * Payment status information
    */
   status?: LmsPaymentRequestStatus | undefined;
   /**
@@ -84,15 +116,21 @@ export type PaymentInformationDto = {
   /**
    * Reconciliation type
    */
-  reconciliation?: LmsReconciliation | undefined;
+  reconciliation?: PaymentInformationDtoReconciliation | undefined;
   /**
    * Third Party Payment Status
    */
-  thirdPartyPaymentStatus?: LmsPaymentRequestStatus | undefined;
+  thirdPartyPaymentStatus?:
+    | PaymentInformationDtoThirdPartyPaymentStatus
+    | undefined;
   /**
    * Third Party Transfer Id
    */
   thirdPartyTransferId?: string | undefined;
+  /**
+   * Error message from payment rails when payment fails
+   */
+  errorMessage?: string | undefined;
   /**
    * The date when the payment information was created
    */
@@ -103,6 +141,16 @@ export type PaymentInformationDto = {
   updatedAt: Date;
 };
 
+/** @internal */
+export const PaymentInformationDtoReconciliation$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentInformationDtoReconciliation
+> = z.nativeEnum(PaymentInformationDtoReconciliation);
+
+/** @internal */
+export const PaymentInformationDtoThirdPartyPaymentStatus$inboundSchema:
+  z.ZodNativeEnum<typeof PaymentInformationDtoThirdPartyPaymentStatus> = z
+    .nativeEnum(PaymentInformationDtoThirdPartyPaymentStatus);
+
 /** @internal */
 export const PaymentInformationDto$inboundSchema: z.ZodType<
   PaymentInformationDto,
@@ -123,9 +171,11 @@ export const PaymentInformationDto$inboundSchema: z.ZodType<
   breakdown: RepaymentBreakdownDto$inboundSchema.optional(),
   triggered_by: LmsPaymentRequestTriggeredBy$inboundSchema.optional(),
   settlement_date: z.number().optional(),
-  reconciliation: LmsReconciliation$inboundSchema.optional(),
-  third_party_payment_status: LmsPaymentRequestStatus$inboundSchema.optional(),
+  reconciliation: PaymentInformationDtoReconciliation$inboundSchema.optional(),
+  third_party_payment_status:
+    PaymentInformationDtoThirdPartyPaymentStatus$inboundSchema.optional(),
   third_party_transfer_id: z.string().optional(),
+  error_message: z.string().optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 }).transform((v) => {
@@ -138,6 +188,7 @@ export const PaymentInformationDto$inboundSchema: z.ZodType<
     "settlement_date": "settlementDate",
     "third_party_payment_status": "thirdPartyPaymentStatus",
     "third_party_transfer_id": "thirdPartyTransferId",
+    "error_message": "errorMessage",
     "created_at": "createdAt",
     "updated_at": "updatedAt",
   });

package/src/models/paymentintentresponsedto.ts

@@ -5,16 +5,27 @@
 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 {
   InvoiceStatusEnum,
   InvoiceStatusEnum$inboundSchema,
 } from "./invoicestatusenum.js";
-import {
-  PaymentIntentType,
-  PaymentIntentType$inboundSchema,
-} from "./paymentintenttype.js";
+
+/**
+ * Type of the payment intent.
+ */
+export const PaymentIntentResponseDtoType = {
+  Invoice: "INVOICE",
+  CardReceivable: "CARD_RECEIVABLE",
+} as const;
+/**
+ * Type of the payment intent.
+ */
+export type PaymentIntentResponseDtoType = ClosedEnum<
+  typeof PaymentIntentResponseDtoType
+>;
 
 export type PaymentIntentResponseDto = {
   /**
@@ -32,11 +43,11 @@ export type PaymentIntentResponseDto = {
   /**
    * Identifier of the associated partner (platform in V2).
    */
-  platformId?: string | undefined;
+  platform?: string | undefined;
   /**
    * Type of the payment intent.
    */
-  type?: PaymentIntentType | undefined;
+  type?: PaymentIntentResponseDtoType | undefined;
   /**
    * Date when the payment intent was created.
    */
@@ -87,6 +98,11 @@ export type PaymentIntentResponseDto = {
   loanIds?: Array<string> | undefined;
 };
 
+/** @internal */
+export const PaymentIntentResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentIntentResponseDtoType
+> = z.nativeEnum(PaymentIntentResponseDtoType);
+
 /** @internal */
 export const PaymentIntentResponseDto$inboundSchema: z.ZodType<
   PaymentIntentResponseDto,
@@ -96,8 +112,8 @@ export const PaymentIntentResponseDto$inboundSchema: z.ZodType<
   object: z.string(),
   id: z.string(),
   external_id: z.string().optional(),
-  platform_id: z.string().optional(),
-  type: PaymentIntentType$inboundSchema.optional(),
+  platform: z.string().optional(),
+  type: PaymentIntentResponseDtoType$inboundSchema.optional(),
   created_date: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ).optional(),
@@ -118,7 +134,6 @@ 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

@@ -56,7 +56,7 @@ export type PaymentRailDataDto = {
   /**
    * Business ID
    */
-  businessId?: string | undefined;
+  business?: string | undefined;
   /**
    * Lockbox Address
    */
@@ -96,7 +96,7 @@ export const PaymentRailDataDto$inboundSchema: z.ZodType<
   unit_account_id: z.string().optional(),
   swift_code: z.string().optional(),
   remittance_information: z.string().optional(),
-  business_id: z.string().optional(),
+  business: z.string().optional(),
   lockbox_address: z.string().optional(),
   account_number_id: z.string().optional(),
   oatfi_account_number: z.string().optional(),
@@ -115,7 +115,6 @@ 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 +135,7 @@ export type PaymentRailDataDto$Outbound = {
   unit_account_id?: string | undefined;
   swift_code?: string | undefined;
   remittance_information?: string | undefined;
-  business_id?: string | undefined;
+  business?: string | undefined;
   lockbox_address?: string | undefined;
   account_number_id?: string | undefined;
   oatfi_account_number?: string | undefined;
@@ -161,7 +160,7 @@ export const PaymentRailDataDto$outboundSchema: z.ZodType<
   unitAccountId: z.string().optional(),
   swiftCode: z.string().optional(),
   remittanceInformation: z.string().optional(),
-  businessId: z.string().optional(),
+  business: z.string().optional(),
   lockboxAddress: z.string().optional(),
   accountNumberId: z.string().optional(),
   oatfiAccountNumber: z.string().optional(),
@@ -180,7 +179,6 @@ 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/person.ts

@@ -78,7 +78,7 @@ export type Person = {
   /**
    * Additional metadata about the person
    */
-  metadata?: { [k: string]: any } | undefined;
+  metadata: { [k: string]: any };
 };
 
 /** @internal */
@@ -119,7 +119,7 @@ export const Person$inboundSchema: z.ZodType<Person, z.ZodTypeDef, unknown> = z
       new Date(v)
     ),
     relationship: PersonRelationship$inboundSchema,
-    metadata: z.record(z.any()).optional(),
+    metadata: z.record(z.any()),
   }).transform((v) => {
     return remap$(v, {
       "external_id": "externalId",

package/src/models/personinformationdto.ts

@@ -0,0 +1,226 @@
+/*
+ * 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 {
+  AddressDto,
+  AddressDto$inboundSchema,
+  AddressDto$Outbound,
+  AddressDto$outboundSchema,
+} from "./addressdto.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+ */
+export const PersonInformationDtoRelationshipToBusiness = {
+  Owner: "Owner",
+  Director: "Director",
+  Officer: "Officer",
+  BeneficialOwner: "Beneficial Owner",
+  AuthorizedRepresentative: "Authorized Representative",
+  Other: "Other",
+} as const;
+/**
+ * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+ */
+export type PersonInformationDtoRelationshipToBusiness = ClosedEnum<
+  typeof PersonInformationDtoRelationshipToBusiness
+>;
+
+/**
+ * Person's KYC status
+ */
+export const PersonInformationDtoKycStatus = {
+  NotStarted: "NOT_STARTED",
+  Started: "STARTED",
+  Failed: "FAILED",
+  ActionRequired: "ACTION_REQUIRED",
+  ManualReview: "MANUAL_REVIEW",
+  Approved: "APPROVED",
+} as const;
+/**
+ * Person's KYC status
+ */
+export type PersonInformationDtoKycStatus = ClosedEnum<
+  typeof PersonInformationDtoKycStatus
+>;
+
+export type PersonInformationDto = {
+  /**
+   * External ID for the person, if available
+   */
+  externalId?: string | undefined;
+  /**
+   * Person's first name
+   */
+  firstName: string;
+  /**
+   * Person's last name
+   */
+  lastName: string;
+  /**
+   * Person's title or role in the business
+   */
+  title: string;
+  /**
+   * Person's email address
+   */
+  email: string;
+  /**
+   * Person's phone number
+   */
+  phone: string;
+  /**
+   * Person's date of birth (YYYY-MM-DD)
+   */
+  dateOfBirth: string;
+  /**
+   * Person's physical address
+   */
+  address: AddressDto;
+  /**
+   * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+   */
+  relationshipToBusiness?:
+    | PersonInformationDtoRelationshipToBusiness
+    | undefined;
+  /**
+   * Is this person a control person for the business?
+   */
+  isControlPerson: boolean;
+  /**
+   * Ownership percentage (0-100). A value greater than 0 implies beneficial ownership.
+   */
+  ownershipPercentage?: number | undefined;
+  /**
+   * Person's KYC status
+   */
+  kycStatus?: PersonInformationDtoKycStatus | undefined;
+  /**
+   * Full SSN (Social Security Number) - for KYC purposes, Application-only field.
+   */
+  ssn?: string | undefined;
+};
+
+/** @internal */
+export const PersonInformationDtoRelationshipToBusiness$inboundSchema:
+  z.ZodNativeEnum<typeof PersonInformationDtoRelationshipToBusiness> = z
+    .nativeEnum(PersonInformationDtoRelationshipToBusiness);
+/** @internal */
+export const PersonInformationDtoRelationshipToBusiness$outboundSchema:
+  z.ZodNativeEnum<typeof PersonInformationDtoRelationshipToBusiness> =
+    PersonInformationDtoRelationshipToBusiness$inboundSchema;
+
+/** @internal */
+export const PersonInformationDtoKycStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PersonInformationDtoKycStatus
+> = z.nativeEnum(PersonInformationDtoKycStatus);
+/** @internal */
+export const PersonInformationDtoKycStatus$outboundSchema: z.ZodNativeEnum<
+  typeof PersonInformationDtoKycStatus
+> = PersonInformationDtoKycStatus$inboundSchema;
+
+/** @internal */
+export const PersonInformationDto$inboundSchema: z.ZodType<
+  PersonInformationDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  external_id: z.string().optional(),
+  first_name: z.string(),
+  last_name: z.string(),
+  title: z.string(),
+  email: z.string(),
+  phone: z.string(),
+  date_of_birth: z.string(),
+  address: AddressDto$inboundSchema,
+  relationship_to_business:
+    PersonInformationDtoRelationshipToBusiness$inboundSchema.optional(),
+  is_control_person: z.boolean(),
+  ownership_percentage: z.number().optional(),
+  kyc_status: PersonInformationDtoKycStatus$inboundSchema.optional(),
+  ssn: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+    "first_name": "firstName",
+    "last_name": "lastName",
+    "date_of_birth": "dateOfBirth",
+    "relationship_to_business": "relationshipToBusiness",
+    "is_control_person": "isControlPerson",
+    "ownership_percentage": "ownershipPercentage",
+    "kyc_status": "kycStatus",
+  });
+});
+/** @internal */
+export type PersonInformationDto$Outbound = {
+  external_id?: string | undefined;
+  first_name: string;
+  last_name: string;
+  title: string;
+  email: string;
+  phone: string;
+  date_of_birth: string;
+  address: AddressDto$Outbound;
+  relationship_to_business?: string | undefined;
+  is_control_person: boolean;
+  ownership_percentage?: number | undefined;
+  kyc_status?: string | undefined;
+  ssn?: string | undefined;
+};
+
+/** @internal */
+export const PersonInformationDto$outboundSchema: z.ZodType<
+  PersonInformationDto$Outbound,
+  z.ZodTypeDef,
+  PersonInformationDto
+> = z.object({
+  externalId: z.string().optional(),
+  firstName: z.string(),
+  lastName: z.string(),
+  title: z.string(),
+  email: z.string(),
+  phone: z.string(),
+  dateOfBirth: z.string(),
+  address: AddressDto$outboundSchema,
+  relationshipToBusiness:
+    PersonInformationDtoRelationshipToBusiness$outboundSchema.optional(),
+  isControlPerson: z.boolean(),
+  ownershipPercentage: z.number().optional(),
+  kycStatus: PersonInformationDtoKycStatus$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 personInformationDtoToJSON(
+  personInformationDto: PersonInformationDto,
+): string {
+  return JSON.stringify(
+    PersonInformationDto$outboundSchema.parse(personInformationDto),
+  );
+}
+export function personInformationDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonInformationDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonInformationDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonInformationDto' from JSON`,
+  );
+}

package/src/models/platformcomponentsdto.ts

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

package/src/models/platformproductsettingsdto.ts

@@ -36,7 +36,7 @@ export type PlatformProductSettingsDto = {
    */
   id?: string | undefined;
   /**
-   * Product type
+   * Terms template type
    */
   termsTemplateType?: ProductType | undefined;
   /**

package/src/models/productbalancesummarydto.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 {
+  BalanceSummaryInvoiceDto,
+  BalanceSummaryInvoiceDto$inboundSchema,
+} from "./balancesummaryinvoicedto.js";
+import {
+  BalanceSummaryOutstandingDto,
+  BalanceSummaryOutstandingDto$inboundSchema,
+} from "./balancesummaryoutstandingdto.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type ProductBalanceSummaryDto = {
+  /**
+   * Total available credit limit in cents
+   */
+  totalAvailableCreditLimit?: number | undefined;
+  /**
+   * Outstanding balance details
+   */
+  outstandingBalance?: BalanceSummaryOutstandingDto | undefined;
+  /**
+   * Invoice balances
+   */
+  invoices?: Array<BalanceSummaryInvoiceDto> | undefined;
+};
+
+/** @internal */
+export const ProductBalanceSummaryDto$inboundSchema: z.ZodType<
+  ProductBalanceSummaryDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_available_credit_limit: z.number().optional(),
+  outstanding_balance: BalanceSummaryOutstandingDto$inboundSchema.optional(),
+  invoices: z.array(BalanceSummaryInvoiceDto$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_available_credit_limit": "totalAvailableCreditLimit",
+    "outstanding_balance": "outstandingBalance",
+  });
+});
+
+export function productBalanceSummaryDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductBalanceSummaryDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductBalanceSummaryDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductBalanceSummaryDto' from JSON`,
+  );
+}

package/src/models/producttype.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../types/enums.js";
 
 /**
- * Product type
+ * Terms template type
  */
 export const ProductType = {
   Bnpl: "BNPL",
@@ -17,7 +17,7 @@ export const ProductType = {
   InvoiceBased: "INVOICE_BASED",
 } as const;
 /**
- * Product type
+ * Terms template type
  */
 export type ProductType = ClosedEnum<typeof ProductType>;