@matech/thebigpos-sdk 3.12.0 → 3.13.0-dev-5466

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

@@ -249,8 +249,10 @@ export interface AdminAccessUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
     /** @format uuid */
     accountID?: string | null;
     loans: UserLoan[];
@@ -1064,8 +1066,10 @@ export interface BranchUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
     /** @format uuid */
     branchID: string;
     branchName: string;
@@ -1623,8 +1627,10 @@ export interface DetailedUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
 }
 export interface DocumentDataRequest {
     documentID?: string | null;
@@ -2374,8 +2380,10 @@ export interface ImpersonatedDetailedUser {
     preferredLoanOfficer?: PreferredLoanOfficer | null;
     loanIDs: string[];
     drafts: Draft[];
+    inProgressLoans?: InProgressLoan[] | null;
     notificationSettings?: UserNotificationSettings | null;
     hasExtendedLoanVisibility: boolean;
+    applicationV3Enabled?: boolean | null;
     /** @deprecated */
     impersonatedBy?: string | null;
     impersonatingUser?: User | null;
@@ -2386,6 +2394,16 @@ export interface ImportUserLoanTaskRequest {
     /** @format uuid */
     userID: string;
 }
+export interface InProgressLoan {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    borrowerId: string;
+    /** @format uuid */
+    siteConfigurationId?: string | null;
+    /** @format date-time */
+    updatedAt?: string | null;
+}
 export interface IncompleteApplicationSummary {
     /** @format int32 */
     total: number;
@@ -2642,6 +2660,18 @@ export interface LoanApplicationRequest {
     /** @format uuid */
     existingLoanId?: string | null;
 }
+export interface LoanApplicationSession {
+    routeName: string;
+    currentQuestionId?: string | null;
+    questionHistory: string[];
+    /** @format date-time */
+    completedAt?: string | null;
+}
+export interface LoanApplicationSessionRequest {
+    routeName: string;
+    currentQuestionId?: string | null;
+    questionHistory: string[];
+}
 export interface LoanBorrower {
     /** @format uuid */
     id: string;
@@ -4192,6 +4222,8 @@ export interface LoanTaskCounts {
     completed: number;
     /** @format int32 */
     rejected: number;
+    /** @format int32 */
+    awaitingRegistration: number;
 }
 export interface LoanTaskSearchRequest {
     searchText?: string | null;
@@ -6883,7 +6915,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.12.0
+ * @version v3.13.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -10395,7 +10427,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any, {}>>;
         /**
-         * @description Returns every folder the caller can access on this loan — including folders holding no documents — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
+         * @description Returns the folders the caller can access that are relevant to this loan — those holding a document the caller can read, plus those bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
          *
          * @tags LoanDocumentFoldersForSingleLoan
          * @name ListLoanDocumentFolders
@@ -11026,7 +11058,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getLoanRoleTasks: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LoanRoleSlotTasks[], any, {}>>;
         /**
-         * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue. An optional due date is stored on the row; without one the row has none.
+         * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue. An optional due date is stored on the row; without one the row has none. A template already queued for the slot is refused; one staff removed earlier can be queued again this way.
          *
          * @tags LoanRoleTasks
          * @name CreateLoanRoleTask
@@ -11141,8 +11173,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `400` `any` Bad Request
          * @response `401` `ProblemDetails` Unauthorized
          * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
          */
-        createLoanv3: (data: LoanApplicationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any, {}>>;
+        createLoanv3: (data: LoanApplicationRequest, query?: {
+            application?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any, {}>>;
         /**
          * No description
          *
@@ -11190,6 +11225,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `400` `ProblemDetails` Bad Request
          * @response `404` `ProblemDetails` Not Found
          * @response `409` `ProblemDetails` Conflict
+         * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         completeBorrowerApplication: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
@@ -11203,8 +11239,39 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `LoanBorrowerSsn` OK
          * @response `403` `ProblemDetails` Forbidden
          * @response `404` `ProblemDetails` Not Found
+         * @response `429` `ProblemDetails` Too Many Requests
          */
         getLoanBorrowerSsn: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<LoanBorrowerSsn, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags Loans
+         * @name GetBorrowerApplicationSession
+         * @summary Get borrower application session
+         * @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+         * @secure
+         * @response `200` `LoanApplicationSession` OK
+         * @response `400` `any` Bad Request
+         * @response `401` `ProblemDetails` Unauthorized
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         */
+        getBorrowerApplicationSession: (loanId: string, borrowerId: string, params?: RequestParams) => Promise<AxiosResponse<LoanApplicationSession, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags Loans
+         * @name UpdateBorrowerApplicationSession
+         * @summary Update borrower application session
+         * @request PUT:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+         * @secure
+         * @response `200` `LoanApplicationSession` OK
+         * @response `400` `any` Bad Request
+         * @response `401` `ProblemDetails` Unauthorized
+         * @response `403` `ProblemDetails` Forbidden
+         * @response `404` `ProblemDetails` Not Found
+         */
+        updateBorrowerApplicationSession: (loanId: string, borrowerId: string, data: LoanApplicationSessionRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplicationSession, 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.12.0
+ * @version v3.13.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -3228,7 +3234,7 @@ export class Api extends HttpClient {
              */
             getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
             /**
-             * @description Returns every folder the caller can access on this loan — including folders holding no documents — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
+             * @description Returns the folders the caller can access that are relevant to this loan — those holding a document the caller can read, plus those bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
              *
              * @tags LoanDocumentFoldersForSingleLoan
              * @name ListLoanDocumentFolders
@@ -3784,7 +3790,7 @@ export class Api extends HttpClient {
              */
             getLoanRoleTasks: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/role-tasks`, method: "GET", secure: true, format: "json" }, params)),
             /**
-             * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue. An optional due date is stored on the row; without one the row has none.
+             * @description Queues an account template against a borrower slot that has no registered user yet. The row owns a per-loan copy of the template, so editing it never changes the account's catalogue. An optional due date is stored on the row; without one the row has none. A template already queued for the slot is refused; one staff removed earlier can be queued again this way.
              *
              * @tags LoanRoleTasks
              * @name CreateLoanRoleTask
@@ -3899,8 +3905,9 @@ export class Api extends HttpClient {
              * @response `400` `any` Bad Request
              * @response `401` `ProblemDetails` Unauthorized
              * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
              */
-            createLoanv3: (data, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            createLoanv3: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -3941,6 +3948,7 @@ export class Api extends HttpClient {
              * @response `400` `ProblemDetails` Bad Request
              * @response `404` `ProblemDetails` Not Found
              * @response `409` `ProblemDetails` Conflict
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             completeBorrowerApplication: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/complete`, method: "POST", secure: true }, params)),
             /**
@@ -3954,8 +3962,39 @@ export class Api extends HttpClient {
              * @response `200` `LoanBorrowerSsn` OK
              * @response `403` `ProblemDetails` Forbidden
              * @response `404` `ProblemDetails` Not Found
+             * @response `429` `ProblemDetails` Too Many Requests
              */
             getLoanBorrowerSsn: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/ssn`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Loans
+             * @name GetBorrowerApplicationSession
+             * @summary Get borrower application session
+             * @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+             * @secure
+             * @response `200` `LoanApplicationSession` OK
+             * @response `400` `any` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getBorrowerApplicationSession: (loanId, borrowerId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application-session`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Loans
+             * @name UpdateBorrowerApplicationSession
+             * @summary Update borrower application session
+             * @request PUT:/api/loans/{loanId}/borrowers/{borrowerId}/application-session
+             * @secure
+             * @response `200` `LoanApplicationSession` OK
+             * @response `400` `any` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            updateBorrowerApplicationSession: (loanId, borrowerId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/borrowers/${borrowerId}/application-session`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *