@propxchain/core-client 0.2.1 → 0.3.0-canary.23

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

@@ -2,17 +2,29 @@ import type { Principal } from '@dfinity/principal';
 import type { ActorMethod } from '@dfinity/agent';
 import type { IDL } from '@dfinity/candid';
 
-export type ContactType = { 'support' : null } |
+export type ContactType = { 'lr_budget_alert' : null } |
+  { 'lr_application_submitted' : null } |
+  { 'message_notification' : null } |
+  { 'support' : null } |
   { 'partners' : null } |
-  { 'sales' : null };
+  { 'sales' : null } |
+  { 'lr_search_expiry_warning' : null } |
+  { 'email_verification' : null } |
+  { 'lr_official_search_complete' : null } |
+  { 'lr_requisition_raised' : null } |
+  { 'lr_application_registered' : null } |
+  { 'lr_status_change' : null };
 export interface EmailNotification {
   'id' : bigint,
   'userType' : [] | [string],
   'contactType' : ContactType,
   'subject' : string,
   'partnerType' : [] | [string],
+  'titleNumber' : [] | [string],
   'name' : string,
   'volume' : [] | [string],
+  'propertyAddress' : [] | [string],
+  'lrNotificationType' : [] | [string],
   'email' : string,
   'website' : [] | [string],
   'company' : [] | [string],
@@ -20,14 +32,49 @@ export interface EmailNotification {
   'timestamp' : bigint,
   'phone' : [] | [string],
   'processed' : boolean,
+  'transactionId' : [] | [string],
 }
+export type Result = { 'ok' : string } |
+  { 'err' : string };
+export type Result_1 = { 'ok' : bigint } |
+  { 'err' : string };
 export interface _SERVICE {
+  'checkAndSendExpiryWarnings' : ActorMethod<[bigint], Result_1>,
+  'disableExpiryWarningTimer' : ActorMethod<[], Result>,
+  'enableExpiryWarningTimer' : ActorMethod<[], Result>,
   'formatNotificationAsEmail' : ActorMethod<[bigint], [] | [string]>,
   'getAllNotifications' : ActorMethod<[], Array<EmailNotification>>,
+  'getCycles' : ActorMethod<[], bigint>,
+  'getExpiryWarningStatus' : ActorMethod<
+    [],
+    { 'timerActive' : boolean, 'lastCheckTime' : bigint }
+  >,
+  'getLandRegistryNotifications' : ActorMethod<
+    [string],
+    Array<EmailNotification>
+  >,
   'getNotification' : ActorMethod<[bigint], [] | [EmailNotification]>,
+  'getTransactionManagerCanister' : ActorMethod<[], string>,
   'getUnprocessedCount' : ActorMethod<[], bigint>,
+  'getUnprocessedLRNotifications' : ActorMethod<[], Array<EmailNotification>>,
   'getUnprocessedNotifications' : ActorMethod<[], Array<EmailNotification>>,
+  'getUserManagementCanister' : ActorMethod<[], string>,
   'markAsProcessed' : ActorMethod<[bigint], boolean>,
+  'sendBudgetAlert' : ActorMethod<
+    [string, string, bigint, bigint, bigint],
+    bigint
+  >,
+  'sendLandRegistryNotification' : ActorMethod<
+    [string, string, string, string, string, string, string],
+    bigint
+  >,
+  'setTransactionManagerCanister' : ActorMethod<[string], Result>,
+  'setUserManagementCanister' : ActorMethod<[string], Result>,
+  'submitEmailVerification' : ActorMethod<[string, string, string], bigint>,
+  'submitMessageNotification' : ActorMethod<
+    [string, string, string, string, string, string, string, string, string],
+    bigint
+  >,
   'submitPartnerInquiry' : ActorMethod<
     [string, string, string, string, string, string],
     bigint

package/src/canisters/email_service/email_service.did.js

@@ -1,8 +1,19 @@
 export const idlFactory = ({ IDL }) => {
+  const Result_1 = IDL.Variant({ 'ok' : IDL.Nat, 'err' : IDL.Text });
+  const Result = IDL.Variant({ 'ok' : IDL.Text, 'err' : IDL.Text });
   const ContactType = IDL.Variant({
+    'lr_budget_alert' : IDL.Null,
+    'lr_application_submitted' : IDL.Null,
+    'message_notification' : IDL.Null,
     'support' : IDL.Null,
     'partners' : IDL.Null,
     'sales' : IDL.Null,
+    'lr_search_expiry_warning' : IDL.Null,
+    'email_verification' : IDL.Null,
+    'lr_official_search_complete' : IDL.Null,
+    'lr_requisition_raised' : IDL.Null,
+    'lr_application_registered' : IDL.Null,
+    'lr_status_change' : IDL.Null,
   });
   const EmailNotification = IDL.Record({
     'id' : IDL.Nat,
@@ -10,8 +21,11 @@ export const idlFactory = ({ IDL }) => {
     'contactType' : ContactType,
     'subject' : IDL.Text,
     'partnerType' : IDL.Opt(IDL.Text),
+    'titleNumber' : IDL.Opt(IDL.Text),
     'name' : IDL.Text,
     'volume' : IDL.Opt(IDL.Text),
+    'propertyAddress' : IDL.Opt(IDL.Text),
+    'lrNotificationType' : IDL.Opt(IDL.Text),
     'email' : IDL.Text,
     'website' : IDL.Opt(IDL.Text),
     'company' : IDL.Opt(IDL.Text),
@@ -19,8 +33,12 @@ export const idlFactory = ({ IDL }) => {
     'timestamp' : IDL.Int,
     'phone' : IDL.Opt(IDL.Text),
     'processed' : IDL.Bool,
+    'transactionId' : IDL.Opt(IDL.Text),
   });
   return IDL.Service({
+    'checkAndSendExpiryWarnings' : IDL.Func([IDL.Nat], [Result_1], []),
+    'disableExpiryWarningTimer' : IDL.Func([], [Result], []),
+    'enableExpiryWarningTimer' : IDL.Func([], [Result], []),
     'formatNotificationAsEmail' : IDL.Func(
         [IDL.Nat],
         [IDL.Opt(IDL.Text)],
@@ -31,18 +49,68 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Vec(EmailNotification)],
         ['query'],
       ),
+    'getCycles' : IDL.Func([], [IDL.Nat], ['query']),
+    'getExpiryWarningStatus' : IDL.Func(
+        [],
+        [IDL.Record({ 'timerActive' : IDL.Bool, 'lastCheckTime' : IDL.Int })],
+        ['query'],
+      ),
+    'getLandRegistryNotifications' : IDL.Func(
+        [IDL.Text],
+        [IDL.Vec(EmailNotification)],
+        ['query'],
+      ),
     'getNotification' : IDL.Func(
         [IDL.Nat],
         [IDL.Opt(EmailNotification)],
         ['query'],
       ),
+    'getTransactionManagerCanister' : IDL.Func([], [IDL.Text], ['query']),
     'getUnprocessedCount' : IDL.Func([], [IDL.Nat], ['query']),
+    'getUnprocessedLRNotifications' : IDL.Func(
+        [],
+        [IDL.Vec(EmailNotification)],
+        ['query'],
+      ),
     'getUnprocessedNotifications' : IDL.Func(
         [],
         [IDL.Vec(EmailNotification)],
         ['query'],
       ),
+    'getUserManagementCanister' : IDL.Func([], [IDL.Text], ['query']),
     'markAsProcessed' : IDL.Func([IDL.Nat], [IDL.Bool], []),
+    'sendBudgetAlert' : IDL.Func(
+        [IDL.Text, IDL.Text, IDL.Nat, IDL.Nat, IDL.Nat],
+        [IDL.Nat],
+        [],
+      ),
+    'sendLandRegistryNotification' : IDL.Func(
+        [IDL.Text, IDL.Text, IDL.Text, IDL.Text, IDL.Text, IDL.Text, IDL.Text],
+        [IDL.Nat],
+        [],
+      ),
+    'setTransactionManagerCanister' : IDL.Func([IDL.Text], [Result], []),
+    'setUserManagementCanister' : IDL.Func([IDL.Text], [Result], []),
+    'submitEmailVerification' : IDL.Func(
+        [IDL.Text, IDL.Text, IDL.Text],
+        [IDL.Nat],
+        [],
+      ),
+    'submitMessageNotification' : IDL.Func(
+        [
+          IDL.Text,
+          IDL.Text,
+          IDL.Text,
+          IDL.Text,
+          IDL.Text,
+          IDL.Text,
+          IDL.Text,
+          IDL.Text,
+          IDL.Text,
+        ],
+        [IDL.Nat],
+        [],
+      ),
     'submitPartnerInquiry' : IDL.Func(
         [IDL.Text, IDL.Text, IDL.Text, IDL.Text, IDL.Text, IDL.Text],
         [IDL.Nat],

package/src/canisters/land_registry_integration/land_registry_integration.did

@@ -1,3 +1,8 @@
+type TransformArgs = 
+ record {
+   context: blob;
+   response: HttpResponse;
+ };
 type TransactionStatus = 
  variant {
    confirmed;
@@ -6,21 +11,36 @@ type TransactionStatus =
    requires_manual_review;
    sent_to_lr;
  };
-type Result_4 = 
+type Result_7 = 
  variant {
    err: text;
    ok: LandRegistryAPIResponse;
  };
-type Result_3 = 
+type Result_6 = 
  variant {
    err: text;
    ok: nat32;
  };
-type Result_2 = 
+type Result_5 = 
  variant {
    err: text;
    ok: OwnershipTransferPayload;
  };
+type Result_4 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result_3 = 
+ variant {
+   err: text;
+   ok: OfficialSearchResponse;
+ };
+type Result_2 = 
+ variant {
+   err: text;
+   ok;
+ };
 type Result_1 = 
  variant {
    err: text;
@@ -31,6 +51,15 @@ type Result =
    err: text;
    ok: bool;
  };
+type RateLimitInfo = 
+ record {
+   callsThisHour: nat;
+   callsToday: nat;
+   dayResetAt: int;
+   endpoint: text;
+   hourResetAt: int;
+   lastCallAt: int;
+ };
 type Period = 
  variant {
    day;
@@ -56,6 +85,20 @@ type OwnershipTransferPayload =
    transactionDate: int;
    transferID: text;
  };
+type OfficialSearchResponse = 
+ record {
+   advisoryEntries: vec text;
+   certificatePdfHash: opt text;
+   certificateTimestamp: text;
+   documentStorageId: opt nat;
+   httpStatus: nat;
+   officialCopyTimestamp: opt text;
+   priorityExpiry: text;
+   registerChangedSinceSearchFromDate: bool;
+   registeredProprietorNames: vec text;
+   resultContainsAdvisoryEntries: bool;
+   searchRef: text;
+ };
 type NewOwnerInfo = 
  record {
    address: text;
@@ -94,14 +137,6 @@ type LandRegistryAPIResponse =
    responseID: text;
    status: LRStatus;
  };
-type LandRegistryAPICredentials = 
- record {
-   apiEndpoint: text;
-   apiKey: text;
-   authenticationType: AuthenticationType;
-   environment: Environment;
-   lastValidated: int;
- };
 type LRStatus = 
  variant {
    failed;
@@ -109,28 +144,83 @@ type LRStatus =
    received;
    registered;
  };
+type HttpResponse = 
+ record {
+   body: blob;
+   headers: vec HttpHeader;
+   status: nat;
+ };
+type HttpHeader = 
+ record {
+   name: text;
+   value: text;
+ };
 type Environment = 
  variant {
    production;
    sandbox;
  };
+type CredentialStatus = 
+ record {
+   daysSinceRotation: opt nat;
+   environment: opt Environment;
+   isConfigured: bool;
+   isExpired: bool;
+   lastRotated: opt int;
+ };
+type CostSummary = 
+ record {
+   byEndpoint: vec record {
+                     text;
+                     nat;
+                   };
+   byTransaction: vec record {
+                        text;
+                        nat;
+                      };
+   entryCount: nat;
+   totalPence: nat;
+ };
 type ConveyancerInfo = 
  record {
    contactEmail: text;
    licenseNumber: text;
    name: text;
  };
-type AuthenticationType = 
+type AuditEntry = 
+ record {
+   action: text;
+   actorType: ActorType;
+   caller: principal;
+   delegatedBy: opt principal;
+   details: text;
+   success: bool;
+   timestamp: int;
+ };
+type ActorType = 
  variant {
-   api_key;
-   oauth2;
+   agent;
+   systemActor;
+   user;
  };
 service : {
   check_land_registry_status: (transactionID: text) ->
    (opt LandRegistryTransactionRecord) query;
-  configure_land_registry_api: (credentials: LandRegistryAPICredentials) ->
-   (Result_1);
+  getAuditLog: () -> (vec AuditEntry) query;
+  getCredentialStatus: () -> (CredentialStatus) query;
   getCycles: () -> (nat) query;
+  getDailySpend: () -> (nat) query;
+  getNotificationPollingStatus: () ->
+   (record {
+      enabled: bool;
+      intervalSeconds: nat;
+      lastPollAt: int;
+    }) query;
+  getRateLimitStatus: () -> (vec record {
+                                   text;
+                                   RateLimitInfo;
+                                 }) query;
+  getTotalCosts: (fromDate: int, toDate: int) -> (CostSummary) query;
   get_all_pending_land_registry_submissions: (companyAccountID: text) ->
    (vec LandRegistryTransactionRecord) query;
   get_all_transactions: () ->
@@ -147,9 +237,9 @@ service : {
        environment: Environment;
        lastValidated: int;
      }) query;
-  get_lr_response: (confirmationID: text) -> (Result_4) query;
+  get_lr_response: (confirmationID: text) -> (Result_7) query;
   log_land_registry_error: (transactionID: text, errorDetails: text) ->
-   (Result_3);
+   (Result_6);
   prepare_ownership_transfer_payload: (transactionID: text,
    blockchainTransactionID: text, propertyAddress: text, postcode: text,
    titleNumber: text, previousOwner: text, newOwnerDetails: NewOwnerInfo,
@@ -157,13 +247,22 @@ service : {
    buyerSolicitorSignature: text, sellerSolicitorSignature: text,
    blockchainProofHash: text, blockchainCompletionProof: text,
    contractExchangeTimestamp: int, blockchainCompletionTimestamp: int) ->
-   (Result_2);
+   (Result_5);
   receive_land_registry_callback: (callbackData: LandRegistryAPIResponse) ->
    (Result_1);
+  recordAuditEntry: (actorType: ActorType, delegatedBy: opt principal,
+   action: text, details: text, success: bool) -> (Result_4);
+  requestOfficialSearch: (titleNumber: text, searchFromDate: text,
+   proprietorNames: vec text, transactionId: text) -> (Result_3);
   retry_failed_land_registry_transmission: (transactionID: text) ->
    (Result_1);
   send_to_land_registry: (transactionID: text) -> (Result_1);
+  setDailySpendLimit: (limitPence: nat) -> (Result_2);
+  setNotificationPolling: (enabled: bool, intervalSeconds: opt nat) ->
+   (Result_2);
+  setUserManagementCanisterId: (canisterId: text) -> (Result_2);
   simulate_land_registry_processing: (confirmationNumber: text) -> (Result_1);
+  transform: (args: TransformArgs) -> (HttpResponse) query;
   validate_land_registry_connection: () -> (Result);
   verify_land_registry_receipt: (transactionID: text) -> (Result);
 }

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

@@ -2,26 +2,48 @@ import type { Principal } from '@dfinity/principal';
 import type { ActorMethod } from '@dfinity/agent';
 import type { IDL } from '@dfinity/candid';
 
-export type AuthenticationType = { 'api_key' : null } |
-  { 'oauth2' : null };
+export type ActorType = { 'agent' : null } |
+  { 'systemActor' : null } |
+  { 'user' : null };
+export interface AuditEntry {
+  'action' : string,
+  'actorType' : ActorType,
+  'delegatedBy' : [] | [Principal],
+  'timestamp' : bigint,
+  'details' : string,
+  'caller' : Principal,
+  'success' : boolean,
+}
 export interface ConveyancerInfo {
   'name' : string,
   'contactEmail' : string,
   'licenseNumber' : string,
 }
+export interface CostSummary {
+  'entryCount' : bigint,
+  'byEndpoint' : Array<[string, bigint]>,
+  'totalPence' : bigint,
+  'byTransaction' : Array<[string, bigint]>,
+}
+export interface CredentialStatus {
+  'isExpired' : boolean,
+  'isConfigured' : boolean,
+  'lastRotated' : [] | [bigint],
+  'environment' : [] | [Environment],
+  'daysSinceRotation' : [] | [bigint],
+}
 export type Environment = { 'sandbox' : null } |
   { 'production' : null };
+export interface HttpHeader { 'value' : string, 'name' : string }
+export interface HttpResponse {
+  'status' : bigint,
+  'body' : Uint8Array | number[],
+  'headers' : Array<HttpHeader>,
+}
 export type LRStatus = { 'processing' : null } |
   { 'received' : null } |
   { 'failed' : null } |
   { 'registered' : null };
-export interface LandRegistryAPICredentials {
-  'authenticationType' : AuthenticationType,
-  'lastValidated' : bigint,
-  'apiEndpoint' : string,
-  'apiKey' : string,
-  'environment' : Environment,
-}
 export interface LandRegistryAPIResponse {
   'status' : LRStatus,
   'registeredTimestamp' : [] | [bigint],
@@ -56,6 +78,19 @@ export interface NewOwnerInfo {
   'address' : string,
   'contactEmail' : string,
 }
+export interface OfficialSearchResponse {
+  'httpStatus' : bigint,
+  'officialCopyTimestamp' : [] | [string],
+  'advisoryEntries' : Array<string>,
+  'documentStorageId' : [] | [bigint],
+  'certificatePdfHash' : [] | [string],
+  'registeredProprietorNames' : Array<string>,
+  'certificateTimestamp' : string,
+  'resultContainsAdvisoryEntries' : boolean,
+  'registerChangedSinceSearchFromDate' : boolean,
+  'priorityExpiry' : string,
+  'searchRef' : string,
+}
 export interface OwnershipTransferPayload {
   'transactionDate' : bigint,
   'postcode' : string,
@@ -77,31 +112,54 @@ export type Period = { 'day' : null } |
   { 'month' : null } |
   { 'week' : null } |
   { 'year' : null };
+export interface RateLimitInfo {
+  'callsThisHour' : bigint,
+  'endpoint' : string,
+  'dayResetAt' : bigint,
+  'lastCallAt' : bigint,
+  'callsToday' : bigint,
+  'hourResetAt' : bigint,
+}
 export type Result = { 'ok' : boolean } |
   { 'err' : string };
 export type Result_1 = { 'ok' : string } |
   { 'err' : string };
-export type Result_2 = { 'ok' : OwnershipTransferPayload } |
+export type Result_2 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_3 = { 'ok' : OfficialSearchResponse } |
+  { 'err' : string };
+export type Result_4 = { 'ok' : bigint } |
   { 'err' : string };
-export type Result_3 = { 'ok' : number } |
+export type Result_5 = { 'ok' : OwnershipTransferPayload } |
   { 'err' : string };
-export type Result_4 = { 'ok' : LandRegistryAPIResponse } |
+export type Result_6 = { 'ok' : number } |
+  { 'err' : string };
+export type Result_7 = { 'ok' : LandRegistryAPIResponse } |
   { 'err' : string };
 export type TransactionStatus = { 'sent_to_lr' : null } |
   { 'requires_manual_review' : null } |
   { 'pending_api_call' : null } |
   { 'confirmed' : null } |
   { 'failed' : null };
+export interface TransformArgs {
+  'context' : Uint8Array | number[],
+  'response' : HttpResponse,
+}
 export interface _SERVICE {
   'check_land_registry_status' : ActorMethod<
     [string],
     [] | [LandRegistryTransactionRecord]
   >,
-  'configure_land_registry_api' : ActorMethod<
-    [LandRegistryAPICredentials],
-    Result_1
-  >,
+  'getAuditLog' : ActorMethod<[], Array<AuditEntry>>,
+  'getCredentialStatus' : ActorMethod<[], CredentialStatus>,
   'getCycles' : ActorMethod<[], bigint>,
+  'getDailySpend' : ActorMethod<[], bigint>,
+  'getNotificationPollingStatus' : ActorMethod<
+    [],
+    { 'enabled' : boolean, 'intervalSeconds' : bigint, 'lastPollAt' : bigint }
+  >,
+  'getRateLimitStatus' : ActorMethod<[], Array<[string, RateLimitInfo]>>,
+  'getTotalCosts' : ActorMethod<[bigint, bigint], CostSummary>,
   'get_all_pending_land_registry_submissions' : ActorMethod<
     [string],
     Array<LandRegistryTransactionRecord>
@@ -121,8 +179,8 @@ export interface _SERVICE {
       }
     ]
   >,
-  'get_lr_response' : ActorMethod<[string], Result_4>,
-  'log_land_registry_error' : ActorMethod<[string, string], Result_3>,
+  'get_lr_response' : ActorMethod<[string], Result_7>,
+  'log_land_registry_error' : ActorMethod<[string, string], Result_6>,
   'prepare_ownership_transfer_payload' : ActorMethod<
     [
       string,
@@ -141,15 +199,27 @@ export interface _SERVICE {
       bigint,
       bigint,
     ],
-    Result_2
+    Result_5
   >,
   'receive_land_registry_callback' : ActorMethod<
     [LandRegistryAPIResponse],
     Result_1
   >,
+  'recordAuditEntry' : ActorMethod<
+    [ActorType, [] | [Principal], string, string, boolean],
+    Result_4
+  >,
+  'requestOfficialSearch' : ActorMethod<
+    [string, string, Array<string>, string],
+    Result_3
+  >,
   'retry_failed_land_registry_transmission' : ActorMethod<[string], Result_1>,
   'send_to_land_registry' : ActorMethod<[string], Result_1>,
+  'setDailySpendLimit' : ActorMethod<[bigint], Result_2>,
+  'setNotificationPolling' : ActorMethod<[boolean, [] | [bigint]], Result_2>,
+  'setUserManagementCanisterId' : ActorMethod<[string], Result_2>,
   'simulate_land_registry_processing' : ActorMethod<[string], Result_1>,
+  'transform' : ActorMethod<[TransformArgs], HttpResponse>,
   'validate_land_registry_connection' : ActorMethod<[], Result>,
   'verify_land_registry_receipt' : ActorMethod<[string], Result>,
 }