@matech/thebigpos-sdk 2.22.4-rc0 → 2.22.4-rc1

package/.husky/pre-commit

@@ -1,3 +1,3 @@
-[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
-yarn build
+[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
+yarn build
 git add .

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Mortgage Automation Technologies
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Mortgage Automation Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,44 +1,44 @@
-# The BIG POS Typescript SDK
-
-## Installation
-Using npm:
-
-```bash
-$ npm install @matech/thebigpos-sdk
-```
-
-Using yarn:
-
-```bash
-$ yarn add @matech/thebigpos-sdk
-```
-
-## Quick Start
-```js
-import { Api } from "@matech/thebigpos-sdk";
-
-const securityWorker = (data: any) => {
-    return { headers: data }
-}
-
-const setBearerSecurityWorker = (accessToken:string) => {
-    const data = {
-        Authorization: `Bearer ${accessToken}`
-    };
-
-    apiClient.setSecurityData(data);
-};
-
-const apiClient = new Api({
-    baseURL:
-        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
-    securityWorker,
-})
-
-apiClient.api.getSiteConfiguration().then((response) => {
-    console.log(response.data);
-});
-```
-
-____
-© 2024 Mortgage Automation Technologies. All rights reserved
+# The BIG POS Typescript SDK
+
+## Installation
+Using npm:
+
+```bash
+$ npm install @matech/thebigpos-sdk
+```
+
+Using yarn:
+
+```bash
+$ yarn add @matech/thebigpos-sdk
+```
+
+## Quick Start
+```js
+import { Api } from "@matech/thebigpos-sdk";
+
+const securityWorker = (data: any) => {
+    return { headers: data }
+}
+
+const setBearerSecurityWorker = (accessToken:string) => {
+    const data = {
+        Authorization: `Bearer ${accessToken}`
+    };
+
+    apiClient.setSecurityData(data);
+};
+
+const apiClient = new Api({
+    baseURL:
+        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
+    securityWorker,
+})
+
+apiClient.api.getSiteConfiguration().then((response) => {
+    console.log(response.data);
+});
+```
+
+____
+© 2024 Mortgage Automation Technologies. All rights reserved

package/dist/index.d.ts

@@ -16,6 +16,7 @@ export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "R
 export type BranchType = "Mortgage" | "RealEstate";
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
 export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
+export type AccessScopeType = "User" | "Branch";
 export interface ASOSettings {
     enabled: boolean;
     softPull: boolean;
@@ -517,6 +518,13 @@ export interface CorporateSearchCriteria {
     searchText?: string | null;
     isActive?: boolean | null;
 }
+export interface CreateAccessScopeRequest {
+    scopeType: "User" | "Branch";
+    /** @format uuid */
+    userId?: string | null;
+    /** @format uuid */
+    branchId?: string | null;
+}
 export interface CreateAccountRequest {
     /** @minLength 1 */
     name: string;
@@ -560,6 +568,11 @@ export interface CreateDocumentTemplateRequest {
     destinationBucket?: string | null;
     status: string;
 }
+export interface CreateGroupMemberRequest {
+    /** @format uuid */
+    userId: string;
+    loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+}
 export interface CreateInviteRequest {
     /** @minLength 1 */
     firstName: string;
@@ -599,6 +612,15 @@ export interface CreateUserDeviceRequest {
 export interface CreateUserDraft {
     loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
 }
+export interface CreateUserGroupRequest {
+    /**
+     * @minLength 1
+     * @maxLength 200
+     */
+    name: string;
+    /** @maxLength 1000 */
+    description?: string | null;
+}
 export interface CreateUserLoan {
     loanRole?: LoanRole | null;
 }
@@ -2131,7 +2153,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 }
 export interface Operation {
     op?: string;
-    value?: string | number | boolean | null | object;
+    value?: object | null;
     path?: string;
 }
 export interface OverridePasswordRequest {
@@ -2499,6 +2521,18 @@ export interface SendNotificationForLoanRequest {
     phone?: string | null;
     attachments: Attachment[];
 }
+export interface SimpleBranch {
+    /** @format uuid */
+    id: string;
+    name: string;
+    type: string;
+}
+export interface SimpleUser {
+    /** @format uuid */
+    id: string;
+    name?: string | null;
+    email?: string | null;
+}
 export interface SiteConfiguration {
     /** @format date-time */
     createdAt?: string | null;
@@ -3432,6 +3466,15 @@ export interface UpdateMeRequest {
 export interface UpdateMobilePhoneRequest {
     phone: string;
 }
+export interface UpdateUserGroupRequest {
+    /**
+     * @minLength 1
+     * @maxLength 200
+     */
+    name: string;
+    /** @maxLength 1000 */
+    description?: string | null;
+}
 export interface UpdateUserRequest {
     phone?: string | null;
     /**
@@ -3507,6 +3550,48 @@ export interface UserDraftPaginated {
     /** @format int64 */
     count: number;
 }
+export interface UserGroup {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    accountID: string;
+    name: string;
+    description?: string | null;
+    isDeleted: boolean;
+    /** @format date-time */
+    createdAt: string;
+    /** @format date-time */
+    updatedAt?: string | null;
+}
+export interface UserGroupAccessScope {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    groupId: string;
+    scopeType: "User" | "Branch";
+    /** @format uuid */
+    userId?: string | null;
+    /** @format uuid */
+    branchId?: string | null;
+    user?: SimpleUser | null;
+    branch?: SimpleBranch | null;
+}
+export interface UserGroupMember {
+    /** @format uuid */
+    id: string;
+    /** @format uuid */
+    groupId: string;
+    /** @format uuid */
+    userId: string;
+    loanRole: string;
+    user: SimpleUser;
+}
+export interface UserGroupPaginated {
+    rows: UserGroup[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
 export interface UserLoan {
     /** @format date-time */
     createdAt: string;
@@ -3564,13 +3649,11 @@ export interface UserNotificationSettings {
     emailEnabled: boolean;
     textEnabled: boolean;
     textOptIn?: boolean | null;
-    pushEnabled: boolean;
 }
 export interface UserNotificationSettingsUpdateRequest {
     emailEnabled: boolean;
     textEnabled: boolean;
     textOptIn?: boolean | null;
-    pushEnabled: boolean;
 }
 export interface UserPaginated {
     rows: User[];
@@ -3698,7 +3781,6 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
     format?: ResponseType;
 }
 export declare enum ContentType {
-    JsonPatch = "application/json-patch+json",
     Json = "application/json",
     JsonApi = "application/vnd.api+json",
     FormData = "multipart/form-data",
@@ -3720,7 +3802,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.22.4
+ * @version v2.22.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6818,6 +6900,138 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `204` `void` No Content
          */
         deleteDraftUser: (draftId: string, userId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroupAccessScopes
+         * @name ListGroupScopes
+         * @summary List Group Access Scopes
+         * @request GET:/api/user-groups/{groupId}/scopes
+         * @secure
+         * @response `200` `(UserGroupAccessScope)[]` OK
+         */
+        listGroupScopes: (groupId: string, params?: RequestParams) => Promise<AxiosResponse<UserGroupAccessScope[], any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroupAccessScopes
+         * @name CreateGroupScope
+         * @summary Create Group Access Scope
+         * @request POST:/api/user-groups/{groupId}/scopes
+         * @secure
+         * @response `200` `UserGroupAccessScope` OK
+         */
+        createGroupScope: (groupId: string, data: CreateAccessScopeRequest, params?: RequestParams) => Promise<AxiosResponse<UserGroupAccessScope, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroupAccessScopes
+         * @name RemoveGroupScope
+         * @summary Remove Group Access Scope
+         * @request DELETE:/api/user-groups/{groupId}/scopes/{scopeId}
+         * @secure
+         * @response `204` `void` No Content
+         */
+        removeGroupScope: (groupId: string, scopeId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroupMembers
+         * @name ListGroupMembers
+         * @summary List Group Members
+         * @request GET:/api/user-groups/{groupId}/members
+         * @secure
+         * @response `200` `(UserGroupMember)[]` OK
+         */
+        listGroupMembers: (groupId: string, params?: RequestParams) => Promise<AxiosResponse<UserGroupMember[], any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroupMembers
+         * @name CreateGroupMember
+         * @summary Create Group Member
+         * @request POST:/api/user-groups/{groupId}/members
+         * @secure
+         * @response `200` `UserGroupMember` OK
+         */
+        createGroupMember: (groupId: string, data: CreateGroupMemberRequest, query?: {
+            /** @format uuid */
+            userId?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<UserGroupMember, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroupMembers
+         * @name RemoveGroupMember
+         * @summary Remove Group Member
+         * @request DELETE:/api/user-groups/{groupId}/members/{userId}
+         * @secure
+         * @response `204` `void` No Content
+         */
+        removeGroupMember: (groupId: string, userId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroups
+         * @name ListUserGroups
+         * @summary List User Groups
+         * @request GET:/api/user-groups
+         * @secure
+         * @response `200` `UserGroupPaginated` OK
+         */
+        listUserGroups: (query?: {
+            search?: string;
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<UserGroupPaginated, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroups
+         * @name CreateUserGroup
+         * @summary Create User Group
+         * @request POST:/api/user-groups
+         * @secure
+         * @response `201` `UserGroup` Created
+         */
+        createUserGroup: (data: CreateUserGroupRequest, params?: RequestParams) => Promise<AxiosResponse<UserGroup, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroups
+         * @name GetUserGroup
+         * @summary Get User Group by ID
+         * @request GET:/api/user-groups/{groupId}
+         * @secure
+         * @response `200` `UserGroup` OK
+         */
+        getUserGroup: (groupId: string, params?: RequestParams) => Promise<AxiosResponse<UserGroup, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroups
+         * @name UpdateUserGroup
+         * @summary Update User Group
+         * @request PUT:/api/user-groups/{groupId}
+         * @secure
+         * @response `200` `UserGroup` OK
+         */
+        updateUserGroup: (groupId: string, data: UpdateUserGroupRequest, params?: RequestParams) => Promise<AxiosResponse<UserGroup, any>>;
+        /**
+         * No description
+         *
+         * @tags UserGroups
+         * @name DeleteUserGroup
+         * @summary Delete (soft) User Group
+         * @request DELETE:/api/user-groups/{groupId}
+         * @secure
+         * @response `204` `void` No Content
+         */
+        deleteUserGroup: (groupId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *

package/dist/index.js

@@ -32,7 +32,6 @@ var __rest = (this && this.__rest) || function (s, e) {
 import axios from "axios";
 export var ContentType;
 (function (ContentType) {
-    ContentType["JsonPatch"] = "application/json-patch+json";
     ContentType["Json"] = "application/json";
     ContentType["JsonApi"] = "application/vnd.api+json";
     ContentType["FormData"] = "multipart/form-data";
@@ -104,7 +103,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v2.22.4
+ * @version v2.22.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -1163,7 +1162,7 @@ export class Api extends HttpClient {
              * @response `200` `string` OK
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
-            updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1287,7 +1286,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `ListingFile` OK
              */
-            updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1320,7 +1319,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `(ListingPhoto)[]` OK
              */
-            updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1981,7 +1980,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `Loan` OK
              */
-            updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
+            updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -2915,6 +2914,127 @@ export class Api extends HttpClient {
              * @response `204` `void` No Content
              */
             deleteDraftUser: (draftId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroupAccessScopes
+             * @name ListGroupScopes
+             * @summary List Group Access Scopes
+             * @request GET:/api/user-groups/{groupId}/scopes
+             * @secure
+             * @response `200` `(UserGroupAccessScope)[]` OK
+             */
+            listGroupScopes: (groupId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/scopes`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroupAccessScopes
+             * @name CreateGroupScope
+             * @summary Create Group Access Scope
+             * @request POST:/api/user-groups/{groupId}/scopes
+             * @secure
+             * @response `200` `UserGroupAccessScope` OK
+             */
+            createGroupScope: (groupId, data, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/scopes`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroupAccessScopes
+             * @name RemoveGroupScope
+             * @summary Remove Group Access Scope
+             * @request DELETE:/api/user-groups/{groupId}/scopes/{scopeId}
+             * @secure
+             * @response `204` `void` No Content
+             */
+            removeGroupScope: (groupId, scopeId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/scopes/${scopeId}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroupMembers
+             * @name ListGroupMembers
+             * @summary List Group Members
+             * @request GET:/api/user-groups/{groupId}/members
+             * @secure
+             * @response `200` `(UserGroupMember)[]` OK
+             */
+            listGroupMembers: (groupId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/members`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroupMembers
+             * @name CreateGroupMember
+             * @summary Create Group Member
+             * @request POST:/api/user-groups/{groupId}/members
+             * @secure
+             * @response `200` `UserGroupMember` OK
+             */
+            createGroupMember: (groupId, data, query, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/members`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroupMembers
+             * @name RemoveGroupMember
+             * @summary Remove Group Member
+             * @request DELETE:/api/user-groups/{groupId}/members/{userId}
+             * @secure
+             * @response `204` `void` No Content
+             */
+            removeGroupMember: (groupId, userId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}/members/${userId}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroups
+             * @name ListUserGroups
+             * @summary List User Groups
+             * @request GET:/api/user-groups
+             * @secure
+             * @response `200` `UserGroupPaginated` OK
+             */
+            listUserGroups: (query, params = {}) => this.request(Object.assign({ path: `/api/user-groups`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroups
+             * @name CreateUserGroup
+             * @summary Create User Group
+             * @request POST:/api/user-groups
+             * @secure
+             * @response `201` `UserGroup` Created
+             */
+            createUserGroup: (data, params = {}) => this.request(Object.assign({ path: `/api/user-groups`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroups
+             * @name GetUserGroup
+             * @summary Get User Group by ID
+             * @request GET:/api/user-groups/{groupId}
+             * @secure
+             * @response `200` `UserGroup` OK
+             */
+            getUserGroup: (groupId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroups
+             * @name UpdateUserGroup
+             * @summary Update User Group
+             * @request PUT:/api/user-groups/{groupId}
+             * @secure
+             * @response `200` `UserGroup` OK
+             */
+            updateUserGroup: (groupId, data, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserGroups
+             * @name DeleteUserGroup
+             * @summary Delete (soft) User Group
+             * @request DELETE:/api/user-groups/{groupId}
+             * @secure
+             * @response `204` `void` No Content
+             */
+            deleteUserGroup: (groupId, params = {}) => this.request(Object.assign({ path: `/api/user-groups/${groupId}`, method: "DELETE", secure: true }, params)),
             /**
              * No description
              *