@matech/thebigpos-sdk 3.5.0-stag-2100 → 3.5.1-dev-2413

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

@@ -53,6 +53,7 @@ export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency"
 export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
 export type LoanGenderType = "Male" | "Female";
 export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
+export type LoanDocumentFolderScope = "Any" | "Assigned" | "Unassigned";
 export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
 export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
 export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
@@ -2350,6 +2351,12 @@ export interface GuidPatchOperation {
     value?: any | null;
     from?: string | null;
 }
+export interface HttpError {
+    logId?: string | null;
+    message?: string | null;
+    errorCode?: string | null;
+    errors?: string[] | null;
+}
 export interface IPAddress {
     addressFamily: IpAddressAddressFamilyEnum;
     /** @format int64 */
@@ -2932,6 +2939,8 @@ export interface LoanBorrowerEmploymentCurrentGrossIncome {
     /** @format double */
     hourlyRate?: number | null;
     /** @format double */
+    annualBasePay?: number | null;
+    /** @format double */
     other?: number | null;
     /** @format double */
     bonus?: number | null;
@@ -3482,6 +3491,8 @@ export interface LoanDocument {
     losStatus: string;
     contents?: string | null;
     failoverDocumentPath?: string | null;
+    /** @format int64 */
+    fileSizeBytes?: number | null;
     /** @format date-time */
     sensitiveDataPurgedOn?: string | null;
     observedDocumentType?: LoanDocumentType | null;
@@ -3550,6 +3561,7 @@ export interface LoanDocumentFolderWithCount {
     isActive: boolean;
     /** @format int32 */
     documentCount: number;
+    isUnassigned: boolean;
 }
 export interface LoanDocumentPreviewsRequest {
     documentIds: string[];
@@ -3587,6 +3599,7 @@ export interface LoanDocumentSearchCriteria {
     bucket?: string | null;
     /** @format uuid */
     folderID?: string | null;
+    folderScope?: LoanDocumentFolderScope | null;
     /** @format uuid */
     userID?: string | null;
     documentIDs?: string[] | null;
@@ -6686,7 +6699,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.5.0
+ * @version v3.5.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -9854,7 +9867,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/listings
          * @secure
          * @response `201` `Listing` Created
-         * @response `403` `ProblemDetails` Forbidden
+         * @response `401` `HttpError` Unauthorized
+         * @response `403` `HttpError` Forbidden
          */
         createListing: (data: ListingRequest, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
         /**
@@ -9888,7 +9902,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/api/listings/{id}
          * @secure
          * @response `200` `Listing` OK
-         * @response `403` `ProblemDetails` Forbidden
+         * @response `401` `HttpError` Unauthorized
+         * @response `403` `HttpError` Forbidden
          */
         replaceListing: (id: string, data: ListingRequest, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
         /**
@@ -10212,7 +10227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any, {}>>;
         /**
-         * @description Returns each folder that holds at least one document the caller can read, with the document count per folder. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID).
+         * @description Returns each folder that holds at least one document the caller can read, with the document count per folder. 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
@@ -10265,7 +10280,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getLoanDocumentPreviews: (loanId: string, data: LoanDocumentPreviewsRequest, params?: RequestParams) => Promise<AxiosResponse<Record<string, string>, any, {}>>;
         /**
-         * No description
+         * @description Filters the loan's readable documents. Pass folderID to filter to one folder, or folderScope 'Unassigned' for the documents that have no folder (the synthetic folder listLoanDocumentFolders reports with isUnassigned true); the two cannot be combined.
          *
          * @tags LoanDocuments
          * @name SearchLoanDocuments
@@ -10273,6 +10288,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/loans/{loanId}/documents/search
          * @secure
          * @response `200` `LoanDocumentSearchPaginated` OK
+         * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         searchLoanDocuments: (loanId: string, data: LoanDocumentSearchCriteria, query?: {
             /** @format int32 */
@@ -10975,6 +10991,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          * @response `201` `TaskComment` Created
          * @response `404` `ProblemDetails` Not Found
+         * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         createLoanTaskComment: (loanId: string, userLoanTaskId: string, data: TaskCommentRequest, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any, {}>>;
         /**
@@ -10987,6 +11004,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          * @response `200` `TaskComment` OK
          * @response `404` `ProblemDetails` Not Found
+         * @response `422` `UnprocessableEntity` Unprocessable Content
          */
         replaceLoanTaskComment: (loanId: string, userLoanTaskId: string, commentId: string, data: TaskCommentRequest, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any, {}>>;
         /**

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.5.0
+ * @version v3.5.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -2921,7 +2927,8 @@ export class Api extends HttpClient {
              * @request POST:/api/listings
              * @secure
              * @response `201` `Listing` Created
-             * @response `403` `ProblemDetails` Forbidden
+             * @response `401` `HttpError` Unauthorized
+             * @response `403` `HttpError` Forbidden
              */
             createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -2955,7 +2962,8 @@ export class Api extends HttpClient {
              * @request PUT:/api/listings/{id}
              * @secure
              * @response `200` `Listing` OK
-             * @response `403` `ProblemDetails` Forbidden
+             * @response `401` `HttpError` Unauthorized
+             * @response `403` `HttpError` Forbidden
              */
             replaceListing: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3262,7 +3270,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 each folder that holds at least one document the caller can read, with the document count per folder. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID).
+             * @description Returns each folder that holds at least one document the caller can read, with the document count per folder. 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
@@ -3309,7 +3317,7 @@ export class Api extends HttpClient {
              */
             getLoanDocumentPreviews: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/previews`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
-             * No description
+             * @description Filters the loan's readable documents. Pass folderID to filter to one folder, or folderScope 'Unassigned' for the documents that have no folder (the synthetic folder listLoanDocumentFolders reports with isUnassigned true); the two cannot be combined.
              *
              * @tags LoanDocuments
              * @name SearchLoanDocuments
@@ -3317,6 +3325,7 @@ export class Api extends HttpClient {
              * @request POST:/api/loans/{loanId}/documents/search
              * @secure
              * @response `200` `LoanDocumentSearchPaginated` OK
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             searchLoanDocuments: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3936,6 +3945,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `201` `TaskComment` Created
              * @response `404` `ProblemDetails` Not Found
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             createLoanTaskComment: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3948,6 +3958,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `TaskComment` OK
              * @response `404` `ProblemDetails` Not Found
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             replaceLoanTaskComment: (loanId, userLoanTaskId, commentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**