@matech/thebigpos-sdk 3.18.0-dev-6739 → 3.18.0-dev-6750

package/src/index.ts

@@ -69,6 +69,8 @@ export type PendingInviteStatus =
   | "InviteExpired"
   | "NotInvited";
 
+export type PartnerTier = "Lite" | "LitePlusPortal" | "Pending";
+
 export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
 
 export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
@@ -882,6 +884,7 @@ export interface Account {
   updatedAt?: string | null;
   /** @format int32 */
   allowedLoginsWithoutMFA: number;
+  isPartnerPortalEnabled: boolean;
   losSettings: LOSSettings;
   asoSettings?: ASOSettings | null;
   settings: AccountSettings;
@@ -912,12 +915,14 @@ export interface AccountSettings {
   smsNumber?: string | null;
   ssoHostOverride?: string | null;
   isEarlyAdopter: boolean;
+  allowLoanOfficerPartnerInvites: boolean;
 }
 
 export interface AccountSettingsRequest {
   isSmsEnabled: boolean;
   smsNumber?: string | null;
   isEarlyAdopter: boolean;
+  allowLoanOfficerPartnerInvites?: boolean | null;
 }
 
 export interface Address {
@@ -2448,6 +2453,7 @@ export interface CreateAccountRequest {
   domain: string;
   eConsentBucket?: string | null;
   ignoreCoBorrowerRelationship: boolean;
+  isPartnerPortalEnabled: boolean;
   user: AdminUser;
   companyAddress: CompanyAddress;
   contactInfo: ContactInfo;
@@ -2981,6 +2987,7 @@ export interface DraftRequest {
   applicationPayload: any;
   customData?: any | null;
   isCoBorrower: boolean;
+  partnerId?: string | null;
 }
 
 export interface EconsentPendingSummary {
@@ -4010,6 +4017,7 @@ export interface LoanApplicationRequest {
   nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
   /** @format uuid */
   draftId?: string | null;
+  partnerId?: string | null;
   additionalFields?: Record<string, any> | null;
   /** @format uuid */
   existingLoanId?: string | null;
@@ -5115,6 +5123,7 @@ export interface LoanFieldAccess {
 export interface LoanFieldAccessItem {
   fieldKey: string;
   access: LoanFieldAccessItemAccessEnum;
+  patchPath?: string | null;
 }
 
 export interface LoanFinancial {
@@ -5257,6 +5266,7 @@ export interface LoanList {
   buyerAgentContact?: LoanContactList | null;
   sellerAgentContact?: LoanContactList | null;
   userLoans: UserLoan[];
+  myLoanRoles: LoanRole[];
   contacts: LoanContact[];
   borrowers: LoanListBorrower[];
   taskCounts: LoanTaskCounts;
@@ -6221,6 +6231,20 @@ export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
   type: MonthlyPaymentWidgetConfigTypeEnum;
 };
 
+export interface MyPartner {
+  /** @format uuid */
+  partnerID?: string | null;
+  /** @format uuid */
+  inviteID?: string | null;
+  firstName: string;
+  lastName: string;
+  email: string;
+  phone?: string | null;
+  tier: MyPartnerTierEnum;
+  /** @format date-time */
+  createdAt: string;
+}
+
 export type MyTasksWidgetConfig = UtilRequiredKeys<
   BaseCanvasWidgetConfig,
   "type"
@@ -6419,6 +6443,26 @@ export interface Pagination {
   pageSize: number;
 }
 
+export interface PartnerFormLink {
+  /** @format int32 */
+  formType: number;
+  name: string;
+  url: string;
+}
+
+export interface PartnerLinks {
+  slug: string;
+  loanOfficers: PartnerLoanOfficerLinks[];
+}
+
+export interface PartnerLoanOfficerLinks {
+  /** @format uuid */
+  loanOfficerId: string;
+  name: string;
+  siteUrl: string;
+  links: PartnerFormLink[];
+}
+
 export interface PartnerSearchCriteria {
   searchText?: string | null;
   isActive?: boolean | null;
@@ -6426,6 +6470,10 @@ export interface PartnerSearchCriteria {
   roles?: UserRole[] | null;
 }
 
+export interface PartnerSlug {
+  slug: string;
+}
+
 export interface PendingInvite {
   status: PendingInviteStatusEnum;
   /** @format uuid */
@@ -7048,6 +7096,7 @@ export interface SiteConfiguration {
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
+  isPartnerPortalEnabled: boolean;
   autoTaskReminderIntervalsInDays?: number[] | null;
   mobileSettings?: MobileSettings | null;
   losSettings?: LOSSettings | null;
@@ -7243,6 +7292,7 @@ export interface SiteConfigurationByUrl {
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
+  isPartnerPortalEnabled: boolean;
   autoTaskReminderIntervalsInDays?: number[] | null;
   mobileSettings?: MobileSettings | null;
   losSettings?: LOSSettings | null;
@@ -8049,6 +8099,14 @@ export interface UpdateMobilePhoneRequest {
   phone: string;
 }
 
+export interface UpdatePartnerPortalRequest {
+  isEnabled?: boolean | null;
+}
+
+export interface UpdatePartnerSlugRequest {
+  slug: string;
+}
+
 export interface UpdateUserGroupRequest {
   name: string;
   description?: string | null;
@@ -9502,6 +9560,8 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
 
 export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
 
+export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
+
 export type MyTasksWidgetConfigTypeEnum = "MyTasks";
 
 export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
@@ -10225,6 +10285,33 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * @description Turns the account's partner portal on or off. While Partner-lite is on for the account, off refuses its realtors' leads and listings and the creation of partner sites.
+     *
+     * @tags Accounts
+     * @name UpdateAccountPartnerPortal
+     * @summary Update partner portal switch
+     * @request PUT:/api/accounts/{id}/partner-portal
+     * @secure
+     * @response `200` `Account` OK
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    updateAccountPartnerPortal: (
+      id: string,
+      data: UpdatePartnerPortalRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<Account, ProblemDetails>({
+        path: `/api/accounts/${id}/partner-portal`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -14984,13 +15071,14 @@ export class Api<
      * @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
      * @secure
      * @response `204` `void` No Content
+     * @response `403` `HttpError` Forbidden
      */
     deleteFormSubmissionFile: (
       formSubmissionFileId: string,
       formSubmissionId: string,
       params: RequestParams = {},
     ) =>
-      this.request<void, any>({
+      this.request<void, HttpError>({
         path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}`,
         method: "DELETE",
         secure: true,
@@ -15006,6 +15094,7 @@ export class Api<
      * @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
      * @secure
      * @response `200` `FileWithBytes` OK
+     * @response `403` `HttpError` Forbidden
      */
     downloadFormSubmissionFile: (
       formSubmissionFileId: string,
@@ -15016,7 +15105,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<FileWithBytes, any>({
+      this.request<FileWithBytes, HttpError>({
         path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}/download`,
         method: "GET",
         query: query,
@@ -15034,6 +15123,7 @@ export class Api<
      * @request GET:/api/form-submissions
      * @secure
      * @response `200` `FormSubmissionPaginated` OK
+     * @response `403` `HttpError` Forbidden
      */
     getFormSubmissions: (
       query?: {
@@ -15046,7 +15136,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<FormSubmissionPaginated, any>({
+      this.request<FormSubmissionPaginated, HttpError>({
         path: `/api/form-submissions`,
         method: "GET",
         query: query,
@@ -15092,9 +15182,10 @@ export class Api<
      * @request GET:/api/form-submissions/{id}
      * @secure
      * @response `200` `FormSubmission` OK
+     * @response `403` `HttpError` Forbidden
      */
     getFormSubmission: (id: string, params: RequestParams = {}) =>
-      this.request<FormSubmission, any>({
+      this.request<FormSubmission, HttpError>({
         path: `/api/form-submissions/${id}`,
         method: "GET",
         secure: true,
@@ -15111,13 +15202,14 @@ export class Api<
      * @request PUT:/api/form-submissions/{id}
      * @secure
      * @response `200` `FormSubmission` OK
+     * @response `403` `HttpError` Forbidden
      */
     replaceFormSubmission: (
       id: string,
       data: FormSubmissionRequest,
       params: RequestParams = {},
     ) =>
-      this.request<FormSubmission, any>({
+      this.request<FormSubmission, HttpError>({
         path: `/api/form-submissions/${id}`,
         method: "PUT",
         body: data,
@@ -15136,9 +15228,10 @@ export class Api<
      * @request DELETE:/api/form-submissions/{id}
      * @secure
      * @response `204` `void` No Content
+     * @response `403` `HttpError` Forbidden
      */
     deleteFormSubmission: (id: string, params: RequestParams = {}) =>
-      this.request<void, any>({
+      this.request<void, HttpError>({
         path: `/api/form-submissions/${id}`,
         method: "DELETE",
         secure: true,
@@ -15154,6 +15247,7 @@ export class Api<
      * @request POST:/api/form-submissions/search
      * @secure
      * @response `200` `FormSubmissionPaginated` OK
+     * @response `403` `HttpError` Forbidden
      */
     searchFormSubmissions: (
       data: FormSubmissionSearchCriteria,
@@ -15167,7 +15261,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<FormSubmissionPaginated, any>({
+      this.request<FormSubmissionPaginated, HttpError>({
         path: `/api/form-submissions/search`,
         method: "POST",
         query: query,
@@ -15659,6 +15753,7 @@ export class Api<
      * @request POST:/api/listings/{listingId}/files
      * @secure
      * @response `200` `ListingFile` OK
+     * @response `403` `HttpError` Forbidden
      */
     addListingFile: (
       listingId: string,
@@ -15670,7 +15765,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<ListingFile, any>({
+      this.request<ListingFile, HttpError>({
         path: `/api/listings/${listingId}/files`,
         method: "POST",
         body: data,
@@ -15689,13 +15784,14 @@ export class Api<
      * @request PATCH:/api/listings/{listingId}/files
      * @secure
      * @response `200` `ListingFile` OK
+     * @response `403` `HttpError` Forbidden
      */
     updateListingFiles: (
       listingId: string,
       data: JsonPatchDocument,
       params: RequestParams = {},
     ) =>
-      this.request<ListingFile, any>({
+      this.request<ListingFile, HttpError>({
         path: `/api/listings/${listingId}/files`,
         method: "PATCH",
         body: data,
@@ -15714,13 +15810,14 @@ export class Api<
      * @request DELETE:/api/listings/{listingId}/files/{id}
      * @secure
      * @response `204` `Listing` No Content
+     * @response `403` `HttpError` Forbidden
      */
     removeListingFile: (
       listingId: string,
       id: string,
       params: RequestParams = {},
     ) =>
-      this.request<Listing, any>({
+      this.request<Listing, HttpError>({
         path: `/api/listings/${listingId}/files/${id}`,
         method: "DELETE",
         secure: true,
@@ -15737,6 +15834,7 @@ export class Api<
      * @request POST:/api/listings/{listingId}/photos
      * @secure
      * @response `200` `ListingPhoto` OK
+     * @response `403` `HttpError` Forbidden
      */
     addListingPhoto: (
       listingId: string,
@@ -15750,7 +15848,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<ListingPhoto, any>({
+      this.request<ListingPhoto, HttpError>({
         path: `/api/listings/${listingId}/photos`,
         method: "POST",
         body: data,
@@ -15769,13 +15867,14 @@ export class Api<
      * @request PATCH:/api/listings/{listingId}/photos
      * @secure
      * @response `200` `(ListingPhoto)[]` OK
+     * @response `403` `HttpError` Forbidden
      */
     updateListingPhotos: (
       listingId: string,
       data: JsonPatchDocument,
       params: RequestParams = {},
     ) =>
-      this.request<ListingPhoto[], any>({
+      this.request<ListingPhoto[], HttpError>({
         path: `/api/listings/${listingId}/photos`,
         method: "PATCH",
         body: data,
@@ -15794,13 +15893,14 @@ export class Api<
      * @request DELETE:/api/listings/{listingId}/photos/{id}
      * @secure
      * @response `204` `Listing` No Content
+     * @response `403` `HttpError` Forbidden
      */
     removeListingPhoto: (
       listingId: string,
       id: string,
       params: RequestParams = {},
     ) =>
-      this.request<Listing, any>({
+      this.request<Listing, HttpError>({
         path: `/api/listings/${listingId}/photos/${id}`,
         method: "DELETE",
         secure: true,
@@ -15935,9 +16035,10 @@ export class Api<
      * @request DELETE:/api/listings/{id}
      * @secure
      * @response `204` `void` No Content
+     * @response `403` `HttpError` Forbidden
      */
     deleteListing: (id: string, params: RequestParams = {}) =>
-      this.request<void, any>({
+      this.request<void, HttpError>({
         path: `/api/listings/${id}`,
         method: "DELETE",
         secure: true,
@@ -15986,6 +16087,7 @@ export class Api<
      * @request PUT:/api/listings/{id}/background-image
      * @secure
      * @response `200` `File` OK
+     * @response `403` `HttpError` Forbidden
      */
     updateListingBackgroundImage: (
       id: string,
@@ -15995,7 +16097,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<File, any>({
+      this.request<File, HttpError>({
         path: `/api/listings/${id}/background-image`,
         method: "PUT",
         body: data,
@@ -16014,9 +16116,10 @@ export class Api<
      * @request DELETE:/api/listings/{id}/background-image
      * @secure
      * @response `204` `void` No Content
+     * @response `403` `HttpError` Forbidden
      */
     deleteListingBackgroundImage: (id: string, params: RequestParams = {}) =>
-      this.request<void, any>({
+      this.request<void, HttpError>({
         path: `/api/listings/${id}/background-image`,
         method: "DELETE",
         secure: true,
@@ -19769,6 +19872,35 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
+     *
+     * @tags Partners
+     * @name UpdatePartnerLinkSlug
+     * @summary Update Partner Link Slug
+     * @request PUT:/api/partners/{realtorId}/link-slug
+     * @secure
+     * @response `200` `PartnerSlug` OK
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     */
+    updatePartnerLinkSlug: (
+      realtorId: string,
+      data: UpdatePartnerSlugRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<PartnerSlug, ProblemDetails | UnprocessableEntity>({
+        path: `/api/partners/${realtorId}/link-slug`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -22666,6 +22798,115 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * @description The partners on the loan officer's list and the loan officer's portal relations, plus the open partner invites the loan officer sent
+     *
+     * @tags UsersMe
+     * @name GetMyPartners
+     * @summary Get My Partners
+     * @request GET:/api/users/me/partners
+     * @secure
+     * @response `200` `(MyPartner)[]` OK
+     * @response `403` `ProblemDetails` Forbidden
+     */
+    getMyPartners: (params: RequestParams = {}) =>
+      this.request<MyPartner[], ProblemDetails>({
+        path: `/api/users/me/partners`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsersMe
+     * @name AddMyPartner
+     * @summary Add My Partner
+     * @request POST:/api/users/me/partners/{partnerId}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    addMyPartner: (partnerId: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/users/me/partners/${partnerId}`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags UsersMe
+     * @name RemoveMyPartner
+     * @summary Remove My Partner
+     * @request DELETE:/api/users/me/partners/{partnerId}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    removeMyPartner: (partnerId: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/users/me/partners/${partnerId}`,
+        method: "DELETE",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
+     *
+     * @tags UsersMe
+     * @name GetMyPartnerLinks
+     * @summary Get My Partner Links
+     * @request GET:/api/users/me/partner-links
+     * @secure
+     * @response `200` `PartnerLinks` OK
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getMyPartnerLinks: (params: RequestParams = {}) =>
+      this.request<PartnerLinks, ProblemDetails>({
+        path: `/api/users/me/partner-links`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @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.
+     *
+     * @tags UsersMe
+     * @name UpdateMyPartnerLinkSlug
+     * @summary Update My Partner Link Slug
+     * @request PUT:/api/users/me/partner-links/slug
+     * @secure
+     * @response `200` `PartnerLinks` OK
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     */
+    updateMyPartnerLinkSlug: (
+      data: UpdatePartnerSlugRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<PartnerLinks, ProblemDetails | UnprocessableEntity>({
+        path: `/api/users/me/partner-links/slug`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *