@oatfi/oatfi-sdk-ts 0.12.0 → 0.12.2

package/src/funcs/{onboardingTermsOnboardingTermsInternalControllerCreate.ts → onboardingTermsAgreementAssignmentInternalControllerCreate.ts}

@@ -26,18 +26,18 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a new onboarding terms acceptance record
+ * Create a new onboarding terms assignment record
  *
  * @remarks
- * Creates a new agreement acceptance 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 external ID, timestamp of acceptance, terms version identifier, and terms file URL.
+ * 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 external ID, timestamp of acceptance, terms version identifier, and terms file URL.
  */
-export function onboardingTermsOnboardingTermsInternalControllerCreate(
+export function onboardingTermsAgreementAssignmentInternalControllerCreate(
   client: OatFiSDKCore,
-  request: models.CreateOnboardingTermsAcceptanceDto,
+  request: models.CreateAgreementAssignmentDto,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.OnboardingTermsAcceptanceResponseDto,
+    models.AgreementAssignmentResponseDto,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -57,12 +57,12 @@ export function onboardingTermsOnboardingTermsInternalControllerCreate(
 
 async function $do(
   client: OatFiSDKCore,
-  request: models.CreateOnboardingTermsAcceptanceDto,
+  request: models.CreateAgreementAssignmentDto,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      models.OnboardingTermsAcceptanceResponseDto,
+      models.AgreementAssignmentResponseDto,
       | OatFiSDKError
       | ResponseValidationError
       | ConnectionError
@@ -77,8 +77,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      models.CreateOnboardingTermsAcceptanceDto$outboundSchema.parse(value),
+    (value) => models.CreateAgreementAssignmentDto$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -101,7 +100,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "OnboardingTermsInternalController_create",
+    operationID: "AgreementAssignmentInternalController_create",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -151,7 +150,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    models.OnboardingTermsAcceptanceResponseDto,
+    models.AgreementAssignmentResponseDto,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -161,7 +160,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, models.OnboardingTermsAcceptanceResponseDto$inboundSchema),
+    M.json(201, models.AgreementAssignmentResponseDto$inboundSchema),
     M.fail([400, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/onboardingTermsCreate.ts

@@ -30,15 +30,15 @@ import { Result } from "../types/fp.js";
  * Create an onboarding terms acceptance for a business
  *
  * @remarks
- * Creates a new agreement acceptance record for the given business. The acceptance source is always recorded as `OATFI_API`. A webhook event `agreement_acceptance.created` is emitted to the partner's configured webhook endpoint.
+ * Creates a new agreement assignment record for the given business. The acceptance source is always recorded as `PARTNER_API`. The caller MUST send `user_accepted` to attest whether the borrower actually accepted the terms. A webhook event `agreement_acceptance.created` is emitted to the partner's configured webhook endpoint.
  */
 export function onboardingTermsCreate(
   client: OatFiSDKCore,
-  request: operations.BusinessOnboardingTermsControllerCreateRequest,
+  request: operations.BusinessAgreementAssignmentsControllerCreateRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.OnboardingTermsAcceptanceResponseDto,
+    models.PartnerAgreementAssignmentResponseDto,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -58,12 +58,12 @@ export function onboardingTermsCreate(
 
 async function $do(
   client: OatFiSDKCore,
-  request: operations.BusinessOnboardingTermsControllerCreateRequest,
+  request: operations.BusinessAgreementAssignmentsControllerCreateRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      models.OnboardingTermsAcceptanceResponseDto,
+      models.PartnerAgreementAssignmentResponseDto,
       | OatFiSDKError
       | ResponseValidationError
       | ConnectionError
@@ -79,7 +79,8 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.BusinessOnboardingTermsControllerCreateRequest$outboundSchema
+      operations
+        .BusinessAgreementAssignmentsControllerCreateRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -87,11 +88,9 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON(
-    "body",
-    payload.CreatePartnerOnboardingTermsAcceptanceDto,
-    { explode: true },
-  );
+  const body = encodeJSON("body", payload.CreatePartnerAgreementAssignmentDto, {
+    explode: true,
+  });
 
   const pathParams = {
     business: encodeSimple("business", payload.business, {
@@ -120,7 +119,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "BusinessOnboardingTermsController_create",
+    operationID: "BusinessAgreementAssignmentsController_create",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -170,7 +169,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    models.OnboardingTermsAcceptanceResponseDto,
+    models.PartnerAgreementAssignmentResponseDto,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -180,7 +179,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(201, models.OnboardingTermsAcceptanceResponseDto$inboundSchema),
+    M.json(201, models.PartnerAgreementAssignmentResponseDto$inboundSchema),
     M.fail([400, 403, 404, 409, 429, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/onboardingTermsGetAll.ts

@@ -33,16 +33,16 @@ import {
 } from "../types/operations.js";
 
 /**
- * Get onboarding terms acceptance records
+ * Get onboarding terms assignment records
  */
 export function onboardingTermsGetAll(
   client: OatFiSDKCore,
-  request: operations.OnboardingTermsInternalControllerFindAllRequest,
+  request: operations.AgreementAssignmentInternalControllerFindAllRequest,
   options?: RequestOptions,
 ): APIPromise<
   PageIterator<
     Result<
-      operations.OnboardingTermsInternalControllerFindAllResponse,
+      operations.AgreementAssignmentInternalControllerFindAllResponse,
       | OatFiSDKError
       | ResponseValidationError
       | ConnectionError
@@ -64,13 +64,13 @@ export function onboardingTermsGetAll(
 
 async function $do(
   client: OatFiSDKCore,
-  request: operations.OnboardingTermsInternalControllerFindAllRequest,
+  request: operations.AgreementAssignmentInternalControllerFindAllRequest,
   options?: RequestOptions,
 ): Promise<
   [
     PageIterator<
       Result<
-        operations.OnboardingTermsInternalControllerFindAllResponse,
+        operations.AgreementAssignmentInternalControllerFindAllResponse,
         | OatFiSDKError
         | ResponseValidationError
         | ConnectionError
@@ -88,7 +88,8 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.OnboardingTermsInternalControllerFindAllRequest$outboundSchema
+      operations
+        .AgreementAssignmentInternalControllerFindAllRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -121,7 +122,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "OnboardingTermsInternalController_findAll",
+    operationID: "AgreementAssignmentInternalController_findAll",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -176,7 +177,7 @@ async function $do(
   };
 
   const [result, raw] = await M.match<
-    operations.OnboardingTermsInternalControllerFindAllResponse,
+    operations.AgreementAssignmentInternalControllerFindAllResponse,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -188,7 +189,8 @@ async function $do(
   >(
     M.json(
       200,
-      operations.OnboardingTermsInternalControllerFindAllResponse$inboundSchema,
+      operations
+        .AgreementAssignmentInternalControllerFindAllResponse$inboundSchema,
       { key: "Result" },
     ),
     M.fail([400, "4XX"]),
@@ -207,7 +209,7 @@ async function $do(
   ): {
     next: Paginator<
       Result<
-        operations.OnboardingTermsInternalControllerFindAllResponse,
+        operations.AgreementAssignmentInternalControllerFindAllResponse,
         | OatFiSDKError
         | ResponseValidationError
         | ConnectionError

package/src/funcs/onboardingTermsGetHtml.ts

@@ -35,7 +35,7 @@ import * as types$ from "../types/primitives.js";
 export function onboardingTermsGetHtml(
   client: OatFiSDKCore,
   request:
-    operations.BusinessOnboardingTermsControllerGetOnboardingTermsHtmlRequest,
+    operations.BusinessAgreementAssignmentsControllerGetOnboardingTermsHtmlRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -60,7 +60,7 @@ export function onboardingTermsGetHtml(
 async function $do(
   client: OatFiSDKCore,
   request:
-    operations.BusinessOnboardingTermsControllerGetOnboardingTermsHtmlRequest,
+    operations.BusinessAgreementAssignmentsControllerGetOnboardingTermsHtmlRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -82,7 +82,7 @@ async function $do(
     request,
     (value) =>
       operations
-        .BusinessOnboardingTermsControllerGetOnboardingTermsHtmlRequest$outboundSchema
+        .BusinessAgreementAssignmentsControllerGetOnboardingTermsHtmlRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -117,7 +117,8 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "BusinessOnboardingTermsController_getOnboardingTermsHtml",
+    operationID:
+      "BusinessAgreementAssignmentsController_getOnboardingTermsHtml",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,

package/src/funcs/onboardingTermsList.ts

@@ -33,16 +33,16 @@ import {
 } from "../types/operations.js";
 
 /**
- * List onboarding terms acceptance records for a business
+ * List onboarding terms assignment records for a business
  */
 export function onboardingTermsList(
   client: OatFiSDKCore,
-  request: operations.BusinessOnboardingTermsControllerFindAllRequest,
+  request: operations.BusinessAgreementAssignmentsControllerFindAllRequest,
   options?: RequestOptions,
 ): APIPromise<
   PageIterator<
     Result<
-      operations.BusinessOnboardingTermsControllerFindAllResponse,
+      operations.BusinessAgreementAssignmentsControllerFindAllResponse,
       | OatFiSDKError
       | ResponseValidationError
       | ConnectionError
@@ -64,13 +64,13 @@ export function onboardingTermsList(
 
 async function $do(
   client: OatFiSDKCore,
-  request: operations.BusinessOnboardingTermsControllerFindAllRequest,
+  request: operations.BusinessAgreementAssignmentsControllerFindAllRequest,
   options?: RequestOptions,
 ): Promise<
   [
     PageIterator<
       Result<
-        operations.BusinessOnboardingTermsControllerFindAllResponse,
+        operations.BusinessAgreementAssignmentsControllerFindAllResponse,
         | OatFiSDKError
         | ResponseValidationError
         | ConnectionError
@@ -88,7 +88,8 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.BusinessOnboardingTermsControllerFindAllRequest$outboundSchema
+      operations
+        .BusinessAgreementAssignmentsControllerFindAllRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -128,7 +129,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "BusinessOnboardingTermsController_findAll",
+    operationID: "BusinessAgreementAssignmentsController_findAll",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -183,7 +184,7 @@ async function $do(
   };
 
   const [result, raw] = await M.match<
-    operations.BusinessOnboardingTermsControllerFindAllResponse,
+    operations.BusinessAgreementAssignmentsControllerFindAllResponse,
     | OatFiSDKError
     | ResponseValidationError
     | ConnectionError
@@ -195,7 +196,8 @@ async function $do(
   >(
     M.json(
       200,
-      operations.BusinessOnboardingTermsControllerFindAllResponse$inboundSchema,
+      operations
+        .BusinessAgreementAssignmentsControllerFindAllResponse$inboundSchema,
       { key: "Result" },
     ),
     M.fail([400, 403, 404, 429, "4XX"]),
@@ -214,7 +216,7 @@ async function $do(
   ): {
     next: Paginator<
       Result<
-        operations.BusinessOnboardingTermsControllerFindAllResponse,
+        operations.BusinessAgreementAssignmentsControllerFindAllResponse,
         | OatFiSDKError
         | ResponseValidationError
         | ConnectionError

package/src/funcs/paymentIntentsDelete.ts

@@ -167,7 +167,7 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, models.PaymentIntentResponseDto$inboundSchema),
-    M.fail([404, "4XX"]),
+    M.fail([403, 404, "4XX"]),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/paymentIntentsGetBalance.ts

@@ -167,7 +167,7 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, models.PaymentIntentBalanceDto$inboundSchema),
-    M.fail([400, 404, "4XX"]),
+    M.fail([400, 403, 404, 429, "4XX"]),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/paymentIntentsGetBalanceByProgram.ts

@@ -92,12 +92,12 @@ async function $do(
       explode: false,
       charEncoding: "percent",
     }),
-    programId: encodeSimple("programId", payload.programId, {
+    program: encodeSimple("program", payload.program, {
       explode: false,
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/v3/payment-intents/{id}/balance/{programId}")(
+  const path = pathToFunc("/v3/payment-intents/{id}/balance/{program}")(
     pathParams,
   );
 
@@ -173,7 +173,7 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, models.PaymentIntentBalanceByProductDto$inboundSchema),
-    M.fail([400, 404, "4XX"]),
+    M.fail([400, 403, 404, 429, "4XX"]),
     M.fail("5XX"),
   )(response, req);
   if (!result.ok) {

package/src/funcs/platformSettingsGetBrandingConfiguration.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OatFiSDKCore } from "../core.js";
+import { 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 { 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 platform branding configuration for embedded component
+ */
+export function platformSettingsGetBrandingConfiguration(
+  client: OatFiSDKCore,
+  request:
+    operations.PlatformSettingsInternalControllerFindBrandingConfigurationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.BrandingResponseDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OatFiSDKCore,
+  request:
+    operations.PlatformSettingsInternalControllerFindBrandingConfigurationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.BrandingResponseDto,
+      | OatFiSDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations
+        .PlatformSettingsInternalControllerFindBrandingConfigurationRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    platformId: encodeSimple("platformId", payload.platformId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/v3/platforms/{platformId}/platform-settings/branding-configuration",
+  )(pathParams);
+
+  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: "PlatformSettingsInternalController_findBrandingConfiguration",
+    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,
+    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,
+    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.BrandingResponseDto,
+    | OatFiSDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.BrandingResponseDto$inboundSchema),
+    M.fail([400, 403, 404, "4XX"]),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}