@oatfi/oatfi-sdk-ts 0.12.3 → 0.12.4

package/src/funcs/networkLedgerRemoveObligation.ts

@@ -0,0 +1,210 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OatFiSDKCore } from "../core.js";
+import { encodeJSON, encodeSimple } 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 { resolveSecurity } 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";
+
+/**
+ * Remove buyer obligation (removeObligation).
+ */
+export function networkLedgerRemoveObligation(
+  client: OatFiSDKCore,
+  security: operations.NetworkControllerRemoveObligationSecurity,
+  request: operations.NetworkControllerRemoveObligationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.ConfirmedEnvelopeDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OatFiSDKCore,
+  security: operations.NetworkControllerRemoveObligationSecurity,
+  request: operations.NetworkControllerRemoveObligationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.ConfirmedEnvelopeDto,
+      | OatFiSDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.NetworkControllerRemoveObligationRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.CancelRequestDto, { explode: true });
+
+  const pathParams = {
+    ledger_entry_external_id: encodeSimple(
+      "ledger_entry_external_id",
+      payload.ledger_entry_external_id,
+      { explode: false, charEncoding: "percent" },
+    ),
+  };
+  const path = pathToFunc(
+    "/v3/network/ledger-entries/{ledger_entry_external_id}/cancel",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+    "Idempotency-Key": encodeSimple(
+      "Idempotency-Key",
+      payload["Idempotency-Key"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "User-Agent": encodeSimple("User-Agent", payload["User-Agent"], {
+      explode: false,
+      charEncoding: "none",
+    }),
+    "X-Network-Request-Id": encodeSimple(
+      "X-Network-Request-Id",
+      payload["X-Network-Request-Id"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "X-Network-Role": encodeSimple(
+      "X-Network-Role",
+      payload["X-Network-Role"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        type: "http:basic",
+        value: { username: security?.username, password: security?.password },
+      },
+    ],
+  );
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "NetworkController_removeObligation",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: security,
+    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: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    uaHeader: "x-speakeasy-user-agent",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.ConfirmedEnvelopeDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.ConfirmedEnvelopeDto$inboundSchema),
+    M.fail([400, 401, 404, 409, 422, 429, "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/funcs/networkLedgerUpdateHold.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OatFiSDKCore } from "../core.js";
+import { encodeJSON, encodeSimple } 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 { resolveSecurity } 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";
+
+/**
+ * Patch hold — amend outstanding_amount down (patchHold).
+ */
+export function networkLedgerUpdateHold(
+  client: OatFiSDKCore,
+  security: operations.NetworkControllerPatchHoldSecurity,
+  request: operations.NetworkControllerPatchHoldRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.OkEnvelopeDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OatFiSDKCore,
+  security: operations.NetworkControllerPatchHoldSecurity,
+  request: operations.NetworkControllerPatchHoldRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.OkEnvelopeDto,
+      | OatFiSDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.NetworkControllerPatchHoldRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.PatchHoldRequestDto, {
+    explode: true,
+  });
+
+  const pathParams = {
+    hold_id: encodeSimple("hold_id", payload.hold_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v3/network/holds/{hold_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+    "Idempotency-Key": encodeSimple(
+      "Idempotency-Key",
+      payload["Idempotency-Key"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "User-Agent": encodeSimple("User-Agent", payload["User-Agent"], {
+      explode: false,
+      charEncoding: "none",
+    }),
+    "X-Network-Request-Id": encodeSimple(
+      "X-Network-Request-Id",
+      payload["X-Network-Request-Id"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "X-Network-Role": encodeSimple(
+      "X-Network-Role",
+      payload["X-Network-Role"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        type: "http:basic",
+        value: { username: security?.username, password: security?.password },
+      },
+    ],
+  );
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "NetworkController_patchHold",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: security,
+    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: "PATCH",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    uaHeader: "x-speakeasy-user-agent",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.OkEnvelopeDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.OkEnvelopeDto$inboundSchema),
+    M.fail([400, 401, 404, 409, 422, 429, "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/funcs/networkLedgerUpdateInvoice.ts

@@ -0,0 +1,212 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OatFiSDKCore } from "../core.js";
+import { encodeJSON, encodeSimple } 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 { resolveSecurity } 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";
+
+/**
+ * Update invoice on the lender (updateInvoice).
+ */
+export function networkLedgerUpdateInvoice(
+  client: OatFiSDKCore,
+  security: operations.NetworkControllerUpdateInvoiceSecurity,
+  request: operations.NetworkControllerUpdateInvoiceRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.OkEnvelopeDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OatFiSDKCore,
+  security: operations.NetworkControllerUpdateInvoiceSecurity,
+  request: operations.NetworkControllerUpdateInvoiceRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.OkEnvelopeDto,
+      | OatFiSDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.NetworkControllerUpdateInvoiceRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.LedgerEntrySnapshotDto, {
+    explode: true,
+  });
+
+  const pathParams = {
+    ledger_entry_external_id: encodeSimple(
+      "ledger_entry_external_id",
+      payload.ledger_entry_external_id,
+      { explode: false, charEncoding: "percent" },
+    ),
+  };
+  const path = pathToFunc(
+    "/v3/network/ledger-entries/{ledger_entry_external_id}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+    "Idempotency-Key": encodeSimple(
+      "Idempotency-Key",
+      payload["Idempotency-Key"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "User-Agent": encodeSimple("User-Agent", payload["User-Agent"], {
+      explode: false,
+      charEncoding: "none",
+    }),
+    "X-Network-Request-Id": encodeSimple(
+      "X-Network-Request-Id",
+      payload["X-Network-Request-Id"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "X-Network-Role": encodeSimple(
+      "X-Network-Role",
+      payload["X-Network-Role"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        type: "http:basic",
+        value: { username: security?.username, password: security?.password },
+      },
+    ],
+  );
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "NetworkController_updateInvoice",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: security,
+    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: "PATCH",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    uaHeader: "x-speakeasy-user-agent",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.OkEnvelopeDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.OkEnvelopeDto$inboundSchema),
+    M.fail([400, 401, 404, 409, 422, 429, "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/funcs/onboardingTermsAgreementAssignmentInternalControllerCreate.ts

@@ -30,6 +30,8 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Creates a new agreement assignment record. When a business entity accepts onboarding terms (via hosted flow or embedded component), a webhook event `agreement_acceptance.created` is automatically emitted to the partner's configured webhook endpoint. The event payload includes the business Mongo id, timestamp of acceptance, and terms version identifier.
+ *
+ * If set, this operation will use {@link Security.bearer} from the global security.
  */
 export function onboardingTermsAgreementAssignmentInternalControllerCreate(
   client: OatFiSDKCore,
@@ -95,7 +97,7 @@ async function $do(
 
   const secConfig = await extractSecurity(client._options.bearer);
   const securityInput = secConfig == null ? {} : { bearer: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [0]);
 
   const context = {
     options: client._options,
@@ -129,6 +131,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    uaHeader: "x-speakeasy-user-agent",
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);

package/src/funcs/onboardingTermsCreate.ts

@@ -31,6 +31,8 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Creates a new agreement assignment record for the given business. The acceptance source is always recorded as `PARTNER_API`. The caller MAY send `user_accepted` to attest whether the borrower actually accepted the terms; it defaults to true when omitted. A webhook event `agreement_acceptance.created` is emitted to the partner's configured webhook endpoint.
+ *
+ * If set, this operation will use {@link Security.bearer} from the global security.
  */
 export function onboardingTermsCreate(
   client: OatFiSDKCore,
@@ -114,7 +116,7 @@ async function $do(
 
   const secConfig = await extractSecurity(client._options.bearer);
   const securityInput = secConfig == null ? {} : { bearer: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [0]);
 
   const context = {
     options: client._options,
@@ -148,6 +150,7 @@ async function $do(
     path: path,
     headers: headers,
     body: body,
+    uaHeader: "x-speakeasy-user-agent",
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);

package/src/funcs/onboardingTermsGetAll.ts

@@ -34,6 +34,8 @@ import {
 
 /**
  * Get onboarding terms assignment records
+ *
+ * If set, this operation will use {@link Security.bearer} from the global security.
  */
 export function onboardingTermsGetAll(
   client: OatFiSDKCore,
@@ -117,7 +119,7 @@ async function $do(
 
   const secConfig = await extractSecurity(client._options.bearer);
   const securityInput = secConfig == null ? {} : { bearer: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [0]);
 
   const context = {
     options: client._options,
@@ -152,6 +154,7 @@ async function $do(
     headers: headers,
     query: query,
     body: body,
+    uaHeader: "x-speakeasy-user-agent",
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);