@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.62

package/src/models/expectedusagedto.ts

@@ -0,0 +1,139 @@
+/*
+ * 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 {
+  CustomerType,
+  CustomerType$inboundSchema,
+  CustomerType$outboundSchema,
+} from "./customertype.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  RestrictedActivitiesDto,
+  RestrictedActivitiesDto$inboundSchema,
+  RestrictedActivitiesDto$Outbound,
+  RestrictedActivitiesDto$outboundSchema,
+} from "./restrictedactivitiesdto.js";
+
+/**
+ * Expected monthly payments volume range
+ */
+export const ExpectedMonthlyPaymentsVolumeRange = {
+  ZeroMinus100000: "0-100,000",
+  OneHundredThousandAndOneMinus500000: "100,001-500,000",
+  GreaterThan500000: ">500,000",
+} as const;
+/**
+ * Expected monthly payments volume range
+ */
+export type ExpectedMonthlyPaymentsVolumeRange = ClosedEnum<
+  typeof ExpectedMonthlyPaymentsVolumeRange
+>;
+
+export type ExpectedUsageDto = {
+  /**
+   * Expected monthly payments volume range
+   */
+  expectedMonthlyPaymentsVolumeRange: ExpectedMonthlyPaymentsVolumeRange;
+  /**
+   * Operational countries (ISO 3166-1 alpha-2 codes)
+   */
+  operationalCountries: Array<string>;
+  /**
+   * Customer types
+   */
+  customerTypes: Array<CustomerType>;
+  /**
+   * Funds transfer countries (ISO 3166-1 alpha-2 codes)
+   */
+  fundsTransferCountries: Array<string>;
+  /**
+   * Restricted activities configuration
+   */
+  restrictedActivities: RestrictedActivitiesDto;
+};
+
+/** @internal */
+export const ExpectedMonthlyPaymentsVolumeRange$inboundSchema: z.ZodNativeEnum<
+  typeof ExpectedMonthlyPaymentsVolumeRange
+> = z.nativeEnum(ExpectedMonthlyPaymentsVolumeRange);
+/** @internal */
+export const ExpectedMonthlyPaymentsVolumeRange$outboundSchema: z.ZodNativeEnum<
+  typeof ExpectedMonthlyPaymentsVolumeRange
+> = ExpectedMonthlyPaymentsVolumeRange$inboundSchema;
+
+/** @internal */
+export const ExpectedUsageDto$inboundSchema: z.ZodType<
+  ExpectedUsageDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expected_monthly_payments_volume_range:
+    ExpectedMonthlyPaymentsVolumeRange$inboundSchema,
+  operational_countries: z.array(z.string()),
+  customer_types: z.array(CustomerType$inboundSchema),
+  funds_transfer_countries: z.array(z.string()),
+  restricted_activities: RestrictedActivitiesDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "expected_monthly_payments_volume_range":
+      "expectedMonthlyPaymentsVolumeRange",
+    "operational_countries": "operationalCountries",
+    "customer_types": "customerTypes",
+    "funds_transfer_countries": "fundsTransferCountries",
+    "restricted_activities": "restrictedActivities",
+  });
+});
+/** @internal */
+export type ExpectedUsageDto$Outbound = {
+  expected_monthly_payments_volume_range: string;
+  operational_countries: Array<string>;
+  customer_types: Array<string>;
+  funds_transfer_countries: Array<string>;
+  restricted_activities: RestrictedActivitiesDto$Outbound;
+};
+
+/** @internal */
+export const ExpectedUsageDto$outboundSchema: z.ZodType<
+  ExpectedUsageDto$Outbound,
+  z.ZodTypeDef,
+  ExpectedUsageDto
+> = z.object({
+  expectedMonthlyPaymentsVolumeRange:
+    ExpectedMonthlyPaymentsVolumeRange$outboundSchema,
+  operationalCountries: z.array(z.string()),
+  customerTypes: z.array(CustomerType$outboundSchema),
+  fundsTransferCountries: z.array(z.string()),
+  restrictedActivities: RestrictedActivitiesDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    expectedMonthlyPaymentsVolumeRange:
+      "expected_monthly_payments_volume_range",
+    operationalCountries: "operational_countries",
+    customerTypes: "customer_types",
+    fundsTransferCountries: "funds_transfer_countries",
+    restrictedActivities: "restricted_activities",
+  });
+});
+
+export function expectedUsageDtoToJSON(
+  expectedUsageDto: ExpectedUsageDto,
+): string {
+  return JSON.stringify(
+    ExpectedUsageDto$outboundSchema.parse(expectedUsageDto),
+  );
+}
+export function expectedUsageDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ExpectedUsageDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExpectedUsageDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExpectedUsageDto' from JSON`,
+  );
+}

package/src/models/fileresourcetype.ts

@@ -23,11 +23,7 @@ export const FileResourceType = {
  */
 export type FileResourceType = ClosedEnum<typeof FileResourceType>;
 
-/** @internal */
-export const FileResourceType$inboundSchema: z.ZodNativeEnum<
-  typeof FileResourceType
-> = z.nativeEnum(FileResourceType);
 /** @internal */
 export const FileResourceType$outboundSchema: z.ZodNativeEnum<
   typeof FileResourceType
-> = FileResourceType$inboundSchema;
+> = z.nativeEnum(FileResourceType);

package/src/models/fileresponsedto.ts

@@ -5,13 +5,68 @@
 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 {
-  FileResourceType,
-  FileResourceType$inboundSchema,
-} from "./fileresourcetype.js";
-import { FileType, FileType$inboundSchema } from "./filetype.js";
+
+/**
+ * Type of resource this file is linked to
+ */
+export const FileResponseDtoResourceType = {
+  Business: "business",
+  Application: "application",
+  Person: "person",
+  Partner: "partner",
+  User: "user",
+  PaymentIntent: "payment_intent",
+  Origination: "origination",
+  Payment: "payment",
+} as const;
+/**
+ * Type of resource this file is linked to
+ */
+export type FileResponseDtoResourceType = ClosedEnum<
+  typeof FileResponseDtoResourceType
+>;
+
+/**
+ * Type of file
+ */
+export const FileResponseDtoFileType = {
+  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 FileResponseDtoFileType = ClosedEnum<
+  typeof FileResponseDtoFileType
+>;
 
 /**
  * Additional metadata about the file
@@ -34,7 +89,7 @@ export type FileResponseDto = {
   /**
    * Type of resource this file is linked to
    */
-  resourceType?: FileResourceType | undefined;
+  resourceType?: FileResponseDtoResourceType | undefined;
   /**
    * ID of the resource this file is linked to
    */
@@ -42,7 +97,7 @@ export type FileResponseDto = {
   /**
    * Type of file
    */
-  fileType?: FileType | undefined;
+  fileType?: FileResponseDtoFileType | undefined;
   /**
    * Original filename of the uploaded file
    */
@@ -77,6 +132,16 @@ export type FileResponseDto = {
   updatedAt?: string | undefined;
 };
 
+/** @internal */
+export const FileResponseDtoResourceType$inboundSchema: z.ZodNativeEnum<
+  typeof FileResponseDtoResourceType
+> = z.nativeEnum(FileResponseDtoResourceType);
+
+/** @internal */
+export const FileResponseDtoFileType$inboundSchema: z.ZodNativeEnum<
+  typeof FileResponseDtoFileType
+> = z.nativeEnum(FileResponseDtoFileType);
+
 /** @internal */
 export const FileResponseDtoMetadata$inboundSchema: z.ZodType<
   FileResponseDtoMetadata,
@@ -103,9 +168,9 @@ export const FileResponseDto$inboundSchema: z.ZodType<
   id: z.string(),
   object: z.string().default("file"),
   platform: z.string().optional(),
-  resource_type: FileResourceType$inboundSchema.optional(),
+  resource_type: FileResponseDtoResourceType$inboundSchema.optional(),
   resource_id: z.string().optional(),
-  file_type: FileType$inboundSchema.optional(),
+  file_type: FileResponseDtoFileType$inboundSchema.optional(),
   file_name: z.string().optional(),
   file_size: z.number().optional(),
   mime_type: z.string().optional(),

package/src/models/filetype.ts

@@ -43,8 +43,5 @@ export const FileType = {
 export type FileType = ClosedEnum<typeof FileType>;
 
 /** @internal */
-export const FileType$inboundSchema: z.ZodNativeEnum<typeof FileType> = z
+export const FileType$outboundSchema: z.ZodNativeEnum<typeof FileType> = z
   .nativeEnum(FileType);
-/** @internal */
-export const FileType$outboundSchema: z.ZodNativeEnum<typeof FileType> =
-  FileType$inboundSchema;

package/src/models/financialaccountdatadto.ts

@@ -120,7 +120,7 @@ export type FinancialAccountDataDto = {
   /**
    * Business ID
    */
-  businessId?: string | undefined;
+  business?: string | undefined;
   /**
    * Lockbox Address
    */
@@ -287,7 +287,7 @@ export const FinancialAccountDataDto$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.lazy(() => LockboxAddress$inboundSchema).optional(),
   account_number_id: z.string().optional(),
   oatfi_account_number: z.string().optional(),
@@ -306,7 +306,6 @@ export const FinancialAccountDataDto$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",
@@ -327,7 +326,7 @@ export type FinancialAccountDataDto$Outbound = {
   unit_account_id?: string | undefined;
   swift_code?: string | undefined;
   remittance_information?: string | undefined;
-  business_id?: string | undefined;
+  business?: string | undefined;
   lockbox_address?: LockboxAddress$Outbound | undefined;
   account_number_id?: string | undefined;
   oatfi_account_number?: string | undefined;
@@ -354,7 +353,7 @@ export const FinancialAccountDataDto$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.lazy(() => LockboxAddress$outboundSchema).optional(),
   accountNumberId: z.string().optional(),
   oatfiAccountNumber: z.string().optional(),
@@ -373,7 +372,6 @@ export const FinancialAccountDataDto$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/financialaccountresponsedto.ts

@@ -45,7 +45,7 @@ export type FinancialAccountResponseDtoType = ClosedEnum<
 /**
  * Transaction Type
  */
-export const TransactionType = {
+export const FinancialAccountResponseDtoTransactionType = {
   Funding: "FUNDING",
   Repayment: "REPAYMENT",
   Bidirectional: "BIDIRECTIONAL",
@@ -54,7 +54,9 @@ export const TransactionType = {
 /**
  * Transaction Type
  */
-export type TransactionType = ClosedEnum<typeof TransactionType>;
+export type FinancialAccountResponseDtoTransactionType = ClosedEnum<
+  typeof FinancialAccountResponseDtoTransactionType
+>;
 
 export type FinancialAccountResponseDto = {
   /**
@@ -72,7 +74,7 @@ export type FinancialAccountResponseDto = {
   /**
    * Transaction Type
    */
-  transactionType?: TransactionType | undefined;
+  transactionType?: FinancialAccountResponseDtoTransactionType | undefined;
   /**
    * Default Payment Method
    */
@@ -101,9 +103,9 @@ export const FinancialAccountResponseDtoType$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(FinancialAccountResponseDtoType);
 
 /** @internal */
-export const TransactionType$inboundSchema: z.ZodNativeEnum<
-  typeof TransactionType
-> = z.nativeEnum(TransactionType);
+export const FinancialAccountResponseDtoTransactionType$inboundSchema:
+  z.ZodNativeEnum<typeof FinancialAccountResponseDtoTransactionType> = z
+    .nativeEnum(FinancialAccountResponseDtoTransactionType);
 
 /** @internal */
 export const FinancialAccountResponseDto$inboundSchema: z.ZodType<
@@ -114,7 +116,8 @@ export const FinancialAccountResponseDto$inboundSchema: z.ZodType<
   id: z.string(),
   object: z.string(),
   type: FinancialAccountResponseDtoType$inboundSchema,
-  transaction_type: TransactionType$inboundSchema.optional(),
+  transaction_type: FinancialAccountResponseDtoTransactionType$inboundSchema
+    .optional(),
   is_default: z.boolean().optional(),
   scheduled_repayment: z.boolean().optional(),
   alias: z.string().optional(),

package/src/models/increasetransactiondto.ts

@@ -0,0 +1,137 @@
+/*
+ * 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";
+import {
+  IncreaseTransactionInvoiceDto,
+  IncreaseTransactionInvoiceDto$inboundSchema,
+} from "./increasetransactioninvoicedto.js";
+import {
+  OatfiReconciliationBreakdownDto,
+  OatfiReconciliationBreakdownDto$inboundSchema,
+} from "./oatfireconciliationbreakdowndto.js";
+
+export type IncreaseTransactionDto = {
+  /**
+   * Unique identifier for the increase transaction
+   */
+  object: string;
+  /**
+   * Unique identifier for the increase transaction
+   */
+  id: string;
+  /**
+   * Transaction ID from Increase
+   */
+  transaction: string;
+  /**
+   * Current status of the transaction
+   */
+  status: string;
+  /**
+   * Transaction status from Increase
+   */
+  transactionStatus: string;
+  /**
+   * Beneficiary ID
+   */
+  beneficiaryId: string;
+  /**
+   * Originator ID
+   */
+  originatorId: string;
+  /**
+   * Payment channel used for the transaction
+   */
+  paymentChannel: string;
+  /**
+   * Transaction amount in cents
+   */
+  amount: number;
+  /**
+   * Transaction description
+   */
+  description: string;
+  /**
+   * Originator company name from metadata
+   */
+  originatorCompanyName: string;
+  /**
+   * Account number associated with the transaction
+   */
+  accountNumber: string;
+  /**
+   * When the transaction was created
+   */
+  createdAt: string;
+  /**
+   * When the transaction was last updated
+   */
+  updatedAt: string;
+  /**
+   * Associated invoices
+   */
+  invoices: Array<IncreaseTransactionInvoiceDto>;
+  /**
+   * When the reconciliation status was last updated
+   */
+  reconciliationStatusUpdatedAt?: string | undefined;
+  /**
+   * Oatfi reconciliation breakdown
+   */
+  oatfiReconciliationBreakdown?: OatfiReconciliationBreakdownDto | undefined;
+};
+
+/** @internal */
+export const IncreaseTransactionDto$inboundSchema: z.ZodType<
+  IncreaseTransactionDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  id: z.string(),
+  transaction: z.string(),
+  status: z.string(),
+  transaction_status: z.string(),
+  beneficiary_id: z.string(),
+  originator_id: z.string(),
+  payment_channel: z.string(),
+  amount: z.number(),
+  description: z.string(),
+  originator_company_name: z.string(),
+  account_number: z.string(),
+  created_at: z.string(),
+  updated_at: z.string(),
+  invoices: z.array(IncreaseTransactionInvoiceDto$inboundSchema),
+  reconciliation_status_updated_at: z.string().optional(),
+  oatfi_reconciliation_breakdown: OatfiReconciliationBreakdownDto$inboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "transaction_status": "transactionStatus",
+    "beneficiary_id": "beneficiaryId",
+    "originator_id": "originatorId",
+    "payment_channel": "paymentChannel",
+    "originator_company_name": "originatorCompanyName",
+    "account_number": "accountNumber",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+    "reconciliation_status_updated_at": "reconciliationStatusUpdatedAt",
+    "oatfi_reconciliation_breakdown": "oatfiReconciliationBreakdown",
+  });
+});
+
+export function increaseTransactionDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<IncreaseTransactionDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IncreaseTransactionDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IncreaseTransactionDto' from JSON`,
+  );
+}

package/src/models/increasetransactioninvoicedto.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 IncreaseTransactionInvoiceDto = {
+  /**
+   * Invoice ID
+   */
+  id: string;
+  /**
+   * External ID of the invoice
+   */
+  externalId: string;
+};
+
+/** @internal */
+export const IncreaseTransactionInvoiceDto$inboundSchema: z.ZodType<
+  IncreaseTransactionInvoiceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  external_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+  });
+});
+
+export function increaseTransactionInvoiceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<IncreaseTransactionInvoiceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IncreaseTransactionInvoiceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IncreaseTransactionInvoiceDto' from JSON`,
+  );
+}