@matech/thebigpos-sdk 3.8.0-stag-3544 → 3.9.0-dev-3835

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

@@ -1431,6 +1431,8 @@ export interface CreateLoanRoleTaskRequest {
     borrowerPair: number;
     /** @format int32 */
     borrowerPosition: number;
+    /** @format date */
+    dueDate?: string | null;
 }
 export interface CreateSession {
     sessionId: string;
@@ -2084,8 +2086,6 @@ export interface File {
     fileName: string;
     name: string;
     s3FilePath: string;
-    user?: User | null;
-    account?: Account | null;
     url: string;
 }
 export interface FilePaginated {
@@ -2469,7 +2469,6 @@ export interface Invite {
     /** @format date-time */
     expiresAt?: string | null;
     status: string;
-    invitedBy?: User | null;
     loan: LoanIdentifier;
     url: string;
 }
@@ -3514,7 +3513,7 @@ export interface LoanDocument {
     /** @format uuid */
     id: string;
     name: string;
-    loan: Loan;
+    loan: LoanIdentifier;
     user?: UserSummary | null;
     /** @deprecated */
     initialBucket?: string | null;
@@ -3676,6 +3675,7 @@ export interface LoanFinancialRequest {
     cashToClose?: number | null;
     /** @format double */
     cashDownPayment?: number | null;
+    downPaymentPercent?: string | null;
     /** @format double */
     maximumPurchasePrice?: number | null;
     isDownPaymentGift?: boolean | null;
@@ -4084,6 +4084,7 @@ export interface LoanRecommendation {
     canonicalName: string;
     displayName: string;
     extractedValue: string;
+    mintable: boolean;
     currentLoanValue?: any | null;
     /** @format uuid */
     sourceDocumentId: string;
@@ -4113,6 +4114,8 @@ export interface LoanRefinance {
     existingLiens?: number | null;
     /** @format double */
     costOfImprovements?: number | null;
+    /** @format double */
+    cashOutAmount?: number | null;
     purpose?: LoanRefinancePurpose | null;
     currentLoan?: LoanRefinanceCurrentLoan | null;
 }
@@ -4142,6 +4145,8 @@ export interface LoanRefinanceRequest {
     /** @format int32 */
     yearAcquired?: number | null;
     purpose?: LoanRefinancePurpose | null;
+    /** @format double */
+    cashOutAmount?: number | null;
     currentLoan?: LoanRefinanceCurrentLoanRequest | null;
 }
 export interface LoanRoleSlotTasks {
@@ -4560,6 +4565,14 @@ export interface MilestoneConfigurationRequest {
     loanType: string;
     notificationsEnabled: boolean;
 }
+export interface MintedProposal {
+    /** @format uuid */
+    id: string;
+    /** @format date-time */
+    expiresAt: string;
+    columns: string[];
+    rows: string[][];
+}
 export interface MobileAppReviewSeed {
     /** @format uuid */
     userID: string;
@@ -6887,7 +6900,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.8.0
+ * @version v3.9.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -8118,13 +8131,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          *
          * @tags Authentication
          * @name LogOut
-         * @summary Sign out (clear auth cookies)
+         * @summary Sign out (revoke the session and clear auth cookies)
          * @request POST:/api/logout
          * @secure
          * @response `204` `NoContentResult` No Content
          * @response `422` `UnprocessableEntity` Unprocessable Content
          */
-        logOut: (params?: RequestParams) => Promise<AxiosResponse<NoContentResult, any, {}>>;
+        logOut: (query?: {
+            /** @default true */
+            revokeSessions?: boolean;
+        }, params?: RequestParams) => Promise<AxiosResponse<NoContentResult, any, {}>>;
         /**
          * No description
          *
@@ -11019,6 +11035,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          */
         dismissLoanRecommendation: (loanId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags LoanRecommendations
+         * @name MintLoanRecommendationProposal
+         * @summary Mint a confirmable pending update from a recommendation
+         * @request POST:/api/loans/{loanId}/recommendations/{id}/proposals
+         * @secure
+         * @response `200` `MintedProposal` OK
+         * @response `400` `ProblemDetails` Bad Request
+         * @response `404` `ProblemDetails` Not Found
+         * @response `409` `ProblemDetails` Conflict
+         */
+        mintLoanRecommendationProposal: (loanId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<MintedProposal, any, {}>>;
         /**
          * No description
          *
@@ -11032,7 +11062,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.
+         * @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.
          *
          * @tags LoanRoleTasks
          * @name CreateLoanRoleTask

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.8.0
+ * @version v3.9.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -1192,13 +1198,13 @@ export class Api extends HttpClient {
              *
              * @tags Authentication
              * @name LogOut
-             * @summary Sign out (clear auth cookies)
+             * @summary Sign out (revoke the session and clear auth cookies)
              * @request POST:/api/logout
              * @secure
              * @response `204` `NoContentResult` No Content
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
-            logOut: (params = {}) => this.request(Object.assign({ path: `/api/logout`, method: "POST", secure: true, format: "json" }, params)),
+            logOut: (query, params = {}) => this.request(Object.assign({ path: `/api/logout`, method: "POST", query: query, secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -3793,6 +3799,20 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             dismissLoanRecommendation: (loanId, id, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/recommendations/${id}/dismiss`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanRecommendations
+             * @name MintLoanRecommendationProposal
+             * @summary Mint a confirmable pending update from a recommendation
+             * @request POST:/api/loans/{loanId}/recommendations/{id}/proposals
+             * @secure
+             * @response `200` `MintedProposal` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            mintLoanRecommendationProposal: (loanId, id, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/recommendations/${id}/proposals`, method: "POST", secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -3806,7 +3826,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.
+             * @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.
              *
              * @tags LoanRoleTasks
              * @name CreateLoanRoleTask