@oatfi/oatfi-sdk-ts 0.11.59 → 0.11.61

package/src/funcs/increaseTransactionsList.ts

@@ -0,0 +1,253 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { JsonValue, query as jpQuery } from "jsonpath-rfc9535";
+import { OatFiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OatFiSDKError } from "../models/errors/oatfisdkerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List increase transactions
+ *
+ * @remarks
+ * Retrieve a paginated list of increase transactions for a specific beneficiary with filtering, sorting, and search capabilities.
+ */
+export function increaseTransactionsList(
+  client: OatFiSDKCore,
+  request:
+    operations.IncreaseTransactionsControllerListIncreaseTransactionsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.IncreaseTransactionsControllerListIncreaseTransactionsResponse,
+      | OatFiSDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OatFiSDKCore,
+  request:
+    operations.IncreaseTransactionsControllerListIncreaseTransactionsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.IncreaseTransactionsControllerListIncreaseTransactionsResponse,
+        | OatFiSDKError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations
+        .IncreaseTransactionsControllerListIncreaseTransactionsRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v3/increase-transactions")();
+
+  const query = encodeFormQuery({
+    "beneficiary_id": payload.beneficiary_id,
+    "ending_before": payload.ending_before,
+    "limit": payload.limit,
+    "q": payload.q,
+    "starting_after": payload.starting_after,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearer);
+  const securityInput = secConfig == null ? {} : { bearer: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "IncreaseTransactionsController_listIncreaseTransactions",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearer,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "422", "429", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.IncreaseTransactionsControllerListIncreaseTransactionsResponse,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations
+        .IncreaseTransactionsControllerListIncreaseTransactionsResponse$inboundSchema,
+      { key: "Result" },
+    ),
+    M.fail([400, 401, 403, 422, 429, "4XX"]),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.IncreaseTransactionsControllerListIncreaseTransactionsResponse,
+        | OatFiSDKError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = jpQuery(responseData as JsonValue, "$.data[-1].id")[0];
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+    if (nextCursor.trim() === "") {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      increaseTransactionsList(
+        client,
+        {
+          ...request,
+          startingAfter: nextCursor,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/funcs/underwritingTermsGetHtml.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OatFiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+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";
+
+/**
+ * Get underwriting terms HTML
+ *
+ * @remarks
+ * Retrieves the rendered HTML content for underwriting terms given a business and loan program.
+ */
+export function underwritingTermsGetHtml(
+  client: OatFiSDKCore,
+  request:
+    operations.UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.UnderwritingTermsHtmlResponseDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OatFiSDKCore,
+  request:
+    operations.UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.UnderwritingTermsHtmlResponseDto,
+      | OatFiSDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations
+        .UnderwritingTermsControllerGetUnderwritingTermsHtmlRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v3/underwriting-terms/html")();
+
+  const query = encodeFormQuery({
+    "business_id": payload.business_id,
+    "loan_program_id": payload.loan_program_id,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearer);
+  const securityInput = secConfig == null ? {} : { bearer: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "UnderwritingTermsController_getUnderwritingTermsHtml",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearer,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    models.UnderwritingTermsHtmlResponseDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.UnderwritingTermsHtmlResponseDto$inboundSchema),
+    M.fail([404, "4XX"]),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

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.59",
-  genVersion: "2.859.2",
+  sdkVersion: "0.11.61",
+  genVersion: "2.865.2",
   userAgent:
-    "speakeasy-sdk/typescript 0.11.59 2.859.2 3.0.0 @oatfi/oatfi-sdk-ts",
+    "speakeasy-sdk/typescript 0.11.61 2.865.2 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/addressdto.ts

@@ -32,7 +32,7 @@ export type AddressDto = {
   /**
    * Country code (2-letter ISO 3166-1 alpha-2)
    */
-  country: string;
+  country?: string | undefined;
 };
 
 /** @internal */
@@ -54,7 +54,39 @@ export const AddressDto$inboundSchema: z.ZodType<
     "postal_code": "postalCode",
   });
 });
+/** @internal */
+export type AddressDto$Outbound = {
+  line_1: string;
+  line_2?: string | undefined;
+  city: string;
+  state: string;
+  postal_code: string;
+  country: string;
+};
+
+/** @internal */
+export const AddressDto$outboundSchema: z.ZodType<
+  AddressDto$Outbound,
+  z.ZodTypeDef,
+  AddressDto
+> = z.object({
+  line1: z.string(),
+  line2: z.string().optional(),
+  city: z.string(),
+  state: z.string(),
+  postalCode: z.string(),
+  country: z.string().default("US"),
+}).transform((v) => {
+  return remap$(v, {
+    line1: "line_1",
+    line2: "line_2",
+    postalCode: "postal_code",
+  });
+});
 
+export function addressDtoToJSON(addressDto: AddressDto): string {
+  return JSON.stringify(AddressDto$outboundSchema.parse(addressDto));
+}
 export function addressDtoFromJSON(
   jsonString: string,
 ): SafeParseResult<AddressDto, SDKValidationError> {

package/src/models/adverseactiondto.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 {
+  AdverseActionType,
+  AdverseActionType$inboundSchema,
+  AdverseActionType$outboundSchema,
+} from "./adverseactiontype.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type AdverseActionDto = {
+  /**
+   * Description of the adverse action
+   */
+  description: string;
+  /**
+   * Type of adverse action
+   */
+  type: AdverseActionType;
+  /**
+   * ID of the entity (e.g., person ID from persons_information) this adverse action relates to. Required if type is KYC.
+   */
+  entityId?: string | undefined;
+};
+
+/** @internal */
+export const AdverseActionDto$inboundSchema: z.ZodType<
+  AdverseActionDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.string(),
+  type: AdverseActionType$inboundSchema,
+  entity_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "entity_id": "entityId",
+  });
+});
+/** @internal */
+export type AdverseActionDto$Outbound = {
+  description: string;
+  type: string;
+  entity_id?: string | undefined;
+};
+
+/** @internal */
+export const AdverseActionDto$outboundSchema: z.ZodType<
+  AdverseActionDto$Outbound,
+  z.ZodTypeDef,
+  AdverseActionDto
+> = z.object({
+  description: z.string(),
+  type: AdverseActionType$outboundSchema,
+  entityId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    entityId: "entity_id",
+  });
+});
+
+export function adverseActionDtoToJSON(
+  adverseActionDto: AdverseActionDto,
+): string {
+  return JSON.stringify(
+    AdverseActionDto$outboundSchema.parse(adverseActionDto),
+  );
+}
+export function adverseActionDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<AdverseActionDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdverseActionDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdverseActionDto' from JSON`,
+  );
+}

package/src/models/adverseactiontype.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * Type of adverse action
+ */
+export const AdverseActionType = {
+  Kyb: "KYB",
+  Kyc: "KYC",
+} as const;
+/**
+ * Type of adverse action
+ */
+export type AdverseActionType = ClosedEnum<typeof AdverseActionType>;
+
+/** @internal */
+export const AdverseActionType$inboundSchema: z.ZodNativeEnum<
+  typeof AdverseActionType
+> = z.nativeEnum(AdverseActionType);
+/** @internal */
+export const AdverseActionType$outboundSchema: z.ZodNativeEnum<
+  typeof AdverseActionType
+> = AdverseActionType$inboundSchema;