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

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,31 +11,100 @@ type TransactionStatus =
    requires_manual_review;
    sent_to_lr;
  };
-type Result_4 = 
+type Result_9 = 
  variant {
    err: text;
    ok: LandRegistryAPIResponse;
  };
-type Result_3 = 
+type Result_8 = 
  variant {
    err: text;
    ok: nat32;
  };
-type Result_2 = 
+type Result_7 = 
+ variant {
+   err: text;
+   ok: vec LRNotification;
+ };
+type Result_6 = 
  variant {
    err: text;
    ok: OwnershipTransferPayload;
  };
-type Result_1 = 
+type Result_5 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result_4 = 
+ variant {
+   err: text;
+   ok: OfficialSearchResponse;
+ };
+type Result_3 = 
+ variant {
+   err: text;
+   ok;
+ };
+type Result_2 = 
  variant {
    err: text;
    ok: text;
  };
+type Result_12 = 
+ variant {
+   err: text;
+   ok: ApplicationEnquiryResponse;
+ };
+type Result_11 = 
+ variant {
+   err: text;
+   ok: ECDResponse;
+ };
+type Result_10 = 
+ variant {
+   err: text;
+   ok: ProprietorNamesResponse;
+ };
+type Result_1 = 
+ variant {
+   err: text;
+   ok: AP1SubmissionResponse;
+ };
 type Result = 
  variant {
    err: text;
    ok: bool;
  };
+type RateLimitInfo = 
+ record {
+   callsThisHour: nat;
+   callsToday: nat;
+   dayResetAt: int;
+   endpoint: text;
+   hourResetAt: int;
+   lastCallAt: int;
+ };
+type ProprietorNamesResponse = 
+ record {
+   httpStatus: nat;
+   proprietors: vec ProprietorData;
+   titleNumber: text;
+   titleStatus: text;
+   titleStatusCode: text;
+ };
+type ProprietorData = 
+ record {
+   companyLocation: opt text;
+   decoration: opt text;
+   forenames: opt text;
+   organisationType: opt text;
+   proprietorName: text;
+   proprietorType: text;
+   sequence: nat;
+   surname: opt text;
+   title: opt text;
+ };
 type Period = 
  variant {
    day;
@@ -56,6 +130,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;
@@ -109,11 +197,62 @@ type LRStatus =
    received;
    registered;
  };
+type LRNotification = 
+ record {
+   applicationReference: opt text;
+   message: text;
+   metadata: vec record {
+                   text;
+                   text;
+                 };
+   notificationType: text;
+   receivedAt: int;
+   titleNumber: opt text;
+ };
+type HttpResponse = 
+ record {
+   body: blob;
+   headers: vec HttpHeader;
+   status: nat;
+ };
+type HttpHeader = 
+ record {
+   name: text;
+   value: text;
+ };
 type Environment = 
  variant {
    production;
    sandbox;
  };
+type ECDResponse = 
+ record {
+   applicationReference: text;
+   confidence: opt text;
+   estimatedCompletionDate: text;
+   httpStatus: nat;
+ };
+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;
@@ -125,12 +264,84 @@ type AuthenticationType =
    api_key;
    oauth2;
  };
+type AuditEntry = 
+ record {
+   action: text;
+   actorType: ActorType;
+   caller: principal;
+   delegatedBy: opt principal;
+   details: text;
+   success: bool;
+   timestamp: int;
+ };
+type ApplicationEnquiryResponse = 
+ record {
+   applicationDate: text;
+   applicationReference: text;
+   completedDate: opt text;
+   httpStatus: nat;
+   lastUpdated: text;
+   notes: vec text;
+   status: text;
+ };
+type ActorType = 
+ variant {
+   agent;
+   systemActor;
+   user;
+ };
+type AP1SubmissionResponse = 
+ record {
+   applicationReference: text;
+   confirmationNumber: text;
+   estimatedCompletionDate: opt text;
+   httpStatus: nat;
+   message: text;
+   scaleFePence: nat;
+ };
+type AP1SubmissionRequest = 
+ record {
+   applicationType: text;
+   blockchainProofHash: text;
+   conveyancerAddress: text;
+   conveyancerName: text;
+   conveyancerReference: text;
+   conveyancerSRANumber: text;
+   officialSearchRef: text;
+   propertyAddress: text;
+   propertyPostcode: text;
+   titleNumber: text;
+   transferAmount: nat;
+   transferDate: text;
+   transfereeAddress: text;
+   transfereeNames: vec text;
+   transfereeType: text;
+   transferorAddress: text;
+   transferorNames: vec text;
+ };
 service : {
   check_land_registry_status: (transactionID: text) ->
    (opt LandRegistryTransactionRecord) query;
-  configure_land_registry_api: (credentials: LandRegistryAPICredentials) ->
-   (Result_1);
+  configure_land_registry_api: (_creds: LandRegistryAPICredentials) ->
+   (Result_2);
+  getApplicationStatus: (applicationReference: text) -> (Result_12);
+  getAuditLog: () -> (vec AuditEntry) query;
+  getCredentialStatus: () -> (CredentialStatus) query;
   getCycles: () -> (nat) query;
+  getDailySpend: () -> (nat) query;
+  getEstimatedCompletionDate: (applicationReference: text) -> (Result_11);
+  getNotificationPollingStatus: () ->
+   (record {
+      enabled: bool;
+      intervalSeconds: nat;
+      lastPollAt: int;
+    }) query;
+  getRateLimitStatus: () -> (vec record {
+                                   text;
+                                   RateLimitInfo;
+                                 }) query;
+  getRegisteredProprietorNames: (titleNumber: text) -> (Result_10);
+  getTotalCosts: (fromDate: int, toDate: int) -> (CostSummary) query;
   get_all_pending_land_registry_submissions: (companyAccountID: text) ->
    (vec LandRegistryTransactionRecord) query;
   get_all_transactions: () ->
@@ -147,9 +358,10 @@ service : {
        environment: Environment;
        lastValidated: int;
      }) query;
-  get_lr_response: (confirmationID: text) -> (Result_4) query;
+  get_lr_response: (confirmationID: text) -> (Result_9) query;
   log_land_registry_error: (transactionID: text, errorDetails: text) ->
-   (Result_3);
+   (Result_8);
+  pollNotifications: () -> (Result_7);
   prepare_ownership_transfer_payload: (transactionID: text,
    blockchainTransactionID: text, propertyAddress: text, postcode: text,
    titleNumber: text, previousOwner: text, newOwnerDetails: NewOwnerInfo,
@@ -157,13 +369,27 @@ service : {
    buyerSolicitorSignature: text, sellerSolicitorSignature: text,
    blockchainProofHash: text, blockchainCompletionProof: text,
    contractExchangeTimestamp: int, blockchainCompletionTimestamp: int) ->
-   (Result_2);
+   (Result_6);
   receive_land_registry_callback: (callbackData: LandRegistryAPIResponse) ->
-   (Result_1);
+   (Result_2);
+  recordAuditEntry: (actorType: ActorType, delegatedBy: opt principal,
+   action: text, details: text, success: bool) -> (Result_5);
+  requestOfficialSearch: (titleNumber: text, searchFromDate: text,
+   proprietorNames: vec text, transactionId: text) -> (Result_4);
   retry_failed_land_registry_transmission: (transactionID: text) ->
-   (Result_1);
-  send_to_land_registry: (transactionID: text) -> (Result_1);
-  simulate_land_registry_processing: (confirmationNumber: text) -> (Result_1);
+   (Result_2);
+  rotateCredentials: (_newPassword: text) -> (Result_3);
+  send_to_land_registry: (transactionID: text) -> (Result_2);
+  setCredentials: (username: text, _password: text, _apiEndpoint: text,
+   _environment: Environment) -> (Result_3);
+  setDailySpendLimit: (limitPence: nat) -> (Result_3);
+  setNotificationPolling: (enabled: bool, intervalSeconds: opt nat) ->
+   (Result_3);
+  setUserManagementCanisterId: (canisterId: text) -> (Result_3);
+  simulate_land_registry_processing: (confirmationNumber: text) -> (Result_2);
+  submitApplicationToChangeRegister: (request: AP1SubmissionRequest,
+   transactionId: 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

@@ -1,7 +1,55 @@
-import type { Principal } from '@icp-sdk/core/principal';
-import type { ActorMethod } from '@icp-sdk/core/agent';
-import type { IDL } from '@icp-sdk/core/candid';
+import type { Principal } from '@dfinity/principal';
+import type { ActorMethod } from '@dfinity/agent';
+import type { IDL } from '@dfinity/candid';
 
+export interface AP1SubmissionRequest {
+  'transfereeNames' : Array<string>,
+  'transferAmount' : bigint,
+  'transferDate' : string,
+  'titleNumber' : string,
+  'transfereeAddress' : string,
+  'propertyAddress' : string,
+  'transferorAddress' : string,
+  'blockchainProofHash' : string,
+  'propertyPostcode' : string,
+  'conveyancerReference' : string,
+  'conveyancerAddress' : string,
+  'conveyancerSRANumber' : string,
+  'officialSearchRef' : string,
+  'transfereeType' : string,
+  'conveyancerName' : string,
+  'transferorNames' : Array<string>,
+  'applicationType' : string,
+}
+export interface AP1SubmissionResponse {
+  'httpStatus' : bigint,
+  'applicationReference' : string,
+  'message' : string,
+  'confirmationNumber' : string,
+  'estimatedCompletionDate' : [] | [string],
+  'scaleFePence' : bigint,
+}
+export type ActorType = { 'agent' : null } |
+  { 'systemActor' : null } |
+  { 'user' : null };
+export interface ApplicationEnquiryResponse {
+  'completedDate' : [] | [string],
+  'status' : string,
+  'httpStatus' : bigint,
+  'lastUpdated' : string,
+  'applicationReference' : string,
+  'notes' : Array<string>,
+  'applicationDate' : string,
+}
+export interface AuditEntry {
+  'action' : string,
+  'actorType' : ActorType,
+  'delegatedBy' : [] | [Principal],
+  'timestamp' : bigint,
+  'details' : string,
+  'caller' : Principal,
+  'success' : boolean,
+}
 export type AuthenticationType = { 'api_key' : null } |
   { 'oauth2' : null };
 export interface ConveyancerInfo {
@@ -9,8 +57,41 @@ export interface ConveyancerInfo {
   '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 interface ECDResponse {
+  'httpStatus' : bigint,
+  'applicationReference' : string,
+  'estimatedCompletionDate' : string,
+  'confidence' : [] | [string],
+}
 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 interface LRNotification {
+  'titleNumber' : [] | [string],
+  'metadata' : Array<[string, string]>,
+  'notificationType' : string,
+  'applicationReference' : [] | [string],
+  'receivedAt' : bigint,
+  'message' : string,
+}
 export type LRStatus = { 'processing' : null } |
   { 'received' : null } |
   { 'failed' : null } |
@@ -56,6 +137,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,21 +171,67 @@ export type Period = { 'day' : null } |
   { 'month' : null } |
   { 'week' : null } |
   { 'year' : null };
+export interface ProprietorData {
+  'title' : [] | [string],
+  'decoration' : [] | [string],
+  'forenames' : [] | [string],
+  'surname' : [] | [string],
+  'companyLocation' : [] | [string],
+  'organisationType' : [] | [string],
+  'proprietorName' : string,
+  'sequence' : bigint,
+  'proprietorType' : string,
+}
+export interface ProprietorNamesResponse {
+  'httpStatus' : bigint,
+  'titleStatusCode' : string,
+  'titleNumber' : string,
+  'proprietors' : Array<ProprietorData>,
+  'titleStatus' : string,
+}
+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 } |
+export type Result_1 = { 'ok' : AP1SubmissionResponse } |
+  { 'err' : string };
+export type Result_10 = { 'ok' : ProprietorNamesResponse } |
   { 'err' : string };
-export type Result_2 = { 'ok' : OwnershipTransferPayload } |
+export type Result_11 = { 'ok' : ECDResponse } |
   { 'err' : string };
-export type Result_3 = { 'ok' : number } |
+export type Result_12 = { 'ok' : ApplicationEnquiryResponse } |
   { 'err' : string };
-export type Result_4 = { 'ok' : LandRegistryAPIResponse } |
+export type Result_2 = { 'ok' : string } |
+  { 'err' : string };
+export type Result_3 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_4 = { 'ok' : OfficialSearchResponse } |
+  { 'err' : string };
+export type Result_5 = { 'ok' : bigint } |
+  { 'err' : string };
+export type Result_6 = { 'ok' : OwnershipTransferPayload } |
+  { 'err' : string };
+export type Result_7 = { 'ok' : Array<LRNotification> } |
+  { 'err' : string };
+export type Result_8 = { 'ok' : number } |
+  { 'err' : string };
+export type Result_9 = { '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],
@@ -99,9 +239,21 @@ export interface _SERVICE {
   >,
   'configure_land_registry_api' : ActorMethod<
     [LandRegistryAPICredentials],
-    Result_1
+    Result_2
   >,
+  'getApplicationStatus' : ActorMethod<[string], Result_12>,
+  'getAuditLog' : ActorMethod<[], Array<AuditEntry>>,
+  'getCredentialStatus' : ActorMethod<[], CredentialStatus>,
   'getCycles' : ActorMethod<[], bigint>,
+  'getDailySpend' : ActorMethod<[], bigint>,
+  'getEstimatedCompletionDate' : ActorMethod<[string], Result_11>,
+  'getNotificationPollingStatus' : ActorMethod<
+    [],
+    { 'enabled' : boolean, 'intervalSeconds' : bigint, 'lastPollAt' : bigint }
+  >,
+  'getRateLimitStatus' : ActorMethod<[], Array<[string, RateLimitInfo]>>,
+  'getRegisteredProprietorNames' : ActorMethod<[string], Result_10>,
+  'getTotalCosts' : ActorMethod<[bigint, bigint], CostSummary>,
   'get_all_pending_land_registry_submissions' : ActorMethod<
     [string],
     Array<LandRegistryTransactionRecord>
@@ -121,8 +273,9 @@ 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_9>,
+  'log_land_registry_error' : ActorMethod<[string, string], Result_8>,
+  'pollNotifications' : ActorMethod<[], Result_7>,
   'prepare_ownership_transfer_payload' : ActorMethod<
     [
       string,
@@ -141,15 +294,36 @@ export interface _SERVICE {
       bigint,
       bigint,
     ],
-    Result_2
+    Result_6
   >,
   'receive_land_registry_callback' : ActorMethod<
     [LandRegistryAPIResponse],
+    Result_2
+  >,
+  'recordAuditEntry' : ActorMethod<
+    [ActorType, [] | [Principal], string, string, boolean],
+    Result_5
+  >,
+  'requestOfficialSearch' : ActorMethod<
+    [string, string, Array<string>, string],
+    Result_4
+  >,
+  'retry_failed_land_registry_transmission' : ActorMethod<[string], Result_2>,
+  'rotateCredentials' : ActorMethod<[string], Result_3>,
+  'send_to_land_registry' : ActorMethod<[string], Result_2>,
+  'setCredentials' : ActorMethod<
+    [string, string, string, Environment],
+    Result_3
+  >,
+  'setDailySpendLimit' : ActorMethod<[bigint], Result_3>,
+  'setNotificationPolling' : ActorMethod<[boolean, [] | [bigint]], Result_3>,
+  'setUserManagementCanisterId' : ActorMethod<[string], Result_3>,
+  'simulate_land_registry_processing' : ActorMethod<[string], Result_2>,
+  'submitApplicationToChangeRegister' : ActorMethod<
+    [AP1SubmissionRequest, string],
     Result_1
   >,
-  'retry_failed_land_registry_transmission' : ActorMethod<[string], Result_1>,
-  'send_to_land_registry' : ActorMethod<[string], Result_1>,
-  '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>,
 }