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

package/src/canisters/document_verification/document_verification.did.js

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

package/src/canisters/email_service/email_service.did

@@ -1,37 +1,86 @@
-type EmailNotification = 
- record {
-   company: opt text;
-   contactType: ContactType;
-   email: text;
-   id: nat;
-   message: text;
-   name: text;
-   partnerType: opt text;
-   phone: opt text;
-   processed: bool;
-   subject: text;
-   timestamp: int;
-   userType: opt text;
-   volume: opt text;
-   website: opt text;
- };
-type ContactType = 
- variant {
-   partners;
-   sales;
-   support;
- };
-service : {
-  formatNotificationAsEmail: (id: nat) -> (opt text) query;
-  getAllNotifications: () -> (vec EmailNotification) query;
-  getNotification: (id: nat) -> (opt EmailNotification) query;
-  getUnprocessedCount: () -> (nat) query;
-  getUnprocessedNotifications: () -> (vec EmailNotification) query;
-  markAsProcessed: (id: nat) -> (bool);
-  submitPartnerInquiry: (name: text, email: text, company: text, website:
-   text, partnerType: text, message: text) -> (nat);
-  submitSalesInquiry: (name: text, email: text, company: text, phone: 
-   text, userType: text, volume: text, message: text) -> (nat);
-  submitSupportRequest: (name: text, email: text, subject: text, message:
-   text) -> (nat);
-}
+type Result_1 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result = 
+ variant {
+   err: text;
+   ok: text;
+ };
+type EmailNotification = 
+ record {
+   company: opt text;
+   contactType: ContactType;
+   email: text;
+   id: nat;
+   lrNotificationType: opt text;
+   message: text;
+   name: text;
+   partnerType: opt text;
+   phone: opt text;
+   processed: bool;
+   propertyAddress: opt text;
+   subject: text;
+   timestamp: int;
+   titleNumber: opt text;
+   transactionId: opt text;
+   userType: opt text;
+   volume: opt text;
+   website: opt text;
+ };
+type ContactType = 
+ variant {
+   email_verification;
+   lr_application_registered;
+   lr_application_submitted;
+   lr_budget_alert;
+   lr_official_search_complete;
+   lr_requisition_raised;
+   lr_search_expiry_warning;
+   lr_status_change;
+   message_notification;
+   partners;
+   sales;
+   support;
+ };
+service : {
+  checkAndSendExpiryWarnings: (daysThreshold: nat) -> (Result_1);
+  disableExpiryWarningTimer: () -> (Result);
+  enableExpiryWarningTimer: () -> (Result);
+  formatNotificationAsEmail: (id: nat) -> (opt text) query;
+  getAllNotifications: () -> (vec EmailNotification) query;
+  getCycles: () -> (nat) query;
+  getExpiryWarningStatus: () ->
+   (record {
+      lastCheckTime: int;
+      timerActive: bool;
+    }) query;
+  getLandRegistryNotifications: (txnId: text) ->
+   (vec EmailNotification) query;
+  getNotification: (id: nat) -> (opt EmailNotification) query;
+  getTransactionManagerCanister: () -> (text) query;
+  getUnprocessedCount: () -> (nat) query;
+  getUnprocessedLRNotifications: () -> (vec EmailNotification) query;
+  getUnprocessedNotifications: () -> (vec EmailNotification) query;
+  getUserManagementCanister: () -> (text) query;
+  markAsProcessed: (id: nat) -> (bool);
+  sendBudgetAlert: (recipientEmail: text, recipientName: text, currentSpend:
+   nat, budgetLimit: nat, percentUsed: nat) -> (nat);
+  sendLandRegistryNotification: (recipientEmail: text, recipientName: 
+   text, notificationType: text, txnId: text, title: text, propAddress: 
+   text, details: text) -> (nat);
+  setTransactionManagerCanister: (canisterId: text) -> (Result);
+  setUserManagementCanister: (canisterId: text) -> (Result);
+  submitEmailVerification: (name: text, email: text, verificationToken:
+   text) -> (nat);
+  submitMessageNotification: (recipientEmail: text, recipientName: text,
+   senderName: text, subject: text, messagePreview: text, threadId: text,
+   transactionId: text, propertyAddress: text, priority: text) -> (nat);
+  submitPartnerInquiry: (name: text, email: text, company: text, website:
+   text, partnerType: text, message: text) -> (nat);
+  submitSalesInquiry: (name: text, email: text, company: text, phone: 
+   text, userType: text, volume: text, message: text) -> (nat);
+  submitSupportRequest: (name: text, email: text, subject: text, message:
+   text) -> (nat);
+}