@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.61

package/src/models/businessinformationdto.ts

@@ -0,0 +1,184 @@
+/*
+ * 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 {
+  UpdateAddressDto,
+  UpdateAddressDto$inboundSchema,
+  UpdateAddressDto$Outbound,
+  UpdateAddressDto$outboundSchema,
+} from "./updateaddressdto.js";
+
+export type BusinessInformationDto = {
+  /**
+   * Legal name of the business
+   */
+  name?: string | undefined;
+  /**
+   * External ID for the business from the platform
+   */
+  externalId?: string | undefined;
+  /**
+   * Doing Business As (DBA) name
+   */
+  dbaName?: string | undefined;
+  /**
+   * Tax ID (e.g., EIN for US businesses). Must be exactly 9 numeric characters.
+   */
+  taxId?: string | undefined;
+  /**
+   * Type of business entity
+   */
+  businessEntityType?: string | undefined;
+  /**
+   * State of incorporation (2-letter ISO code)
+   */
+  stateOfIncorporation?: string | undefined;
+  /**
+   * Date business was established (YYYY-MM-DD)
+   */
+  dateEstablished?: string | undefined;
+  /**
+   * Physical address of the business
+   */
+  physicalAddress?: UpdateAddressDto | undefined;
+  /**
+   * Business contact phone number
+   */
+  contactPhone?: string | undefined;
+  /**
+   * Business contact email address
+   */
+  contactEmail?: string | undefined;
+  /**
+   * Industry type (NAICS code, max 6 numeric chars)
+   */
+  industryType?: string | undefined;
+  /**
+   * Description of the business operations
+   */
+  businessDescription?: string | undefined;
+  /**
+   * URL of the business website
+   */
+  websiteUrl?: string | undefined;
+  /**
+   * Mailing address if different from physical address
+   */
+  mailingAddress?: UpdateAddressDto | undefined;
+};
+
+/** @internal */
+export const BusinessInformationDto$inboundSchema: z.ZodType<
+  BusinessInformationDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  external_id: z.string().optional(),
+  dba_name: z.string().optional(),
+  tax_id: z.string().optional(),
+  business_entity_type: z.string().optional(),
+  state_of_incorporation: z.string().optional(),
+  date_established: z.string().optional(),
+  physical_address: UpdateAddressDto$inboundSchema.optional(),
+  contact_phone: z.string().optional(),
+  contact_email: z.string().optional(),
+  industry_type: z.string().optional(),
+  business_description: z.string().optional(),
+  website_url: z.string().optional(),
+  mailing_address: UpdateAddressDto$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+    "dba_name": "dbaName",
+    "tax_id": "taxId",
+    "business_entity_type": "businessEntityType",
+    "state_of_incorporation": "stateOfIncorporation",
+    "date_established": "dateEstablished",
+    "physical_address": "physicalAddress",
+    "contact_phone": "contactPhone",
+    "contact_email": "contactEmail",
+    "industry_type": "industryType",
+    "business_description": "businessDescription",
+    "website_url": "websiteUrl",
+    "mailing_address": "mailingAddress",
+  });
+});
+/** @internal */
+export type BusinessInformationDto$Outbound = {
+  name?: string | undefined;
+  external_id?: string | undefined;
+  dba_name?: string | undefined;
+  tax_id?: string | undefined;
+  business_entity_type?: string | undefined;
+  state_of_incorporation?: string | undefined;
+  date_established?: string | undefined;
+  physical_address?: UpdateAddressDto$Outbound | undefined;
+  contact_phone?: string | undefined;
+  contact_email?: string | undefined;
+  industry_type?: string | undefined;
+  business_description?: string | undefined;
+  website_url?: string | undefined;
+  mailing_address?: UpdateAddressDto$Outbound | undefined;
+};
+
+/** @internal */
+export const BusinessInformationDto$outboundSchema: z.ZodType<
+  BusinessInformationDto$Outbound,
+  z.ZodTypeDef,
+  BusinessInformationDto
+> = z.object({
+  name: z.string().optional(),
+  externalId: z.string().optional(),
+  dbaName: z.string().optional(),
+  taxId: z.string().optional(),
+  businessEntityType: z.string().optional(),
+  stateOfIncorporation: z.string().optional(),
+  dateEstablished: z.string().optional(),
+  physicalAddress: UpdateAddressDto$outboundSchema.optional(),
+  contactPhone: z.string().optional(),
+  contactEmail: z.string().optional(),
+  industryType: z.string().optional(),
+  businessDescription: z.string().optional(),
+  websiteUrl: z.string().optional(),
+  mailingAddress: UpdateAddressDto$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    dbaName: "dba_name",
+    taxId: "tax_id",
+    businessEntityType: "business_entity_type",
+    stateOfIncorporation: "state_of_incorporation",
+    dateEstablished: "date_established",
+    physicalAddress: "physical_address",
+    contactPhone: "contact_phone",
+    contactEmail: "contact_email",
+    industryType: "industry_type",
+    businessDescription: "business_description",
+    websiteUrl: "website_url",
+    mailingAddress: "mailing_address",
+  });
+});
+
+export function businessInformationDtoToJSON(
+  businessInformationDto: BusinessInformationDto,
+): string {
+  return JSON.stringify(
+    BusinessInformationDto$outboundSchema.parse(businessInformationDto),
+  );
+}
+export function businessInformationDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BusinessInformationDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessInformationDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessInformationDto' from JSON`,
+  );
+}

package/src/models/consentsdto.ts

@@ -0,0 +1,115 @@
+/*
+ * 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 ConsentsDto = {
+  /**
+   * E-sign disclosure agreed
+   */
+  eSignDisclosureAgreed: boolean;
+  /**
+   * OatFi terms and conditions agreed
+   */
+  oatfiTermsAndConditionsAgreed: boolean;
+  /**
+   * OatFi privacy policy agreed
+   */
+  oatfiPrivacyPolicyAgreed: boolean;
+  /**
+   * Grasshopper privacy policy agreed
+   */
+  grasshopperPrivacyPolicyAgreed: boolean;
+  /**
+   * Grasshopper bank MSA agreed
+   */
+  grasshopperBankMsa: boolean;
+  /**
+   * Grasshopper prohibited and restricted guidelines agreed
+   */
+  grasshopperProhibitedAndRestrictedGuidelines: boolean;
+  /**
+   * OatFi debit authorization
+   */
+  oatfiDebitAuthorization: boolean;
+};
+
+/** @internal */
+export const ConsentsDto$inboundSchema: z.ZodType<
+  ConsentsDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  e_sign_disclosure_agreed: z.boolean(),
+  oatfi_terms_and_conditions_agreed: z.boolean(),
+  oatfi_privacy_policy_agreed: z.boolean(),
+  grasshopper_privacy_policy_agreed: z.boolean(),
+  grasshopper_bank_msa: z.boolean(),
+  grasshopper_prohibited_and_restricted_guidelines: z.boolean(),
+  oatfi_debit_authorization: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "e_sign_disclosure_agreed": "eSignDisclosureAgreed",
+    "oatfi_terms_and_conditions_agreed": "oatfiTermsAndConditionsAgreed",
+    "oatfi_privacy_policy_agreed": "oatfiPrivacyPolicyAgreed",
+    "grasshopper_privacy_policy_agreed": "grasshopperPrivacyPolicyAgreed",
+    "grasshopper_bank_msa": "grasshopperBankMsa",
+    "grasshopper_prohibited_and_restricted_guidelines":
+      "grasshopperProhibitedAndRestrictedGuidelines",
+    "oatfi_debit_authorization": "oatfiDebitAuthorization",
+  });
+});
+/** @internal */
+export type ConsentsDto$Outbound = {
+  e_sign_disclosure_agreed: boolean;
+  oatfi_terms_and_conditions_agreed: boolean;
+  oatfi_privacy_policy_agreed: boolean;
+  grasshopper_privacy_policy_agreed: boolean;
+  grasshopper_bank_msa: boolean;
+  grasshopper_prohibited_and_restricted_guidelines: boolean;
+  oatfi_debit_authorization: boolean;
+};
+
+/** @internal */
+export const ConsentsDto$outboundSchema: z.ZodType<
+  ConsentsDto$Outbound,
+  z.ZodTypeDef,
+  ConsentsDto
+> = z.object({
+  eSignDisclosureAgreed: z.boolean(),
+  oatfiTermsAndConditionsAgreed: z.boolean(),
+  oatfiPrivacyPolicyAgreed: z.boolean(),
+  grasshopperPrivacyPolicyAgreed: z.boolean(),
+  grasshopperBankMsa: z.boolean(),
+  grasshopperProhibitedAndRestrictedGuidelines: z.boolean(),
+  oatfiDebitAuthorization: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    eSignDisclosureAgreed: "e_sign_disclosure_agreed",
+    oatfiTermsAndConditionsAgreed: "oatfi_terms_and_conditions_agreed",
+    oatfiPrivacyPolicyAgreed: "oatfi_privacy_policy_agreed",
+    grasshopperPrivacyPolicyAgreed: "grasshopper_privacy_policy_agreed",
+    grasshopperBankMsa: "grasshopper_bank_msa",
+    grasshopperProhibitedAndRestrictedGuidelines:
+      "grasshopper_prohibited_and_restricted_guidelines",
+    oatfiDebitAuthorization: "oatfi_debit_authorization",
+  });
+});
+
+export function consentsDtoToJSON(consentsDto: ConsentsDto): string {
+  return JSON.stringify(ConsentsDto$outboundSchema.parse(consentsDto));
+}
+export function consentsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ConsentsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConsentsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConsentsDto' from JSON`,
+  );
+}

package/src/models/createagreementacceptancedto.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 { AcceptedVia, AcceptedVia$outboundSchema } from "./acceptedvia.js";
+import {
+  AgreementType,
+  AgreementType$outboundSchema,
+} from "./agreementtype.js";
+import {
+  EntityCollectionName,
+  EntityCollectionName$outboundSchema,
+} from "./entitycollectionname.js";
+
+export type CreateAgreementAcceptanceDto = {
+  /**
+   * 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 (application, business, or person)
+   */
+  entityId: string;
+  /**
+   * Collection name of the entity
+   */
+  entityCollectionName: EntityCollectionName;
+  /**
+   * ID of the loan program
+   */
+  loanProgram?: string | undefined;
+  /**
+   * Type of agreement
+   */
+  type: AgreementType;
+};
+
+/** @internal */
+export type CreateAgreementAcceptanceDto$Outbound = {
+  terms_file_url?: string | undefined;
+  accepted_via: string;
+  entity_id: string;
+  entity_collection_name: string;
+  loan_program?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const CreateAgreementAcceptanceDto$outboundSchema: z.ZodType<
+  CreateAgreementAcceptanceDto$Outbound,
+  z.ZodTypeDef,
+  CreateAgreementAcceptanceDto
+> = z.object({
+  termsFileUrl: z.string().optional(),
+  acceptedVia: AcceptedVia$outboundSchema,
+  entityId: z.string(),
+  entityCollectionName: EntityCollectionName$outboundSchema,
+  loanProgram: z.string().optional(),
+  type: AgreementType$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    termsFileUrl: "terms_file_url",
+    acceptedVia: "accepted_via",
+    entityId: "entity_id",
+    entityCollectionName: "entity_collection_name",
+    loanProgram: "loan_program",
+  });
+});
+
+export function createAgreementAcceptanceDtoToJSON(
+  createAgreementAcceptanceDto: CreateAgreementAcceptanceDto,
+): string {
+  return JSON.stringify(
+    CreateAgreementAcceptanceDto$outboundSchema.parse(
+      createAgreementAcceptanceDto,
+    ),
+  );
+}

package/src/models/createapplicationdto.ts

@@ -0,0 +1,116 @@
+/*
+ * 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 {
+  AttachmentDto,
+  AttachmentDto$Outbound,
+  AttachmentDto$outboundSchema,
+} from "./attachmentdto.js";
+import {
+  BusinessInformationDto,
+  BusinessInformationDto$Outbound,
+  BusinessInformationDto$outboundSchema,
+} from "./businessinformationdto.js";
+import {
+  ConsentsDto,
+  ConsentsDto$Outbound,
+  ConsentsDto$outboundSchema,
+} from "./consentsdto.js";
+import {
+  ExpectedUsageDto,
+  ExpectedUsageDto$Outbound,
+  ExpectedUsageDto$outboundSchema,
+} from "./expectedusagedto.js";
+import {
+  PersonInformationDto,
+  PersonInformationDto$Outbound,
+  PersonInformationDto$outboundSchema,
+} from "./personinformationdto.js";
+
+/**
+ * Additional metadata
+ */
+export type CreateApplicationDtoMetadata = {};
+
+export type CreateApplicationDto = {
+  /**
+   * Platform ID submitting the application
+   */
+  platform: string;
+  businessInformation?: BusinessInformationDto | undefined;
+  personsInformation?: Array<PersonInformationDto> | undefined;
+  expectedUsage?: ExpectedUsageDto | undefined;
+  consents?: ConsentsDto | undefined;
+  /**
+   * Optional list of attachments
+   */
+  attachments?: Array<AttachmentDto> | undefined;
+  /**
+   * Additional metadata
+   */
+  metadata?: CreateApplicationDtoMetadata | undefined;
+};
+
+/** @internal */
+export type CreateApplicationDtoMetadata$Outbound = {};
+
+/** @internal */
+export const CreateApplicationDtoMetadata$outboundSchema: z.ZodType<
+  CreateApplicationDtoMetadata$Outbound,
+  z.ZodTypeDef,
+  CreateApplicationDtoMetadata
+> = z.object({});
+
+export function createApplicationDtoMetadataToJSON(
+  createApplicationDtoMetadata: CreateApplicationDtoMetadata,
+): string {
+  return JSON.stringify(
+    CreateApplicationDtoMetadata$outboundSchema.parse(
+      createApplicationDtoMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateApplicationDto$Outbound = {
+  platform: string;
+  business_information?: BusinessInformationDto$Outbound | undefined;
+  persons_information?: Array<PersonInformationDto$Outbound> | undefined;
+  expected_usage?: ExpectedUsageDto$Outbound | undefined;
+  consents?: ConsentsDto$Outbound | undefined;
+  attachments?: Array<AttachmentDto$Outbound> | undefined;
+  metadata?: CreateApplicationDtoMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateApplicationDto$outboundSchema: z.ZodType<
+  CreateApplicationDto$Outbound,
+  z.ZodTypeDef,
+  CreateApplicationDto
+> = z.object({
+  platform: z.string(),
+  businessInformation: BusinessInformationDto$outboundSchema.optional(),
+  personsInformation: z.array(PersonInformationDto$outboundSchema).optional(),
+  expectedUsage: ExpectedUsageDto$outboundSchema.optional(),
+  consents: ConsentsDto$outboundSchema.optional(),
+  attachments: z.array(AttachmentDto$outboundSchema).optional(),
+  metadata: z.lazy(() => CreateApplicationDtoMetadata$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    businessInformation: "business_information",
+    personsInformation: "persons_information",
+    expectedUsage: "expected_usage",
+  });
+});
+
+export function createApplicationDtoToJSON(
+  createApplicationDto: CreateApplicationDto,
+): string {
+  return JSON.stringify(
+    CreateApplicationDto$outboundSchema.parse(createApplicationDto),
+  );
+}

package/src/models/createpersondto.ts

@@ -78,7 +78,7 @@ export type CreatePersonDto = {
    */
   dateOfBirth: Date;
   /**
-   * Relationship to the business
+   * Relationship of the person to the business. If not provided, will be determined based on ownership percentage and control person status.
    */
   relationship: PersonBusinessRelationship;
   /**

package/src/models/customertype.ts

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

package/src/models/entitycollectionname.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";
+
+/**
+ * Collection name of the entity
+ */
+export const EntityCollectionName = {
+  Businesses: "businesses",
+} as const;
+/**
+ * Collection name of the entity
+ */
+export type EntityCollectionName = ClosedEnum<typeof EntityCollectionName>;
+
+/** @internal */
+export const EntityCollectionName$inboundSchema: z.ZodNativeEnum<
+  typeof EntityCollectionName
+> = z.nativeEnum(EntityCollectionName);
+/** @internal */
+export const EntityCollectionName$outboundSchema: z.ZodNativeEnum<
+  typeof EntityCollectionName
+> = EntityCollectionName$inboundSchema;

package/src/models/expectedusagedto.ts

@@ -0,0 +1,114 @@
+/*
+ * 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 {
+  CustomerType,
+  CustomerType$inboundSchema,
+  CustomerType$outboundSchema,
+} from "./customertype.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  PaymentVolumeRange,
+  PaymentVolumeRange$inboundSchema,
+  PaymentVolumeRange$outboundSchema,
+} from "./paymentvolumerange.js";
+import {
+  RestrictedActivitiesDto,
+  RestrictedActivitiesDto$inboundSchema,
+  RestrictedActivitiesDto$Outbound,
+  RestrictedActivitiesDto$outboundSchema,
+} from "./restrictedactivitiesdto.js";
+
+export type ExpectedUsageDto = {
+  /**
+   * Expected monthly payments volume range
+   */
+  expectedMonthlyPaymentsVolumeRange: PaymentVolumeRange;
+  /**
+   * Operational countries (ISO 3166-1 alpha-2 codes)
+   */
+  operationalCountries: Array<string>;
+  customerTypes: Array<CustomerType>;
+  /**
+   * Funds transfer countries (ISO 3166-1 alpha-2 codes)
+   */
+  fundsTransferCountries: Array<string>;
+  /**
+   * Restricted activities configuration
+   */
+  restrictedActivities: RestrictedActivitiesDto;
+};
+
+/** @internal */
+export const ExpectedUsageDto$inboundSchema: z.ZodType<
+  ExpectedUsageDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expected_monthly_payments_volume_range: PaymentVolumeRange$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: PaymentVolumeRange$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`,
+  );
+}