@matech/thebigpos-sdk 3.28.0-dev-8410 → 3.28.0-dev-8425

package/src/index.ts

@@ -825,6 +825,8 @@ export type AddressFamily =
   | "ControllerAreaNetwork"
   | "Unknown";
 
+export type AccountPartnerStatus = "Active" | "Invited";
+
 export type CanvasWidgetConfig = BaseCanvasWidgetConfig &
   (
     | BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig>
@@ -937,6 +939,32 @@ export interface AccountFailureCount {
   count: number;
 }
 
+export interface AccountPartner {
+  /** @format uuid */
+  partnerProfileID?: string | null;
+  /** @format uuid */
+  partnerID?: string | null;
+  firstName: string;
+  lastName: string;
+  email: string;
+  phone?: string | null;
+  status: AccountPartnerStatusEnum;
+  tier: AccountPartnerTierEnum;
+  /** @format date-time */
+  createdAt: string;
+}
+
+export interface AccountPartnerPaginated {
+  rows: AccountPartner[];
+  pagination: Pagination;
+  /** @format int64 */
+  count: number;
+}
+
+export interface AccountPartnerSearchCriteria {
+  searchText?: string | null;
+}
+
 export interface AccountSettings {
   isSmsEnabled: boolean;
   smsNumber?: string | null;
@@ -8234,6 +8262,13 @@ export interface UpdatePartnerPortalRequest {
   isEnabled?: boolean | null;
 }
 
+export interface UpdatePartnerRequest {
+  firstName: string;
+  lastName: string;
+  email: string;
+  phone?: string | null;
+}
+
 export interface UpdateUserGroupRequest {
   name: string;
   description?: string | null;
@@ -8837,6 +8872,10 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
 
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 
+export type AccountPartnerStatusEnum = "Active" | "Invited";
+
+export type AccountPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
+
 export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
 
 export type AiAccessReadAloudVoiceEnum =
@@ -10365,6 +10404,141 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * @description Every partner of the caller's account: Realtors with an account and pending partners who have not signed up yet
+     *
+     * @tags AccountPartners
+     * @name SearchAccountPartners
+     * @summary Search Account Partners
+     * @request POST:/api/account/partners/search
+     * @secure
+     * @response `200` `AccountPartnerPaginated` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    searchAccountPartners: (
+      data: AccountPartnerSearchCriteria,
+      query?: {
+        /** @format int32 */
+        pageSize?: number;
+        /** @format int32 */
+        pageNumber?: number;
+        sortBy?: string;
+        sortDirection?: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<AccountPartnerPaginated, ProblemDetails>({
+        path: `/api/account/partners/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @description Makes a settlement agent, by user ID or by an open invite's ID, a partner with no loan officer
+     *
+     * @tags AccountPartners
+     * @name PromotePartner
+     * @summary Promote To Partner
+     * @request POST:/api/account/partners/promotions
+     * @secure
+     * @response `200` `PromotePartner` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    promotePartner: (data: PromotePartnerRequest, params: RequestParams = {}) =>
+      this.request<PromotePartner, ProblemDetails>({
+        path: `/api/account/partners/promotions`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @description Changes a registered partner's name, sign-in email and phone
+     *
+     * @tags AccountPartners
+     * @name ReplacePartner
+     * @summary Replace Partner
+     * @request PUT:/api/account/partners/{partnerProfileId}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    replacePartner: (
+      partnerProfileId: string,
+      data: UpdatePartnerRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/account/partners/${partnerProfileId}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        ...params,
+      }),
+
+    /**
+     * @description Makes a registered partner a settlement agent again and retires their partner profile; their account and loans stay
+     *
+     * @tags AccountPartners
+     * @name DemotePartner
+     * @summary Demote Partner
+     * @request POST:/api/account/partners/{partnerProfileId}/demote
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    demotePartner: (partnerProfileId: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/account/partners/${partnerProfileId}/demote`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * @description Cancels a pending partner's invites and retires their partner profile; inviting the email again restores it
+     *
+     * @tags AccountPartners
+     * @name CancelPartnerInvite
+     * @summary Cancel Partner Invite
+     * @request POST:/api/account/partners/{partnerProfileId}/cancel
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     */
+    cancelPartnerInvite: (
+      partnerProfileId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/account/partners/${partnerProfileId}/cancel`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *