@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.61

package/src/models/agreementacceptanceresponsedto.ts

@@ -0,0 +1,102 @@
+/*
+ * 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 { AcceptedVia, AcceptedVia$inboundSchema } from "./acceptedvia.js";
+import { AgreementType, AgreementType$inboundSchema } from "./agreementtype.js";
+import {
+  EntityCollectionName,
+  EntityCollectionName$inboundSchema,
+} from "./entitycollectionname.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type AgreementAcceptanceResponseDto = {
+  /**
+   * Resource type
+   */
+  object: string;
+  /**
+   * Agreement acceptance ID
+   */
+  id: string;
+  /**
+   * Terms version (semantic version)
+   */
+  termsVersion: string;
+  /**
+   * URL to the exact PDF/HTML artifact accepted
+   */
+  termsFileUrl?: string | undefined;
+  /**
+   * How the terms were accepted
+   */
+  acceptedVia: AcceptedVia;
+  /**
+   * ID of the entity that accepted the terms
+   */
+  entityId: string;
+  /**
+   * Collection name of the entity
+   */
+  entityCollectionName: EntityCollectionName;
+  /**
+   * ID of the loan program
+   */
+  loanProgram?: string | undefined;
+  /**
+   * Type of agreement
+   */
+  type: AgreementType;
+  /**
+   * Creation timestamp (when the terms were accepted)
+   */
+  createdAt: Date;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const AgreementAcceptanceResponseDto$inboundSchema: z.ZodType<
+  AgreementAcceptanceResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  id: z.string(),
+  terms_version: z.string(),
+  terms_file_url: z.string().optional(),
+  accepted_via: AcceptedVia$inboundSchema,
+  entity_id: z.string(),
+  entity_collection_name: EntityCollectionName$inboundSchema,
+  loan_program: z.string().optional(),
+  type: AgreementType$inboundSchema,
+  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) => {
+  return remap$(v, {
+    "terms_version": "termsVersion",
+    "terms_file_url": "termsFileUrl",
+    "accepted_via": "acceptedVia",
+    "entity_id": "entityId",
+    "entity_collection_name": "entityCollectionName",
+    "loan_program": "loanProgram",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function agreementAcceptanceResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AgreementAcceptanceResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgreementAcceptanceResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgreementAcceptanceResponseDto' from JSON`,
+  );
+}

package/src/models/agreementtype.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Type of agreement
+ */
+export const AgreementType = {
+  UnderwritingTerms: "UNDERWRITING_TERMS",
+} as const;
+/**
+ * Type of agreement
+ */
+export type AgreementType = ClosedEnum<typeof AgreementType>;
+
+/** @internal */
+export const AgreementType$inboundSchema: z.ZodNativeEnum<
+  typeof AgreementType
+> = z.nativeEnum(AgreementType);
+/** @internal */
+export const AgreementType$outboundSchema: z.ZodNativeEnum<
+  typeof AgreementType
+> = AgreementType$inboundSchema;

package/src/models/applicationresponsedto.ts

@@ -0,0 +1,156 @@
+/*
+ * 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 {
+  AdverseActionDto,
+  AdverseActionDto$inboundSchema,
+} from "./adverseactiondto.js";
+import {
+  ApplicationStatus,
+  ApplicationStatus$inboundSchema,
+} from "./applicationstatus.js";
+import { AttachmentDto, AttachmentDto$inboundSchema } from "./attachmentdto.js";
+import {
+  BusinessInformationDto,
+  BusinessInformationDto$inboundSchema,
+} from "./businessinformationdto.js";
+import { ConsentsDto, ConsentsDto$inboundSchema } from "./consentsdto.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  ExpectedUsageDto,
+  ExpectedUsageDto$inboundSchema,
+} from "./expectedusagedto.js";
+import { KybStatus, KybStatus$inboundSchema } from "./kybstatus.js";
+import {
+  PersonInformationDto,
+  PersonInformationDto$inboundSchema,
+} from "./personinformationdto.js";
+
+/**
+ * Additional metadata.
+ */
+export type ApplicationResponseDtoMetadata = {};
+
+export type ApplicationResponseDto = {
+  /**
+   * Object type, always 'application'.
+   */
+  object: string;
+  /**
+   * Unique identifier for the application.
+   */
+  id: string;
+  /**
+   * Platform ID associated with the application.
+   */
+  platform?: string | undefined;
+  /**
+   * Current status of the application.
+   */
+  status?: ApplicationStatus | undefined;
+  /**
+   * Current KYB status of the application.
+   */
+  kybStatus?: KybStatus | undefined;
+  /**
+   * Timestamp of when the application was submitted.
+   */
+  submittedAt?: Date | undefined;
+  /**
+   * Timestamp of when a decision was made on the application.
+   */
+  decisionedAt?: Date | undefined;
+  businessInformation?: BusinessInformationDto | undefined;
+  personsInformation?: Array<PersonInformationDto> | undefined;
+  expectedUsage?: ExpectedUsageDto | undefined;
+  consents?: ConsentsDto | undefined;
+  adverseActions?: Array<AdverseActionDto> | undefined;
+  attachments?: Array<AttachmentDto> | undefined;
+  /**
+   * Additional metadata.
+   */
+  metadata?: ApplicationResponseDtoMetadata | undefined;
+  /**
+   * Timestamp of when the application was created.
+   */
+  createdAt?: Date | undefined;
+  /**
+   * Timestamp of when the application was last updated.
+   */
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const ApplicationResponseDtoMetadata$inboundSchema: z.ZodType<
+  ApplicationResponseDtoMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function applicationResponseDtoMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ApplicationResponseDtoMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApplicationResponseDtoMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApplicationResponseDtoMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const ApplicationResponseDto$inboundSchema: z.ZodType<
+  ApplicationResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  id: z.string(),
+  platform: z.string().optional(),
+  status: ApplicationStatus$inboundSchema.optional(),
+  kyb_status: KybStatus$inboundSchema.optional(),
+  submitted_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  decisioned_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  business_information: BusinessInformationDto$inboundSchema.optional(),
+  persons_information: z.array(PersonInformationDto$inboundSchema).optional(),
+  expected_usage: ExpectedUsageDto$inboundSchema.optional(),
+  consents: ConsentsDto$inboundSchema.optional(),
+  adverse_actions: z.array(AdverseActionDto$inboundSchema).optional(),
+  attachments: z.array(AttachmentDto$inboundSchema).optional(),
+  metadata: z.lazy(() => ApplicationResponseDtoMetadata$inboundSchema)
+    .optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "kyb_status": "kybStatus",
+    "submitted_at": "submittedAt",
+    "decisioned_at": "decisionedAt",
+    "business_information": "businessInformation",
+    "persons_information": "personsInformation",
+    "expected_usage": "expectedUsage",
+    "adverse_actions": "adverseActions",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function applicationResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ApplicationResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApplicationResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApplicationResponseDto' from JSON`,
+  );
+}

package/src/models/applicationstatus.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Current status of the application.
+ */
+export const ApplicationStatus = {
+  Draft: "DRAFT",
+  Submitted: "SUBMITTED",
+  Failed: "FAILED",
+  Error: "ERROR",
+  ActionRequired: "ACTION_REQUIRED",
+  ManualReview: "MANUAL_REVIEW",
+  Approved: "APPROVED",
+  Processed: "PROCESSED",
+} as const;
+/**
+ * Current status of the application.
+ */
+export type ApplicationStatus = ClosedEnum<typeof ApplicationStatus>;
+
+/** @internal */
+export const ApplicationStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ApplicationStatus
+> = z.nativeEnum(ApplicationStatus);

package/src/models/approveapplicationdto.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 ApproveApplicationDto = {
+  /**
+   * Capital source portfolio ID
+   */
+  capitalSource: string;
+};
+
+/** @internal */
+export type ApproveApplicationDto$Outbound = {
+  capital_source: string;
+};
+
+/** @internal */
+export const ApproveApplicationDto$outboundSchema: z.ZodType<
+  ApproveApplicationDto$Outbound,
+  z.ZodTypeDef,
+  ApproveApplicationDto
+> = z.object({
+  capitalSource: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    capitalSource: "capital_source",
+  });
+});
+
+export function approveApplicationDtoToJSON(
+  approveApplicationDto: ApproveApplicationDto,
+): string {
+  return JSON.stringify(
+    ApproveApplicationDto$outboundSchema.parse(approveApplicationDto),
+  );
+}

package/src/models/attachmentdto.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 AttachmentDto = {
+  /**
+   * Type of document
+   */
+  documentType: string;
+  /**
+   * File ID from a file service
+   */
+  fileId: string;
+  /**
+   * Optional description of the attachment
+   */
+  description?: string | undefined;
+};
+
+/** @internal */
+export const AttachmentDto$inboundSchema: z.ZodType<
+  AttachmentDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  document_type: z.string(),
+  file_id: z.string(),
+  description: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "document_type": "documentType",
+    "file_id": "fileId",
+  });
+});
+/** @internal */
+export type AttachmentDto$Outbound = {
+  document_type: string;
+  file_id: string;
+  description?: string | undefined;
+};
+
+/** @internal */
+export const AttachmentDto$outboundSchema: z.ZodType<
+  AttachmentDto$Outbound,
+  z.ZodTypeDef,
+  AttachmentDto
+> = z.object({
+  documentType: z.string(),
+  fileId: z.string(),
+  description: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    documentType: "document_type",
+    fileId: "file_id",
+  });
+});
+
+export function attachmentDtoToJSON(attachmentDto: AttachmentDto): string {
+  return JSON.stringify(AttachmentDto$outboundSchema.parse(attachmentDto));
+}
+export function attachmentDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AttachmentDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AttachmentDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AttachmentDto' from JSON`,
+  );
+}

package/src/models/balancebyproductdto.ts

@@ -0,0 +1,53 @@
+/*
+ * 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";
+import {
+  ProductBalanceSummaryDto,
+  ProductBalanceSummaryDto$inboundSchema,
+} from "./productbalancesummarydto.js";
+
+export type BalanceByProductDto = {
+  /**
+   * BNPL product balance
+   */
+  bnpl?: ProductBalanceSummaryDto | undefined;
+  /**
+   * AR product balance
+   */
+  ar?: ProductBalanceSummaryDto | undefined;
+  /**
+   * EWC product balance
+   */
+  ewc?: ProductBalanceSummaryDto | undefined;
+  /**
+   * Factoring product balance
+   */
+  factoring?: ProductBalanceSummaryDto | undefined;
+};
+
+/** @internal */
+export const BalanceByProductDto$inboundSchema: z.ZodType<
+  BalanceByProductDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bnpl: ProductBalanceSummaryDto$inboundSchema.optional(),
+  ar: ProductBalanceSummaryDto$inboundSchema.optional(),
+  ewc: ProductBalanceSummaryDto$inboundSchema.optional(),
+  factoring: ProductBalanceSummaryDto$inboundSchema.optional(),
+});
+
+export function balanceByProductDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BalanceByProductDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BalanceByProductDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BalanceByProductDto' from JSON`,
+  );
+}

package/src/models/balancesummaryinvoicedto.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 {
+  BalanceSummaryOutstandingDto,
+  BalanceSummaryOutstandingDto$inboundSchema,
+} from "./balancesummaryoutstandingdto.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type BalanceSummaryInvoiceDto = {
+  /**
+   * Invoice external identifier
+   */
+  invoiceExternalId?: string | undefined;
+  /**
+   * Outstanding balance details
+   */
+  outstandingBalance?: BalanceSummaryOutstandingDto | undefined;
+};
+
+/** @internal */
+export const BalanceSummaryInvoiceDto$inboundSchema: z.ZodType<
+  BalanceSummaryInvoiceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  invoice_external_id: z.string().optional(),
+  outstanding_balance: BalanceSummaryOutstandingDto$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "invoice_external_id": "invoiceExternalId",
+    "outstanding_balance": "outstandingBalance",
+  });
+});
+
+export function balanceSummaryInvoiceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BalanceSummaryInvoiceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BalanceSummaryInvoiceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BalanceSummaryInvoiceDto' from JSON`,
+  );
+}

package/src/models/balancesummaryoutstandingdto.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 BalanceSummaryOutstandingDto = {
+  /**
+   * Principal balance amount in cents
+   */
+  principalBalance: number;
+  /**
+   * Fee balance amount in cents
+   */
+  feeBalance: number;
+  /**
+   * Total balance amount in cents
+   */
+  totalBalance: number;
+  /**
+   * Late fee balance amount in cents
+   */
+  lateFeeBalance: number;
+};
+
+/** @internal */
+export const BalanceSummaryOutstandingDto$inboundSchema: z.ZodType<
+  BalanceSummaryOutstandingDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  principal_balance: z.number(),
+  fee_balance: z.number(),
+  total_balance: z.number(),
+  late_fee_balance: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "principal_balance": "principalBalance",
+    "fee_balance": "feeBalance",
+    "total_balance": "totalBalance",
+    "late_fee_balance": "lateFeeBalance",
+  });
+});
+
+export function balanceSummaryOutstandingDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BalanceSummaryOutstandingDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BalanceSummaryOutstandingDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BalanceSummaryOutstandingDto' from JSON`,
+  );
+}

package/src/models/businessbalancesummarydto.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 {
+  BalanceByProductDto,
+  BalanceByProductDto$inboundSchema,
+} from "./balancebyproductdto.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type BusinessBalanceSummaryDto = {
+  /**
+   * Object type. Always 'business_balance_summary'.
+   */
+  object: string;
+  /**
+   * Unique identifier for the balance summary
+   */
+  id: string;
+  /**
+   * Business identifier
+   */
+  businessId: string;
+  /**
+   * Balance breakdown by product type
+   */
+  balanceByProduct: BalanceByProductDto;
+  /**
+   * Timestamp when the balance was retrieved
+   */
+  createdAt: string;
+  /**
+   * Timestamp when the balance was last updated
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const BusinessBalanceSummaryDto$inboundSchema: z.ZodType<
+  BusinessBalanceSummaryDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  id: z.string(),
+  business_id: z.string(),
+  balance_by_product: BalanceByProductDto$inboundSchema,
+  created_at: z.string(),
+  updated_at: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "business_id": "businessId",
+    "balance_by_product": "balanceByProduct",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function businessBalanceSummaryDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BusinessBalanceSummaryDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessBalanceSummaryDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessBalanceSummaryDto' from JSON`,
+  );
+}