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

package/src/canisters/ledger_manager/ledger_manager.did

@@ -1,161 +1,232 @@
-type VerificationStatus = 
- variant {
-   failed;
-   pending;
-   verified;
- };
-type UserLedgerEntry = 
- record {
-   accountID: text;
-   completedDate: opt Time;
-   costsSaved: nat;
-   counterparties: vec Counterparty;
-   documentStatus: DocumentVerification;
-   entryID: text;
-   initiatedDate: Time;
-   propertyAddress: text;
-   propertyValue: nat;
-   roleInTransaction: TransactionRole;
-   status: TransactionStatus;
-   transactionID: text;
- };
-type UserAccount = 
- record {
-   accountID: text;
-   accountType: AccountType;
-   companyName: opt text;
-   email: text;
-   isActive: bool;
-   name: text;
-   registrationDate: Time;
-   taxID: opt text;
- };
-type TransactionStatus = 
- variant {
-   active;
-   completed;
-   failed;
-   pending;
- };
-type TransactionRole = 
- variant {
-   agent;
-   buyer;
-   seller;
-   solicitor;
- };
-type Time = int;
-type TeamPermissions = 
- record {
-   canInitiate: bool;
-   canManageTeam: bool;
-   canSign: bool;
-   canViewAnalytics: bool;
- };
-type TeamMemberRole = 
- variant {
-   admin;
-   manager;
-   viewer;
- };
-type Result = 
- variant {
-   err: text;
-   ok: text;
- };
-type Result_1 = 
- variant {
-   err: text;
-   ok: nat;
- };
-type DocumentVerification = 
- record {
-   landRegistryConfirm: VerificationStatus;
-   mortgageApproval: VerificationStatus;
-   propertyDeed: VerificationStatus;
-   surveyReport: VerificationStatus;
- };
-type Counterparty = 
- record {
-   accountID: text;
-   name: text;
- };
-type CompanyTeamMember = 
- record {
-   accountID: text;
-   email: text;
-   joinDate: Time;
-   memberID: text;
-   name: text;
-   permissions: TeamPermissions;
-   role: TeamMemberRole;
- };
-type CompanyLedger = 
- record {
-   activeTransactions: nat;
-   avgCompletionTime: nat;
-   companyAccountID: text;
-   completedThisMonth: nat;
-   costSavings: nat;
-   teamMemberCount: nat;
-   totalTransactions: nat;
- };
-type BlockchainEfficiencyMetrics = 
- record {
-   avgBlockchainCompletionDays: nat;
-   avgBlockchainCost: nat;
-   avgTraditionalCompletionDays: nat;
-   avgTraditionalCost: nat;
-   costReductionPercent: nat;
-   timeReductionPercent: nat;
-   totalCostSaved: nat;
-   totalTimeSavedDays: nat;
-   transactionsCompleted: nat;
- };
-type Analytics = 
- record {
-   avgCompletionTime: nat;
-   completedTransactions: nat;
-   period: text;
-   totalCostSavings: nat;
-   totalTransactions: nat;
-   transactionVolume: nat;
- };
-type AccountType = 
- variant {
-   company;
-   individual;
- };
-service : {
-  addTransactionToLedger: (accountID: text, transactionID: text,
-   roleInTransaction: TransactionRole, propertyAddress: text, propertyValue:
-   nat, counterparties: vec Counterparty) -> (bool);
-  createCompanyTeamMember: (companyID: text, name: text, email: text, role:
-   TeamMemberRole, permissions: TeamPermissions) -> (text);
-  createUserAccount: (name: text, email: text, accountType: AccountType,
-   companyName: opt text, taxID: opt text) -> (text);
-  getBlockchainEfficiencyMetrics: (accountID: text) ->
-   (BlockchainEfficiencyMetrics) query;
-  getCompanyLedger: (companyAccountID: text) -> (CompanyLedger) query;
-  getCompanyTeamMembers: (companyAccountID: text) ->
-   (vec CompanyTeamMember) query;
-  getCycles: () -> (nat) query;
-  getGlobalBlockchainStats: () -> (BlockchainEfficiencyMetrics) query;
-  getLedgerAnalytics: (accountID: text, period: text) -> (Analytics) query;
-  getMyAccount: () -> (opt UserAccount) query;
-  getMyLedger: () -> (vec UserLedgerEntry) query;
-  getUserAccount: (accountID: text) -> (opt UserAccount) query;
-  getUserLedger: (accountID: text) -> (vec UserLedgerEntry) query;
-  logEvent: (transactionId: text, eventType: text, details: text,
-   metadata: opt text) -> (Result_1);
-  setDocumentVerificationCanister: (canisterId: principal) -> ();
-  setPropertyRegistryCanister: (canisterId: principal) -> ();
-  setTransactionManagerCanister: (canisterId: principal) -> ();
-  setUserManagementCanister: (canisterId: principal) -> ();
-  syncTransactionToLedger: (transactionId: nat, userPrincipal: principal) ->
-   (Result);
-  updateTeamMemberPermissions: (companyID: text, memberID: text, permissions:
-   TeamPermissions) -> (bool);
-  updateTransactionStatus: (transactionID: text, accountID: text, newStatus:
-   TransactionStatus) -> (bool);
-}
+type VerificationStatus = 
+ variant {
+   failed;
+   pending;
+   verified;
+ };
+type UserLedgerEntry = 
+ record {
+   accountID: text;
+   completedDate: opt Time;
+   costsSaved: nat;
+   counterparties: vec Counterparty;
+   documentStatus: DocumentVerification;
+   entryID: text;
+   initiatedDate: Time;
+   propertyAddress: text;
+   propertyValue: nat;
+   roleInTransaction: TransactionRole;
+   status: TransactionStatus;
+   transactionID: text;
+ };
+type UserAccount = 
+ record {
+   accountID: text;
+   accountType: AccountType;
+   companyName: opt text;
+   email: text;
+   isActive: bool;
+   name: text;
+   registrationDate: Time;
+   taxID: opt text;
+ };
+type TransactionStatus = 
+ variant {
+   active;
+   completed;
+   failed;
+   pending;
+ };
+type TransactionRole = 
+ variant {
+   agent;
+   buyer;
+   seller;
+   solicitor;
+ };
+type Time = int;
+type TeamPermissions = 
+ record {
+   canInitiate: bool;
+   canManageTeam: bool;
+   canSign: bool;
+   canViewAnalytics: bool;
+ };
+type TeamMemberRole = 
+ variant {
+   admin;
+   manager;
+   viewer;
+ };
+type Result_2 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result_1 = 
+ variant {
+   err: text;
+   ok;
+ };
+type Result = 
+ variant {
+   err: text;
+   ok: text;
+ };
+type LandRegistryCostEntry = 
+ record {
+   apiEndpoint: text;
+   calledAt: int;
+   calledBy: principal;
+   costPence: nat;
+   description: text;
+   id: nat;
+   invoiceReference: opt text;
+   titleNumber: text;
+   transactionId: text;
+ };
+type LRCostReport = 
+ record {
+   avgCostPerTransaction: nat;
+   byEndpoint: vec record {
+                     text;
+                     nat;
+                   };
+   entryCount: nat;
+   totalGBP: text;
+   totalPence: nat;
+ };
+type DocumentVerification = 
+ record {
+   landRegistryConfirm: VerificationStatus;
+   mortgageApproval: VerificationStatus;
+   propertyDeed: VerificationStatus;
+   surveyReport: VerificationStatus;
+ };
+type Counterparty = 
+ record {
+   accountID: text;
+   name: text;
+ };
+type CompanyTeamMember = 
+ record {
+   accountID: text;
+   email: text;
+   joinDate: Time;
+   memberID: text;
+   name: text;
+   permissions: TeamPermissions;
+   role: TeamMemberRole;
+ };
+type CompanyLedger = 
+ record {
+   activeTransactions: nat;
+   avgCompletionTime: nat;
+   companyAccountID: text;
+   completedThisMonth: nat;
+   costSavings: nat;
+   teamMemberCount: nat;
+   totalTransactions: nat;
+ };
+type BudgetStatus = 
+ record {
+   dailyLimit: nat;
+   dailyRemaining: nat;
+   dailySpent: nat;
+   isOverDailyBudget: bool;
+   isOverMonthlyBudget: bool;
+   monthlyLimit: nat;
+   monthlyRemaining: nat;
+   monthlySpent: nat;
+ };
+type BlockchainEfficiencyMetrics = 
+ record {
+   avgBlockchainCompletionDays: nat;
+   avgBlockchainCost: nat;
+   avgTraditionalCompletionDays: nat;
+   avgTraditionalCost: nat;
+   costReductionPercent: nat;
+   timeReductionPercent: nat;
+   totalCostSaved: nat;
+   totalTimeSavedDays: nat;
+   transactionsCompleted: nat;
+ };
+type AuditEvent = 
+ record {
+   caller: principal;
+   details: text;
+   eventId: nat;
+   eventType: text;
+   metadata: opt text;
+   timestamp: int;
+   transactionId: text;
+ };
+type Analytics = 
+ record {
+   avgCompletionTime: nat;
+   completedTransactions: nat;
+   period: text;
+   totalCostSavings: nat;
+   totalTransactions: nat;
+   transactionVolume: nat;
+ };
+type AccountType = 
+ variant {
+   company;
+   individual;
+ };
+service : {
+  addTransactionToLedger: (accountID: text, transactionID: text,
+   roleInTransaction: TransactionRole, propertyAddress: text, propertyValue:
+   nat, counterparties: vec Counterparty) -> (bool);
+  canAffordAPICall: (costPence: nat) -> (bool) query;
+  clearFailedAuditEvents: () -> ();
+  createCompanyTeamMember: (companyID: text, name: text, email: text, role:
+   TeamMemberRole, permissions: TeamPermissions) -> (text);
+  createUserAccount: (name: text, email: text, accountType: AccountType,
+   companyName: opt text, taxID: opt text) -> (text);
+  getAllAuditEvents: () -> (vec AuditEvent) query;
+  getBlockchainEfficiencyMetrics: (accountID: text) ->
+   (BlockchainEfficiencyMetrics) query;
+  getBudgetStatus: () -> (BudgetStatus) query;
+  getCompanyLedger: (companyAccountID: text) -> (CompanyLedger) query;
+  getCompanyTeamMembers: (companyAccountID: text) ->
+   (vec CompanyTeamMember) query;
+  getCycles: () -> (nat) query;
+  getDailyLRSpend: () -> (nat) query;
+  getEventsByTransaction: (transactionId: text) -> (vec AuditEvent) query;
+  getFailedAuditEvents: () -> (vec AuditEvent) query;
+  getGlobalBlockchainStats: () -> (BlockchainEfficiencyMetrics) query;
+  getLRCostReport: (fromDate: int, toDate: int) -> (LRCostReport) query;
+  getLRCostsForTransaction: (transactionId: text) ->
+   (vec LandRegistryCostEntry) query;
+  getLRSpendByEndpoint: (fromDate: int, toDate: int) ->
+   (vec record {
+          text;
+          nat;
+        }) query;
+  getLedgerAnalytics: (accountID: text, period: text) -> (Analytics) query;
+  getMonthlyLRSpend: () -> (nat) query;
+  getMyAccount: () -> (opt UserAccount) query;
+  getMyLedger: () -> (vec UserLedgerEntry) query;
+  getUserAccount: (accountID: text) -> (opt UserAccount) query;
+  getUserLedger: (accountID: text) -> (vec UserLedgerEntry) query;
+  logEvent: (transactionId: text, eventType: text, details: text, metadata:
+   opt text) -> (Result_2);
+  recordLandRegistryCost: (transactionId: text, apiEndpoint: text, costPence:
+   nat, titleNumber: text, description: text, invoiceReference: opt text) ->
+   (Result_2);
+  setDailyBudget: (limitPence: nat) -> (Result_1);
+  setDocumentStorageCanister: (canisterId: principal) -> ();
+  setDocumentVerificationCanister: (canisterId: principal) -> ();
+  setMonthlyBudget: (limitPence: nat) -> (Result_1);
+  setPropertyRegistryCanister: (canisterId: principal) -> ();
+  setTransactionManagerCanister: (canisterId: principal) -> ();
+  setUserManagementCanister: (canisterId: principal) -> ();
+  syncTransactionToLedger: (transactionId: nat, userPrincipal: principal) ->
+   (Result);
+  updateTeamMemberPermissions: (companyID: text, memberID: text, permissions:
+   TeamPermissions) -> (bool);
+  updateTransactionStatus: (transactionID: text, accountID: text, newStatus:
+   TransactionStatus) -> (bool);
+}