@propxchain/core-client 0.1.0-canary.3

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

@@ -0,0 +1,517 @@
+import type { Principal } from '@dfinity/principal';
+import type { ActorMethod } from '@dfinity/agent';
+import type { IDL } from '@dfinity/candid';
+
+export type AMLStatus = { 'verified' : null } |
+  { 'pending' : null } |
+  { 'rejected' : null } |
+  { 'not_started' : null };
+export interface ApplicationStatusUpdate {
+  'lastUpdated' : string,
+  'applicationReference' : string,
+  'estimatedCompletionDate' : [] | [string],
+  'statusChanged' : boolean,
+  'currentStatus' : LandRegistryStatus,
+  'previousStatus' : LandRegistryStatus,
+}
+export interface BotConnection {
+  'principal' : Principal,
+  'name' : string,
+  'addedAt' : bigint,
+  'addedBy' : Principal,
+}
+export interface LandRegistryIntegration {
+  'status' : LandRegistryStatus,
+  'lastPolledAt' : [] | [bigint],
+  'advisoryEntries' : Array<string>,
+  'officialSearchCost' : bigint,
+  'officialSearchRequestedAt' : [] | [bigint],
+  'registerChangedSinceSearch' : [] | [boolean],
+  'officialSearchCompletedAt' : [] | [bigint],
+  'registrationNotes' : Array<string>,
+  'lastUpdated' : bigint,
+  'estimatedLRCompletionTime' : [] | [bigint],
+  'applicationReference' : [] | [string],
+  'officialSearchPriorityExpiry' : [] | [bigint],
+  'officialSearchCertificateRef' : [] | [string],
+  'preValidationErrors' : Array<string>,
+  'applicationFee' : bigint,
+  'caseworkerAssigned' : [] | [boolean],
+  'lrPayloadID' : [] | [string],
+  'requisitions' : Array<Requisition>,
+  'submissionResponseCode' : [] | [bigint],
+  'submittedToLRAt' : [] | [bigint],
+  'pollCount' : bigint,
+  'estimatedCompletionDate' : [] | [string],
+  'registeredAt' : [] | [bigint],
+  'newTitleNumber' : [] | [string],
+  'totalLRCosts' : bigint,
+  'landRegistryConfirmationNumber' : [] | [string],
+}
+export type LandRegistryStatus = { 'cancelled' : null } |
+  { 'submitted' : null } |
+  { 'completed_with_notes' : null } |
+  { 'under_examination' : null } |
+  { 'requisition_raised' : null } |
+  { 'pending_official_search' : null } |
+  { 'not_initiated' : null } |
+  { 'pending_submission' : null } |
+  { 'pre_validation_failed' : null } |
+  { 'queued_manual_processing' : null } |
+  { 'application_received' : null } |
+  { 'official_search_completed' : null } |
+  { 'requisition_responded' : null } |
+  { 'rejected' : null } |
+  { 'official_search_expired' : null } |
+  { 'failed' : null } |
+  { 'registered' : null };
+export interface Notification {
+  'id' : bigint,
+  'documentHash' : string,
+  'createdAt' : Time,
+  'read' : boolean,
+  'recipient' : Principal,
+  'message' : string,
+  'docType' : string,
+  'uploadedBy' : Principal,
+  'transactionId' : string,
+}
+export interface OfficialSearchResult {
+  'officialCopyTimestamp' : [] | [string],
+  'advisoryEntries' : Array<string>,
+  'certificateTimestamp' : string,
+  'registerChanged' : boolean,
+  'priorityExpiry' : string,
+  'certificateRef' : string,
+}
+export interface PartyProgress {
+  'completedParties' : bigint,
+  'overallProgress' : bigint,
+  'allAMLComplete' : boolean,
+  'totalParties' : bigint,
+  'parties' : Array<TransactionParty>,
+}
+export type Phase = { 'buyerSetup' : null } |
+  { 'preContract' : null } |
+  { 'completed' : null } |
+  { 'sellerPrep' : null } |
+  { 'preCompletion' : null } |
+  { 'searches' : null };
+export interface PhaseMilestones {
+  'contractDraftedAt' : [] | [bigint],
+  'searchesOrderedAt' : [] | [bigint],
+}
+export type RegulatoryBody = { 'clc' : null } |
+  { 'sra' : null };
+export interface Requisition {
+  'requisitionId' : string,
+  'description' : string,
+  'isResolved' : boolean,
+  'category' : string,
+  'raisedAt' : bigint,
+  'responseText' : [] | [string],
+  'respondedAt' : [] | [bigint],
+  'resolvedAt' : [] | [bigint],
+}
+export type Result = { 'ok' : string } |
+  { 'err' : string };
+export type Result_1 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_10 = { 'ok' : Array<BotConnection> } |
+  { 'err' : string };
+export type Result_11 = { 'ok' : [] | [TA7LeaseholdInformation] } |
+  { 'err' : string };
+export type Result_12 = { 'ok' : [] | [TA6PropertyInformation] } |
+  { 'err' : string };
+export type Result_13 = { 'ok' : [] | [TA10FittingsAndContents] } |
+  { 'err' : string };
+export type Result_14 = {
+    'ok' : {
+      'sellerSolicitor' : [] | [SolicitorRecord],
+      'buyerSolicitor' : [] | [SolicitorRecord],
+    }
+  } |
+  { 'err' : string };
+export type Result_15 = { 'ok' : PhaseMilestones } |
+  { 'err' : string };
+export type Result_16 = { 'ok' : TransactionPartyProgress } |
+  { 'err' : string };
+export type Result_17 = { 'ok' : Phase } |
+  { 'err' : string };
+export type Result_18 = { 'ok' : [string, string] } |
+  { 'err' : string };
+export type Result_2 = { 'ok' : TransactionParty } |
+  { 'err' : string };
+export type Result_3 = { 'ok' : OfficialSearchResult } |
+  { 'err' : string };
+export type Result_4 = { 'ok' : ApplicationStatusUpdate } |
+  { 'err' : string };
+export type Result_5 = { 'ok' : bigint } |
+  { 'err' : string };
+export type Result_6 = { 'ok' : Transaction } |
+  { 'err' : string };
+export type Result_7 = {
+    'ok' : {
+      'sellers' : Array<TransactionParty>,
+      'buyers' : Array<TransactionParty>,
+    }
+  } |
+  { 'err' : string };
+export type Result_8 = { 'ok' : Array<Notification> } |
+  { 'err' : string };
+export type Result_9 = { 'ok' : Array<Transaction> } |
+  { 'err' : string };
+export interface SolicitorRecord {
+  'consentRecordedAt' : Time,
+  'tasks' : Array<SolicitorTask>,
+  'regNumber' : string,
+  'principal' : Principal,
+  'verified' : boolean,
+  'name' : string,
+  'joinedAt' : Time,
+  'firmName' : string,
+  'piiCertUploaded' : boolean,
+  'email' : string,
+  'actingFor' : { 'both' : null } |
+    { 'seller' : null } |
+    { 'buyer' : null },
+  'removalRequested' : boolean,
+  'regulatoryBody' : RegulatoryBody,
+}
+export interface SolicitorTask {
+  'status' : SolicitorTaskStatus,
+  'completedAt' : [] | [Time],
+  'startedAt' : [] | [Time],
+  'taskType' : SolicitorTaskType,
+  'evidenceDocId' : [] | [string],
+  'priceGBP' : bigint,
+}
+export type SolicitorTaskStatus = { 'pending' : null } |
+  { 'in_progress' : null } |
+  { 'completed' : null } |
+  { 'confirmed_by_client' : null };
+export type SolicitorTaskType = { 'identity_certification' : null } |
+  { 'ap1_submission' : null } |
+  { 'tr1_preparation' : null };
+export interface TA10FittingItem {
+  'item' : string,
+  'included' : boolean,
+  'notes' : [] | [string],
+}
+export interface TA10FittingsAndContents {
+  'completedAt' : [] | [bigint],
+  'completedBy' : Principal,
+  'additionalItems' : string,
+  'outdoorItems' : Array<TA10FittingItem>,
+  'lastModifiedAt' : bigint,
+  'lastModifiedBy' : Principal,
+  'rooms' : Array<TA10Room>,
+}
+export interface TA10Room {
+  'fittings' : Array<TA10FittingItem>,
+  'roomName' : string,
+}
+export interface TA6Alterations {
+  'hasAlterations' : boolean,
+  'requiresPermission' : boolean,
+  'details' : string,
+}
+export interface TA6BoundaryDisputes {
+  'details' : string,
+  'hasDisputes' : boolean,
+}
+export interface TA6Disputes { 'details' : string, 'disputeType' : string }
+export interface TA6EstateManagement {
+  'isManaged' : boolean,
+  'annualCharge' : bigint,
+  'managementCompany' : string,
+}
+export interface TA6Notices { 'noticeType' : string, 'details' : string }
+export interface TA6PropertyInformation {
+  'completedAt' : [] | [bigint],
+  'completedBy' : Principal,
+  'disputes' : [] | [TA6Disputes],
+  'boundaries' : string,
+  'otherInformation' : string,
+  'notices' : [] | [TA6Notices],
+  'environmentalDetails' : string,
+  'guarantees' : string,
+  'insurance' : string,
+  'alterations' : [] | [TA6Alterations],
+  'estateManagement' : [] | [TA6EstateManagement],
+  'environmentalIssues' : Array<string>,
+  'boundaryDisputes' : [] | [TA6BoundaryDisputes],
+  'lastModifiedAt' : bigint,
+  'lastModifiedBy' : Principal,
+  'parkingDetails' : string,
+  'connectionAgreements' : string,
+  'services' : string,
+  'rightsAndEasements' : string,
+  'parkingSpaces' : bigint,
+}
+export interface TA7LeaseholdInformation {
+  'completedAt' : [] | [bigint],
+  'completedBy' : Principal,
+  'restrictions' : string,
+  'serviceChargePaymentFrequency' : string,
+  'freeholder' : string,
+  'groundRentPaymentFrequency' : string,
+  'serviceChargeAmount' : bigint,
+  'sublettingAllowed' : boolean,
+  'groundRentAmount' : bigint,
+  'leaseExpiryDate' : string,
+  'lastModifiedAt' : bigint,
+  'lastModifiedBy' : Principal,
+  'leaseTermYears' : bigint,
+  'petsAllowed' : boolean,
+  'managingAgent' : [] | [string],
+  'leaseStartDate' : string,
+  'alterationsAllowed' : boolean,
+}
+export type Time = bigint;
+export interface Transaction {
+  'id' : string,
+  'status' : TransactionStatus,
+  'buyerFundsHash' : [] | [string],
+  'userRole' : string,
+  'oldStatus' : string,
+  'postcode' : string,
+  'exchangedAt' : [] | [bigint],
+  'propertyCategory' : string,
+  'transactionType' : string,
+  'completionDate' : string,
+  'completionStatementHash' : [] | [string],
+  'landRegistryRegisteredAt' : [] | [bigint],
+  'sellerSolicitorSignature' : [] | [string],
+  'propertyType' : string,
+  'completionInitiatedAt' : [] | [bigint],
+  'buyerSolicitorSignature' : [] | [string],
+  'titleNumber' : string,
+  'mode' : string,
+  'createdAt' : bigint,
+  'createdBy' : Principal,
+  'blockchainCompletionProof' : [] | [string],
+  'blockchainCompletedAt' : [] | [bigint],
+  'accessList' : Array<Principal>,
+  'solicitor' : [] | [Principal],
+  'sellerSolicitor' : [] | [SolicitorRecord],
+  'chainedTransactions' : Array<string>,
+  'previousOwner' : string,
+  'propertyId' : string,
+  'propertyAddress' : string,
+  'deposit' : bigint,
+  'seller' : Principal,
+  'contractExchangeTimestamp' : [] | [bigint],
+  'sellers' : [] | [Array<TransactionParty>],
+  'mortgageAmount' : bigint,
+  'inviteCode' : string,
+  'chainPosition' : [] | [bigint],
+  'buyer' : Principal,
+  'landRegistryIntegration' : LandRegistryIntegration,
+  'amount' : bigint,
+  'buyers' : [] | [Array<TransactionParty>],
+  'linkToTransaction' : [] | [string],
+  'buyerSolicitor' : [] | [SolicitorRecord],
+  'blockchainCompletionTimestamp' : [] | [bigint],
+}
+export interface TransactionParty {
+  'amlComplete' : boolean,
+  'amlStatus' : AMLStatus,
+  'principal' : Principal,
+  'epcUploaded' : boolean,
+  'proofOfIdentityUploaded' : boolean,
+  'mortgageAgreementUploaded' : boolean,
+  'name' : string,
+  'joinedAt' : Time,
+  'role' : TransactionPartyRole,
+  'email' : string,
+  'isPrimary' : boolean,
+  'proofOfAddressUploaded' : boolean,
+  'proofOfFundsUploaded' : boolean,
+  'titleDeedsUploaded' : boolean,
+  'ta6FormUploaded' : boolean,
+  'ta10FormUploaded' : boolean,
+}
+export interface TransactionPartyProgress {
+  'readyToExchange' : boolean,
+  'sellers' : PartyProgress,
+  'buyers' : PartyProgress,
+}
+export type TransactionPartyRole = { 'secondary_seller' : null } |
+  { 'primary_buyer' : null } |
+  { 'secondary_buyer' : null } |
+  { 'primary_seller' : null };
+export type TransactionStatus = { 'completion_initiated' : null } |
+  { 'active' : null } |
+  { 'blockchain_completed' : null } |
+  { 'exchanged' : null } |
+  { 'land_registry_registered' : null };
+export interface TransactionTimeline {
+  'exchangedAt' : [] | [bigint],
+  'landRegistryRegisteredAt' : [] | [bigint],
+  'completionInitiatedAt' : [] | [bigint],
+  'createdAt' : bigint,
+  'blockchainCompletedAt' : [] | [bigint],
+  'totalTimeToCompletion' : bigint,
+  'totalTimeIncludingLR' : bigint,
+}
+export interface _SERVICE {
+  'addParty' : ActorMethod<[string, string, string, string, boolean], Result_2>,
+  'adminForceDeleteTransaction' : ActorMethod<[string], Result>,
+  'assignBuyer' : ActorMethod<[string, Principal], Result>,
+  'assignSolicitor' : ActorMethod<[string, Principal], Result>,
+  'assignSolicitorRecord' : ActorMethod<[string, SolicitorRecord], Result_1>,
+  'bootstrapDocumentStorageCanister' : ActorMethod<[Principal], Result>,
+  'canAccessTransaction' : ActorMethod<[string], boolean>,
+  'connectBot' : ActorMethod<[string, Principal, string], Result_1>,
+  'consumeLandRegistryNotification' : ActorMethod<
+    [string, [] | [string], [] | [string], string, Array<[string, string]>],
+    Result_1
+  >,
+  'createTransaction' : ActorMethod<
+    [
+      string,
+      string,
+      string,
+      string,
+      Principal,
+      string,
+      bigint,
+      string,
+      string,
+      string,
+      string,
+      string,
+      bigint,
+      bigint,
+      string,
+    ],
+    string
+  >,
+  'createTransactionWithInvite' : ActorMethod<
+    [
+      string,
+      string,
+      string,
+      string,
+      Principal,
+      string,
+      bigint,
+      string,
+      string,
+      string,
+      string,
+      string,
+      bigint,
+      bigint,
+      string,
+    ],
+    Result_18
+  >,
+  'deleteTransaction' : ActorMethod<[string], Result>,
+  'disconnectBot' : ActorMethod<[string, Principal], Result_1>,
+  'doesTransactionExist' : ActorMethod<[string], boolean>,
+  'getAllInviteCodes' : ActorMethod<[], Array<[string, string]>>,
+  'getAllTransactions' : ActorMethod<[], Array<Transaction>>,
+  'getCurrentPhase' : ActorMethod<[string], Result_17>,
+  'getCycles' : ActorMethod<[], bigint>,
+  'getDocumentStorageCanister' : ActorMethod<[], [] | [Principal]>,
+  'getExpiringSearches' : ActorMethod<[bigint], Array<Transaction>>,
+  'getFlowState' : ActorMethod<[string], [] | [string]>,
+  'getInviteCode' : ActorMethod<[string], Result>,
+  'getLandRegistryDetail' : ActorMethod<
+    [string],
+    [] | [LandRegistryIntegration]
+  >,
+  'getListingData' : ActorMethod<[string], [] | [string]>,
+  'getMyNotifications' : ActorMethod<[], Array<Notification>>,
+  'getMyTransactions' : ActorMethod<[], Array<Transaction>>,
+  'getOutstandingRequisitions' : ActorMethod<[], Array<[string, Requisition]>>,
+  'getPartyProgress' : ActorMethod<[string], Result_16>,
+  'getPendingLRApplications' : ActorMethod<[], Array<Transaction>>,
+  'getPhaseMilestones' : ActorMethod<[string], Result_15>,
+  'getSolicitorStatus' : ActorMethod<[string], Result_14>,
+  'getTA10' : ActorMethod<[string], Result_13>,
+  'getTA6' : ActorMethod<[string], Result_12>,
+  'getTA7' : ActorMethod<[string], Result_11>,
+  'getTransaction' : ActorMethod<[string], [] | [Transaction]>,
+  'getTransactionBots' : ActorMethod<[string], Result_10>,
+  'getTransactionByInviteCode' : ActorMethod<[string], [] | [Transaction]>,
+  'getTransactionChain' : ActorMethod<[string], Result_9>,
+  'getTransactionNotifications' : ActorMethod<[string], Result_8>,
+  'getTransactionParties' : ActorMethod<[string], Result_7>,
+  'getTransactionsByStatus' : ActorMethod<
+    [TransactionStatus],
+    Array<Transaction>
+  >,
+  'getTransactionsForPrincipal' : ActorMethod<[Principal], Array<Transaction>>,
+  'getTransactionsNeedingSearch' : ActorMethod<[], Array<Transaction>>,
+  'getUnreadNotificationCount' : ActorMethod<[], bigint>,
+  'getUnreadNotificationCountForPrincipal' : ActorMethod<[Principal], bigint>,
+  'getUserManagementCanister' : ActorMethod<[], string>,
+  'get_transaction_timeline' : ActorMethod<
+    [string],
+    [] | [TransactionTimeline]
+  >,
+  'initiate_blockchain_completion' : ActorMethod<
+    [string, string, string],
+    Result
+  >,
+  'joinTransactionByInviteCode' : ActorMethod<[string], Result_6>,
+  'linkTransactionToChain' : ActorMethod<[string, string], Result_1>,
+  'markAllNotificationsRead' : ActorMethod<[], bigint>,
+  'markContractDrafted' : ActorMethod<[string], Result_1>,
+  'markNotificationRead' : ActorMethod<[bigint], Result_1>,
+  'markSearchesOrdered' : ActorMethod<[string], Result_1>,
+  'onDocumentRegistered' : ActorMethod<
+    [string, string, string, Principal],
+    undefined
+  >,
+  'on_blockchain_completion_success' : ActorMethod<[string], Result>,
+  'pollAllPendingApplications' : ActorMethod<[], Result_5>,
+  'pollApplicationStatus' : ActorMethod<[string], Result_4>,
+  'recordContractExchange' : ActorMethod<[string, string, string], Result>,
+  'recordFormUpload' : ActorMethod<[string, string, string, string], 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' : ActorMethod<[string, string, string], Result>,
+  'recordRequisition' : ActorMethod<[string, Requisition], Result_1>,
+  'removeParty' : ActorMethod<[string, Principal], Result_1>,
+  'removeSolicitor' : ActorMethod<
+    [string, { 'seller' : null } | { 'buyer' : null }],
+    Result_1
+  >,
+  'requestOfficialSearch' : ActorMethod<[string], Result_3>,
+  'respondToRequisition' : ActorMethod<
+    [string, string, string, Array<string>],
+    Result_1
+  >,
+  'revokeBuyer' : ActorMethod<[string, Principal], Result>,
+  'setDocumentStorageCanister' : ActorMethod<[Principal], Result>,
+  'setFlowState' : ActorMethod<[string, string], Result>,
+  'setListingData' : ActorMethod<[string, string], Result>,
+  'setUserManagementCanister' : ActorMethod<[string], Result>,
+  'trigger_land_registry_submission' : ActorMethod<[string], Result>,
+  'updatePartyAMLDoc' : ActorMethod<[string, Principal, string], Result_2>,
+  'updateSolicitorTaskStatus' : ActorMethod<
+    [string, SolicitorTaskType, SolicitorTaskStatus, [] | [string]],
+    Result_1
+  >,
+  'updateSolicitorVerification' : ActorMethod<
+    [string, { 'seller' : null } | { 'buyer' : null }, boolean],
+    Result_1
+  >,
+  'updateTA10' : ActorMethod<[string, TA10FittingsAndContents], Result_1>,
+  'updateTA6' : ActorMethod<[string, TA6PropertyInformation], Result_1>,
+  'updateTA7' : ActorMethod<[string, TA7LeaseholdInformation], Result_1>,
+  'updateTransactionStatus' : ActorMethod<[bigint, string], boolean>,
+  'update_land_registry_status' : ActorMethod<
+    [string, LandRegistryStatus, [] | [string], [] | [bigint]],
+    Result
+  >,
+}
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];