@matech/thebigpos-sdk 3.18.0-dev-6743 → 3.18.0-dev-6756

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";
@@ -380,6 +382,15 @@ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
 
 export type LoanGenderType = "Male" | "Female";
 
+export type LoanFieldDataType =
+  | "Text"
+  | "Number"
+  | "Boolean"
+  | "Date"
+  | "Enum"
+  | "Identifier"
+  | "Object";
+
 export type LoanDocumentType =
   | "W2"
   | "Paystub"
@@ -649,6 +660,11 @@ export type CanvasAudience = "Staff" | "Borrower" | "Partner";
 
 export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
 
+export type BulkLoanFieldOperationType =
+  | "SetAccess"
+  | "SetAiEnabled"
+  | "ResetToDefaults";
+
 export type BranchType = "Mortgage" | "RealEstate";
 
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -882,6 +898,7 @@ export interface Account {
   updatedAt?: string | null;
   /** @format int32 */
   allowedLoginsWithoutMFA: number;
+  isPartnerPortalEnabled: boolean;
   losSettings: LOSSettings;
   asoSettings?: ASOSettings | null;
   settings: AccountSettings;
@@ -912,12 +929,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 {
@@ -1939,6 +1958,24 @@ export interface BranchUserPaginated {
   count: number;
 }
 
+export interface BulkLoanFieldOperation {
+  applied: string[];
+  skipped: BulkLoanFieldSkip[];
+}
+
+export interface BulkLoanFieldOperationRequest {
+  fieldKeys: string[];
+  operation?: BulkLoanFieldOperationType | null;
+  role?: UserRole | null;
+  accessLevel?: CustomFieldAccessLevel | null;
+  enabled?: boolean | null;
+}
+
+export interface BulkLoanFieldSkip {
+  fieldKey: string;
+  reason: string;
+}
+
 export interface BulkLoanTaskFailure {
   /** @format uuid */
   userLoanTaskID: string;
@@ -2448,6 +2485,7 @@ export interface CreateAccountRequest {
   domain: string;
   eConsentBucket?: string | null;
   ignoreCoBorrowerRelationship: boolean;
+  isPartnerPortalEnabled: boolean;
   user: AdminUser;
   companyAddress: CompanyAddress;
   contactInfo: ContactInfo;
@@ -2981,6 +3019,7 @@ export interface DraftRequest {
   applicationPayload: any;
   customData?: any | null;
   isCoBorrower: boolean;
+  partnerId?: string | null;
 }
 
 export interface EconsentPendingSummary {
@@ -4010,6 +4049,7 @@ export interface LoanApplicationRequest {
   nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
   /** @format uuid */
   draftId?: string | null;
+  partnerId?: string | null;
   additionalFields?: Record<string, any> | null;
   /** @format uuid */
   existingLoanId?: string | null;
@@ -5118,6 +5158,19 @@ export interface LoanFieldAccessItem {
   patchPath?: string | null;
 }
 
+export interface LoanFieldMappings {
+  encompassFieldIds: string[];
+  templateToken: string;
+}
+
+export interface LoanFieldPermissionsRequest {
+  permissions: CustomFieldPermissionRequest[];
+}
+
+export interface LoanFieldSettingsRequest {
+  isAiEnabled?: boolean | null;
+}
+
 export interface LoanFinancial {
   /** @format uuid */
   id?: string | null;
@@ -5258,6 +5311,7 @@ export interface LoanList {
   buyerAgentContact?: LoanContactList | null;
   sellerAgentContact?: LoanContactList | null;
   userLoans: UserLoan[];
+  myLoanRoles: LoanRole[];
   contacts: LoanContact[];
   borrowers: LoanListBorrower[];
   taskCounts: LoanTaskCounts;
@@ -6222,6 +6276,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"
@@ -6420,6 +6488,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;
@@ -6427,6 +6515,10 @@ export interface PartnerSearchCriteria {
   roles?: UserRole[] | null;
 }
 
+export interface PartnerSlug {
+  slug: string;
+}
+
 export interface PendingInvite {
   status: PendingInviteStatusEnum;
   /** @format uuid */
@@ -7049,6 +7141,7 @@ export interface SiteConfiguration {
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
+  isPartnerPortalEnabled: boolean;
   autoTaskReminderIntervalsInDays?: number[] | null;
   mobileSettings?: MobileSettings | null;
   losSettings?: LOSSettings | null;
@@ -7244,6 +7337,7 @@ export interface SiteConfigurationByUrl {
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
+  isPartnerPortalEnabled: boolean;
   autoTaskReminderIntervalsInDays?: number[] | null;
   mobileSettings?: MobileSettings | null;
   losSettings?: LOSSettings | null;
@@ -7612,6 +7706,20 @@ export interface SocialSurveyRecord {
   reviewCompletedTimeStamp?: string | null;
 }
 
+export interface StandardLoanField {
+  fieldKey: string;
+  displayName: string;
+  category: string;
+  dataType: StandardLoanFieldDataTypeEnum;
+  isPii: boolean;
+  isWritable: boolean;
+  patchPath?: string | null;
+  mappings: LoanFieldMappings;
+  access: Record<string, CustomFieldAccessLevel>;
+  isCustomized: boolean;
+  isAiEnabled?: boolean | null;
+}
+
 export interface SupportedModel {
   modelId: string;
   displayName: string;
@@ -8050,6 +8158,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;
@@ -9503,6 +9619,8 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
 
 export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
 
+export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
+
 export type MyTasksWidgetConfigTypeEnum = "MyTasks";
 
 export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
@@ -9585,6 +9703,15 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
 
 export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
 
+export type StandardLoanFieldDataTypeEnum =
+  | "Text"
+  | "Number"
+  | "Boolean"
+  | "Date"
+  | "Enum"
+  | "Identifier"
+  | "Object";
+
 export type TextBlockWidgetConfigTypeEnum = "TextBlock";
 
 export type UnregisteredBorrowerRoleEnum =
@@ -10226,6 +10353,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
      *
@@ -14985,13 +15139,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,
@@ -15007,6 +15162,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,
@@ -15017,7 +15173,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,
@@ -15035,6 +15191,7 @@ export class Api<
      * @request GET:/api/form-submissions
      * @secure
      * @response `200` `FormSubmissionPaginated` OK
+     * @response `403` `HttpError` Forbidden
      */
     getFormSubmissions: (
       query?: {
@@ -15047,7 +15204,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<FormSubmissionPaginated, any>({
+      this.request<FormSubmissionPaginated, HttpError>({
         path: `/api/form-submissions`,
         method: "GET",
         query: query,
@@ -15093,9 +15250,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,
@@ -15112,13 +15270,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,
@@ -15137,9 +15296,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,
@@ -15155,6 +15315,7 @@ export class Api<
      * @request POST:/api/form-submissions/search
      * @secure
      * @response `200` `FormSubmissionPaginated` OK
+     * @response `403` `HttpError` Forbidden
      */
     searchFormSubmissions: (
       data: FormSubmissionSearchCriteria,
@@ -15168,7 +15329,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<FormSubmissionPaginated, any>({
+      this.request<FormSubmissionPaginated, HttpError>({
         path: `/api/form-submissions/search`,
         method: "POST",
         query: query,
@@ -15660,6 +15821,7 @@ export class Api<
      * @request POST:/api/listings/{listingId}/files
      * @secure
      * @response `200` `ListingFile` OK
+     * @response `403` `HttpError` Forbidden
      */
     addListingFile: (
       listingId: string,
@@ -15671,7 +15833,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<ListingFile, any>({
+      this.request<ListingFile, HttpError>({
         path: `/api/listings/${listingId}/files`,
         method: "POST",
         body: data,
@@ -15690,13 +15852,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,
@@ -15715,13 +15878,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,
@@ -15738,6 +15902,7 @@ export class Api<
      * @request POST:/api/listings/{listingId}/photos
      * @secure
      * @response `200` `ListingPhoto` OK
+     * @response `403` `HttpError` Forbidden
      */
     addListingPhoto: (
       listingId: string,
@@ -15751,7 +15916,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<ListingPhoto, any>({
+      this.request<ListingPhoto, HttpError>({
         path: `/api/listings/${listingId}/photos`,
         method: "POST",
         body: data,
@@ -15770,13 +15935,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,
@@ -15795,13 +15961,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,
@@ -15936,9 +16103,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,
@@ -15987,6 +16155,7 @@ export class Api<
      * @request PUT:/api/listings/{id}/background-image
      * @secure
      * @response `200` `File` OK
+     * @response `403` `HttpError` Forbidden
      */
     updateListingBackgroundImage: (
       id: string,
@@ -15996,7 +16165,7 @@ export class Api<
       },
       params: RequestParams = {},
     ) =>
-      this.request<File, any>({
+      this.request<File, HttpError>({
         path: `/api/listings/${id}/background-image`,
         method: "PUT",
         body: data,
@@ -16015,9 +16184,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,
@@ -17160,6 +17330,133 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanFields
+     * @name GetStandardLoanFields
+     * @summary List standard loan fields with effective access and settings
+     * @request GET:/api/loan-fields/standard
+     * @secure
+     * @response `200` `(StandardLoanField)[]` OK
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     */
+    getStandardLoanFields: (params: RequestParams = {}) =>
+      this.request<StandardLoanField[], ProblemDetails>({
+        path: `/api/loan-fields/standard`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanFields
+     * @name SetLoanFieldPermissions
+     * @summary Set role access levels on one loan field
+     * @request PUT:/api/loan-fields/{fieldKey}/permissions
+     * @secure
+     * @response `204` `void` No Content
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    setLoanFieldPermissions: (
+      fieldKey: string,
+      data: LoanFieldPermissionsRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loan-fields/${fieldKey}/permissions`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanFields
+     * @name SetLoanFieldSettings
+     * @summary Set the AI setting on one loan field
+     * @request PUT:/api/loan-fields/{fieldKey}/settings
+     * @secure
+     * @response `204` `void` No Content
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    setLoanFieldSettings: (
+      fieldKey: string,
+      data: LoanFieldSettingsRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loan-fields/${fieldKey}/settings`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanFields
+     * @name ResetLoanFieldOverrides
+     * @summary Reset one standard loan field to its seeded defaults
+     * @request DELETE:/api/loan-fields/{fieldKey}/overrides
+     * @secure
+     * @response `204` `void` No Content
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    resetLoanFieldOverrides: (fieldKey: string, params: RequestParams = {}) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loan-fields/${fieldKey}/overrides`,
+        method: "DELETE",
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanFields
+     * @name BulkLoanFieldOperation
+     * @summary Apply one operation to many loan fields
+     * @request POST:/api/loan-fields/bulk
+     * @secure
+     * @response `200` `BulkLoanFieldOperation` OK
+     * @response `401` `ProblemDetails` Unauthorized
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `UnprocessableEntity` Unprocessable Content
+     */
+    bulkLoanFieldOperation: (
+      data: BulkLoanFieldOperationRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<
+        BulkLoanFieldOperation,
+        ProblemDetails | UnprocessableEntity
+      >({
+        path: `/api/loan-fields/bulk`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -19770,6 +20067,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
      *
@@ -22667,6 +22993,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
      *