@propxchain/core-client 0.1.0-canary.3

package/src/canisters/transaction_manager/transaction_manager.did

@@ -0,0 +1,599 @@
+type TransactionTimeline = 
+ record {
+   blockchainCompletedAt: opt int;
+   completionInitiatedAt: opt int;
+   createdAt: int;
+   exchangedAt: opt int;
+   landRegistryRegisteredAt: opt int;
+   totalTimeIncludingLR: nat;
+   totalTimeToCompletion: nat;
+ };
+type TransactionStatus = 
+ variant {
+   active;
+   blockchain_completed;
+   completion_initiated;
+   exchanged;
+   land_registry_registered;
+ };
+type TransactionPartyRole = 
+ variant {
+   primary_buyer;
+   primary_seller;
+   secondary_buyer;
+   secondary_seller;
+ };
+type TransactionPartyProgress = 
+ record {
+   buyers: PartyProgress;
+   readyToExchange: bool;
+   sellers: PartyProgress;
+ };
+type TransactionParty = 
+ record {
+   amlComplete: bool;
+   amlStatus: AMLStatus;
+   email: text;
+   epcUploaded: bool;
+   isPrimary: bool;
+   joinedAt: Time;
+   mortgageAgreementUploaded: bool;
+   name: text;
+   "principal": principal;
+   proofOfAddressUploaded: bool;
+   proofOfFundsUploaded: bool;
+   proofOfIdentityUploaded: bool;
+   role: TransactionPartyRole;
+   ta10FormUploaded: bool;
+   ta6FormUploaded: bool;
+   titleDeedsUploaded: bool;
+ };
+type Transaction = 
+ record {
+   accessList: vec principal;
+   amount: nat64;
+   blockchainCompletedAt: opt int;
+   blockchainCompletionProof: opt text;
+   blockchainCompletionTimestamp: opt int;
+   buyer: principal;
+   buyerFundsHash: opt text;
+   buyerSolicitor: opt SolicitorRecord;
+   buyerSolicitorSignature: opt text;
+   buyers: opt vec TransactionParty;
+   chainPosition: opt nat;
+   chainedTransactions: vec text;
+   completionDate: text;
+   completionInitiatedAt: opt int;
+   completionStatementHash: opt text;
+   contractExchangeTimestamp: opt int;
+   createdAt: int;
+   createdBy: principal;
+   deposit: nat64;
+   exchangedAt: opt int;
+   id: text;
+   inviteCode: text;
+   landRegistryIntegration: LandRegistryIntegration;
+   landRegistryRegisteredAt: opt int;
+   linkToTransaction: opt text;
+   mode: text;
+   mortgageAmount: nat64;
+   oldStatus: text;
+   postcode: text;
+   previousOwner: text;
+   propertyAddress: text;
+   propertyCategory: text;
+   propertyId: text;
+   propertyType: text;
+   seller: principal;
+   sellerSolicitor: opt SolicitorRecord;
+   sellerSolicitorSignature: opt text;
+   sellers: opt vec TransactionParty;
+   solicitor: opt principal;
+   status: TransactionStatus;
+   titleNumber: text;
+   transactionType: text;
+   userRole: text;
+ };
+type Time = int;
+type TA7LeaseholdInformation = 
+ record {
+   alterationsAllowed: bool;
+   completedAt: opt int;
+   completedBy: principal;
+   freeholder: text;
+   groundRentAmount: nat;
+   groundRentPaymentFrequency: text;
+   lastModifiedAt: int;
+   lastModifiedBy: principal;
+   leaseExpiryDate: text;
+   leaseStartDate: text;
+   leaseTermYears: nat;
+   managingAgent: opt text;
+   petsAllowed: bool;
+   restrictions: text;
+   serviceChargeAmount: nat;
+   serviceChargePaymentFrequency: text;
+   sublettingAllowed: bool;
+ };
+type TA6PropertyInformation = 
+ record {
+   alterations: opt TA6Alterations;
+   boundaries: text;
+   boundaryDisputes: opt TA6BoundaryDisputes;
+   completedAt: opt int;
+   completedBy: principal;
+   connectionAgreements: text;
+   disputes: opt TA6Disputes;
+   environmentalDetails: text;
+   environmentalIssues: vec text;
+   estateManagement: opt TA6EstateManagement;
+   guarantees: text;
+   insurance: text;
+   lastModifiedAt: int;
+   lastModifiedBy: principal;
+   notices: opt TA6Notices;
+   otherInformation: text;
+   parkingDetails: text;
+   parkingSpaces: nat;
+   rightsAndEasements: text;
+   services: text;
+ };
+type TA6Notices = 
+ record {
+   details: text;
+   noticeType: text;
+ };
+type TA6EstateManagement = 
+ record {
+   annualCharge: nat;
+   isManaged: bool;
+   managementCompany: text;
+ };
+type TA6Disputes = 
+ record {
+   details: text;
+   disputeType: text;
+ };
+type TA6BoundaryDisputes = 
+ record {
+   details: text;
+   hasDisputes: bool;
+ };
+type TA6Alterations = 
+ record {
+   details: text;
+   hasAlterations: bool;
+   requiresPermission: bool;
+ };
+type TA10Room = 
+ record {
+   fittings: vec TA10FittingItem;
+   roomName: text;
+ };
+type TA10FittingsAndContents = 
+ record {
+   additionalItems: text;
+   completedAt: opt int;
+   completedBy: principal;
+   lastModifiedAt: int;
+   lastModifiedBy: principal;
+   outdoorItems: vec TA10FittingItem;
+   rooms: vec TA10Room;
+ };
+type TA10FittingItem = 
+ record {
+   included: bool;
+   item: text;
+   notes: opt text;
+ };
+type SolicitorTaskType = 
+ variant {
+   ap1_submission;
+   identity_certification;
+   tr1_preparation;
+ };
+type SolicitorTaskStatus = 
+ variant {
+   completed;
+   confirmed_by_client;
+   in_progress;
+   pending;
+ };
+type SolicitorTask = 
+ record {
+   completedAt: opt Time;
+   evidenceDocId: opt text;
+   priceGBP: nat;
+   startedAt: opt Time;
+   status: SolicitorTaskStatus;
+   taskType: SolicitorTaskType;
+ };
+type SolicitorRecord = 
+ record {
+   actingFor: variant {
+                both;
+                buyer;
+                seller;
+              };
+   consentRecordedAt: Time;
+   email: text;
+   firmName: text;
+   joinedAt: Time;
+   name: text;
+   piiCertUploaded: bool;
+   "principal": principal;
+   regNumber: text;
+   regulatoryBody: RegulatoryBody;
+   removalRequested: bool;
+   tasks: vec SolicitorTask;
+   verified: bool;
+ };
+type Result_9 = 
+ variant {
+   err: text;
+   ok: vec Transaction;
+ };
+type Result_8 = 
+ variant {
+   err: text;
+   ok: vec Notification;
+ };
+type Result_7 = 
+ variant {
+   err: text;
+   ok: record {
+         buyers: vec TransactionParty;
+         sellers: vec TransactionParty;
+       };
+ };
+type Result_6 = 
+ variant {
+   err: text;
+   ok: Transaction;
+ };
+type Result_5 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result_4 = 
+ variant {
+   err: text;
+   ok: ApplicationStatusUpdate;
+ };
+type Result_3 = 
+ variant {
+   err: text;
+   ok: OfficialSearchResult;
+ };
+type Result_2 = 
+ variant {
+   err: text;
+   ok: TransactionParty;
+ };
+type Result_18 = 
+ variant {
+   err: text;
+   ok: record {
+         text;
+         text;
+       };
+ };
+type Result_17 = 
+ variant {
+   err: text;
+   ok: Phase;
+ };
+type Result_16 = 
+ variant {
+   err: text;
+   ok: TransactionPartyProgress;
+ };
+type Result_15 = 
+ variant {
+   err: text;
+   ok: PhaseMilestones;
+ };
+type Result_14 = 
+ variant {
+   err: text;
+   ok:
+    record {
+      buyerSolicitor: opt SolicitorRecord;
+      sellerSolicitor: opt SolicitorRecord;
+    };
+ };
+type Result_13 = 
+ variant {
+   err: text;
+   ok: opt TA10FittingsAndContents;
+ };
+type Result_12 = 
+ variant {
+   err: text;
+   ok: opt TA6PropertyInformation;
+ };
+type Result_11 = 
+ variant {
+   err: text;
+   ok: opt TA7LeaseholdInformation;
+ };
+type Result_10 = 
+ variant {
+   err: text;
+   ok: vec BotConnection;
+ };
+type Result_1 = 
+ variant {
+   err: text;
+   ok;
+ };
+type Result = 
+ variant {
+   err: text;
+   ok: text;
+ };
+type Requisition = 
+ record {
+   category: text;
+   description: text;
+   isResolved: bool;
+   raisedAt: int;
+   requisitionId: text;
+   resolvedAt: opt int;
+   respondedAt: opt int;
+   responseText: opt text;
+ };
+type RegulatoryBody = 
+ variant {
+   clc;
+   sra;
+ };
+type PhaseMilestones = 
+ record {
+   contractDraftedAt: opt int;
+   searchesOrderedAt: opt int;
+ };
+type Phase = 
+ variant {
+   buyerSetup;
+   completed;
+   preCompletion;
+   preContract;
+   searches;
+   sellerPrep;
+ };
+type PartyProgress = 
+ record {
+   allAMLComplete: bool;
+   completedParties: nat;
+   overallProgress: nat;
+   parties: vec TransactionParty;
+   totalParties: nat;
+ };
+type OfficialSearchResult = 
+ record {
+   advisoryEntries: vec text;
+   certificateRef: text;
+   certificateTimestamp: text;
+   officialCopyTimestamp: opt text;
+   priorityExpiry: text;
+   registerChanged: bool;
+ };
+type Notification = 
+ record {
+   createdAt: Time;
+   docType: text;
+   documentHash: text;
+   id: nat;
+   message: text;
+   read: bool;
+   recipient: principal;
+   transactionId: text;
+   uploadedBy: principal;
+ };
+type LandRegistryStatus = 
+ variant {
+   application_received;
+   cancelled;
+   completed_with_notes;
+   failed;
+   not_initiated;
+   official_search_completed;
+   official_search_expired;
+   pending_official_search;
+   pending_submission;
+   pre_validation_failed;
+   queued_manual_processing;
+   registered;
+   rejected;
+   requisition_raised;
+   requisition_responded;
+   submitted;
+   under_examination;
+ };
+type LandRegistryIntegration = 
+ record {
+   advisoryEntries: vec text;
+   applicationFee: nat;
+   applicationReference: opt text;
+   caseworkerAssigned: opt bool;
+   estimatedCompletionDate: opt text;
+   estimatedLRCompletionTime: opt int;
+   landRegistryConfirmationNumber: opt text;
+   lastPolledAt: opt int;
+   lastUpdated: int;
+   lrPayloadID: opt text;
+   newTitleNumber: opt text;
+   officialSearchCertificateRef: opt text;
+   officialSearchCompletedAt: opt int;
+   officialSearchCost: nat;
+   officialSearchPriorityExpiry: opt int;
+   officialSearchRequestedAt: opt int;
+   pollCount: nat;
+   preValidationErrors: vec text;
+   registerChangedSinceSearch: opt bool;
+   registeredAt: opt int;
+   registrationNotes: vec text;
+   requisitions: vec Requisition;
+   status: LandRegistryStatus;
+   submissionResponseCode: opt nat;
+   submittedToLRAt: opt int;
+   totalLRCosts: nat;
+ };
+type BotConnection = 
+ record {
+   addedAt: int;
+   addedBy: principal;
+   name: text;
+   "principal": principal;
+ };
+type ApplicationStatusUpdate = 
+ record {
+   applicationReference: text;
+   currentStatus: LandRegistryStatus;
+   estimatedCompletionDate: opt text;
+   lastUpdated: text;
+   previousStatus: LandRegistryStatus;
+   statusChanged: bool;
+ };
+type AMLStatus = 
+ variant {
+   not_started;
+   pending;
+   rejected;
+   verified;
+ };
+service : {
+  addParty: (transactionId: text, name: text, email: text, roleText: 
+   text, isPrimary: bool) -> (Result_2);
+  adminForceDeleteTransaction: (transactionId: text) -> (Result);
+  assignBuyer: (transactionId: text, buyerPrincipal: principal) -> (Result);
+  assignSolicitor: (transactionId: text, solicitorPrincipal: principal) ->
+   (Result);
+  assignSolicitorRecord: (transactionId: text, solicitorRecord:
+   SolicitorRecord) -> (Result_1);
+  bootstrapDocumentStorageCanister: (canisterId: principal) -> (Result);
+  canAccessTransaction: (transactionId: text) -> (bool) query;
+  connectBot: (transactionId: text, botPrincipal: principal, botName:
+   text) -> (Result_1);
+  consumeLandRegistryNotification: (notificationType: text,
+   applicationReference: opt text, titleNumber: opt text, message: text,
+   _metadata: vec record {
+                    text;
+                    text;
+                  }) -> (Result_1);
+  createTransaction: (propertyId: text, propertyAddress: text, postcode:
+   text, titleNumber: text, seller: principal, previousOwner: text, amount:
+   nat64, transactionType: text, userRole: text, propertyType: text,
+   propertyCategory: text, mode: text, deposit: nat64, mortgageAmount: 
+   nat64, completionDate: text) -> (text);
+  createTransactionWithInvite: (propertyId: text, propertyAddress: text,
+   postcode: text, titleNumber: text, seller: principal, previousOwner: 
+   text, amount: nat64, transactionType: text, userRole: text, propertyType:
+   text, propertyCategory: text, mode: text, deposit: nat64, mortgageAmount:
+   nat64, completionDate: text) -> (Result_18);
+  deleteTransaction: (transactionId: text) -> (Result);
+  disconnectBot: (transactionId: text, botPrincipal: principal) -> (Result_1);
+  doesTransactionExist: (transactionId: text) -> (bool) query;
+  getAllInviteCodes: () -> (vec record {
+                                  text;
+                                  text;
+                                }) query;
+  getAllTransactions: () -> (vec Transaction) query;
+  getCurrentPhase: (transactionId: text) -> (Result_17) query;
+  getCycles: () -> (nat) query;
+  getDocumentStorageCanister: () -> (opt principal) query;
+  getExpiringSearches: (withinDays: nat) -> (vec Transaction) query;
+  getFlowState: (transactionId: text) -> (opt text) query;
+  getInviteCode: (transactionId: text) -> (Result) query;
+  getLandRegistryDetail: (transactionID: text) ->
+   (opt LandRegistryIntegration) query;
+  getListingData: (transactionId: text) -> (opt text) query;
+  getMyNotifications: () -> (vec Notification) query;
+  getMyTransactions: () -> (vec Transaction) query;
+  getOutstandingRequisitions: () -> (vec record {
+                                           text;
+                                           Requisition;
+                                         }) query;
+  getPartyProgress: (transactionId: text) -> (Result_16) query;
+  getPendingLRApplications: () -> (vec Transaction) query;
+  getPhaseMilestones: (transactionId: text) -> (Result_15) query;
+  getSolicitorStatus: (transactionId: text) -> (Result_14) query;
+  getTA10: (txId: text) -> (Result_13) query;
+  getTA6: (txId: text) -> (Result_12) query;
+  getTA7: (txId: text) -> (Result_11) query;
+  getTransaction: (id: text) -> (opt Transaction) query;
+  getTransactionBots: (transactionId: text) -> (Result_10) query;
+  getTransactionByInviteCode: (inviteCode: text) -> (opt Transaction);
+  getTransactionChain: (transactionId: text) -> (Result_9) query;
+  getTransactionNotifications: (transactionId: text) -> (Result_8) query;
+  getTransactionParties: (transactionId: text) -> (Result_7) query;
+  getTransactionsByStatus: (status: TransactionStatus) ->
+   (vec Transaction) query;
+  getTransactionsForPrincipal: ("principal": principal) ->
+   (vec Transaction) query;
+  getTransactionsNeedingSearch: () -> (vec Transaction) query;
+  getUnreadNotificationCount: () -> (nat) query;
+  getUnreadNotificationCountForPrincipal: ("principal": principal) ->
+   (nat) query;
+  getUserManagementCanister: () -> (text) query;
+  get_transaction_timeline: (transactionID: text) ->
+   (opt TransactionTimeline) query;
+  initiate_blockchain_completion: (transactionID: text, buyerFundsHash: 
+   text, completionStatementHash: text) -> (Result);
+  joinTransactionByInviteCode: (inviteCode: text) -> (Result_6);
+  linkTransactionToChain: (myTransactionId: text, buyingTransactionId:
+   text) -> (Result_1);
+  markAllNotificationsRead: () -> (nat);
+  markContractDrafted: (transactionId: text) -> (Result_1);
+  markNotificationRead: (notificationId: nat) -> (Result_1);
+  markSearchesOrdered: (transactionId: text) -> (Result_1);
+  onDocumentRegistered: (transactionId: text, docType: text, documentHash:
+   text, uploadedBy: principal) -> ();
+  on_blockchain_completion_success: (transactionID: text) -> (Result);
+  pollAllPendingApplications: () -> (Result_5);
+  pollApplicationStatus: (transactionID: text) -> (Result_4);
+  recordContractExchange: (transactionID: text, buyerSolicitorSignature:
+   text, sellerSolicitorSignature: text) -> (Result);
+  recordFormUpload: (txId: text, formType: text, fileHash: text, fileName:
+   text) -> (Result_1);
+  /// Record a single party's signature on-chain.
+  /// The canister identifies the caller as buyer or seller from the transaction principals.
+  /// When both parties have signed, the status auto-advances to #exchanged.
+  recordPartySignature: (transactionID: text, signatureHash: text,
+   signingRole: text) -> (Result);
+  recordRequisition: (transactionID: text, requisition: Requisition) ->
+   (Result_1);
+  removeParty: (transactionId: text, partyPrincipal: principal) -> (Result_1);
+  removeSolicitor: (transactionId: text, side: variant {
+                                                 buyer;
+                                                 seller;
+                                               }) -> (Result_1);
+  requestOfficialSearch: (transactionID: text) -> (Result_3);
+  respondToRequisition: (transactionID: text, requisitionId: text,
+   responseText: text, _supportingDocumentHashes: vec text) -> (Result_1);
+  revokeBuyer: (transactionId: text, buyerPrincipal: principal) -> (Result);
+  setDocumentStorageCanister: (canisterId: principal) -> (Result);
+  setFlowState: (transactionId: text, jsonData: text) -> (Result);
+  setListingData: (transactionId: text, jsonData: text) -> (Result);
+  setUserManagementCanister: (canisterId: text) -> (Result);
+  trigger_land_registry_submission: (transactionID: text) -> (Result);
+  updatePartyAMLDoc: (transactionId: text, partyPrincipal: principal,
+   docType: text) -> (Result_2);
+  updateSolicitorTaskStatus: (transactionId: text, taskType:
+   SolicitorTaskType, newStatus: SolicitorTaskStatus, evidenceDocId:
+   opt text) -> (Result_1);
+  updateSolicitorVerification: (transactionId: text, side:
+   variant {
+     buyer;
+     seller;
+   }, verified: bool) -> (Result_1);
+  updateTA10: (txId: text, data: TA10FittingsAndContents) -> (Result_1);
+  updateTA6: (txId: text, data: TA6PropertyInformation) -> (Result_1);
+  updateTA7: (txId: text, data: TA7LeaseholdInformation) -> (Result_1);
+  updateTransactionStatus: (transactionId: nat, newStatus: text) -> (bool);
+  update_land_registry_status: (transactionID: text, lrStatus:
+   LandRegistryStatus, confirmationNumber: opt text, estimatedCompletionTime:
+   opt int) -> (Result);
+}