@matech/thebigpos-sdk 3.16.0 → 3.17.0-dev-6319

package/README.md

@@ -40,5 +40,44 @@ apiClient.api.getSiteConfiguration().then((response) => {
 });
 ```
 
+## Generate SDK from Swagger
+
+To regenerate the SDK from a specific API version, run:
+
+```bash
+npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --enum-style union
+```
+
+Replace `{version}` with the target API version (e.g. `v2.34.0`):
+
+```bash
+npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --enum-style union
+```
+
+Then apply the PATCH content-type fixup, passing the **same** spec that was given
+to the generator. The generator does not propagate `application/json-patch+json`,
+so this step sets each PATCH method's content type from the spec (no hard-coded
+endpoint list):
+
+```bash
+node scripts/apply-json-patch-content-type.js https://api.thebigpos.dev/swagger/v2.34.0/swagger.json
+yarn build
+```
+
+## Publishing
+
+1. Update the `version` field in `package.json` before publishing.
+2. Build the project:
+
+```bash
+yarn build
+```
+
+3. Publish to npm:
+
+```bash
+yarn publish
+```
+
 ____
 © 2024 Mortgage Automation Technologies. All rights reserved

package/dist/index.d.ts

@@ -78,6 +78,7 @@ export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "Docum
 export type EncompassEnvironment = "Production" | "UAT";
 export type DraftType = "NewLoan" | "EditLoan";
 export type DocumentVisibilityScope = "Own" | "All";
+export type DocumentType = "PrequalLetter" | "PreapprovalLetter" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "OpenHouseFlyer" | "LoanComparison" | "BuyerAgencyAgreements" | "ListingAgreements" | "Addendums" | "RentalAgreements" | "SalesContracts" | "RealEstateMarketFlyer" | "MortgageMarketingFlyer" | "FeeItemization" | "RefinanceDocument" | "CertifiedCommitments" | "CoBrandedMarketingFlyer";
 export type CustomFieldEntityType = "Loan";
 export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
 export type CustomFieldAnswerWarningReason = "Unresolved" | "Inactive" | "ReadOnly" | "DuplicateDefinition";
@@ -101,6 +102,7 @@ export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
 export type BranchType = "Mortgage" | "RealEstate";
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
 export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
+export type BorrowerApplicationWarningCode = "UnknownKey" | "NotWritable" | "CustomFieldUnresolved" | "CustomFieldInactive" | "CustomFieldReadOnly" | "CustomFieldDuplicateDefinition" | "LoanOfficerUnresolved";
 export type BorrowerApplicationStatus = "Draft" | "Complete";
 export type BillingType = "ClosedLoan" | "LoanOfficer";
 export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
@@ -188,6 +190,7 @@ export interface AccountFailureCount {
 export interface AccountSettings {
     isSmsEnabled: boolean;
     isLoanEditEnabled: boolean;
+    isApplicationEditEnabled?: boolean | null;
     smsNumber?: string | null;
     ssoHostOverride?: string | null;
     isEarlyAdopter: boolean;
@@ -196,6 +199,7 @@ export interface AccountSettingsRequest {
     isSmsEnabled: boolean;
     smsNumber?: string | null;
     isEarlyAdopter: boolean;
+    isApplicationEditEnabled?: boolean | null;
 }
 export interface Address {
     /** @format uuid */
@@ -458,8 +462,6 @@ export interface AiCanonicalField {
     isDefault: boolean;
     category?: string | null;
     jsonPropertyName?: string | null;
-    textractKey?: string | null;
-    textractKeyAliases: string[];
     hasAccountOverride: boolean;
     writable: boolean;
     patchPath?: string | null;
@@ -1015,6 +1017,32 @@ export interface AutomatedService {
     skipped: string[];
     rateLimited: string[];
 }
+export interface BorrowerApplication {
+    /** @format uuid */
+    loanId: string;
+    /** @format uuid */
+    borrowerId: string;
+    /** @format uuid */
+    coBorrowerId?: string | null;
+    applicationStatus: BorrowerApplicationApplicationStatusEnum;
+    answers: Record<string, any>;
+    additionalFields: Record<string, string>;
+    cursor?: LoanApplicationSession | null;
+}
+export interface BorrowerApplicationUpdate {
+    warnings: BorrowerApplicationWarning[];
+    application: BorrowerApplication;
+}
+export interface BorrowerApplicationUpdateRequest {
+    answers: Record<string, any>;
+    additionalFields?: Record<string, any> | null;
+    cursor?: LoanApplicationSessionRequest | null;
+}
+export interface BorrowerApplicationWarning {
+    key: string;
+    code: BorrowerApplicationWarningCodeEnum;
+    message: string;
+}
 export interface BorrowerCount {
     /** @format uuid */
     userId: string;
@@ -1550,7 +1578,6 @@ export interface CreateAiCanonicalFieldRequest {
     description: string;
     allowedRoles: string[];
     isPii: boolean;
-    dataSource: string;
     category?: string | null;
 }
 export interface CreateAiGuardrailRequest {
@@ -2702,7 +2729,7 @@ export interface Invite {
     phoneNumber: string;
     relationship: string;
     /** @deprecated */
-    loanID: string;
+    loanID?: string | null;
     route?: string | null;
     /** @format uuid */
     siteConfigurationID: string;
@@ -2718,7 +2745,7 @@ export interface Invite {
     /** @format date-time */
     expiresAt?: string | null;
     status: string;
-    loan: LoanIdentifier;
+    loan?: LoanIdentifier | null;
     url: string;
     linksBorrowerApplication?: boolean | null;
 }
@@ -5104,6 +5131,9 @@ export interface NotificationTemplateVersionUpdateRequest {
     textBody?: string | null;
     pushNotificationBody?: string | null;
 }
+export interface OpenBorrowerApplicationEditRequest {
+    isCoBorrower: boolean;
+}
 export type OpenTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
     /** @format int32 */
     maxItems: number;
@@ -7160,6 +7190,8 @@ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
 export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
 export type AmortizationWidgetConfigTypeEnum = "Amortization";
 export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
+export type BorrowerApplicationApplicationStatusEnum = "Draft" | "Complete";
+export type BorrowerApplicationWarningCodeEnum = "UnknownKey" | "NotWritable" | "CustomFieldUnresolved" | "CustomFieldInactive" | "CustomFieldReadOnly" | "CustomFieldDuplicateDefinition" | "LoanOfficerUnresolved";
 export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
@@ -7352,7 +7384,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.16.0
+ * @version v3.17.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -8649,6 +8681,35 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             /** @default true */
             revokeSessions?: boolean;
         }, params?: RequestParams) => Promise<AxiosResponse<NoContentResult, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags BorrowerApplication
+         * @name GetBorrowerApplication
+         * @summary Get a borrower's application as flat answers
+         * @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application
+         * @secure
+         * @response `200` `BorrowerApplication` OK
+         * @response `400` `any` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         */
+        getBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<BorrowerApplication, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags BorrowerApplication
+         * @name UpdateBorrowerApplication
+         * @summary Save a step of a borrower's application from flat answers
+         * @request PATCH:/api/loans/{loanId}/borrowers/{borrowerId}/application
+         * @secure
+         * @response `200` `BorrowerApplicationUpdate` OK
+         * @response `400` `any` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `422` `UnprocessableEntity` Unprocessable Content
+         */
+        updateBorrowerApplication: (loanId: string, borrowerId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<BorrowerApplicationUpdate, any, {}>>;
         /**
          * No description
          *
@@ -10672,6 +10733,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `File` OK
          */
         getListingOpenHouseFlyer: (id: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags LoanApplicationEdit
+         * @name OpenBorrowerApplicationEdit
+         * @summary Open a borrower's submitted application for editing
+         * @request POST:/api/loans/{loanId}/application/edit
+         * @secure
+         * @response `200` `BorrowerApplication` OK
+         * @response `400` `any` Bad Request
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         * @response `423` `any` Locked
+         */
+        openBorrowerApplicationEdit: (loanId: string, data: OpenBorrowerApplicationEditRequest, params?: RequestParams) => Promise<AxiosResponse<BorrowerApplication, any, {}>>;
         /**
          * No description
          *
@@ -11773,6 +11850,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          * @response `409` `ProblemDetails` Conflict
          * @response `422` `UnprocessableEntity` Unprocessable Content
+         * @response `423` `ProblemDetails` Locked
          */
         completeBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
@@ -13217,9 +13295,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/api/template-tokens
          * @secure
          * @response `200` `(TemplateTokenRoot)[]` OK
+         * @response `400` `ProblemDetails` Bad Request
          * @response `403` `ProblemDetails` Forbidden
          */
-        getTemplateTokens: (params?: RequestParams) => Promise<AxiosResponse<TemplateTokenRoot[], any, {}>>;
+        getTemplateTokens: (query?: {
+            notificationKey?: string;
+            documentType?: DocumentType;
+        }, params?: RequestParams) => Promise<AxiosResponse<TemplateTokenRoot[], any, {}>>;
         /**
          * No description
          *

package/dist/index.js

@@ -86,7 +86,13 @@ export class HttpClient {
             const property = input[key];
             const propertyContent = property instanceof Array ? property : [property];
             for (const formItem of propertyContent) {
-                const isFileType = formItem instanceof Blob || formItem instanceof File;
+                // React Native files are plain { uri, name, type } objects, not Blob/File.
+                const isReactNativeFile = !!formItem &&
+                    typeof formItem === "object" &&
+                    "uri" in formItem &&
+                    "name" in formItem &&
+                    "type" in formItem;
+                const isFileType = isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
                 formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
             }
             return formData;
@@ -95,7 +101,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.16.0
+ * @version v3.17.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -1229,6 +1235,35 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             logOut: (query, params = {}) => this.request(Object.assign({ path: `/api/logout`, method: "POST", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags BorrowerApplication
+             * @name GetBorrowerApplication
+             * @summary Get a borrower's application as flat answers
+             * @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application
+             * @secure
+             * @response `200` `BorrowerApplication` OK
+             * @response `400` `any` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getBorrowerApplication: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags BorrowerApplication
+             * @name UpdateBorrowerApplication
+             * @summary Save a step of a borrower's application from flat answers
+             * @request PATCH:/api/loans/{loanId}/borrowers/{borrowerId}/application
+             * @secure
+             * @response `200` `BorrowerApplicationUpdate` OK
+             * @response `400` `any` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `UnprocessableEntity` Unprocessable Content
+             */
+            updateBorrowerApplication: (loanId, borrowerId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -3033,6 +3068,22 @@ export class Api extends HttpClient {
              * @response `200` `File` OK
              */
             getListingOpenHouseFlyer: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/open-house-flyer`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanApplicationEdit
+             * @name OpenBorrowerApplicationEdit
+             * @summary Open a borrower's submitted application for editing
+             * @request POST:/api/loans/{loanId}/application/edit
+             * @secure
+             * @response `200` `BorrowerApplication` OK
+             * @response `400` `any` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `423` `any` Locked
+             */
+            openBorrowerApplicationEdit: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/edit`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -4043,6 +4094,7 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              * @response `409` `ProblemDetails` Conflict
              * @response `422` `UnprocessableEntity` Unprocessable Content
+             * @response `423` `ProblemDetails` Locked
              */
             completeBorrowerApplication: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/complete`, method: "POST", secure: true }, params)),
             /**
@@ -5352,9 +5404,10 @@ export class Api extends HttpClient {
              * @request GET:/api/template-tokens
              * @secure
              * @response `200` `(TemplateTokenRoot)[]` OK
+             * @response `400` `ProblemDetails` Bad Request
              * @response `403` `ProblemDetails` Forbidden
              */
-            getTemplateTokens: (params = {}) => this.request(Object.assign({ path: `/api/template-tokens`, method: "GET", secure: true, format: "json" }, params)),
+            getTemplateTokens: (query, params = {}) => this.request(Object.assign({ path: `/api/template-tokens`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
              * No description
              *