@propxchain/core-client 0.2.1-canary.21 → 0.2.1-canary.22

package/src/canisters/user_management/user_management.did

@@ -1,297 +1,297 @@
-type UserType = 
- variant {
-   admin;
-   assisted_buyer;
-   assisted_seller;
-   buyer;
-   conveyancer_managed;
-   conveyancer_transparent;
-   diy_buyer;
-   diy_seller;
-   estate_agent;
-   mortgage_broker;
-   platform_admin;
-   platform_support;
-   property_developer;
-   seller;
-   solicitor_client_linked;
-   solicitor_managed;
-   solicitor_platform_only;
-   solicitor_transparent;
- };
-type UserRole = 
- variant {
-   admin;
-   buyer;
-   guest;
-   seller;
-   solicitor;
- };
-type UserProfile = 
- record {
-   businessGatewayEnabled: bool;
-   businessGatewayUsername: opt text;
-   clientPrincipals: vec principal;
-   conveyancerReference: opt text;
-   createdAt: Time;
-   email: text;
-   emailVerificationSentAt: opt Time;
-   emailVerificationToken: opt text;
-   emailVerified: bool;
-   firmSRANumber: opt text;
-   isPlatformOnlySolicitor: bool;
-   isVerified: bool;
-   lawFirmAddress: opt text;
-   lawFirmName: opt text;
-   managedBySolicitor: opt principal;
-   mobile: text;
-   name: text;
-   "principal": principal;
-   role: opt UserRole;
-   solicitorLicenseNumber: opt text;
-   sraNumber: opt text;
-   userType: UserType;
- };
-type TransactionProgress = 
- record {
-   blockingParties: vec principal;
-   completionPercentage: nat;
-   members: vec TransactionMember;
-   membersComplete: nat;
-   readyToExchange: bool;
-   totalMembers: nat;
-   transactionId: text;
- };
-type TransactionMember = 
- record {
-   canInviteOthers: bool;
-   canViewProgress: bool;
-   documentsComplete: bool;
-   joinedAt: Time;
-   lastActivityAt: Time;
-   "principal": principal;
-   requiredDocuments: vec text;
-   role: UserType;
-   transactionId: text;
-   uploadedDocuments: vec text;
- };
-type Time = int;
-type SolicitorSubmissionDetails = 
- record {
-   businessGatewayEnabled: bool;
-   conveyancerReference: opt text;
-   email: text;
-   firmAddress: text;
-   firmName: text;
-   firmSRANumber: opt text;
-   fullName: text;
-   principalId: principal;
-   sraNumber: text;
- };
-type Result_5 = 
- variant {
-   err: text;
-   ok: SolicitorSubmissionDetails;
- };
-type Result_4 = 
- variant {
-   err: text;
-   ok;
- };
-type Result_3 = 
- variant {
-   err: text;
-   ok: nat;
- };
-type Result_2 = 
- variant {
-   err: text;
-   ok: BotAgent;
- };
-type Result_1 = 
- variant {
-   err: text;
-   ok: text;
- };
-type Result = 
- variant {
-   err: text;
-   ok: record {
-         ownerPrincipal: principal;
-         role: BotRole;
-       };
- };
-type Permission = 
- variant {
-   AdminManageUsers;
-   AdminViewAllTransactions;
-   InvitePartyToTransaction: text;
-   ManageClientAccess: principal;
-   UpdateMemberDocuments: record {
-                            text;
-                            principal;
-                          };
-   ViewDevelopmentUnits: text;
-   ViewSharedTransaction: text;
-   ViewTransactionProgress: text;
- };
-type BotRole = 
- variant {
-   BotFirm;
-   BotInternal;
-   BotPersonal;
- };
-type BotAgent = 
- record {
-   botPrincipal: principal;
-   callCount: nat;
-   createdAt: Time;
-   description: text;
-   isActive: bool;
-   lastActive: Time;
-   name: text;
-   ownerPrincipal: principal;
-   role: BotRole;
- };
-type BotActionLog = 
- record {
-   action: text;
-   botPrincipal: principal;
-   id: nat;
-   metadata: text;
-   success: bool;
-   timestamp: Time;
-   transactionId: opt text;
- };
-type AuditLog = 
- record {
-   action: text;
-   actorPrincipal: principal;
-   actorType: ActorType;
-   delegatedBy: opt principal;
-   id: nat;
-   metadata: text;
-   success: bool;
-   targetPrincipal: opt principal;
-   timestamp: Time;
-   transactionId: opt text;
- };
-type AdminRole = 
- variant {
-   regular;
-   super;
- };
-type AdminRecord = 
- record {
-   grantedAt: Time;
-   grantedBy: principal;
-   note: opt text;
-   "principal": principal;
-   role: AdminRole;
- };
-type AdminMutationResult_1 = 
- variant {
-   err: AdminMutationError;
-   ok;
- };
-type AdminMutationResult = 
- variant {
-   err: AdminMutationError;
-   ok: AdminRecord;
- };
-type AdminMutationError = 
- variant {
-   anonymousCaller;
-   cannotDemoteController;
-   cannotDemoteLastSuperAdmin;
-   invalidCsrfToken;
-   notSuperAdmin;
-   targetIsAnonymous;
- };
-type ActorType = 
- variant {
-   agent;
-   systemActor;
-   user;
- };
-service : {
-  addTransactionMember: (transactionId: text, memberPrincipal: principal,
-   role: UserType, canViewProgress: bool, canInviteOthers: bool, csrfToken:
-   text) -> (bool);
-  adminLinkPrincipals: (primary: principal, alias: principal) -> (Result_1);
-  amIAdmin: () -> (bool) query;
-  bootstrapAdmin: (name: text, email: text) -> (bool);
-  canUserAccessTransaction: (user: principal, txId: text) -> (bool) query;
-  checkPermissionWithAudit: (permission: Permission) -> (bool);
-  claimLinkCode: (code: text) -> (Result_1);
-  createUserForPrincipal: (targetPrincipal: principal, name: text, email:
-   text, mobile: text, userTypeText: text, csrfToken: text) -> (bool);
-  deactivateBot: (botPrincipal: principal) -> (Result_4);
-  deleteUserByPrincipal: (targetPrincipal: principal, csrfToken: text) ->
-   (bool);
-  demoteAdmin: (target: principal, csrfToken: text) ->
-   (AdminMutationResult_1);
-  generateCSRFToken: () -> (text);
-  generateLinkCode: () -> (Result_1);
-  getAllBots: () -> (vec BotAgent) query;
-  getAllUsers: () -> (vec UserProfile) query;
-  getAuditLogs: (limit: nat) -> (vec AuditLog) query;
-  getBotActionLogs: (botPrincipal: principal, limit: nat) ->
-   (vec BotActionLog) query;
-  getBotAgent: (botPrincipal: principal) -> (opt BotAgent) query;
-  getCSRFToken: () -> (opt text) query;
-  getCycles: () -> (nat) query;
-  getLinkedPrincipals: ("principal": principal) -> (vec principal) query;
-  getMyBots: () -> (vec BotAgent) query;
-  getMyLinkedPrincipals: () -> (vec principal) query;
-  getMyManagingSolicitor: () -> (opt UserProfile) query;
-  getMyProfile: () -> (opt UserProfile) query;
-  getMyProfileUpdate: () -> (opt UserProfile);
-  getMySolicitorClients: () -> (vec UserProfile) query;
-  getSolicitorSubmissionDetails: (solicitorPrincipal: principal) ->
-   (Result_5) query;
-  getTransactionMembers: (transactionId: text) ->
-   (opt vec TransactionMember) query;
-  getTransactionProgress: (transactionId: text) ->
-   (opt TransactionProgress) query;
-  getUserProfile: ("principal": principal) -> (opt UserProfile) query;
-  getUserProfileByPrincipal: ("principal": principal) ->
-   (opt UserProfile) query;
-  hasPermission: (permission: Permission) -> (bool) query;
-  linkSolicitorToClient: (solicitorPrincipal: principal, consentGiven: 
-   bool, csrfToken: text) -> (bool);
-  listAdmins: () -> (vec AdminRecord) query;
-  logBotAction: (botPrincipal: principal, action: text, transactionId:
-   opt text, success: bool, metadata: text) -> (Result_4);
-  myAdminRole: () -> (opt AdminRole) query;
-  promoteAdmin: (target: principal, role: AdminRole, note: opt text,
-   csrfToken: text) -> (AdminMutationResult);
-  reactivateBot: (botPrincipal: principal) -> (Result_4);
-  recordAuditEntry: (actorType: ActorType, delegatedBy: opt principal,
-   action: text, targetPrincipal: opt principal, transactionId: opt text,
-   success: bool, metadata: text) -> (Result_3);
-  registerBot: (botPrincipal: principal, name: text, description: text, role:
-   BotRole) -> (Result_2);
-  registerUser: (name: text, email: text, mobile: text, userType: text) ->
-   (bool);
-  registerUserV2: (name: text, email: text, mobile: text, userType: UserType,
-   solicitorLicenseNumber: opt text, lawFirmName: opt text, lawFirmAddress:
-   opt text, sraNumber: opt text, csrfToken: text) -> (bool);
-  resendVerificationEmail: (csrfToken: text) -> (bool);
-  revokeSolicitorAccess: (solicitorPrincipal: principal, csrfToken: text) ->
-   (bool);
-  unlinkPrincipal: (alias: principal) -> (Result_1);
-  updateMemberDocuments: (transactionId: text, uploadedDocumentName: 
-   text, csrfToken: text) -> (bool);
-  updateSolicitorLRDetails: (sraNumber: opt text, businessGatewayEnabled:
-   bool, businessGatewayUsername: opt text, firmSRANumber: opt text,
-   conveyancerReference: opt text) -> (Result_1);
-  updateTransactionMemberRequiredDocs: (transactionId: text,
-   documentsToRemove: vec text, csrfToken: text) -> (bool);
-  validateAdmin: ("principal": principal) -> (bool) query;
-  validateBot: (botPrincipal: principal) -> (Result) query;
-  validateCSRFToken: (token: text) -> (bool);
-  verifyEmail: (token: text, csrfToken: text) -> (bool);
-  verifyUser: (userPrincipal: principal, csrfToken: text) -> (bool);
-  whoAmI: () -> (principal) query;
-}
+type UserType = 
+ variant {
+   admin;
+   assisted_buyer;
+   assisted_seller;
+   buyer;
+   conveyancer_managed;
+   conveyancer_transparent;
+   diy_buyer;
+   diy_seller;
+   estate_agent;
+   mortgage_broker;
+   platform_admin;
+   platform_support;
+   property_developer;
+   seller;
+   solicitor_client_linked;
+   solicitor_managed;
+   solicitor_platform_only;
+   solicitor_transparent;
+ };
+type UserRole = 
+ variant {
+   admin;
+   buyer;
+   guest;
+   seller;
+   solicitor;
+ };
+type UserProfile = 
+ record {
+   businessGatewayEnabled: bool;
+   businessGatewayUsername: opt text;
+   clientPrincipals: vec principal;
+   conveyancerReference: opt text;
+   createdAt: Time;
+   email: text;
+   emailVerificationSentAt: opt Time;
+   emailVerificationToken: opt text;
+   emailVerified: bool;
+   firmSRANumber: opt text;
+   isPlatformOnlySolicitor: bool;
+   isVerified: bool;
+   lawFirmAddress: opt text;
+   lawFirmName: opt text;
+   managedBySolicitor: opt principal;
+   mobile: text;
+   name: text;
+   "principal": principal;
+   role: opt UserRole;
+   solicitorLicenseNumber: opt text;
+   sraNumber: opt text;
+   userType: UserType;
+ };
+type TransactionProgress = 
+ record {
+   blockingParties: vec principal;
+   completionPercentage: nat;
+   members: vec TransactionMember;
+   membersComplete: nat;
+   readyToExchange: bool;
+   totalMembers: nat;
+   transactionId: text;
+ };
+type TransactionMember = 
+ record {
+   canInviteOthers: bool;
+   canViewProgress: bool;
+   documentsComplete: bool;
+   joinedAt: Time;
+   lastActivityAt: Time;
+   "principal": principal;
+   requiredDocuments: vec text;
+   role: UserType;
+   transactionId: text;
+   uploadedDocuments: vec text;
+ };
+type Time = int;
+type SolicitorSubmissionDetails = 
+ record {
+   businessGatewayEnabled: bool;
+   conveyancerReference: opt text;
+   email: text;
+   firmAddress: text;
+   firmName: text;
+   firmSRANumber: opt text;
+   fullName: text;
+   principalId: principal;
+   sraNumber: text;
+ };
+type Result_5 = 
+ variant {
+   err: text;
+   ok: SolicitorSubmissionDetails;
+ };
+type Result_4 = 
+ variant {
+   err: text;
+   ok;
+ };
+type Result_3 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result_2 = 
+ variant {
+   err: text;
+   ok: BotAgent;
+ };
+type Result_1 = 
+ variant {
+   err: text;
+   ok: text;
+ };
+type Result = 
+ variant {
+   err: text;
+   ok: record {
+         ownerPrincipal: principal;
+         role: BotRole;
+       };
+ };
+type Permission = 
+ variant {
+   AdminManageUsers;
+   AdminViewAllTransactions;
+   InvitePartyToTransaction: text;
+   ManageClientAccess: principal;
+   UpdateMemberDocuments: record {
+                            text;
+                            principal;
+                          };
+   ViewDevelopmentUnits: text;
+   ViewSharedTransaction: text;
+   ViewTransactionProgress: text;
+ };
+type BotRole = 
+ variant {
+   BotFirm;
+   BotInternal;
+   BotPersonal;
+ };
+type BotAgent = 
+ record {
+   botPrincipal: principal;
+   callCount: nat;
+   createdAt: Time;
+   description: text;
+   isActive: bool;
+   lastActive: Time;
+   name: text;
+   ownerPrincipal: principal;
+   role: BotRole;
+ };
+type BotActionLog = 
+ record {
+   action: text;
+   botPrincipal: principal;
+   id: nat;
+   metadata: text;
+   success: bool;
+   timestamp: Time;
+   transactionId: opt text;
+ };
+type AuditLog = 
+ record {
+   action: text;
+   actorPrincipal: principal;
+   actorType: ActorType;
+   delegatedBy: opt principal;
+   id: nat;
+   metadata: text;
+   success: bool;
+   targetPrincipal: opt principal;
+   timestamp: Time;
+   transactionId: opt text;
+ };
+type AdminRole = 
+ variant {
+   regular;
+   super;
+ };
+type AdminRecord = 
+ record {
+   grantedAt: Time;
+   grantedBy: principal;
+   note: opt text;
+   "principal": principal;
+   role: AdminRole;
+ };
+type AdminMutationResult_1 = 
+ variant {
+   err: AdminMutationError;
+   ok;
+ };
+type AdminMutationResult = 
+ variant {
+   err: AdminMutationError;
+   ok: AdminRecord;
+ };
+type AdminMutationError = 
+ variant {
+   anonymousCaller;
+   cannotDemoteController;
+   cannotDemoteLastSuperAdmin;
+   invalidCsrfToken;
+   notSuperAdmin;
+   targetIsAnonymous;
+ };
+type ActorType = 
+ variant {
+   agent;
+   systemActor;
+   user;
+ };
+service : {
+  addTransactionMember: (transactionId: text, memberPrincipal: principal,
+   role: UserType, canViewProgress: bool, canInviteOthers: bool, csrfToken:
+   text) -> (bool);
+  adminLinkPrincipals: (primary: principal, alias: principal) -> (Result_1);
+  amIAdmin: () -> (bool) query;
+  bootstrapAdmin: (name: text, email: text) -> (bool);
+  canUserAccessTransaction: (user: principal, txId: text) -> (bool) query;
+  checkPermissionWithAudit: (permission: Permission) -> (bool);
+  claimLinkCode: (code: text) -> (Result_1);
+  createUserForPrincipal: (targetPrincipal: principal, name: text, email:
+   text, mobile: text, userTypeText: text, csrfToken: text) -> (bool);
+  deactivateBot: (botPrincipal: principal) -> (Result_4);
+  deleteUserByPrincipal: (targetPrincipal: principal, csrfToken: text) ->
+   (bool);
+  demoteAdmin: (target: principal, csrfToken: text) ->
+   (AdminMutationResult_1);
+  generateCSRFToken: () -> (text);
+  generateLinkCode: () -> (Result_1);
+  getAllBots: () -> (vec BotAgent) query;
+  getAllUsers: () -> (vec UserProfile) query;
+  getAuditLogs: (limit: nat) -> (vec AuditLog) query;
+  getBotActionLogs: (botPrincipal: principal, limit: nat) ->
+   (vec BotActionLog) query;
+  getBotAgent: (botPrincipal: principal) -> (opt BotAgent) query;
+  getCSRFToken: () -> (opt text) query;
+  getCycles: () -> (nat) query;
+  getLinkedPrincipals: ("principal": principal) -> (vec principal) query;
+  getMyBots: () -> (vec BotAgent) query;
+  getMyLinkedPrincipals: () -> (vec principal) query;
+  getMyManagingSolicitor: () -> (opt UserProfile) query;
+  getMyProfile: () -> (opt UserProfile) query;
+  getMyProfileUpdate: () -> (opt UserProfile);
+  getMySolicitorClients: () -> (vec UserProfile) query;
+  getSolicitorSubmissionDetails: (solicitorPrincipal: principal) ->
+   (Result_5) query;
+  getTransactionMembers: (transactionId: text) ->
+   (opt vec TransactionMember) query;
+  getTransactionProgress: (transactionId: text) ->
+   (opt TransactionProgress) query;
+  getUserProfile: ("principal": principal) -> (opt UserProfile) query;
+  getUserProfileByPrincipal: ("principal": principal) ->
+   (opt UserProfile) query;
+  hasPermission: (permission: Permission) -> (bool) query;
+  linkSolicitorToClient: (solicitorPrincipal: principal, consentGiven: 
+   bool, csrfToken: text) -> (bool);
+  listAdmins: () -> (vec AdminRecord) query;
+  logBotAction: (botPrincipal: principal, action: text, transactionId:
+   opt text, success: bool, metadata: text) -> (Result_4);
+  myAdminRole: () -> (opt AdminRole) query;
+  promoteAdmin: (target: principal, role: AdminRole, note: opt text,
+   csrfToken: text) -> (AdminMutationResult);
+  reactivateBot: (botPrincipal: principal) -> (Result_4);
+  recordAuditEntry: (actorType: ActorType, delegatedBy: opt principal,
+   action: text, targetPrincipal: opt principal, transactionId: opt text,
+   success: bool, metadata: text) -> (Result_3);
+  registerBot: (botPrincipal: principal, name: text, description: text, role:
+   BotRole) -> (Result_2);
+  registerUser: (name: text, email: text, mobile: text, userType: text) ->
+   (bool);
+  registerUserV2: (name: text, email: text, mobile: text, userType: UserType,
+   solicitorLicenseNumber: opt text, lawFirmName: opt text, lawFirmAddress:
+   opt text, sraNumber: opt text, csrfToken: text) -> (bool);
+  resendVerificationEmail: (csrfToken: text) -> (bool);
+  revokeSolicitorAccess: (solicitorPrincipal: principal, csrfToken: text) ->
+   (bool);
+  unlinkPrincipal: (alias: principal) -> (Result_1);
+  updateMemberDocuments: (transactionId: text, uploadedDocumentName: 
+   text, csrfToken: text) -> (bool);
+  updateSolicitorLRDetails: (sraNumber: opt text, businessGatewayEnabled:
+   bool, businessGatewayUsername: opt text, firmSRANumber: opt text,
+   conveyancerReference: opt text) -> (Result_1);
+  updateTransactionMemberRequiredDocs: (transactionId: text,
+   documentsToRemove: vec text, csrfToken: text) -> (bool);
+  validateAdmin: ("principal": principal) -> (bool) query;
+  validateBot: (botPrincipal: principal) -> (Result) query;
+  validateCSRFToken: (token: text) -> (bool);
+  verifyEmail: (token: text, csrfToken: text) -> (bool);
+  verifyUser: (userPrincipal: principal, csrfToken: text) -> (bool);
+  whoAmI: () -> (principal) query;
+}