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

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

@@ -1,112 +1,236 @@
-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 interface AuditLog {
-  'id' : bigint,
-  'action' : string,
-  'performedBy' : Principal,
-  'timestamp' : Time,
-  'details' : string,
-  'success' : boolean,
-  'documentId' : bigint,
-}
-export interface DocumentMetadata {
-  'id' : bigint,
-  'documentHash' : string,
-  'documentType' : string,
-  'contentType' : [] | [string],
-  'propertyId' : bigint,
-  'fileName' : [] | [string],
-  'fileSize' : [] | [bigint],
-  'isVerified' : boolean,
-  'lastVerificationId' : [] | [bigint],
-  'storageDocumentId' : [] | [bigint],
-  'uploadedAt' : Time,
-  'uploadedBy' : Principal,
-  'transactionId' : [] | [bigint],
-}
-export interface DocumentVerification {
-  'id' : bigint,
-  'documentType' : string,
-  'verificationDate' : Time,
-  'expiresAt' : [] | [Time],
-  'failureReason' : [] | [string],
-  'propertyId' : bigint,
-  'hashVerified' : boolean,
-  'notes' : [] | [string],
-  'documentId' : bigint,
-  'isValid' : boolean,
-  'expectedHash' : string,
-  'calculatedHash' : string,
-  'verifiedBy' : Principal,
-  'verificationMethod' : VerificationMethod,
-}
-export type Result = { 'ok' : DocumentVerification } |
-  { 'err' : string };
-export type Time = bigint;
-export type VerificationMethod = { 'passport_dcs' : null } |
-  { 'commercial_api' : string } |
-  { 'system_hash_only' : null } |
-  { 'manual_solicitor' : null } |
-  { 'dvla_api' : null };
-export interface _SERVICE {
-  'deleteDocument' : ActorMethod<
-    [bigint],
-    { 'ok' : null } |
-      { 'err' : string }
-  >,
-  'getAuditLogs' : ActorMethod<[], Array<AuditLog>>,
-  'getConfiguration' : ActorMethod<
-    [],
-    {
-      'userManagement' : [] | [Principal],
-      'documentStorage' : [] | [Principal],
-    }
-  >,
-  'getCycles' : ActorMethod<[], bigint>,
-  'getDocument' : ActorMethod<[bigint], [] | [DocumentMetadata]>,
-  'getDocumentVerifications' : ActorMethod<
-    [bigint],
-    Array<DocumentVerification>
-  >,
-  'getPropertyDocuments' : ActorMethod<[bigint], Array<DocumentMetadata>>,
-  'getRecentAuditLogs' : ActorMethod<[bigint], Array<AuditLog>>,
-  'getStats' : ActorMethod<
-    [],
-    {
-      'totalVerifications' : bigint,
-      'totalAuditLogs' : bigint,
-      'verifiedDocuments' : bigint,
-      'totalDocuments' : bigint,
-    }
-  >,
-  'getUnverifiedDocuments' : ActorMethod<[bigint], Array<DocumentMetadata>>,
-  'getVerification' : ActorMethod<[bigint], [] | [DocumentVerification]>,
-  'getVerificationsByVerifier' : ActorMethod<
-    [Principal],
-    Array<DocumentVerification>
-  >,
-  'registerDocument' : ActorMethod<
-    [
-      bigint,
-      [] | [bigint],
-      string,
-      string,
-      [] | [bigint],
-      [] | [string],
-      [] | [bigint],
-      [] | [string],
-    ],
-    bigint
-  >,
-  'setDocumentStorageCanister' : ActorMethod<[Principal], undefined>,
-  'setUserManagementCanister' : ActorMethod<[Principal], undefined>,
-  'verifyDocument' : ActorMethod<[bigint], boolean>,
-  'verifyDocumentWithHash' : ActorMethod<[bigint, [] | [string]], Result>,
-  'verifyWithCommercialAPI' : ActorMethod<[bigint, string, string], Result>,
-  'verifyWithDVLA' : ActorMethod<[bigint, string], Result>,
-  'verifyWithPassportDCS' : ActorMethod<[bigint, string], Result>,
-}
-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 ActorType = { 'agent' : null } |
+  { 'systemActor' : null } |
+  { 'user' : null };
+export interface AuditLog {
+  'id' : bigint,
+  'action' : string,
+  'actorType' : ActorType,
+  'delegatedBy' : [] | [Principal],
+  'performedBy' : Principal,
+  'timestamp' : Time,
+  'details' : string,
+  'success' : boolean,
+  'documentId' : bigint,
+}
+export interface DataMismatch {
+  'field' : string,
+  'found' : string,
+  'expected' : string,
+}
+export interface DocumentMetadata {
+  'id' : bigint,
+  'documentHash' : string,
+  'documentType' : string,
+  'contentType' : [] | [string],
+  'propertyId' : bigint,
+  'fileName' : [] | [string],
+  'fileSize' : [] | [bigint],
+  'isVerified' : boolean,
+  'lastVerificationId' : [] | [bigint],
+  'storageDocumentId' : [] | [bigint],
+  'uploadedAt' : Time,
+  'uploadedBy' : Principal,
+  'transactionId' : [] | [bigint],
+}
+export interface DocumentVerification {
+  'id' : bigint,
+  'documentType' : string,
+  'verificationDate' : Time,
+  'expiresAt' : [] | [Time],
+  'failureReason' : [] | [string],
+  'propertyId' : bigint,
+  'hashVerified' : boolean,
+  'notes' : [] | [string],
+  'documentId' : bigint,
+  'isValid' : boolean,
+  'expectedHash' : string,
+  'calculatedHash' : string,
+  'verifiedBy' : Principal,
+  'verificationMethod' : VerificationMethod,
+}
+export interface LRDocumentSummary {
+  'documentType' : LRDocumentType,
+  'isVerified' : boolean,
+  'isCurrent' : boolean,
+  'landRegistryReference' : [] | [string],
+  'validUntil' : [] | [bigint],
+}
+export type LRDocumentType = { 'LandChargesSearchK16' : null } |
+  { 'OfficialSearchCertificate' : null } |
+  { 'SearchOfPartCertificate' : null } |
+  { 'RegisterExtract' : null } |
+  { 'OfficialCopyRegister' : null } |
+  { 'LocalAuthoritySearch' : null } |
+  { 'OfficialCopyTitlePlan' : null } |
+  { 'CompletionConfirmation' : null } |
+  { 'AP1Acknowledgement' : null } |
+  { 'RequisitionNotice' : null };
+export interface OSCertificateVerification {
+  'priorityStatus' : PriorityStatus,
+  'registerChangedFlag' : [] | [boolean],
+  'advisoryEntries' : Array<string>,
+  'hashVerified' : boolean,
+  'priorityExpiry' : [] | [bigint],
+  'titleNumberMatches' : boolean,
+  'daysRemaining' : [] | [bigint],
+  'verifiedAt' : bigint,
+  'verifiedBy' : Principal,
+}
+export interface OfficialCopyVerification {
+  'documentAge' : bigint,
+  'hashVerified' : boolean,
+  'issuedAt' : bigint,
+  'titleNumberMatches' : boolean,
+  'isCurrent' : boolean,
+  'copyType' : LRDocumentType,
+  'verifiedAt' : bigint,
+  'verifiedBy' : Principal,
+}
+export interface OscarIssue {
+  'field' : [] | [string],
+  'code' : string,
+  'message' : string,
+  'severity' : { 'warning' : null } |
+    { 'info' : null } |
+    { 'error' : null },
+}
+export interface OscarVerificationDetails {
+  'documentType' : string,
+  'requiresSolicitorReview' : boolean,
+  'extractedData' : string,
+  'issues' : Array<OscarIssue>,
+  'mismatches' : Array<DataMismatch>,
+  'confidence' : bigint,
+  'analysisTimestamp' : Time,
+}
+export interface OscarVerificationInput {
+  'documentType' : string,
+  'requiresSolicitorReview' : boolean,
+  'extractedData' : string,
+  'issues' : Array<OscarIssue>,
+  'mismatches' : Array<DataMismatch>,
+  'confidence' : bigint,
+}
+export type PriorityStatus = { 'Active' : null } |
+  { 'ExpiringImminently' : null } |
+  { 'Unknown' : null } |
+  { 'Expired' : null };
+export type Result = { 'ok' : DocumentVerification } |
+  { 'err' : string };
+export type Result_1 = { 'ok' : OSCertificateVerification } |
+  { 'err' : string };
+export type Result_2 = { 'ok' : OfficialCopyVerification } |
+  { 'err' : string };
+export type Result_3 = { 'ok' : bigint } |
+  { 'err' : string };
+export type Result_4 = { 'ok' : TransactionVerificationSummary } |
+  { 'err' : string };
+export type Time = bigint;
+export interface TransactionVerificationSummary {
+  'missingDocuments' : Array<string>,
+  'expiredDocuments' : bigint,
+  'hasOfficialSearch' : boolean,
+  'titleNumber' : string,
+  'allDocumentsVerified' : boolean,
+  'readyForSubmission' : boolean,
+  'readyForCompletion' : boolean,
+  'officialSearchValid' : boolean,
+  'allLRDocumentsCurrent' : boolean,
+  'verifiedDocuments' : bigint,
+  'daysUntilSearchExpiry' : [] | [bigint],
+  'lrDocuments' : Array<LRDocumentSummary>,
+  'officialSearchExpiry' : [] | [bigint],
+  'readyForExchange' : boolean,
+  'unverifiedDocuments' : bigint,
+  'totalDocuments' : bigint,
+  'transactionId' : string,
+}
+export type VerificationMethod = { 'oscar_ai' : OscarVerificationDetails } |
+  { 'passport_dcs' : null } |
+  { 'commercial_api' : string } |
+  { 'system_hash_only' : null } |
+  { 'manual_solicitor' : null } |
+  { 'dvla_api' : null };
+export interface _SERVICE {
+  'deleteDocument' : ActorMethod<
+    [bigint],
+    { 'ok' : null } |
+      { 'err' : string }
+  >,
+  'getAuditLogs' : ActorMethod<[], Array<AuditLog>>,
+  'getConfiguration' : ActorMethod<
+    [],
+    {
+      'userManagement' : [] | [Principal],
+      'documentStorage' : [] | [Principal],
+    }
+  >,
+  'getCycles' : ActorMethod<[], bigint>,
+  'getDocument' : ActorMethod<[bigint], [] | [DocumentMetadata]>,
+  'getDocumentVerifications' : ActorMethod<
+    [bigint],
+    Array<DocumentVerification>
+  >,
+  'getOscarVerificationDetails' : ActorMethod<
+    [bigint],
+    [] | [OscarVerificationDetails]
+  >,
+  'getPropertyDocuments' : ActorMethod<[bigint], Array<DocumentMetadata>>,
+  'getRecentAuditLogs' : ActorMethod<[bigint], Array<AuditLog>>,
+  'getStats' : ActorMethod<
+    [],
+    {
+      'totalVerifications' : bigint,
+      'totalAuditLogs' : bigint,
+      'verifiedDocuments' : bigint,
+      'totalDocuments' : bigint,
+    }
+  >,
+  'getTransactionVerificationSummary' : ActorMethod<[string, string], Result_4>,
+  'getUnverifiedDocuments' : ActorMethod<[bigint], Array<DocumentMetadata>>,
+  'getVerification' : ActorMethod<[bigint], [] | [DocumentVerification]>,
+  'getVerificationsByTransaction' : ActorMethod<
+    [bigint],
+    Array<DocumentVerification>
+  >,
+  'getVerificationsByVerifier' : ActorMethod<
+    [Principal],
+    Array<DocumentVerification>
+  >,
+  'recordAuditEntry' : ActorMethod<
+    [ActorType, [] | [Principal], string, bigint, string, boolean],
+    Result_3
+  >,
+  'registerDocument' : ActorMethod<
+    [
+      bigint,
+      [] | [bigint],
+      string,
+      string,
+      [] | [bigint],
+      [] | [string],
+      [] | [bigint],
+      [] | [string],
+    ],
+    bigint
+  >,
+  'setDocumentStorageCanister' : ActorMethod<[Principal], undefined>,
+  'setUserManagementCanister' : ActorMethod<[Principal], undefined>,
+  'verifyDocument' : ActorMethod<[bigint], boolean>,
+  'verifyDocumentWithHash' : ActorMethod<[bigint, [] | [string]], Result>,
+  'verifyOfficialCopy' : ActorMethod<[bigint, string, bigint], Result_2>,
+  'verifyOfficialSearchCertificate' : ActorMethod<
+    [bigint, string, [] | [string]],
+    Result_1
+  >,
+  'verifyWithCommercialAPI' : ActorMethod<[bigint, string, string], Result>,
+  'verifyWithDVLA' : ActorMethod<[bigint, string], Result>,
+  'verifyWithOscar' : ActorMethod<[bigint, OscarVerificationInput], Result>,
+  'verifyWithPassportDCS' : ActorMethod<[bigint, string], Result>,
+}
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];