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

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

@@ -1,142 +1,205 @@
-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 AccountType = { 'company' : null } |
-  { 'individual' : null };
-export interface Analytics {
-  'transactionVolume' : bigint,
-  'avgCompletionTime' : bigint,
-  'period' : string,
-  'totalCostSavings' : bigint,
-  'completedTransactions' : bigint,
-  'totalTransactions' : bigint,
-}
-export interface BlockchainEfficiencyMetrics {
-  'avgBlockchainCompletionDays' : bigint,
-  'totalCostSaved' : bigint,
-  'avgTraditionalCompletionDays' : bigint,
-  'timeReductionPercent' : bigint,
-  'avgTraditionalCost' : bigint,
-  'avgBlockchainCost' : bigint,
-  'transactionsCompleted' : bigint,
-  'costReductionPercent' : bigint,
-  'totalTimeSavedDays' : bigint,
-}
-export interface CompanyLedger {
-  'companyAccountID' : string,
-  'avgCompletionTime' : bigint,
-  'costSavings' : bigint,
-  'completedThisMonth' : bigint,
-  'activeTransactions' : bigint,
-  'teamMemberCount' : bigint,
-  'totalTransactions' : bigint,
-}
-export interface CompanyTeamMember {
-  'memberID' : string,
-  'permissions' : TeamPermissions,
-  'accountID' : string,
-  'joinDate' : Time,
-  'name' : string,
-  'role' : TeamMemberRole,
-  'email' : string,
-}
-export interface Counterparty { 'accountID' : string, 'name' : string }
-export interface DocumentVerification {
-  'mortgageApproval' : VerificationStatus,
-  'propertyDeed' : VerificationStatus,
-  'landRegistryConfirm' : VerificationStatus,
-  'surveyReport' : VerificationStatus,
-}
-export type Result = { 'ok' : string } |
-  { 'err' : string };
-export type Result_1 = { 'ok' : bigint } |
-  { 'err' : string };
-export type TeamMemberRole = { 'manager' : null } |
-  { 'admin' : null } |
-  { 'viewer' : null };
-export interface TeamPermissions {
-  'canSign' : boolean,
-  'canInitiate' : boolean,
-  'canViewAnalytics' : boolean,
-  'canManageTeam' : boolean,
-}
-export type Time = bigint;
-export type TransactionRole = { 'agent' : null } |
-  { 'solicitor' : null } |
-  { 'seller' : null } |
-  { 'buyer' : null };
-export type TransactionStatus = { 'active' : null } |
-  { 'pending' : null } |
-  { 'completed' : null } |
-  { 'failed' : null };
-export interface UserAccount {
-  'taxID' : [] | [string],
-  'accountID' : string,
-  'name' : string,
-  'isActive' : boolean,
-  'email' : string,
-  'accountType' : AccountType,
-  'companyName' : [] | [string],
-  'registrationDate' : Time,
-}
-export interface UserLedgerEntry {
-  'completedDate' : [] | [Time],
-  'initiatedDate' : Time,
-  'status' : TransactionStatus,
-  'accountID' : string,
-  'documentStatus' : DocumentVerification,
-  'costsSaved' : bigint,
-  'propertyAddress' : string,
-  'entryID' : string,
-  'propertyValue' : bigint,
-  'roleInTransaction' : TransactionRole,
-  'counterparties' : Array<Counterparty>,
-  'transactionID' : string,
-}
-export type VerificationStatus = { 'verified' : null } |
-  { 'pending' : null } |
-  { 'failed' : null };
-export interface _SERVICE {
-  'addTransactionToLedger' : ActorMethod<
-    [string, string, TransactionRole, string, bigint, Array<Counterparty>],
-    boolean
-  >,
-  'createCompanyTeamMember' : ActorMethod<
-    [string, string, string, TeamMemberRole, TeamPermissions],
-    string
-  >,
-  'createUserAccount' : ActorMethod<
-    [string, string, AccountType, [] | [string], [] | [string]],
-    string
-  >,
-  'getBlockchainEfficiencyMetrics' : ActorMethod<
-    [string],
-    BlockchainEfficiencyMetrics
-  >,
-  'getCompanyLedger' : ActorMethod<[string], CompanyLedger>,
-  'getCompanyTeamMembers' : ActorMethod<[string], Array<CompanyTeamMember>>,
-  'getCycles' : ActorMethod<[], bigint>,
-  'getGlobalBlockchainStats' : ActorMethod<[], BlockchainEfficiencyMetrics>,
-  'getLedgerAnalytics' : ActorMethod<[string, string], Analytics>,
-  'getMyAccount' : ActorMethod<[], [] | [UserAccount]>,
-  'getMyLedger' : ActorMethod<[], Array<UserLedgerEntry>>,
-  'getUserAccount' : ActorMethod<[string], [] | [UserAccount]>,
-  'getUserLedger' : ActorMethod<[string], Array<UserLedgerEntry>>,
-  'logEvent' : ActorMethod<[string, string, string, [] | [string]], Result_1>,
-  'setDocumentVerificationCanister' : ActorMethod<[Principal], undefined>,
-  'setPropertyRegistryCanister' : ActorMethod<[Principal], undefined>,
-  'setTransactionManagerCanister' : ActorMethod<[Principal], undefined>,
-  'setUserManagementCanister' : ActorMethod<[Principal], undefined>,
-  'syncTransactionToLedger' : ActorMethod<[bigint, Principal], Result>,
-  'updateTeamMemberPermissions' : ActorMethod<
-    [string, string, TeamPermissions],
-    boolean
-  >,
-  'updateTransactionStatus' : ActorMethod<
-    [string, string, TransactionStatus],
-    boolean
-  >,
-}
-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 AccountType = { 'company' : null } |
+  { 'individual' : null };
+export interface Analytics {
+  'transactionVolume' : bigint,
+  'avgCompletionTime' : bigint,
+  'period' : string,
+  'totalCostSavings' : bigint,
+  'completedTransactions' : bigint,
+  'totalTransactions' : bigint,
+}
+export interface AuditEvent {
+  'eventId' : bigint,
+  'metadata' : [] | [string],
+  'timestamp' : bigint,
+  'details' : string,
+  'caller' : Principal,
+  'transactionId' : string,
+  'eventType' : string,
+}
+export interface BlockchainEfficiencyMetrics {
+  'avgBlockchainCompletionDays' : bigint,
+  'totalCostSaved' : bigint,
+  'avgTraditionalCompletionDays' : bigint,
+  'timeReductionPercent' : bigint,
+  'avgTraditionalCost' : bigint,
+  'avgBlockchainCost' : bigint,
+  'transactionsCompleted' : bigint,
+  'costReductionPercent' : bigint,
+  'totalTimeSavedDays' : bigint,
+}
+export interface BudgetStatus {
+  'dailyRemaining' : bigint,
+  'isOverDailyBudget' : boolean,
+  'monthlyLimit' : bigint,
+  'monthlySpent' : bigint,
+  'dailyLimit' : bigint,
+  'dailySpent' : bigint,
+  'isOverMonthlyBudget' : boolean,
+  'monthlyRemaining' : bigint,
+}
+export interface CompanyLedger {
+  'companyAccountID' : string,
+  'avgCompletionTime' : bigint,
+  'costSavings' : bigint,
+  'completedThisMonth' : bigint,
+  'activeTransactions' : bigint,
+  'teamMemberCount' : bigint,
+  'totalTransactions' : bigint,
+}
+export interface CompanyTeamMember {
+  'memberID' : string,
+  'permissions' : TeamPermissions,
+  'accountID' : string,
+  'joinDate' : Time,
+  'name' : string,
+  'role' : TeamMemberRole,
+  'email' : string,
+}
+export interface Counterparty { 'accountID' : string, 'name' : string }
+export interface DocumentVerification {
+  'mortgageApproval' : VerificationStatus,
+  'propertyDeed' : VerificationStatus,
+  'landRegistryConfirm' : VerificationStatus,
+  'surveyReport' : VerificationStatus,
+}
+export interface LRCostReport {
+  'entryCount' : bigint,
+  'byEndpoint' : Array<[string, bigint]>,
+  'avgCostPerTransaction' : bigint,
+  'totalGBP' : string,
+  'totalPence' : bigint,
+}
+export interface LandRegistryCostEntry {
+  'id' : bigint,
+  'titleNumber' : string,
+  'invoiceReference' : [] | [string],
+  'description' : string,
+  'calledAt' : bigint,
+  'calledBy' : Principal,
+  'apiEndpoint' : string,
+  'costPence' : bigint,
+  'transactionId' : string,
+}
+export type Result = { 'ok' : string } |
+  { 'err' : string };
+export type Result_1 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_2 = { 'ok' : bigint } |
+  { 'err' : string };
+export type TeamMemberRole = { 'manager' : null } |
+  { 'admin' : null } |
+  { 'viewer' : null };
+export interface TeamPermissions {
+  'canSign' : boolean,
+  'canInitiate' : boolean,
+  'canViewAnalytics' : boolean,
+  'canManageTeam' : boolean,
+}
+export type Time = bigint;
+export type TransactionRole = { 'agent' : null } |
+  { 'solicitor' : null } |
+  { 'seller' : null } |
+  { 'buyer' : null };
+export type TransactionStatus = { 'active' : null } |
+  { 'pending' : null } |
+  { 'completed' : null } |
+  { 'failed' : null };
+export interface UserAccount {
+  'taxID' : [] | [string],
+  'accountID' : string,
+  'name' : string,
+  'isActive' : boolean,
+  'email' : string,
+  'accountType' : AccountType,
+  'companyName' : [] | [string],
+  'registrationDate' : Time,
+}
+export interface UserLedgerEntry {
+  'completedDate' : [] | [Time],
+  'initiatedDate' : Time,
+  'status' : TransactionStatus,
+  'accountID' : string,
+  'documentStatus' : DocumentVerification,
+  'costsSaved' : bigint,
+  'propertyAddress' : string,
+  'entryID' : string,
+  'propertyValue' : bigint,
+  'roleInTransaction' : TransactionRole,
+  'counterparties' : Array<Counterparty>,
+  'transactionID' : string,
+}
+export type VerificationStatus = { 'verified' : null } |
+  { 'pending' : null } |
+  { 'failed' : null };
+export interface _SERVICE {
+  'addTransactionToLedger' : ActorMethod<
+    [string, string, TransactionRole, string, bigint, Array<Counterparty>],
+    boolean
+  >,
+  'canAffordAPICall' : ActorMethod<[bigint], boolean>,
+  'clearFailedAuditEvents' : ActorMethod<[], undefined>,
+  'createCompanyTeamMember' : ActorMethod<
+    [string, string, string, TeamMemberRole, TeamPermissions],
+    string
+  >,
+  'createUserAccount' : ActorMethod<
+    [string, string, AccountType, [] | [string], [] | [string]],
+    string
+  >,
+  'getAllAuditEvents' : ActorMethod<[], Array<AuditEvent>>,
+  'getBlockchainEfficiencyMetrics' : ActorMethod<
+    [string],
+    BlockchainEfficiencyMetrics
+  >,
+  'getBudgetStatus' : ActorMethod<[], BudgetStatus>,
+  'getCompanyLedger' : ActorMethod<[string], CompanyLedger>,
+  'getCompanyTeamMembers' : ActorMethod<[string], Array<CompanyTeamMember>>,
+  'getCycles' : ActorMethod<[], bigint>,
+  'getDailyLRSpend' : ActorMethod<[], bigint>,
+  'getEventsByTransaction' : ActorMethod<[string], Array<AuditEvent>>,
+  'getFailedAuditEvents' : ActorMethod<[], Array<AuditEvent>>,
+  'getGlobalBlockchainStats' : ActorMethod<[], BlockchainEfficiencyMetrics>,
+  'getLRCostReport' : ActorMethod<[bigint, bigint], LRCostReport>,
+  'getLRCostsForTransaction' : ActorMethod<
+    [string],
+    Array<LandRegistryCostEntry>
+  >,
+  'getLRSpendByEndpoint' : ActorMethod<
+    [bigint, bigint],
+    Array<[string, bigint]>
+  >,
+  'getLedgerAnalytics' : ActorMethod<[string, string], Analytics>,
+  'getMonthlyLRSpend' : ActorMethod<[], bigint>,
+  'getMyAccount' : ActorMethod<[], [] | [UserAccount]>,
+  'getMyLedger' : ActorMethod<[], Array<UserLedgerEntry>>,
+  'getUserAccount' : ActorMethod<[string], [] | [UserAccount]>,
+  'getUserLedger' : ActorMethod<[string], Array<UserLedgerEntry>>,
+  'logEvent' : ActorMethod<[string, string, string, [] | [string]], Result_2>,
+  'recordLandRegistryCost' : ActorMethod<
+    [string, string, bigint, string, string, [] | [string]],
+    Result_2
+  >,
+  'setDailyBudget' : ActorMethod<[bigint], Result_1>,
+  'setDocumentStorageCanister' : ActorMethod<[Principal], undefined>,
+  'setDocumentVerificationCanister' : ActorMethod<[Principal], undefined>,
+  'setMonthlyBudget' : ActorMethod<[bigint], Result_1>,
+  'setPropertyRegistryCanister' : ActorMethod<[Principal], undefined>,
+  'setTransactionManagerCanister' : ActorMethod<[Principal], undefined>,
+  'setUserManagementCanister' : ActorMethod<[Principal], undefined>,
+  'syncTransactionToLedger' : ActorMethod<[bigint, Principal], Result>,
+  'updateTeamMemberPermissions' : ActorMethod<
+    [string, string, TeamPermissions],
+    boolean
+  >,
+  'updateTransactionStatus' : ActorMethod<
+    [string, string, TransactionStatus],
+    boolean
+  >,
+}
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];