@oatfi/oatfi-sdk-ts 0.12.4 → 0.12.5

package/src/funcs/transactionsList.ts

@@ -0,0 +1,255 @@
+/*
+ * 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 { matchStatusCode } from "../lib/http.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 stored transactions
+ *
+ * @remarks
+ * Finance-only. Lists partner-uploaded transactions for a business and loan program.
+ *
+ * If set, this operation will use {@link Security.bearer} from the global security.
+ */
+export function transactionsList(
+  client: OatFiSDKCore,
+  request: operations.TransactionsControllerFindAllRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.TransactionsControllerFindAllResponse,
+      | OatFiSDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OatFiSDKCore,
+  request: operations.TransactionsControllerFindAllRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.TransactionsControllerFindAllResponse,
+        | OatFiSDKError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.TransactionsControllerFindAllRequest$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/transactions")();
+
+  const query = encodeFormQuery({
+    "business": payload.business,
+    "ending_before": payload.ending_before,
+    "limit": payload.limit,
+    "program": payload.program,
+    "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, [0]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "TransactionsController_findAll",
+    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,
+    uaHeader: "x-speakeasy-user-agent",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "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.TransactionsControllerFindAllResponse,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.TransactionsControllerFindAllResponse$inboundSchema,
+      { key: "Result" },
+    ),
+    M.fail([400, 403, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.TransactionsControllerFindAllResponse,
+        | 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 = () =>
+      transactionsList(
+        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/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.12.4",
+  sdkVersion: "0.12.5",
   genVersion: "2.912.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.12.4 2.912.1 3.0.0 @oatfi/oatfi-sdk-ts",
+    "speakeasy-sdk/typescript 0.12.5 2.912.1 3.0.0 @oatfi/oatfi-sdk-ts",
 } as const;

package/src/models/businessdataresponsedto.ts

@@ -0,0 +1,94 @@
+/*
+ * 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 * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+ */
+export const BusinessDataResponseDtoStatus = {
+  Active: "active",
+  Inactive: "inactive",
+} as const;
+/**
+ * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+ */
+export type BusinessDataResponseDtoStatus = ClosedEnum<
+  typeof BusinessDataResponseDtoStatus
+>;
+
+export type BusinessDataResponseDto = {
+  /**
+   * Partner-assigned external id (the path key).
+   */
+  externalId: string;
+  /**
+   * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+   */
+  status: BusinessDataResponseDtoStatus;
+  /**
+   * Legal business name.
+   */
+  name?: string | null | undefined;
+  /**
+   * Tax id (e.g. EIN).
+   */
+  taxId?: string | null | undefined;
+  /**
+   * Legal entity type.
+   */
+  businessEntityType?: string | null | undefined;
+  /**
+   * Unix ms when the lender created its record.
+   */
+  createdAt?: number | undefined;
+  /**
+   * Unix ms of the last update.
+   */
+  updatedAt?: number | undefined;
+};
+
+/** @internal */
+export const BusinessDataResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof BusinessDataResponseDtoStatus
+> = z.nativeEnum(BusinessDataResponseDtoStatus);
+
+/** @internal */
+export const BusinessDataResponseDto$inboundSchema: z.ZodType<
+  BusinessDataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  external_id: types.string(),
+  status: BusinessDataResponseDtoStatus$inboundSchema,
+  name: z.nullable(types.string()).optional(),
+  tax_id: z.nullable(types.string()).optional(),
+  business_entity_type: z.nullable(types.string()).optional(),
+  created_at: types.optional(types.number()),
+  updated_at: types.optional(types.number()),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+    "tax_id": "taxId",
+    "business_entity_type": "businessEntityType",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function businessDataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BusinessDataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BusinessDataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BusinessDataResponseDto' from JSON`,
+  );
+}

package/src/models/businessresponsedto.ts

@@ -8,57 +8,187 @@ import { safeParse } from "../lib/schemas.js";
 import { ClosedEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import * as types from "../types/primitives.js";
+import { AddressDto, AddressDto$inboundSchema } from "./addressdto.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  IncreaseDataDto,
+  IncreaseDataDto$inboundSchema,
+} from "./increasedatadto.js";
 
 /**
- * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+ * Current status of the business account
  */
-export const BusinessResponseDtoStatus = {
-  Active: "active",
-  Inactive: "inactive",
+export const AccountStatus = {
+  Active: "ACTIVE",
+  Frozen: "FROZEN",
+  Inactive: "INACTIVE",
+  Closed: "CLOSED",
+  BlockList: "BLOCK_LIST",
 } as const;
 /**
- * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+ * Current status of the business account
  */
-export type BusinessResponseDtoStatus = ClosedEnum<
-  typeof BusinessResponseDtoStatus
+export type AccountStatus = ClosedEnum<typeof AccountStatus>;
+
+/**
+ * Current sub-status of the business account
+ */
+export const AccountSubStatus = {
+  Standard: "STANDARD",
+  Manual: "MANUAL",
+  ManualLock: "MANUAL_LOCK",
+  Dq: "DQ",
+  WaiveDrawRules: "WAIVE_DRAW_RULES",
+  Unit: "UNIT",
+} as const;
+/**
+ * Current sub-status of the business account
+ */
+export type AccountSubStatus = ClosedEnum<typeof AccountSubStatus>;
+
+/**
+ * Source of the requested credit limit.
+ */
+export const BusinessResponseDtoRequestedLimitSource = {
+  Partner: "Partner",
+  Customer: "Customer",
+} as const;
+/**
+ * Source of the requested credit limit.
+ */
+export type BusinessResponseDtoRequestedLimitSource = ClosedEnum<
+  typeof BusinessResponseDtoRequestedLimitSource
 >;
 
 export type BusinessResponseDto = {
   /**
-   * Partner-assigned external id (the path key).
+   * Unique identifier for the business.
+   */
+  id: string;
+  /**
+   * String representing the object's type. Always 'business'.
+   */
+  object: string;
+  /**
+   * External identifier for the business.
+   */
+  externalId?: string | undefined;
+  /**
+   * Identifier of the platform this business is associated with.
+   */
+  platform?: string | undefined;
+  /**
+   * List of financial account IDs associated with this business.
+   */
+  financialAccounts?: Array<string> | undefined;
+  /**
+   * List of Plaid token IDs associated with this business.
+   */
+  plaidTokens?: Array<string> | undefined;
+  /**
+   * List of person IDs associated with this business.
+   */
+  persons?: Array<string> | undefined;
+  /**
+   * Legal name of the business.
+   */
+  name?: string | undefined;
+  /**
+   * Doing Business As (DBA) name.
+   */
+  dbaName?: string | undefined;
+  /**
+   * Tax ID (e.g., EIN for US businesses).
+   */
+  taxId?: string | undefined;
+  /**
+   * Business address.
+   */
+  address?: AddressDto | undefined;
+  /**
+   * Contact person's first name. Populated from the primary user's first name.
+   */
+  contactFirstName?: string | undefined;
+  /**
+   * Contact person's last name. Populated from the primary user's last name.
+   */
+  contactLastName?: string | undefined;
+  /**
+   * Contact person's email address. Populated from the primary user's email.
+   */
+  contactEmail?: string | undefined;
+  /**
+   * Contact person's phone number.
+   */
+  contactPhone?: string | undefined;
+  /**
+   * Month the business started (MM).
+   */
+  businessStartDateMonth?: string | undefined;
+  /**
+   * Year the business started (YYYY).
    */
-  externalId: string;
+  businessStartDateYear?: string | undefined;
   /**
-   * Lender-side account state. inactive covers suspended/frozen/closed/blocked.
+   * Type of business entity (e.g., corporation, llc).
    */
-  status: BusinessResponseDtoStatus;
+  businessEntityType?: string | undefined;
   /**
-   * Legal business name.
+   * Current status of the business account
    */
-  name?: string | null | undefined;
+  accountStatus?: AccountStatus | undefined;
   /**
-   * Tax id (e.g. EIN).
+   * Current sub-status of the business account
    */
-  taxId?: string | null | undefined;
+  accountSubStatus?: AccountSubStatus | undefined;
   /**
-   * Legal entity type.
+   * Timestamp of when the business was created.
    */
-  businessEntityType?: string | null | undefined;
+  createdAt?: Date | undefined;
   /**
-   * Unix ms when the lender created its record.
+   * Timestamp of when the business was last updated.
    */
-  createdAt?: number | undefined;
+  updatedAt?: Date | undefined;
   /**
-   * Unix ms of the last update.
+   * List of user IDs associated with this business.
    */
-  updatedAt?: number | undefined;
+  users?: Array<string> | undefined;
+  /**
+   * ID of the primary user associated with this business.
+   */
+  primaryUser?: string | undefined;
+  /**
+   * Source of the requested credit limit.
+   */
+  requestedLimitSource?: BusinessResponseDtoRequestedLimitSource | undefined;
+  /**
+   * Requested credit limit amount.
+   */
+  requestedCreditLimit?: number | undefined;
+  /**
+   * A set of key-value pairs that can be used to store additional information about the object.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Increase account data associated with this business.
+   */
+  increase?: IncreaseDataDto | undefined;
 };
 
 /** @internal */
-export const BusinessResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
-  typeof BusinessResponseDtoStatus
-> = z.nativeEnum(BusinessResponseDtoStatus);
+export const AccountStatus$inboundSchema: z.ZodNativeEnum<
+  typeof AccountStatus
+> = z.nativeEnum(AccountStatus);
+
+/** @internal */
+export const AccountSubStatus$inboundSchema: z.ZodNativeEnum<
+  typeof AccountSubStatus
+> = z.nativeEnum(AccountSubStatus);
+
+/** @internal */
+export const BusinessResponseDtoRequestedLimitSource$inboundSchema:
+  z.ZodNativeEnum<typeof BusinessResponseDtoRequestedLimitSource> = z
+    .nativeEnum(BusinessResponseDtoRequestedLimitSource);
 
 /** @internal */
 export const BusinessResponseDto$inboundSchema: z.ZodType<
@@ -66,20 +196,57 @@ export const BusinessResponseDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  external_id: types.string(),
-  status: BusinessResponseDtoStatus$inboundSchema,
-  name: z.nullable(types.string()).optional(),
-  tax_id: z.nullable(types.string()).optional(),
-  business_entity_type: z.nullable(types.string()).optional(),
-  created_at: types.optional(types.number()),
-  updated_at: types.optional(types.number()),
+  id: types.string(),
+  object: types.string().default("business"),
+  external_id: types.optional(types.string()),
+  platform: types.optional(types.string()),
+  financial_accounts: types.optional(z.array(types.string())),
+  plaid_tokens: types.optional(z.array(types.string())),
+  persons: types.optional(z.array(types.string())),
+  name: types.optional(types.string()),
+  dba_name: types.optional(types.string()),
+  tax_id: types.optional(types.string()),
+  address: types.optional(AddressDto$inboundSchema),
+  contact_first_name: types.optional(types.string()),
+  contact_last_name: types.optional(types.string()),
+  contact_email: types.optional(types.string()),
+  contact_phone: types.optional(types.string()),
+  business_start_date_month: types.optional(types.string()),
+  business_start_date_year: types.optional(types.string()),
+  business_entity_type: types.optional(types.string()),
+  account_status: types.optional(AccountStatus$inboundSchema),
+  account_sub_status: types.optional(AccountSubStatus$inboundSchema),
+  created_at: types.optional(types.date()),
+  updated_at: types.optional(types.date()),
+  users: types.optional(z.array(types.string())),
+  primary_user: types.optional(types.string()),
+  requested_limit_source: types.optional(
+    BusinessResponseDtoRequestedLimitSource$inboundSchema,
+  ),
+  requested_credit_limit: types.optional(types.number()),
+  metadata: types.optional(z.record(z.any())),
+  increase: types.optional(IncreaseDataDto$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "external_id": "externalId",
+    "financial_accounts": "financialAccounts",
+    "plaid_tokens": "plaidTokens",
+    "dba_name": "dbaName",
     "tax_id": "taxId",
+    "contact_first_name": "contactFirstName",
+    "contact_last_name": "contactLastName",
+    "contact_email": "contactEmail",
+    "contact_phone": "contactPhone",
+    "business_start_date_month": "businessStartDateMonth",
+    "business_start_date_year": "businessStartDateYear",
     "business_entity_type": "businessEntityType",
+    "account_status": "accountStatus",
+    "account_sub_status": "accountSubStatus",
     "created_at": "createdAt",
     "updated_at": "updatedAt",
+    "primary_user": "primaryUser",
+    "requested_limit_source": "requestedLimitSource",
+    "requested_credit_limit": "requestedCreditLimit",
   });
 });
 

package/src/models/createtransactionsdto.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  TransactionItemDto,
+  TransactionItemDto$Outbound,
+  TransactionItemDto$outboundSchema,
+} from "./transactionitemdto.js";
+
+export type CreateTransactionsDto = {
+  /**
+   * Business the transactions belong to
+   */
+  business: string;
+  /**
+   * Loan program the transactions belong to
+   */
+  program: string;
+  /**
+   * Transactions to store
+   */
+  transactions: Array<TransactionItemDto>;
+};
+
+/** @internal */
+export type CreateTransactionsDto$Outbound = {
+  business: string;
+  program: string;
+  transactions: Array<TransactionItemDto$Outbound>;
+};
+
+/** @internal */
+export const CreateTransactionsDto$outboundSchema: z.ZodType<
+  CreateTransactionsDto$Outbound,
+  z.ZodTypeDef,
+  CreateTransactionsDto
+> = z.object({
+  business: z.string(),
+  program: z.string(),
+  transactions: z.array(TransactionItemDto$outboundSchema),
+});
+
+export function createTransactionsDtoToJSON(
+  createTransactionsDto: CreateTransactionsDto,
+): string {
+  return JSON.stringify(
+    CreateTransactionsDto$outboundSchema.parse(createTransactionsDto),
+  );
+}