@matech/thebigpos-sdk 3.19.1 → 3.20.0-dev-6956

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1691,7 +1691,7 @@ export interface CreateInviteRequest {
1691
1691
  phoneNumber?: string | null;
1692
1692
  /** @deprecated */
1693
1693
  relationship: CreateInviteRequestRelationshipEnum;
1694
- loanID: string;
1694
+ loanID?: string | null;
1695
1695
  route?: string | null;
1696
1696
  /** @format uuid */
1697
1697
  siteConfigurationID: string;
@@ -2061,6 +2061,7 @@ export interface DraftRequest {
2061
2061
  applicationPayload: any;
2062
2062
  customData?: any | null;
2063
2063
  isCoBorrower: boolean;
2064
+ /** @format uuid */
2064
2065
  partnerId?: string | null;
2065
2066
  }
2066
2067
  export interface EconsentPendingSummary {
@@ -2996,6 +2997,7 @@ export interface LoanApplicationRequest {
2996
2997
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2997
2998
  /** @format uuid */
2998
2999
  draftId?: string | null;
3000
+ /** @format uuid */
2999
3001
  partnerId?: string | null;
3000
3002
  additionalFields?: Record<string, any> | null;
3001
3003
  /** @format uuid */
@@ -3910,6 +3912,10 @@ export interface LoanDocumentFolderPermission {
3910
3912
  level: LoanDocumentFolderPermissionLevelEnum;
3911
3913
  readScope: LoanDocumentFolderPermissionReadScopeEnum;
3912
3914
  }
3915
+ export interface LoanDocumentFolderPermissionFilter {
3916
+ role: LoanDocumentFolderPermissionFilterRoleEnum;
3917
+ minimumPermissionLevel: LoanDocumentFolderPermissionFilterMinimumPermissionLevelEnum;
3918
+ }
3913
3919
  export interface LoanDocumentFolderPermissionRequest {
3914
3920
  role: LoanDocumentFolderPermissionRequestRoleEnum;
3915
3921
  level: LoanDocumentFolderPermissionRequestLevelEnum;
@@ -3920,6 +3926,7 @@ export interface LoanDocumentFolderSearchCriteria {
3920
3926
  isActive?: boolean | null;
3921
3927
  isSystemDefault?: boolean | null;
3922
3928
  role?: LoanRole | null;
3929
+ permissions?: LoanDocumentFolderPermissionFilter[] | null;
3923
3930
  }
3924
3931
  export interface LoanDocumentFolderSummary {
3925
3932
  /** @format uuid */
@@ -5225,7 +5232,8 @@ export interface PartnerFormLink {
5225
5232
  url: string;
5226
5233
  }
5227
5234
  export interface PartnerLinks {
5228
- slug: string;
5235
+ /** @format uuid */
5236
+ partnerId: string;
5229
5237
  loanOfficers: PartnerLoanOfficerLinks[];
5230
5238
  }
5231
5239
  export interface PartnerLoanOfficerLinks {
@@ -5241,9 +5249,6 @@ export interface PartnerSearchCriteria {
5241
5249
  brands?: string[] | null;
5242
5250
  roles?: UserRole[] | null;
5243
5251
  }
5244
- export interface PartnerSlug {
5245
- slug: string;
5246
- }
5247
5252
  export interface PendingInvite {
5248
5253
  status: PendingInviteStatusEnum;
5249
5254
  /** @format uuid */
@@ -6762,9 +6767,6 @@ export interface UpdateMobilePhoneRequest {
6762
6767
  export interface UpdatePartnerPortalRequest {
6763
6768
  isEnabled?: boolean | null;
6764
6769
  }
6765
- export interface UpdatePartnerSlugRequest {
6766
- slug: string;
6767
- }
6768
6770
  export interface UpdateUserGroupRequest {
6769
6771
  name: string;
6770
6772
  description?: string | null;
@@ -7388,6 +7390,8 @@ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "L
7388
7390
  export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7389
7391
  export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
7390
7392
  export type LoanDocumentFolderPermissionReadScopeEnum = "Own" | "All";
7393
+ export type LoanDocumentFolderPermissionFilterRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7394
+ export type LoanDocumentFolderPermissionFilterMinimumPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
7391
7395
  export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7392
7396
  export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
7393
7397
  export type LoanDocumentFolderPermissionRequestReadScopeEnum = "Own" | "All";
@@ -7526,7 +7530,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
7526
7530
  }
7527
7531
  /**
7528
7532
  * @title The Big POS API
7529
- * @version v3.19.1
7533
+ * @version v3.20.0
7530
7534
  * @termsOfService https://www.thebigpos.com/terms-of-use/
7531
7535
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
7532
7536
  */
@@ -10658,17 +10662,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10658
10662
  * @response `200` `(UnderwritingCondition)[]` OK
10659
10663
  */
10660
10664
  getUnderwritingConditionsForLoan: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<UnderwritingCondition[], any, {}, any>>;
10661
- /**
10662
- * No description
10663
- *
10664
- * @tags LegacyLoan
10665
- * @name GetLoanEmbeddedSigningLink
10666
- * @summary Get Embedded Signing Link
10667
- * @request POST:/api/los/loan/embeddedsigning/{envelopeId}/{userName}/{email}
10668
- * @secure
10669
- * @response `200` `string` OK
10670
- */
10671
- getLoanEmbeddedSigningLink: (envelopeId: string, userName: string, email: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}, any>>;
10672
10665
  /**
10673
10666
  * No description
10674
10667
  *
@@ -12969,21 +12962,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12969
12962
  * @response `200` `NotificationTemplateVersion` OK
12970
12963
  */
12971
12964
  deleteNotificationTemplateVersion: (notificationId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<NotificationTemplateVersion, any, {}, any>>;
12972
- /**
12973
- * @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
12974
- *
12975
- * @tags Partners
12976
- * @name UpdatePartnerLinkSlug
12977
- * @summary Update Partner Link Slug
12978
- * @request PUT:/api/partners/{realtorId}/link-slug
12979
- * @secure
12980
- * @response `200` `PartnerSlug` OK
12981
- * @response `403` `ProblemDetails` Forbidden
12982
- * @response `404` `ProblemDetails` Not Found
12983
- * @response `409` `ProblemDetails` Conflict
12984
- * @response `422` `UnprocessableEntity` Unprocessable Content
12985
- */
12986
- updatePartnerLinkSlug: (realtorId: string, data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerSlug, any, {}, any>>;
12987
12965
  /**
12988
12966
  * No description
12989
12967
  *
@@ -14599,21 +14577,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14599
14577
  * @response `404` `ProblemDetails` Not Found
14600
14578
  */
14601
14579
  getMyPartnerLinks: (params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}, any>>;
14602
- /**
14603
- * @description Changes the short name the partner's links carry and returns the links rebuilt with it. Links shared with the previous name stop working.
14604
- *
14605
- * @tags UsersMe
14606
- * @name UpdateMyPartnerLinkSlug
14607
- * @summary Update My Partner Link Slug
14608
- * @request PUT:/api/users/me/partner-links/slug
14609
- * @secure
14610
- * @response `200` `PartnerLinks` OK
14611
- * @response `403` `ProblemDetails` Forbidden
14612
- * @response `404` `ProblemDetails` Not Found
14613
- * @response `409` `ProblemDetails` Conflict
14614
- * @response `422` `UnprocessableEntity` Unprocessable Content
14615
- */
14616
- updateMyPartnerLinkSlug: (data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}, any>>;
14617
14580
  /**
14618
14581
  * No description
14619
14582
  *
package/dist/index.js CHANGED
@@ -101,7 +101,7 @@ export class HttpClient {
101
101
  }
102
102
  /**
103
103
  * @title The Big POS API
104
- * @version v3.19.1
104
+ * @version v3.20.0
105
105
  * @termsOfService https://www.thebigpos.com/terms-of-use/
106
106
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
107
107
  */
@@ -2883,17 +2883,6 @@ export class Api extends HttpClient {
2883
2883
  * @response `200` `(UnderwritingCondition)[]` OK
2884
2884
  */
2885
2885
  getUnderwritingConditionsForLoan: (loanId, params = {}) => this.request(Object.assign({ path: `/api/los/loan/${loanId}/conditions/underwriting`, method: "GET", secure: true, format: "json" }, params)),
2886
- /**
2887
- * No description
2888
- *
2889
- * @tags LegacyLoan
2890
- * @name GetLoanEmbeddedSigningLink
2891
- * @summary Get Embedded Signing Link
2892
- * @request POST:/api/los/loan/embeddedsigning/{envelopeId}/{userName}/{email}
2893
- * @secure
2894
- * @response `200` `string` OK
2895
- */
2896
- getLoanEmbeddedSigningLink: (envelopeId, userName, email, params = {}) => this.request(Object.assign({ path: `/api/los/loan/embeddedsigning/${envelopeId}/${userName}/${email}`, method: "POST", secure: true, format: "json" }, params)),
2897
2886
  /**
2898
2887
  * No description
2899
2888
  *
@@ -5000,21 +4989,6 @@ export class Api extends HttpClient {
5000
4989
  * @response `200` `NotificationTemplateVersion` OK
5001
4990
  */
5002
4991
  deleteNotificationTemplateVersion: (notificationId, id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
5003
- /**
5004
- * @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
5005
- *
5006
- * @tags Partners
5007
- * @name UpdatePartnerLinkSlug
5008
- * @summary Update Partner Link Slug
5009
- * @request PUT:/api/partners/{realtorId}/link-slug
5010
- * @secure
5011
- * @response `200` `PartnerSlug` OK
5012
- * @response `403` `ProblemDetails` Forbidden
5013
- * @response `404` `ProblemDetails` Not Found
5014
- * @response `409` `ProblemDetails` Conflict
5015
- * @response `422` `UnprocessableEntity` Unprocessable Content
5016
- */
5017
- updatePartnerLinkSlug: (realtorId, data, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/link-slug`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
5018
4992
  /**
5019
4993
  * No description
5020
4994
  *
@@ -6499,21 +6473,6 @@ export class Api extends HttpClient {
6499
6473
  * @response `404` `ProblemDetails` Not Found
6500
6474
  */
6501
6475
  getMyPartnerLinks: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partner-links`, method: "GET", secure: true, format: "json" }, params)),
6502
- /**
6503
- * @description Changes the short name the partner's links carry and returns the links rebuilt with it. Links shared with the previous name stop working.
6504
- *
6505
- * @tags UsersMe
6506
- * @name UpdateMyPartnerLinkSlug
6507
- * @summary Update My Partner Link Slug
6508
- * @request PUT:/api/users/me/partner-links/slug
6509
- * @secure
6510
- * @response `200` `PartnerLinks` OK
6511
- * @response `403` `ProblemDetails` Forbidden
6512
- * @response `404` `ProblemDetails` Not Found
6513
- * @response `409` `ProblemDetails` Conflict
6514
- * @response `422` `UnprocessableEntity` Unprocessable Content
6515
- */
6516
- updateMyPartnerLinkSlug: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/partner-links/slug`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
6517
6476
  /**
6518
6477
  * No description
6519
6478
  *