@oatfi/oatfi-sdk-ts 0.11.53 → 0.11.55

package/src/funcs/underwritingTermsGetHtml.ts

@@ -2,7 +2,6 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod/v3";
 import { OatFiSDKCore } from "../core.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
@@ -21,6 +20,7 @@ import {
 import { OatFiSDKError } from "../models/errors/oatfisdkerror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
@@ -38,7 +38,7 @@ export function underwritingTermsGetHtml(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    void,
+    models.UnderwritingTermsHtmlResponseDto,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -64,7 +64,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      void,
+      models.UnderwritingTermsHtmlResponseDto,
       | OatFiSDKError
       | ResponseValidationError
       | ConnectionError
@@ -99,7 +99,7 @@ async function $do(
   });
 
   const headers = new Headers(compactMap({
-    Accept: "*/*",
+    Accept: "application/json",
   }));
 
   const secConfig = await extractSecurity(client._options.bearer);
@@ -159,7 +159,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    void,
+    models.UnderwritingTermsHtmlResponseDto,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -169,7 +169,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.nil(200, z.void()),
+    M.json(200, models.UnderwritingTermsHtmlResponseDto$inboundSchema),
     M.fail([404, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/usersList.ts

@@ -224,7 +224,7 @@ async function $do(
       usersList(
         client,
         {
-          ...request,
+          ...request!,
           startingAfter: nextCursor,
         },
         options,

package/src/lib/config.ts

@@ -69,8 +69,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "3.0.0",
-  sdkVersion: "0.11.53",
-  genVersion: "2.832.2",
+  sdkVersion: "0.11.55",
+  genVersion: "2.845.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.11.53 2.832.2 3.0.0 @oatfi/oatfi-sdk-ts",
+    "speakeasy-sdk/typescript 0.11.55 2.845.1 3.0.0 @oatfi/oatfi-sdk-ts",
 } as const;

package/src/models/acceptedvia.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";
+
+/**
+ * How the terms were accepted
+ */
+export const AcceptedVia = {
+  Component: "COMPONENT",
+  Hosted: "HOSTED",
+  PartnerApi: "PARTNER_API",
+} as const;
+/**
+ * How the terms were accepted
+ */
+export type AcceptedVia = ClosedEnum<typeof AcceptedVia>;
+
+/** @internal */
+export const AcceptedVia$inboundSchema: z.ZodNativeEnum<typeof AcceptedVia> = z
+  .nativeEnum(AcceptedVia);
+/** @internal */
+export const AcceptedVia$outboundSchema: z.ZodNativeEnum<typeof AcceptedVia> =
+  AcceptedVia$inboundSchema;

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

@@ -24,6 +24,11 @@ import {
   TransferTypeEnum$outboundSchema,
 } from "./transfertypeenum.js";
 
+/**
+ * Verification and consent data
+ */
+export type Verification = {};
+
 export type BusinessPaymentMethodDto = {
   /**
    * Partner associated to the business
@@ -57,8 +62,41 @@ export type BusinessPaymentMethodDto = {
    * The type of payment method
    */
   type: TransferMethodEnum;
+  /**
+   * Verification and consent data
+   */
+  verification?: Verification | undefined;
 };
 
+/** @internal */
+export const Verification$inboundSchema: z.ZodType<
+  Verification,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+/** @internal */
+export type Verification$Outbound = {};
+
+/** @internal */
+export const Verification$outboundSchema: z.ZodType<
+  Verification$Outbound,
+  z.ZodTypeDef,
+  Verification
+> = z.object({});
+
+export function verificationToJSON(verification: Verification): string {
+  return JSON.stringify(Verification$outboundSchema.parse(verification));
+}
+export function verificationFromJSON(
+  jsonString: string,
+): SafeParseResult<Verification, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Verification$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Verification' from JSON`,
+  );
+}
+
 /** @internal */
 export const BusinessPaymentMethodDto$inboundSchema: z.ZodType<
   BusinessPaymentMethodDto,
@@ -73,6 +111,7 @@ export const BusinessPaymentMethodDto$inboundSchema: z.ZodType<
   scheduled_repayment: z.boolean().optional(),
   is_default: z.boolean().optional(),
   type: TransferMethodEnum$inboundSchema,
+  verification: z.lazy(() => Verification$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "transaction_type": "transactionType",
@@ -90,6 +129,7 @@ export type BusinessPaymentMethodDto$Outbound = {
   scheduled_repayment?: boolean | undefined;
   is_default?: boolean | undefined;
   type: string;
+  verification?: Verification$Outbound | undefined;
 };
 
 /** @internal */
@@ -106,6 +146,7 @@ export const BusinessPaymentMethodDto$outboundSchema: z.ZodType<
   scheduledRepayment: z.boolean().optional(),
   isDefault: z.boolean().optional(),
   type: TransferMethodEnum$outboundSchema,
+  verification: z.lazy(() => Verification$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     transactionType: "transaction_type",

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

@@ -9,6 +9,11 @@ import {
   FinancialAccountDataDto$Outbound,
   FinancialAccountDataDto$outboundSchema,
 } from "./financialaccountdatadto.js";
+import {
+  FinancialAccountVerificationDto,
+  FinancialAccountVerificationDto$Outbound,
+  FinancialAccountVerificationDto$outboundSchema,
+} from "./financialaccountverificationdto.js";
 import {
   TransferMethodEnum,
   TransferMethodEnum$outboundSchema,
@@ -76,6 +81,10 @@ export type CreateFinancialAccountDto = {
    * The type of payment method
    */
   type?: TransferMethodEnum | undefined;
+  /**
+   * Verification consent data
+   */
+  verification?: FinancialAccountVerificationDto | undefined;
 };
 
 /** @internal */
@@ -114,6 +123,7 @@ export type CreateFinancialAccountDto$Outbound = {
   scheduled_repayment?: boolean | undefined;
   is_default?: boolean | undefined;
   type?: string | undefined;
+  verification?: FinancialAccountVerificationDto$Outbound | undefined;
 };
 
 /** @internal */
@@ -135,6 +145,7 @@ export const CreateFinancialAccountDto$outboundSchema: z.ZodType<
   scheduledRepayment: z.boolean().optional(),
   isDefault: z.boolean().optional(),
   type: TransferMethodEnum$outboundSchema.optional(),
+  verification: FinancialAccountVerificationDto$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     transactionType: "transaction_type",

package/src/models/createplatformfinancialaccountdto.ts

@@ -9,6 +9,11 @@ import {
   FinancialAccountDataDto$Outbound,
   FinancialAccountDataDto$outboundSchema,
 } from "./financialaccountdatadto.js";
+import {
+  FinancialAccountVerificationDto,
+  FinancialAccountVerificationDto$Outbound,
+  FinancialAccountVerificationDto$outboundSchema,
+} from "./financialaccountverificationdto.js";
 import {
   TransferMethodEnum,
   TransferMethodEnum$outboundSchema,
@@ -64,6 +69,10 @@ export type CreatePlatformFinancialAccountDto = {
    * The type of payment method
    */
   type?: TransferMethodEnum | undefined;
+  /**
+   * Verification consent data
+   */
+  verification?: FinancialAccountVerificationDto | undefined;
 };
 
 /** @internal */
@@ -99,6 +108,7 @@ export type CreatePlatformFinancialAccountDto$Outbound = {
   scheduled_repayment?: boolean | undefined;
   is_default?: boolean | undefined;
   type?: string | undefined;
+  verification?: FinancialAccountVerificationDto$Outbound | undefined;
 };
 
 /** @internal */
@@ -117,6 +127,7 @@ export const CreatePlatformFinancialAccountDto$outboundSchema: z.ZodType<
   scheduledRepayment: z.boolean().optional(),
   isDefault: z.boolean().optional(),
   type: TransferMethodEnum$outboundSchema.optional(),
+  verification: FinancialAccountVerificationDto$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     transactionType: "transaction_type",

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

@@ -12,6 +12,10 @@ import {
   FinancialAccountDataDto,
   FinancialAccountDataDto$inboundSchema,
 } from "./financialaccountdatadto.js";
+import {
+  FinancialAccountVerificationResponseDto,
+  FinancialAccountVerificationResponseDto$inboundSchema,
+} from "./financialaccountverificationresponsedto.js";
 
 /**
  * Payment Method Type
@@ -85,6 +89,10 @@ export type FinancialAccountResponseDto = {
    * Payment rail data
    */
   data: FinancialAccountDataDto;
+  /**
+   * Verification data
+   */
+  verification?: FinancialAccountVerificationResponseDto | undefined;
 };
 
 /** @internal */
@@ -111,6 +119,8 @@ export const FinancialAccountResponseDto$inboundSchema: z.ZodType<
   scheduled_repayment: z.boolean().optional(),
   alias: z.string().optional(),
   data: FinancialAccountDataDto$inboundSchema,
+  verification: FinancialAccountVerificationResponseDto$inboundSchema
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "transaction_type": "transactionType",

package/src/models/financialaccountverificationdto.ts

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+/**
+ * Source of consent
+ */
+export const ConsentSource = {
+  Embedded: "EMBEDDED",
+  Hosted: "HOSTED",
+  PartnerApi: "PARTNER_API",
+} as const;
+/**
+ * Source of consent
+ */
+export type ConsentSource = ClosedEnum<typeof ConsentSource>;
+
+export type FinancialAccountVerificationDto = {
+  /**
+   * Whether consent given for ACH verification
+   */
+  consentGiven: boolean;
+  /**
+   * Source of consent
+   */
+  consentSource: ConsentSource;
+};
+
+/** @internal */
+export const ConsentSource$outboundSchema: z.ZodNativeEnum<
+  typeof ConsentSource
+> = z.nativeEnum(ConsentSource);
+
+/** @internal */
+export type FinancialAccountVerificationDto$Outbound = {
+  consent_given: boolean;
+  consent_source: string;
+};
+
+/** @internal */
+export const FinancialAccountVerificationDto$outboundSchema: z.ZodType<
+  FinancialAccountVerificationDto$Outbound,
+  z.ZodTypeDef,
+  FinancialAccountVerificationDto
+> = z.object({
+  consentGiven: z.boolean(),
+  consentSource: ConsentSource$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    consentGiven: "consent_given",
+    consentSource: "consent_source",
+  });
+});
+
+export function financialAccountVerificationDtoToJSON(
+  financialAccountVerificationDto: FinancialAccountVerificationDto,
+): string {
+  return JSON.stringify(
+    FinancialAccountVerificationDto$outboundSchema.parse(
+      financialAccountVerificationDto,
+    ),
+  );
+}

package/src/models/financialaccountverificationresponsedto.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 FinancialAccountVerificationResponseDto = {
+  /**
+   * Whether consent given for ACH verification
+   */
+  consentGiven: boolean;
+  /**
+   * Source of consent
+   */
+  consentSource: string;
+  /**
+   * Timestamp when consent was given
+   */
+  consentTimestamp?: Date | undefined;
+  /**
+   * Credit verification status
+   */
+  creditVerificationStatus?: string | undefined;
+  /**
+   * Credit verification timestamp
+   */
+  creditVerificationTimestamp?: Date | undefined;
+  /**
+   * Debit verification status
+   */
+  debitVerificationStatus?: string | undefined;
+  /**
+   * Debit verification timestamp
+   */
+  debitVerificationTimestamp?: Date | undefined;
+};
+
+/** @internal */
+export const FinancialAccountVerificationResponseDto$inboundSchema: z.ZodType<
+  FinancialAccountVerificationResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  consent_given: z.boolean(),
+  consent_source: z.string(),
+  consent_timestamp: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  credit_verification_status: z.string().optional(),
+  credit_verification_timestamp: z.string().datetime({ offset: true })
+    .transform(v => new Date(v)).optional(),
+  debit_verification_status: z.string().optional(),
+  debit_verification_timestamp: z.string().datetime({ offset: true }).transform(
+    v => new Date(v)
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "consent_given": "consentGiven",
+    "consent_source": "consentSource",
+    "consent_timestamp": "consentTimestamp",
+    "credit_verification_status": "creditVerificationStatus",
+    "credit_verification_timestamp": "creditVerificationTimestamp",
+    "debit_verification_status": "debitVerificationStatus",
+    "debit_verification_timestamp": "debitVerificationTimestamp",
+  });
+});
+
+export function financialAccountVerificationResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  FinancialAccountVerificationResponseDto,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FinancialAccountVerificationResponseDto$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'FinancialAccountVerificationResponseDto' from JSON`,
+  );
+}