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

package/src/canisters/land_registry_integration/land_registry_integration.did

@@ -1,169 +1,395 @@
-type TransactionStatus = 
- variant {
-   confirmed;
-   failed;
-   pending_api_call;
-   requires_manual_review;
-   sent_to_lr;
- };
-type Result_4 = 
- variant {
-   err: text;
-   ok: LandRegistryAPIResponse;
- };
-type Result_3 = 
- variant {
-   err: text;
-   ok: nat32;
- };
-type Result_2 = 
- variant {
-   err: text;
-   ok: OwnershipTransferPayload;
- };
-type Result_1 = 
- variant {
-   err: text;
-   ok: text;
- };
-type Result = 
- variant {
-   err: text;
-   ok: bool;
- };
-type Period = 
- variant {
-   day;
-   month;
-   week;
-   year;
- };
-type OwnershipTransferPayload = 
- record {
-   blockchainCompletionProof: text;
-   blockchainCompletionTimestamp: int;
-   blockchainProofHash: text;
-   buyerSolicitorSignature: text;
-   contractExchangeTimestamp: int;
-   conveyancerDetails: ConveyancerInfo;
-   newOwnerDetails: NewOwnerInfo;
-   postcode: text;
-   previousOwner: text;
-   propertyAddress: text;
-   sellerSolicitorSignature: text;
-   titleNumber: text;
-   transactionAmount: nat64;
-   transactionDate: int;
-   transferID: text;
- };
-type NewOwnerInfo = 
- record {
-   address: text;
-   contactEmail: text;
-   name: text;
- };
-type LandRegistryTransactionRecord = 
- record {
-   apiResponse: opt LandRegistryAPIResponse;
-   blockchainTransactionID: text;
-   createdAt: int;
-   landRegistryPayload: OwnershipTransferPayload;
-   lastUpdated: int;
-   maxRetries: nat32;
-   nextRetryTime: opt int;
-   retryCount: nat32;
-   status: TransactionStatus;
-   transactionID: text;
- };
-type LandRegistryStats = 
- record {
-   avgTimeToRegistration: nat32;
-   failed: nat32;
-   pending: nat32;
-   successful: nat32;
-   totalSubmissions: nat32;
- };
-type LandRegistryAPIResponse = 
- record {
-   errorMessage: opt text;
-   estimatedCompletionTime: int;
-   landRegistryConfirmationNumber: text;
-   processedTimestamp: opt int;
-   receivedTimestamp: int;
-   registeredTimestamp: opt int;
-   responseID: text;
-   status: LRStatus;
- };
-type LandRegistryAPICredentials = 
- record {
-   apiEndpoint: text;
-   apiKey: text;
-   authenticationType: AuthenticationType;
-   environment: Environment;
-   lastValidated: int;
- };
-type LRStatus = 
- variant {
-   failed;
-   processing;
-   received;
-   registered;
- };
-type Environment = 
- variant {
-   production;
-   sandbox;
- };
-type ConveyancerInfo = 
- record {
-   contactEmail: text;
-   licenseNumber: text;
-   name: text;
- };
-type AuthenticationType = 
- variant {
-   api_key;
-   oauth2;
- };
-service : {
-  check_land_registry_status: (transactionID: text) ->
-   (opt LandRegistryTransactionRecord) query;
-  configure_land_registry_api: (credentials: LandRegistryAPICredentials) ->
-   (Result_1);
-  getCycles: () -> (nat) query;
-  get_all_pending_land_registry_submissions: (companyAccountID: text) ->
-   (vec LandRegistryTransactionRecord) query;
-  get_all_transactions: () ->
-   (vec record {
-          text;
-          LandRegistryTransactionRecord;
-        }) query;
-  get_land_registry_stats: (companyAccountID: text, period: Period) ->
-   (LandRegistryStats) query;
-  get_land_registry_status: () ->
-   (opt
-     record {
-       apiEndpoint: text;
-       environment: Environment;
-       lastValidated: int;
-     }) query;
-  get_lr_response: (confirmationID: text) -> (Result_4) query;
-  log_land_registry_error: (transactionID: text, errorDetails: text) ->
-   (Result_3);
-  prepare_ownership_transfer_payload: (transactionID: text,
-   blockchainTransactionID: text, propertyAddress: text, postcode: text,
-   titleNumber: text, previousOwner: text, newOwnerDetails: NewOwnerInfo,
-   conveyancerDetails: ConveyancerInfo, transactionAmount: nat64,
-   buyerSolicitorSignature: text, sellerSolicitorSignature: text,
-   blockchainProofHash: text, blockchainCompletionProof: text,
-   contractExchangeTimestamp: int, blockchainCompletionTimestamp: int) ->
-   (Result_2);
-  receive_land_registry_callback: (callbackData: LandRegistryAPIResponse) ->
-   (Result_1);
-  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);
-  validate_land_registry_connection: () -> (Result);
-  verify_land_registry_receipt: (transactionID: text) -> (Result);
-}
+type TransformArgs = 
+ record {
+   context: blob;
+   response: HttpResponse;
+ };
+type TransactionStatus = 
+ variant {
+   confirmed;
+   failed;
+   pending_api_call;
+   requires_manual_review;
+   sent_to_lr;
+ };
+type Result_9 = 
+ variant {
+   err: text;
+   ok: LandRegistryAPIResponse;
+ };
+type Result_8 = 
+ variant {
+   err: text;
+   ok: nat32;
+ };
+type Result_7 = 
+ variant {
+   err: text;
+   ok: vec LRNotification;
+ };
+type Result_6 = 
+ variant {
+   err: text;
+   ok: OwnershipTransferPayload;
+ };
+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;
+   month;
+   week;
+   year;
+ };
+type OwnershipTransferPayload = 
+ record {
+   blockchainCompletionProof: text;
+   blockchainCompletionTimestamp: int;
+   blockchainProofHash: text;
+   buyerSolicitorSignature: text;
+   contractExchangeTimestamp: int;
+   conveyancerDetails: ConveyancerInfo;
+   newOwnerDetails: NewOwnerInfo;
+   postcode: text;
+   previousOwner: text;
+   propertyAddress: text;
+   sellerSolicitorSignature: text;
+   titleNumber: text;
+   transactionAmount: nat64;
+   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;
+   contactEmail: text;
+   name: text;
+ };
+type LandRegistryTransactionRecord = 
+ record {
+   apiResponse: opt LandRegistryAPIResponse;
+   blockchainTransactionID: text;
+   createdAt: int;
+   landRegistryPayload: OwnershipTransferPayload;
+   lastUpdated: int;
+   maxRetries: nat32;
+   nextRetryTime: opt int;
+   retryCount: nat32;
+   status: TransactionStatus;
+   transactionID: text;
+ };
+type LandRegistryStats = 
+ record {
+   avgTimeToRegistration: nat32;
+   failed: nat32;
+   pending: nat32;
+   successful: nat32;
+   totalSubmissions: nat32;
+ };
+type LandRegistryAPIResponse = 
+ record {
+   errorMessage: opt text;
+   estimatedCompletionTime: int;
+   landRegistryConfirmationNumber: text;
+   processedTimestamp: opt int;
+   receivedTimestamp: int;
+   registeredTimestamp: opt int;
+   responseID: text;
+   status: LRStatus;
+ };
+type LandRegistryAPICredentials = 
+ record {
+   apiEndpoint: text;
+   apiKey: text;
+   authenticationType: AuthenticationType;
+   environment: Environment;
+   lastValidated: int;
+ };
+type LRStatus = 
+ variant {
+   failed;
+   processing;
+   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;
+   licenseNumber: text;
+   name: text;
+ };
+type AuthenticationType = 
+ variant {
+   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: (_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: () ->
+   (vec record {
+          text;
+          LandRegistryTransactionRecord;
+        }) query;
+  get_land_registry_stats: (companyAccountID: text, period: Period) ->
+   (LandRegistryStats) query;
+  get_land_registry_status: () ->
+   (opt
+     record {
+       apiEndpoint: text;
+       environment: Environment;
+       lastValidated: int;
+     }) query;
+  get_lr_response: (confirmationID: text) -> (Result_9) query;
+  log_land_registry_error: (transactionID: text, errorDetails: text) ->
+   (Result_8);
+  pollNotifications: () -> (Result_7);
+  prepare_ownership_transfer_payload: (transactionID: text,
+   blockchainTransactionID: text, propertyAddress: text, postcode: text,
+   titleNumber: text, previousOwner: text, newOwnerDetails: NewOwnerInfo,
+   conveyancerDetails: ConveyancerInfo, transactionAmount: nat64,
+   buyerSolicitorSignature: text, sellerSolicitorSignature: text,
+   blockchainProofHash: text, blockchainCompletionProof: text,
+   contractExchangeTimestamp: int, blockchainCompletionTimestamp: int) ->
+   (Result_6);
+  receive_land_registry_callback: (callbackData: LandRegistryAPIResponse) ->
+   (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_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);
+}