@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.62

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/businessbalancedto.ts

@@ -24,11 +24,11 @@ export type BusinessBalanceDto = {
   /**
    * Business identifier
    */
-  businessId: string;
+  business: string;
   /**
    * Program identifier
    */
-  programId: string;
+  program: string;
   /**
    * Total available credit limit in cents
    */
@@ -63,8 +63,8 @@ export const BusinessBalanceDto$inboundSchema: z.ZodType<
 > = z.object({
   object: z.string().default("business_balance"),
   id: z.string(),
-  business_id: z.string(),
-  program_id: z.string(),
+  business: z.string(),
+  program: z.string(),
   total_available_credit_limit: z.number(),
   total_loans: z.number(),
   originations: z.array(OriginationBalanceDto$inboundSchema),
@@ -73,8 +73,6 @@ export const BusinessBalanceDto$inboundSchema: z.ZodType<
   metadata: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
-    "business_id": "businessId",
-    "program_id": "programId",
     "total_available_credit_limit": "totalAvailableCreditLimit",
     "total_loans": "totalLoans",
     "created_at": "createdAt",

package/src/models/businessbalancesummarydto.ts

@@ -0,0 +1,70 @@
+/*
+ * 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
+   */
+  business: 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: z.string(),
+  balance_by_product: BalanceByProductDto$inboundSchema,
+  created_at: z.string(),
+  updated_at: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "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`,
+  );
+}

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/businesslistresponsedto.ts

@@ -6,12 +6,10 @@ 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 {
-  BusinessResponseDto,
-  BusinessResponseDto$inboundSchema,
-} from "./businessresponsedto.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
+export type BusinessListResponseDtoData = {};
+
 export type BusinessListResponseDto = {
   /**
    * Type of the response
@@ -20,7 +18,7 @@ export type BusinessListResponseDto = {
   /**
    * Array of business objects
    */
-  data: Array<BusinessResponseDto>;
+  data: Array<BusinessListResponseDtoData>;
   /**
    * Whether there are more items to fetch
    */
@@ -31,6 +29,23 @@ export type BusinessListResponseDto = {
   total: number;
 };
 
+/** @internal */
+export const BusinessListResponseDtoData$inboundSchema: z.ZodType<
+  BusinessListResponseDtoData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function businessListResponseDtoDataFromJSON(
+  jsonString: string,
+): SafeParseResult<BusinessListResponseDtoData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessListResponseDtoData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessListResponseDtoData' from JSON`,
+  );
+}
+
 /** @internal */
 export const BusinessListResponseDto$inboundSchema: z.ZodType<
   BusinessListResponseDto,
@@ -38,7 +53,7 @@ export const BusinessListResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   object: z.string().default("list"),
-  data: z.array(BusinessResponseDto$inboundSchema),
+  data: z.array(z.lazy(() => BusinessListResponseDtoData$inboundSchema)),
   has_more: z.boolean(),
   total: z.number(),
 }).transform((v) => {

package/src/models/businessresponsedto.ts

@@ -48,14 +48,16 @@ export type AccountSubStatus = ClosedEnum<typeof AccountSubStatus>;
 /**
  * Source of the requested credit limit.
  */
-export const RequestedLimitSource = {
+export const BusinessResponseDtoRequestedLimitSource = {
   Partner: "Partner",
   Customer: "Customer",
 } as const;
 /**
  * Source of the requested credit limit.
  */
-export type RequestedLimitSource = ClosedEnum<typeof RequestedLimitSource>;
+export type BusinessResponseDtoRequestedLimitSource = ClosedEnum<
+  typeof BusinessResponseDtoRequestedLimitSource
+>;
 
 export type BusinessResponseDto = {
   /**
@@ -157,7 +159,7 @@ export type BusinessResponseDto = {
   /**
    * Source of the requested credit limit.
    */
-  requestedLimitSource?: RequestedLimitSource | undefined;
+  requestedLimitSource?: BusinessResponseDtoRequestedLimitSource | undefined;
   /**
    * Requested credit limit amount.
    */
@@ -183,9 +185,9 @@ export const AccountSubStatus$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(AccountSubStatus);
 
 /** @internal */
-export const RequestedLimitSource$inboundSchema: z.ZodNativeEnum<
-  typeof RequestedLimitSource
-> = z.nativeEnum(RequestedLimitSource);
+export const BusinessResponseDtoRequestedLimitSource$inboundSchema:
+  z.ZodNativeEnum<typeof BusinessResponseDtoRequestedLimitSource> = z
+    .nativeEnum(BusinessResponseDtoRequestedLimitSource);
 
 /** @internal */
 export const BusinessResponseDto$inboundSchema: z.ZodType<
@@ -219,7 +221,8 @@ export const BusinessResponseDto$inboundSchema: z.ZodType<
     .optional(),
   users: z.array(z.string()).optional(),
   primary_user: z.string().optional(),
-  requested_limit_source: RequestedLimitSource$inboundSchema.optional(),
+  requested_limit_source: BusinessResponseDtoRequestedLimitSource$inboundSchema
+    .optional(),
   requested_credit_limit: z.number().optional(),
   metadata: z.record(z.any()).optional(),
   increase: IncreaseDataDto$inboundSchema.optional(),

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`,
+  );
+}