@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.62

package/src/models/updatefiledto.ts

@@ -4,28 +4,70 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
-import { FileType, FileType$outboundSchema } from "./filetype.js";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Type of file
+ */
+export const UpdateFileDtoFileType = {
+  BankStatement: "bank_statement",
+  TaxReturn: "tax_return",
+  BusinessLicense: "business_license",
+  ArticlesOfIncorporation: "articles_of_incorporation",
+  EinLetter: "ein_letter",
+  FinancialStatement: "financial_statement",
+  CorporateFormationDocument: "corporate_formation_document",
+  CertificateOfGoodStanding: "certificate_of_good_standing",
+  DriversLicense: "drivers_license",
+  Passport: "passport",
+  SocialSecurityCard: "social_security_card",
+  UtilityBill: "utility_bill",
+  BankAccountStatement: "bank_account_statement",
+  KycQrCode: "kyc_qr_code",
+  IdDocument: "id_document",
+  ProofOfAddress: "proof_of_address",
+  ProofOfIncome: "proof_of_income",
+  EmploymentVerification: "employment_verification",
+  BankReferenceLetter: "bank_reference_letter",
+  Contract: "contract",
+  TermsOfService: "terms_of_service",
+  PrivacyPolicy: "privacy_policy",
+  SignedAgreement: "signed_agreement",
+  Invoice: "invoice",
+  Receipt: "receipt",
+  PaymentProof: "payment_proof",
+  Other: "other",
+} as const;
+/**
+ * Type of file
+ */
+export type UpdateFileDtoFileType = ClosedEnum<typeof UpdateFileDtoFileType>;
 
 export type UpdateFileDto = {
   /**
    * Type of file
    */
-  fileType?: FileType | undefined;
+  fileType: UpdateFileDtoFileType;
   /**
    * Optional description of the file
    */
-  description?: string | undefined;
+  description: string;
   /**
    * Additional metadata about the file
    */
-  metadata?: { [k: string]: any } | undefined;
+  metadata: { [k: string]: any };
 };
 
+/** @internal */
+export const UpdateFileDtoFileType$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateFileDtoFileType
+> = z.nativeEnum(UpdateFileDtoFileType);
+
 /** @internal */
 export type UpdateFileDto$Outbound = {
-  file_type?: string | undefined;
-  description?: string | undefined;
-  metadata?: { [k: string]: any } | undefined;
+  file_type: string;
+  description: string;
+  metadata: { [k: string]: any };
 };
 
 /** @internal */
@@ -34,9 +76,9 @@ export const UpdateFileDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateFileDto
 > = z.object({
-  fileType: FileType$outboundSchema.optional(),
-  description: z.string().optional(),
-  metadata: z.record(z.any()).optional(),
+  fileType: UpdateFileDtoFileType$outboundSchema,
+  description: z.string(),
+  metadata: z.record(z.any()),
 }).transform((v) => {
   return remap$(v, {
     fileType: "file_type",

package/src/models/updatefinancialaccountdto.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
 import {
   FinancialAccountDataDto,
   FinancialAccountDataDto$Outbound,
@@ -14,14 +15,36 @@ import {
   FinancialAccountVerificationDto$Outbound,
   FinancialAccountVerificationDto$outboundSchema,
 } from "./financialaccountverificationdto.js";
-import {
-  PaymentMethodSourceEnum,
-  PaymentMethodSourceEnum$outboundSchema,
-} from "./paymentmethodsourceenum.js";
-import {
-  TransferTypeEnum,
-  TransferTypeEnum$outboundSchema,
-} from "./transfertypeenum.js";
+
+/**
+ * Transaction Type
+ */
+export const UpdateFinancialAccountDtoTransactionType = {
+  Funding: "FUNDING",
+  Repayment: "REPAYMENT",
+  Bidirectional: "BIDIRECTIONAL",
+  Reversal: "REVERSAL",
+} as const;
+/**
+ * Transaction Type
+ */
+export type UpdateFinancialAccountDtoTransactionType = ClosedEnum<
+  typeof UpdateFinancialAccountDtoTransactionType
+>;
+
+/**
+ * Source
+ */
+export const UpdateFinancialAccountDtoSource = {
+  Partner: "PARTNER",
+  Business: "BUSINESS",
+} as const;
+/**
+ * Source
+ */
+export type UpdateFinancialAccountDtoSource = ClosedEnum<
+  typeof UpdateFinancialAccountDtoSource
+>;
 
 /**
  * Payment rail data
@@ -42,9 +65,9 @@ export type UpdateFinancialAccountDto = {
    */
   business?: string | undefined;
   /**
-   * Transaction type
+   * Transaction Type
    */
-  transactionType?: TransferTypeEnum | undefined;
+  transactionType?: UpdateFinancialAccountDtoTransactionType | undefined;
   /**
    * External Id
    */
@@ -56,7 +79,7 @@ export type UpdateFinancialAccountDto = {
   /**
    * Source
    */
-  source?: PaymentMethodSourceEnum | undefined;
+  source?: UpdateFinancialAccountDtoSource | undefined;
   /**
    * Payment rail data
    */
@@ -83,6 +106,16 @@ export type UpdateFinancialAccountDto = {
   verification?: FinancialAccountVerificationDto | undefined;
 };
 
+/** @internal */
+export const UpdateFinancialAccountDtoTransactionType$outboundSchema:
+  z.ZodNativeEnum<typeof UpdateFinancialAccountDtoTransactionType> = z
+    .nativeEnum(UpdateFinancialAccountDtoTransactionType);
+
+/** @internal */
+export const UpdateFinancialAccountDtoSource$outboundSchema: z.ZodNativeEnum<
+  typeof UpdateFinancialAccountDtoSource
+> = z.nativeEnum(UpdateFinancialAccountDtoSource);
+
 /** @internal */
 export type UpdateFinancialAccountDtoData$Outbound =
   FinancialAccountDataDto$Outbound;
@@ -130,10 +163,11 @@ export const UpdateFinancialAccountDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   platform: z.string().optional(),
   business: z.string().optional(),
-  transactionType: TransferTypeEnum$outboundSchema.optional(),
+  transactionType: UpdateFinancialAccountDtoTransactionType$outboundSchema
+    .optional(),
   externalId: z.string().optional(),
   alias: z.string().optional(),
-  source: PaymentMethodSourceEnum$outboundSchema.optional(),
+  source: UpdateFinancialAccountDtoSource$outboundSchema.optional(),
   data: FinancialAccountDataDto$outboundSchema.optional(),
   enabled: z.boolean().optional(),
   debitAllowed: z.boolean().optional(),

package/src/models/updatepaymentdto.ts

@@ -4,10 +4,28 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
-import {
-  LmsPaymentRequestStatus,
-  LmsPaymentRequestStatus$outboundSchema,
-} from "./lmspaymentrequeststatus.js";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Third party payment status update
+ */
+export const UpdatePaymentDtoThirdPartyPaymentStatus = {
+  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 update
+ */
+export type UpdatePaymentDtoThirdPartyPaymentStatus = ClosedEnum<
+  typeof UpdatePaymentDtoThirdPartyPaymentStatus
+>;
 
 export type UpdatePaymentDto = {
   /**
@@ -15,11 +33,16 @@ export type UpdatePaymentDto = {
    */
   financialAccount?: string | undefined;
   /**
-   * Third Party Payment Status
+   * Third party payment status update
    */
-  thirdPartyPaymentStatus: LmsPaymentRequestStatus;
+  thirdPartyPaymentStatus: UpdatePaymentDtoThirdPartyPaymentStatus;
 };
 
+/** @internal */
+export const UpdatePaymentDtoThirdPartyPaymentStatus$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePaymentDtoThirdPartyPaymentStatus> = z
+    .nativeEnum(UpdatePaymentDtoThirdPartyPaymentStatus);
+
 /** @internal */
 export type UpdatePaymentDto$Outbound = {
   financial_account?: string | undefined;
@@ -33,7 +56,8 @@ export const UpdatePaymentDto$outboundSchema: z.ZodType<
   UpdatePaymentDto
 > = z.object({
   financialAccount: z.string().optional(),
-  thirdPartyPaymentStatus: LmsPaymentRequestStatus$outboundSchema,
+  thirdPartyPaymentStatus:
+    UpdatePaymentDtoThirdPartyPaymentStatus$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     financialAccount: "financial_account",

package/src/models/updatepersoninformationdto.ts

@@ -0,0 +1,174 @@
+/*
+ * 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 { ClosedEnum } from "../types/enums.js";
+import {
+  UpdateAddressDto,
+  UpdateAddressDto$Outbound,
+  UpdateAddressDto$outboundSchema,
+} from "./updateaddressdto.js";
+
+/**
+ * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+ */
+export const UpdatePersonInformationDtoRelationshipToBusiness = {
+  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 UpdatePersonInformationDtoRelationshipToBusiness = ClosedEnum<
+  typeof UpdatePersonInformationDtoRelationshipToBusiness
+>;
+
+/**
+ * Person's KYC status
+ */
+export const UpdatePersonInformationDtoKycStatus = {
+  NotStarted: "NOT_STARTED",
+  Started: "STARTED",
+  Failed: "FAILED",
+  ActionRequired: "ACTION_REQUIRED",
+  ManualReview: "MANUAL_REVIEW",
+  Approved: "APPROVED",
+} as const;
+/**
+ * Person's KYC status
+ */
+export type UpdatePersonInformationDtoKycStatus = ClosedEnum<
+  typeof UpdatePersonInformationDtoKycStatus
+>;
+
+export type UpdatePersonInformationDto = {
+  /**
+   * External ID for the person, if available
+   */
+  externalId?: string | undefined;
+  /**
+   * Person's first name
+   */
+  firstName?: string | undefined;
+  /**
+   * Person's last name
+   */
+  lastName?: string | undefined;
+  /**
+   * Person's title or role in the business
+   */
+  title?: string | undefined;
+  /**
+   * Person's email address
+   */
+  email?: string | undefined;
+  /**
+   * Person's phone number
+   */
+  phone?: string | undefined;
+  /**
+   * Person's date of birth (YYYY-MM-DD)
+   */
+  dateOfBirth?: string | undefined;
+  /**
+   * Person's physical address
+   */
+  address?: UpdateAddressDto | undefined;
+  /**
+   * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
+   */
+  relationshipToBusiness?:
+    | UpdatePersonInformationDtoRelationshipToBusiness
+    | undefined;
+  /**
+   * Is this person a control person for the business?
+   */
+  isControlPerson?: boolean | undefined;
+  /**
+   * Ownership percentage (0-100). A value greater than 0 implies beneficial ownership.
+   */
+  ownershipPercentage?: number | undefined;
+  /**
+   * Person's KYC status
+   */
+  kycStatus?: UpdatePersonInformationDtoKycStatus | undefined;
+  /**
+   * Full SSN (Social Security Number) - for KYC purposes, Application-only field.
+   */
+  ssn?: string | undefined;
+};
+
+/** @internal */
+export const UpdatePersonInformationDtoRelationshipToBusiness$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePersonInformationDtoRelationshipToBusiness> = z
+    .nativeEnum(UpdatePersonInformationDtoRelationshipToBusiness);
+
+/** @internal */
+export const UpdatePersonInformationDtoKycStatus$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePersonInformationDtoKycStatus> = z.nativeEnum(
+    UpdatePersonInformationDtoKycStatus,
+  );
+
+/** @internal */
+export type UpdatePersonInformationDto$Outbound = {
+  external_id?: string | undefined;
+  first_name?: string | undefined;
+  last_name?: string | undefined;
+  title?: string | undefined;
+  email?: string | undefined;
+  phone?: string | undefined;
+  date_of_birth?: string | undefined;
+  address?: UpdateAddressDto$Outbound | undefined;
+  relationship_to_business?: string | undefined;
+  is_control_person?: boolean | undefined;
+  ownership_percentage?: number | undefined;
+  kyc_status?: string | undefined;
+  ssn?: string | undefined;
+};
+
+/** @internal */
+export const UpdatePersonInformationDto$outboundSchema: z.ZodType<
+  UpdatePersonInformationDto$Outbound,
+  z.ZodTypeDef,
+  UpdatePersonInformationDto
+> = z.object({
+  externalId: z.string().optional(),
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  title: z.string().optional(),
+  email: z.string().optional(),
+  phone: z.string().optional(),
+  dateOfBirth: z.string().optional(),
+  address: UpdateAddressDto$outboundSchema.optional(),
+  relationshipToBusiness:
+    UpdatePersonInformationDtoRelationshipToBusiness$outboundSchema.optional(),
+  isControlPerson: z.boolean().optional(),
+  ownershipPercentage: z.number().optional(),
+  kycStatus: UpdatePersonInformationDtoKycStatus$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 updatePersonInformationDtoToJSON(
+  updatePersonInformationDto: UpdatePersonInformationDto,
+): string {
+  return JSON.stringify(
+    UpdatePersonInformationDto$outboundSchema.parse(updatePersonInformationDto),
+  );
+}

package/src/models/updateplatformfinancialaccountdto.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
+import { ClosedEnum } from "../types/enums.js";
 import {
   FinancialAccountDataDto,
   FinancialAccountDataDto$Outbound,
@@ -14,14 +15,36 @@ import {
   FinancialAccountVerificationDto$Outbound,
   FinancialAccountVerificationDto$outboundSchema,
 } from "./financialaccountverificationdto.js";
-import {
-  PaymentMethodSourceEnum,
-  PaymentMethodSourceEnum$outboundSchema,
-} from "./paymentmethodsourceenum.js";
-import {
-  TransferTypeEnum,
-  TransferTypeEnum$outboundSchema,
-} from "./transfertypeenum.js";
+
+/**
+ * Transaction Type
+ */
+export const UpdatePlatformFinancialAccountDtoTransactionType = {
+  Funding: "FUNDING",
+  Repayment: "REPAYMENT",
+  Bidirectional: "BIDIRECTIONAL",
+  Reversal: "REVERSAL",
+} as const;
+/**
+ * Transaction Type
+ */
+export type UpdatePlatformFinancialAccountDtoTransactionType = ClosedEnum<
+  typeof UpdatePlatformFinancialAccountDtoTransactionType
+>;
+
+/**
+ * Source
+ */
+export const UpdatePlatformFinancialAccountDtoSource = {
+  Partner: "PARTNER",
+  Business: "BUSINESS",
+} as const;
+/**
+ * Source
+ */
+export type UpdatePlatformFinancialAccountDtoSource = ClosedEnum<
+  typeof UpdatePlatformFinancialAccountDtoSource
+>;
 
 /**
  * Payment rail data
@@ -30,9 +53,11 @@ export type UpdatePlatformFinancialAccountDtoData = FinancialAccountDataDto;
 
 export type UpdatePlatformFinancialAccountDto = {
   /**
-   * Transaction type
+   * Transaction Type
    */
-  transactionType?: TransferTypeEnum | undefined;
+  transactionType?:
+    | UpdatePlatformFinancialAccountDtoTransactionType
+    | undefined;
   /**
    * External Id
    */
@@ -44,7 +69,7 @@ export type UpdatePlatformFinancialAccountDto = {
   /**
    * Source
    */
-  source?: PaymentMethodSourceEnum | undefined;
+  source?: UpdatePlatformFinancialAccountDtoSource | undefined;
   /**
    * Payment rail data
    */
@@ -71,6 +96,16 @@ export type UpdatePlatformFinancialAccountDto = {
   verification?: FinancialAccountVerificationDto | undefined;
 };
 
+/** @internal */
+export const UpdatePlatformFinancialAccountDtoTransactionType$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePlatformFinancialAccountDtoTransactionType> = z
+    .nativeEnum(UpdatePlatformFinancialAccountDtoTransactionType);
+
+/** @internal */
+export const UpdatePlatformFinancialAccountDtoSource$outboundSchema:
+  z.ZodNativeEnum<typeof UpdatePlatformFinancialAccountDtoSource> = z
+    .nativeEnum(UpdatePlatformFinancialAccountDtoSource);
+
 /** @internal */
 export type UpdatePlatformFinancialAccountDtoData$Outbound =
   FinancialAccountDataDto$Outbound;
@@ -112,10 +147,11 @@ export const UpdatePlatformFinancialAccountDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdatePlatformFinancialAccountDto
 > = z.object({
-  transactionType: TransferTypeEnum$outboundSchema.optional(),
+  transactionType:
+    UpdatePlatformFinancialAccountDtoTransactionType$outboundSchema.optional(),
   externalId: z.string().optional(),
   alias: z.string().optional(),
-  source: PaymentMethodSourceEnum$outboundSchema.optional(),
+  source: UpdatePlatformFinancialAccountDtoSource$outboundSchema.optional(),
   data: FinancialAccountDataDto$outboundSchema.optional(),
   enabled: z.boolean().optional(),
   debitAllowed: z.boolean().optional(),

package/src/models/updateplatformscopesdto.ts

@@ -6,6 +6,9 @@ import * as z from "zod/v3";
 import { AppScope, AppScope$outboundSchema } from "./appscope.js";
 
 export type UpdatePlatformScopesDto = {
+  /**
+   * The complete list of scopes to assign to the platform.
+   */
   scopes: Array<AppScope>;
 };