@propxchain/core-client 0.3.0 → 0.5.0-canary.42

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

@@ -1,7 +1,314 @@
-export function idlFactory({ IDL }: {
-    IDL: any;
-}): any;
-export function init({ IDL }: {
-    IDL: any;
-}): never[];
-//# sourceMappingURL=user_management.did.d.ts.map
+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 = { '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 AgentGrant {
+  'status' : GrantStatus,
+  'expiresAt' : [] | [Time],
+  'source' : GrantSource,
+  'ownerPrincipal' : [] | [Principal],
+  'scopes' : Array<string>,
+  'tier' : GrantTier,
+  'issuedAt' : Time,
+  'lastElevatedAt' : [] | [Time],
+  'agentPrincipal' : Principal,
+}
+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 GrantSource = { 'authMdEmail' : null } |
+  { 'authMdIdJag' : null } |
+  { 'invite' : null } |
+  { 'authMdAnonymous' : null };
+export type GrantStatus = { 'active' : null } |
+  { 'revoked' : null } |
+  { 'preClaim' : null };
+export type GrantTier = { 'readOnly' : null } |
+  { 'consequential' : 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' : string } |
+  { 'err' : string };
+export type Result_1 = { 'ok' : bigint } |
+  { 'err' : string };
+export type Result_2 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_3 = { 'ok' : BotAgent } |
+  { 'err' : string };
+export type Result_4 = { 'ok' : AgentGrant } |
+  { '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>,
+  'amIAdmin' : ActorMethod<[], boolean>,
+  'bootstrapAdmin' : ActorMethod<[string, string], boolean>,
+  'canUserAccessTransaction' : ActorMethod<[Principal, string], boolean>,
+  'checkPermissionWithAudit' : ActorMethod<[Permission], boolean>,
+  'claimLinkCode' : ActorMethod<[string], Result>,
+  'createUserForPrincipal' : ActorMethod<
+    [Principal, string, string, string, string, string],
+    boolean
+  >,
+  'deactivateBot' : ActorMethod<[Principal], Result_2>,
+  'deleteUserByPrincipal' : ActorMethod<[Principal, string], boolean>,
+  'demoteAdmin' : ActorMethod<[Principal, string], AdminMutationResult_1>,
+  'generateCSRFToken' : ActorMethod<[], string>,
+  'generateLinkCode' : ActorMethod<[], Result>,
+  'getAgentGrant' : ActorMethod<[Principal], [] | [AgentGrant]>,
+  '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>,
+  'getGrantIssuer' : ActorMethod<[], [] | [Principal]>,
+  'getLinkedPrincipals' : ActorMethod<[Principal], Array<Principal>>,
+  'getMemberRoleInTransaction' : ActorMethod<
+    [Principal, string],
+    [] | [UserType]
+  >,
+  'getMyAgentGrants' : ActorMethod<[], Array<AgentGrant>>,
+  '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_2
+  >,
+  'myAdminRole' : ActorMethod<[], [] | [AdminRole]>,
+  'promoteAdmin' : ActorMethod<
+    [Principal, AdminRole, [] | [string], string],
+    AdminMutationResult
+  >,
+  'reactivateBot' : ActorMethod<[Principal], Result_2>,
+  'recordAuditEntry' : ActorMethod<
+    [
+      ActorType,
+      [] | [Principal],
+      string,
+      [] | [Principal],
+      [] | [string],
+      boolean,
+      string,
+    ],
+    Result_1
+  >,
+  'recordGrantElevation' : ActorMethod<
+    [Principal, Principal, GrantTier, Array<string>, GrantSource, [] | [Time]],
+    Result_4
+  >,
+  'recordGrantIssued' : ActorMethod<
+    [
+      Principal,
+      [] | [Principal],
+      GrantTier,
+      Array<string>,
+      GrantStatus,
+      GrantSource,
+      [] | [Time],
+    ],
+    Result_4
+  >,
+  'recordGrantRevocation' : ActorMethod<[Principal, string], Result_2>,
+  'registerBot' : ActorMethod<[Principal, string, string, BotRole], Result_3>,
+  'registerUser' : ActorMethod<[string, string, string, string], boolean>,
+  'registerUserV2' : ActorMethod<
+    [
+      string,
+      string,
+      string,
+      UserType,
+      [] | [string],
+      [] | [string],
+      [] | [string],
+      [] | [string],
+      string,
+    ],
+    boolean
+  >,
+  'repairTransactionMemberRole' : ActorMethod<
+    [string, Principal, UserType],
+    boolean
+  >,
+  'resendVerificationEmail' : ActorMethod<[string], boolean>,
+  'revokeSolicitorAccess' : ActorMethod<[Principal, string], boolean>,
+  'setGrantIssuer' : ActorMethod<[Principal], Result_2>,
+  'sweepStaleGrants' : ActorMethod<[], Result_1>,
+  'unlinkPrincipal' : ActorMethod<[Principal], Result>,
+  'updateMemberDocuments' : ActorMethod<[string, string, string], boolean>,
+  'updateSolicitorLRDetails' : ActorMethod<
+    [[] | [string], boolean, [] | [string], [] | [string], [] | [string]],
+    Result
+  >,
+  'updateTransactionMemberRequiredDocs' : ActorMethod<
+    [string, Array<string>, 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[];