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

package/src/canisters/user_management/user_management.did.d.ts

@@ -1,193 +1,267 @@
-import type { Principal } from '@icp-sdk/core/principal';
-import type { ActorMethod } from '@icp-sdk/core/agent';
-import type { IDL } from '@icp-sdk/core/candid';
-
-export type ActorType = { 'user' : null } |
-  { 'agent' : null } |
-  { 'systemActor' : null };
-export type AdminMutationError = { 'notSuperAdmin' : null } |
-  { 'cannotDemoteController' : null } |
-  { 'invalidCsrfToken' : null } |
-  { 'cannotDemoteLastSuperAdmin' : null } |
-  { 'anonymousCaller' : null } |
-  { 'targetIsAnonymous' : null };
-export interface AdminRecord {
-  'principal' : Principal,
-  'note' : [] | [string],
-  'role' : AdminRole,
-  'grantedAt' : Time,
-  'grantedBy' : Principal,
-}
-export type AdminRole = { 'super' : null } |
-  { 'regular' : null };
-export interface AuditLog {
-  'id' : bigint,
-  'action' : string,
-  'metadata' : string,
-  'targetPrincipal' : [] | [Principal],
-  'timestamp' : Time,
-  'success' : boolean,
-  'actorPrincipal' : Principal,
-  'actorType' : ActorType,
-  'delegatedBy' : [] | [Principal],
-  'transactionId' : [] | [string],
-}
-export type Permission = { 'ViewTransactionProgress' : string } |
-  { 'ViewSharedTransaction' : string } |
-  { 'ViewDevelopmentUnits' : string } |
-  { 'ManageClientAccess' : Principal } |
-  { 'InvitePartyToTransaction' : string } |
-  { 'AdminViewAllTransactions' : null } |
-  { 'AdminManageUsers' : null } |
-  { 'UpdateMemberDocuments' : [string, Principal] };
-export type Time = bigint;
-export interface TransactionMember {
-  'uploadedDocuments' : Array<string>,
-  'principal' : Principal,
-  'requiredDocuments' : Array<string>,
-  'joinedAt' : Time,
-  'role' : UserType,
-  'documentsComplete' : boolean,
-  'canViewProgress' : boolean,
-  'canInviteOthers' : boolean,
-  'lastActivityAt' : Time,
-  'transactionId' : string,
-}
-export interface TransactionProgress {
-  'members' : Array<TransactionMember>,
-  'completionPercentage' : bigint,
-  'readyToExchange' : boolean,
-  'membersComplete' : bigint,
-  'totalMembers' : bigint,
-  'blockingParties' : Array<Principal>,
-  'transactionId' : string,
-}
-export interface UserProfile {
-  'isPlatformOnlySolicitor' : boolean,
-  'userType' : UserType,
-  'principal' : Principal,
-  'managedBySolicitor' : [] | [Principal],
-  'emailVerified' : boolean,
-  'name' : string,
-  'createdAt' : Time,
-  'role' : [] | [UserRole],
-  'email' : string,
-  'lawFirmName' : [] | [string],
-  'isVerified' : boolean,
-  'clientPrincipals' : Array<Principal>,
-  'emailVerificationSentAt' : [] | [Time],
-  'emailVerificationToken' : [] | [string],
-  'mobile' : string,
-  'solicitorLicenseNumber' : [] | [string],
-  'lawFirmAddress' : [] | [string],
-}
-export type UserRole = { 'admin' : null } |
-  { 'solicitor' : null } |
-  { 'seller' : null } |
-  { 'guest' : null } |
-  { 'buyer' : null };
-export type UserType = { 'solicitor_platform_only' : null } |
-  { 'admin' : null } |
-  { 'diy_buyer' : null } |
-  { 'solicitor_transparent' : null } |
-  { 'platform_admin' : null } |
-  { 'solicitor_client_linked' : null } |
-  { 'estate_agent' : null } |
-  { 'platform_support' : null } |
-  { 'mortgage_broker' : null } |
-  { 'seller' : null } |
-  { 'conveyancer_managed' : null } |
-  { 'diy_seller' : null } |
-  { 'assisted_seller' : null } |
-  { 'conveyancer_transparent' : null } |
-  { 'buyer' : null } |
-  { 'property_developer' : null } |
-  { 'solicitor_managed' : null } |
-  { 'assisted_buyer' : null };
-export interface _SERVICE {
-  'addTransactionMember' : ActorMethod<
-    [string, Principal, UserType, boolean, boolean, string],
-    boolean
-  >,
-  'amIAdmin' : ActorMethod<[], boolean>,
-  'bootstrapAdmin' : ActorMethod<[string, string], boolean>,
-  'canUserAccessTransaction' : ActorMethod<[Principal, string], boolean>,
-  'checkPermissionWithAudit' : ActorMethod<[Permission], boolean>,
-  'createUserForPrincipal' : ActorMethod<
-    [Principal, string, string, string, string, string],
-    boolean
-  >,
-  'deleteUserByPrincipal' : ActorMethod<[Principal, string], boolean>,
-  'demoteAdmin' : ActorMethod<
-    [Principal, string],
-    { 'ok' : null } |
-      { 'err' : AdminMutationError }
-  >,
-  'generateCSRFToken' : ActorMethod<[], string>,
-  'getAllUsers' : ActorMethod<[], Array<UserProfile>>,
-  'getAuditLogs' : ActorMethod<[bigint], Array<AuditLog>>,
-  'getCSRFToken' : ActorMethod<[], [] | [string]>,
-  'getCycles' : ActorMethod<[], bigint>,
-  'getMyManagingSolicitor' : ActorMethod<[], [] | [UserProfile]>,
-  'getMyProfile' : ActorMethod<[], [] | [UserProfile]>,
-  'getMyProfileUpdate' : ActorMethod<[], [] | [UserProfile]>,
-  'getMySolicitorClients' : ActorMethod<[], Array<UserProfile>>,
-  'getTransactionMembers' : ActorMethod<
-    [string],
-    [] | [Array<TransactionMember>]
-  >,
-  'getTransactionProgress' : ActorMethod<[string], [] | [TransactionProgress]>,
-  'getUserProfile' : ActorMethod<[Principal], [] | [UserProfile]>,
-  'hasPermission' : ActorMethod<[Permission], boolean>,
-  'initializeKnownAdmin' : ActorMethod<[string, string, string], boolean>,
-  'linkSolicitorToClient' : ActorMethod<[Principal, boolean, string], boolean>,
-  'listAdmins' : ActorMethod<[], Array<AdminRecord>>,
-  'myAdminRole' : ActorMethod<[], [] | [AdminRole]>,
-  'promoteAdmin' : ActorMethod<
-    [Principal, AdminRole, [] | [string], string],
-    { 'ok' : AdminRecord } |
-      { 'err' : AdminMutationError }
-  >,
-  'recordAuditEntry' : ActorMethod<
-    [
-      ActorType,
-      [] | [Principal],
-      string,
-      [] | [Principal],
-      [] | [string],
-      boolean,
-      string,
-    ],
-    { 'ok' : bigint } |
-      { 'err' : string }
-  >,
-  'registerUser' : ActorMethod<[string, string, string, string], boolean>,
-  'registerUserV2' : ActorMethod<
-    [
-      string,
-      string,
-      string,
-      UserType,
-      [] | [string],
-      [] | [string],
-      [] | [string],
-      string,
-    ],
-    boolean
-  >,
-  'resendVerificationEmail' : ActorMethod<[string], boolean>,
-  'revokeSolicitorAccess' : ActorMethod<[Principal, string], boolean>,
-  'updateMemberDocuments' : ActorMethod<[string, string, string], boolean>,
-  'updateTransactionMemberRequiredDocs' : ActorMethod<
-    [string, Array<string>, string],
-    boolean
-  >,
-  'upgradeToAdmin' : ActorMethod<[Principal, string], boolean>,
-  'validateAdmin' : ActorMethod<[Principal], boolean>,
-  'validateCSRFToken' : ActorMethod<[string], boolean>,
-  'verifyEmail' : ActorMethod<[string, string], boolean>,
-  'verifyUser' : ActorMethod<[Principal, string], boolean>,
-  'whoAmI' : ActorMethod<[], Principal>,
-}
-export declare const idlFactory: IDL.InterfaceFactory;
-export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];
+import type { Principal } from '@dfinity/principal';
+import type { ActorMethod } from '@dfinity/agent';
+import type { IDL } from '@dfinity/candid';
+
+export type ActorType = { 'agent' : null } |
+  { 'systemActor' : null } |
+  { 'user' : null };
+export type AdminMutationError = { 'targetIsAnonymous' : null } |
+  { 'cannotDemoteController' : null } |
+  { 'notSuperAdmin' : null } |
+  { 'invalidCsrfToken' : null } |
+  { 'anonymousCaller' : null } |
+  { 'cannotDemoteLastSuperAdmin' : null };
+export type AdminMutationResult = { 'ok' : AdminRecord } |
+  { 'err' : AdminMutationError };
+export type AdminMutationResult_1 = { 'ok' : null } |
+  { 'err' : AdminMutationError };
+export interface AdminRecord {
+  'principal' : Principal,
+  'grantedAt' : Time,
+  'grantedBy' : Principal,
+  'note' : [] | [string],
+  'role' : AdminRole,
+}
+export type AdminRole = { 'regular' : null } |
+  { 'super' : null };
+export interface AuditLog {
+  'id' : bigint,
+  'action' : string,
+  'actorType' : ActorType,
+  'metadata' : string,
+  'delegatedBy' : [] | [Principal],
+  'targetPrincipal' : [] | [Principal],
+  'timestamp' : Time,
+  'success' : boolean,
+  'actorPrincipal' : Principal,
+  'transactionId' : [] | [string],
+}
+export interface BotActionLog {
+  'id' : bigint,
+  'action' : string,
+  'metadata' : string,
+  'timestamp' : Time,
+  'success' : boolean,
+  'botPrincipal' : Principal,
+  'transactionId' : [] | [string],
+}
+export interface BotAgent {
+  'ownerPrincipal' : Principal,
+  'name' : string,
+  'createdAt' : Time,
+  'role' : BotRole,
+  'description' : string,
+  'isActive' : boolean,
+  'callCount' : bigint,
+  'lastActive' : Time,
+  'botPrincipal' : Principal,
+}
+export type BotRole = { 'BotFirm' : null } |
+  { 'BotInternal' : null } |
+  { 'BotPersonal' : null };
+export type Permission = { 'ViewTransactionProgress' : string } |
+  { 'ViewSharedTransaction' : string } |
+  { 'ViewDevelopmentUnits' : string } |
+  { 'ManageClientAccess' : Principal } |
+  { 'InvitePartyToTransaction' : string } |
+  { 'AdminViewAllTransactions' : null } |
+  { 'AdminManageUsers' : null } |
+  { 'UpdateMemberDocuments' : [string, Principal] };
+export type Result = {
+    'ok' : { 'ownerPrincipal' : Principal, 'role' : BotRole }
+  } |
+  { 'err' : string };
+export type Result_1 = { 'ok' : string } |
+  { 'err' : string };
+export type Result_2 = { 'ok' : BotAgent } |
+  { 'err' : string };
+export type Result_3 = { 'ok' : bigint } |
+  { 'err' : string };
+export type Result_4 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_5 = { 'ok' : SolicitorSubmissionDetails } |
+  { 'err' : string };
+export interface SolicitorSubmissionDetails {
+  'firmSRANumber' : [] | [string],
+  'fullName' : string,
+  'firmName' : string,
+  'email' : string,
+  'businessGatewayEnabled' : boolean,
+  'conveyancerReference' : [] | [string],
+  'sraNumber' : string,
+  'principalId' : Principal,
+  'firmAddress' : string,
+}
+export type Time = bigint;
+export interface TransactionMember {
+  'uploadedDocuments' : Array<string>,
+  'principal' : Principal,
+  'requiredDocuments' : Array<string>,
+  'joinedAt' : Time,
+  'role' : UserType,
+  'documentsComplete' : boolean,
+  'canViewProgress' : boolean,
+  'canInviteOthers' : boolean,
+  'lastActivityAt' : Time,
+  'transactionId' : string,
+}
+export interface TransactionProgress {
+  'members' : Array<TransactionMember>,
+  'completionPercentage' : bigint,
+  'readyToExchange' : boolean,
+  'membersComplete' : bigint,
+  'totalMembers' : bigint,
+  'blockingParties' : Array<Principal>,
+  'transactionId' : string,
+}
+export interface UserProfile {
+  'isPlatformOnlySolicitor' : boolean,
+  'userType' : UserType,
+  'principal' : Principal,
+  'managedBySolicitor' : [] | [Principal],
+  'firmSRANumber' : [] | [string],
+  'emailVerified' : boolean,
+  'name' : string,
+  'createdAt' : Time,
+  'role' : [] | [UserRole],
+  'businessGatewayUsername' : [] | [string],
+  'email' : string,
+  'lawFirmName' : [] | [string],
+  'isVerified' : boolean,
+  'clientPrincipals' : Array<Principal>,
+  'businessGatewayEnabled' : boolean,
+  'emailVerificationSentAt' : [] | [Time],
+  'emailVerificationToken' : [] | [string],
+  'conveyancerReference' : [] | [string],
+  'mobile' : string,
+  'solicitorLicenseNumber' : [] | [string],
+  'sraNumber' : [] | [string],
+  'lawFirmAddress' : [] | [string],
+}
+export type UserRole = { 'admin' : null } |
+  { 'solicitor' : null } |
+  { 'seller' : null } |
+  { 'guest' : null } |
+  { 'buyer' : null };
+export type UserType = { 'solicitor_platform_only' : null } |
+  { 'admin' : null } |
+  { 'diy_buyer' : null } |
+  { 'solicitor_transparent' : null } |
+  { 'platform_admin' : null } |
+  { 'solicitor_client_linked' : null } |
+  { 'estate_agent' : null } |
+  { 'platform_support' : null } |
+  { 'mortgage_broker' : null } |
+  { 'seller' : null } |
+  { 'conveyancer_managed' : null } |
+  { 'diy_seller' : null } |
+  { 'assisted_seller' : null } |
+  { 'conveyancer_transparent' : null } |
+  { 'buyer' : null } |
+  { 'property_developer' : null } |
+  { 'solicitor_managed' : null } |
+  { 'assisted_buyer' : null };
+export interface _SERVICE {
+  'addTransactionMember' : ActorMethod<
+    [string, Principal, UserType, boolean, boolean, string],
+    boolean
+  >,
+  'adminLinkPrincipals' : ActorMethod<[Principal, Principal], Result_1>,
+  'amIAdmin' : ActorMethod<[], boolean>,
+  'bootstrapAdmin' : ActorMethod<[string, string], boolean>,
+  'canUserAccessTransaction' : ActorMethod<[Principal, string], boolean>,
+  'checkPermissionWithAudit' : ActorMethod<[Permission], boolean>,
+  'claimLinkCode' : ActorMethod<[string], Result_1>,
+  'createUserForPrincipal' : ActorMethod<
+    [Principal, string, string, string, string, string],
+    boolean
+  >,
+  'deactivateBot' : ActorMethod<[Principal], Result_4>,
+  'deleteUserByPrincipal' : ActorMethod<[Principal, string], boolean>,
+  'demoteAdmin' : ActorMethod<[Principal, string], AdminMutationResult_1>,
+  'generateCSRFToken' : ActorMethod<[], string>,
+  'generateLinkCode' : ActorMethod<[], Result_1>,
+  'getAllBots' : ActorMethod<[], Array<BotAgent>>,
+  'getAllUsers' : ActorMethod<[], Array<UserProfile>>,
+  'getAuditLogs' : ActorMethod<[bigint], Array<AuditLog>>,
+  'getBotActionLogs' : ActorMethod<[Principal, bigint], Array<BotActionLog>>,
+  'getBotAgent' : ActorMethod<[Principal], [] | [BotAgent]>,
+  'getCSRFToken' : ActorMethod<[], [] | [string]>,
+  'getCycles' : ActorMethod<[], bigint>,
+  'getLinkedPrincipals' : ActorMethod<[Principal], Array<Principal>>,
+  'getMyBots' : ActorMethod<[], Array<BotAgent>>,
+  'getMyLinkedPrincipals' : ActorMethod<[], Array<Principal>>,
+  'getMyManagingSolicitor' : ActorMethod<[], [] | [UserProfile]>,
+  'getMyProfile' : ActorMethod<[], [] | [UserProfile]>,
+  'getMyProfileUpdate' : ActorMethod<[], [] | [UserProfile]>,
+  'getMySolicitorClients' : ActorMethod<[], Array<UserProfile>>,
+  'getSolicitorSubmissionDetails' : ActorMethod<[Principal], Result_5>,
+  'getTransactionMembers' : ActorMethod<
+    [string],
+    [] | [Array<TransactionMember>]
+  >,
+  'getTransactionProgress' : ActorMethod<[string], [] | [TransactionProgress]>,
+  'getUserProfile' : ActorMethod<[Principal], [] | [UserProfile]>,
+  'getUserProfileByPrincipal' : ActorMethod<[Principal], [] | [UserProfile]>,
+  'hasPermission' : ActorMethod<[Permission], boolean>,
+  'linkSolicitorToClient' : ActorMethod<[Principal, boolean, string], boolean>,
+  'listAdmins' : ActorMethod<[], Array<AdminRecord>>,
+  'logBotAction' : ActorMethod<
+    [Principal, string, [] | [string], boolean, string],
+    Result_4
+  >,
+  'myAdminRole' : ActorMethod<[], [] | [AdminRole]>,
+  'promoteAdmin' : ActorMethod<
+    [Principal, AdminRole, [] | [string], string],
+    AdminMutationResult
+  >,
+  'reactivateBot' : ActorMethod<[Principal], Result_4>,
+  'recordAuditEntry' : ActorMethod<
+    [
+      ActorType,
+      [] | [Principal],
+      string,
+      [] | [Principal],
+      [] | [string],
+      boolean,
+      string,
+    ],
+    Result_3
+  >,
+  'registerBot' : ActorMethod<[Principal, string, string, BotRole], Result_2>,
+  'registerUser' : ActorMethod<[string, string, string, string], boolean>,
+  'registerUserV2' : ActorMethod<
+    [
+      string,
+      string,
+      string,
+      UserType,
+      [] | [string],
+      [] | [string],
+      [] | [string],
+      [] | [string],
+      string,
+    ],
+    boolean
+  >,
+  'resendVerificationEmail' : ActorMethod<[string], boolean>,
+  'revokeSolicitorAccess' : ActorMethod<[Principal, string], boolean>,
+  'unlinkPrincipal' : ActorMethod<[Principal], Result_1>,
+  'updateMemberDocuments' : ActorMethod<[string, string, string], boolean>,
+  'updateSolicitorLRDetails' : ActorMethod<
+    [[] | [string], boolean, [] | [string], [] | [string], [] | [string]],
+    Result_1
+  >,
+  'updateTransactionMemberRequiredDocs' : ActorMethod<
+    [string, Array<string>, string],
+    boolean
+  >,
+  'validateAdmin' : ActorMethod<[Principal], boolean>,
+  'validateBot' : ActorMethod<[Principal], Result>,
+  'validateCSRFToken' : ActorMethod<[string], boolean>,
+  'verifyEmail' : ActorMethod<[string, string], boolean>,
+  'verifyUser' : ActorMethod<[Principal, string], boolean>,
+  'whoAmI' : ActorMethod<[], Principal>,
+}
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];