@matech/thebigpos-sdk 3.17.0-pr-5679-6304 → 3.17.0

package/README.md

@@ -40,44 +40,5 @@ 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";
@@ -5394,9 +5395,6 @@ export interface ReorderLoanRoleTasksRequest {
 export interface ReorderLoanTasksRequest {
     userLoanTaskIDs: string[];
 }
-export interface ReorderUserTableViewsRequest {
-    viewIds: string[];
-}
 export interface RequestImpersonationRequest {
     email: string;
 }
@@ -7138,8 +7136,6 @@ export interface UserTableSettings {
     searchTerms: string[];
     pinnedColumnIds: string[];
     filters?: PipelineTableFilters | null;
-    /** @format uuid */
-    activeViewId?: string | null;
 }
 export interface UserTableSettingsRequest {
     hiddenColumnIds: string[];
@@ -7149,31 +7145,6 @@ export interface UserTableSettingsRequest {
     searchTerms: string[];
     pinnedColumnIds: string[];
     filters?: PipelineTableFilters | null;
-    /** @format uuid */
-    activeViewId?: string | null;
-}
-export interface UserTableView {
-    /** @format uuid */
-    id: string;
-    tableKey: UserTableViewTableKeyEnum;
-    name: string;
-    /** @format int32 */
-    sortOrder: number;
-    searchTerms: string[];
-    filters?: PipelineTableFilters | null;
-    sortColumnId?: string | null;
-    sortDirection?: SortDirection | null;
-    /** @format date-time */
-    createdAt: string;
-    /** @format date-time */
-    updatedAt?: string | null;
-}
-export interface UserTableViewRequest {
-    name: string;
-    searchTerms: string[];
-    filters?: PipelineTableFilters | null;
-    sortColumnId?: string | null;
-    sortDirection?: SortDirection | null;
 }
 export interface VerifyEmailRequest {
     token: string;
@@ -7351,7 +7322,6 @@ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loan
 export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
 export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
 export type UserTableSettingsTableKeyEnum = "Pipeline";
-export type UserTableViewTableKeyEnum = "Pipeline";
 export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
 export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
 export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
@@ -7376,16 +7346,6 @@ export type GetMyTableSettingsParamsTableKeyEnum = "Pipeline";
 export type GetMyTableSettingsParamsEnum = "Pipeline";
 export type UpdateMyTableSettingsParamsTableKeyEnum = "Pipeline";
 export type UpdateMyTableSettingsParamsEnum = "Pipeline";
-export type GetMyTableViewsParamsTableKeyEnum = "Pipeline";
-export type GetMyTableViewsParamsEnum = "Pipeline";
-export type CreateMyTableViewParamsTableKeyEnum = "Pipeline";
-export type CreateMyTableViewParamsEnum = "Pipeline";
-export type UpdateMyTableViewParamsTableKeyEnum = "Pipeline";
-export type UpdateMyTableViewParamsEnum = "Pipeline";
-export type DeleteMyTableViewParamsTableKeyEnum = "Pipeline";
-export type DeleteMyTableViewParamsEnum = "Pipeline";
-export type ReorderMyTableViewsParamsTableKeyEnum = "Pipeline";
-export type ReorderMyTableViewsParamsEnum = "Pipeline";
 import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
 export type QueryParamsType = Record<string | number, any>;
 export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -13335,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
          *
@@ -14199,75 +14163,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `401` `ProblemDetails` Unauthorized
          */
         updateMyTableSettings: (tableKey: UpdateMyTableSettingsParamsEnum, data: UserTableSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<UserTableSettings, any, {}>>;
-        /**
-         * @description The caller's saved views for the table, in tab order.
-         *
-         * @tags UsersMe
-         * @name GetMyTableViews
-         * @summary Get Table Views
-         * @request GET:/api/users/me/table-settings/{tableKey}/views
-         * @secure
-         * @response `200` `(UserTableView)[]` OK
-         * @response `401` `ProblemDetails` Unauthorized
-         */
-        getMyTableViews: (tableKey: GetMyTableViewsParamsEnum, params?: RequestParams) => Promise<AxiosResponse<UserTableView[], any, {}>>;
-        /**
-         * @description Saves a named view at the end of the tab order. A name the caller already uses on the table (ignoring case) is refused with 409, and a 21st view with 400.
-         *
-         * @tags UsersMe
-         * @name CreateMyTableView
-         * @summary Create Table View
-         * @request POST:/api/users/me/table-settings/{tableKey}/views
-         * @secure
-         * @response `201` `UserTableView` Created
-         * @response `400` `ProblemDetails` Bad Request
-         * @response `401` `ProblemDetails` Unauthorized
-         * @response `409` `ProblemDetails` Conflict
-         * @response `422` `ProblemDetails` Unprocessable Content
-         */
-        createMyTableView: (tableKey: CreateMyTableViewParamsEnum, data: UserTableViewRequest, params?: RequestParams) => Promise<AxiosResponse<UserTableView, any, {}>>;
-        /**
-         * @description Replaces the view's name, search terms, filters and sort.
-         *
-         * @tags UsersMe
-         * @name UpdateMyTableView
-         * @summary Update Table View
-         * @request PUT:/api/users/me/table-settings/{tableKey}/views/{viewId}
-         * @secure
-         * @response `200` `UserTableView` OK
-         * @response `401` `ProblemDetails` Unauthorized
-         * @response `404` `ProblemDetails` Not Found
-         * @response `409` `ProblemDetails` Conflict
-         * @response `422` `ProblemDetails` Unprocessable Content
-         */
-        updateMyTableView: (tableKey: UpdateMyTableViewParamsEnum, viewId: string, data: UserTableViewRequest, params?: RequestParams) => Promise<AxiosResponse<UserTableView, any, {}>>;
-        /**
-         * @description Deletes the view. When it was the open tab saved in the table settings, the settings fall back to the default tab.
-         *
-         * @tags UsersMe
-         * @name DeleteMyTableView
-         * @summary Delete Table View
-         * @request DELETE:/api/users/me/table-settings/{tableKey}/views/{viewId}
-         * @secure
-         * @response `204` `void` No Content
-         * @response `401` `ProblemDetails` Unauthorized
-         * @response `404` `ProblemDetails` Not Found
-         */
-        deleteMyTableView: (tableKey: DeleteMyTableViewParamsEnum, viewId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
-        /**
-         * @description Sets the tab order. The body names every one of the caller's views on the table exactly once; a list that no longer matches them is refused with 409. Two reorders sent at once do not mix: the last to save wins as a whole.
-         *
-         * @tags UsersMe
-         * @name ReorderMyTableViews
-         * @summary Reorder Table Views
-         * @request PUT:/api/users/me/table-settings/{tableKey}/views/order
-         * @secure
-         * @response `204` `void` No Content
-         * @response `401` `ProblemDetails` Unauthorized
-         * @response `409` `ProblemDetails` Conflict
-         * @response `422` `ProblemDetails` Unprocessable Content
-         */
-        reorderMyTableViews: (tableKey: ReorderMyTableViewsParamsEnum, data: ReorderUserTableViewsRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
         /**
          * @description Update the phone number If changed will send a verification code to the new number
          *

package/dist/index.js

@@ -86,13 +86,7 @@ export class HttpClient {
             const property = input[key];
             const propertyContent = property instanceof Array ? property : [property];
             for (const formItem of propertyContent) {
-                // 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;
+                const isFileType = formItem instanceof Blob || formItem instanceof File;
                 formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
             }
             return formData;
@@ -5404,9 +5398,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
              *
@@ -6204,75 +6199,6 @@ export class Api extends HttpClient {
              * @response `401` `ProblemDetails` Unauthorized
              */
             updateMyTableSettings: (tableKey, data, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
-            /**
-             * @description The caller's saved views for the table, in tab order.
-             *
-             * @tags UsersMe
-             * @name GetMyTableViews
-             * @summary Get Table Views
-             * @request GET:/api/users/me/table-settings/{tableKey}/views
-             * @secure
-             * @response `200` `(UserTableView)[]` OK
-             * @response `401` `ProblemDetails` Unauthorized
-             */
-            getMyTableViews: (tableKey, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}/views`, method: "GET", secure: true, format: "json" }, params)),
-            /**
-             * @description Saves a named view at the end of the tab order. A name the caller already uses on the table (ignoring case) is refused with 409, and a 21st view with 400.
-             *
-             * @tags UsersMe
-             * @name CreateMyTableView
-             * @summary Create Table View
-             * @request POST:/api/users/me/table-settings/{tableKey}/views
-             * @secure
-             * @response `201` `UserTableView` Created
-             * @response `400` `ProblemDetails` Bad Request
-             * @response `401` `ProblemDetails` Unauthorized
-             * @response `409` `ProblemDetails` Conflict
-             * @response `422` `ProblemDetails` Unprocessable Content
-             */
-            createMyTableView: (tableKey, data, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}/views`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
-            /**
-             * @description Replaces the view's name, search terms, filters and sort.
-             *
-             * @tags UsersMe
-             * @name UpdateMyTableView
-             * @summary Update Table View
-             * @request PUT:/api/users/me/table-settings/{tableKey}/views/{viewId}
-             * @secure
-             * @response `200` `UserTableView` OK
-             * @response `401` `ProblemDetails` Unauthorized
-             * @response `404` `ProblemDetails` Not Found
-             * @response `409` `ProblemDetails` Conflict
-             * @response `422` `ProblemDetails` Unprocessable Content
-             */
-            updateMyTableView: (tableKey, viewId, data, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}/views/${viewId}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
-            /**
-             * @description Deletes the view. When it was the open tab saved in the table settings, the settings fall back to the default tab.
-             *
-             * @tags UsersMe
-             * @name DeleteMyTableView
-             * @summary Delete Table View
-             * @request DELETE:/api/users/me/table-settings/{tableKey}/views/{viewId}
-             * @secure
-             * @response `204` `void` No Content
-             * @response `401` `ProblemDetails` Unauthorized
-             * @response `404` `ProblemDetails` Not Found
-             */
-            deleteMyTableView: (tableKey, viewId, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}/views/${viewId}`, method: "DELETE", secure: true }, params)),
-            /**
-             * @description Sets the tab order. The body names every one of the caller's views on the table exactly once; a list that no longer matches them is refused with 409. Two reorders sent at once do not mix: the last to save wins as a whole.
-             *
-             * @tags UsersMe
-             * @name ReorderMyTableViews
-             * @summary Reorder Table Views
-             * @request PUT:/api/users/me/table-settings/{tableKey}/views/order
-             * @secure
-             * @response `204` `void` No Content
-             * @response `401` `ProblemDetails` Unauthorized
-             * @response `409` `ProblemDetails` Conflict
-             * @response `422` `ProblemDetails` Unprocessable Content
-             */
-            reorderMyTableViews: (tableKey, data, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}/views/order`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
             /**
              * @description Update the phone number If changed will send a verification code to the new number
              *