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

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

@@ -1,157 +1,331 @@
-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 type AuthenticationType = { 'api_key' : null } |
-  { 'oauth2' : null };
-export interface ConveyancerInfo {
-  'name' : string,
-  'contactEmail' : string,
-  'licenseNumber' : string,
-}
-export type Environment = { 'sandbox' : null } |
-  { 'production' : null };
-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],
-  'processedTimestamp' : [] | [bigint],
-  'errorMessage' : [] | [string],
-  'receivedTimestamp' : bigint,
-  'responseID' : string,
-  'estimatedCompletionTime' : bigint,
-  'landRegistryConfirmationNumber' : string,
-}
-export interface LandRegistryStats {
-  'pending' : number,
-  'totalSubmissions' : number,
-  'avgTimeToRegistration' : number,
-  'successful' : number,
-  'failed' : number,
-}
-export interface LandRegistryTransactionRecord {
-  'status' : TransactionStatus,
-  'createdAt' : bigint,
-  'lastUpdated' : bigint,
-  'maxRetries' : number,
-  'landRegistryPayload' : OwnershipTransferPayload,
-  'retryCount' : number,
-  'nextRetryTime' : [] | [bigint],
-  'blockchainTransactionID' : string,
-  'apiResponse' : [] | [LandRegistryAPIResponse],
-  'transactionID' : string,
-}
-export interface NewOwnerInfo {
-  'name' : string,
-  'address' : string,
-  'contactEmail' : string,
-}
-export interface OwnershipTransferPayload {
-  'transactionDate' : bigint,
-  'postcode' : string,
-  'sellerSolicitorSignature' : string,
-  'buyerSolicitorSignature' : string,
-  'titleNumber' : string,
-  'newOwnerDetails' : NewOwnerInfo,
-  'blockchainCompletionProof' : string,
-  'previousOwner' : string,
-  'propertyAddress' : string,
-  'contractExchangeTimestamp' : bigint,
-  'blockchainProofHash' : string,
-  'transactionAmount' : bigint,
-  'transferID' : string,
-  'conveyancerDetails' : ConveyancerInfo,
-  'blockchainCompletionTimestamp' : bigint,
-}
-export type Period = { 'day' : null } |
-  { 'month' : null } |
-  { 'week' : null } |
-  { 'year' : null };
-export type Result = { 'ok' : boolean } |
-  { 'err' : string };
-export type Result_1 = { 'ok' : string } |
-  { 'err' : string };
-export type Result_2 = { 'ok' : OwnershipTransferPayload } |
-  { 'err' : string };
-export type Result_3 = { 'ok' : number } |
-  { 'err' : string };
-export type Result_4 = { '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 _SERVICE {
-  'check_land_registry_status' : ActorMethod<
-    [string],
-    [] | [LandRegistryTransactionRecord]
-  >,
-  'configure_land_registry_api' : ActorMethod<
-    [LandRegistryAPICredentials],
-    Result_1
-  >,
-  'getCycles' : ActorMethod<[], bigint>,
-  'get_all_pending_land_registry_submissions' : ActorMethod<
-    [string],
-    Array<LandRegistryTransactionRecord>
-  >,
-  'get_all_transactions' : ActorMethod<
-    [],
-    Array<[string, LandRegistryTransactionRecord]>
-  >,
-  'get_land_registry_stats' : ActorMethod<[string, Period], LandRegistryStats>,
-  'get_land_registry_status' : ActorMethod<
-    [],
-    [] | [
-      {
-        'lastValidated' : bigint,
-        'apiEndpoint' : string,
-        'environment' : Environment,
-      }
-    ]
-  >,
-  'get_lr_response' : ActorMethod<[string], Result_4>,
-  'log_land_registry_error' : ActorMethod<[string, string], Result_3>,
-  'prepare_ownership_transfer_payload' : ActorMethod<
-    [
-      string,
-      string,
-      string,
-      string,
-      string,
-      string,
-      NewOwnerInfo,
-      ConveyancerInfo,
-      bigint,
-      string,
-      string,
-      string,
-      string,
-      bigint,
-      bigint,
-    ],
-    Result_2
-  >,
-  'receive_land_registry_callback' : ActorMethod<
-    [LandRegistryAPIResponse],
-    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>,
-  'validate_land_registry_connection' : ActorMethod<[], Result>,
-  'verify_land_registry_receipt' : ActorMethod<[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 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 {
+  '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 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 } |
+  { 'registered' : null };
+export interface LandRegistryAPICredentials {
+  'authenticationType' : AuthenticationType,
+  'lastValidated' : bigint,
+  'apiEndpoint' : string,
+  'apiKey' : string,
+  'environment' : Environment,
+}
+export interface LandRegistryAPIResponse {
+  'status' : LRStatus,
+  'registeredTimestamp' : [] | [bigint],
+  'processedTimestamp' : [] | [bigint],
+  'errorMessage' : [] | [string],
+  'receivedTimestamp' : bigint,
+  'responseID' : string,
+  'estimatedCompletionTime' : bigint,
+  'landRegistryConfirmationNumber' : string,
+}
+export interface LandRegistryStats {
+  'pending' : number,
+  'totalSubmissions' : number,
+  'avgTimeToRegistration' : number,
+  'successful' : number,
+  'failed' : number,
+}
+export interface LandRegistryTransactionRecord {
+  'status' : TransactionStatus,
+  'createdAt' : bigint,
+  'lastUpdated' : bigint,
+  'maxRetries' : number,
+  'landRegistryPayload' : OwnershipTransferPayload,
+  'retryCount' : number,
+  'nextRetryTime' : [] | [bigint],
+  'blockchainTransactionID' : string,
+  'apiResponse' : [] | [LandRegistryAPIResponse],
+  'transactionID' : string,
+}
+export interface NewOwnerInfo {
+  'name' : string,
+  '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,
+  'sellerSolicitorSignature' : string,
+  'buyerSolicitorSignature' : string,
+  'titleNumber' : string,
+  'newOwnerDetails' : NewOwnerInfo,
+  'blockchainCompletionProof' : string,
+  'previousOwner' : string,
+  'propertyAddress' : string,
+  'contractExchangeTimestamp' : bigint,
+  'blockchainProofHash' : string,
+  'transactionAmount' : bigint,
+  'transferID' : string,
+  'conveyancerDetails' : ConveyancerInfo,
+  'blockchainCompletionTimestamp' : bigint,
+}
+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' : AP1SubmissionResponse } |
+  { 'err' : string };
+export type Result_10 = { 'ok' : ProprietorNamesResponse } |
+  { 'err' : string };
+export type Result_11 = { 'ok' : ECDResponse } |
+  { 'err' : string };
+export type Result_12 = { 'ok' : ApplicationEnquiryResponse } |
+  { 'err' : string };
+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],
+    [] | [LandRegistryTransactionRecord]
+  >,
+  'configure_land_registry_api' : ActorMethod<
+    [LandRegistryAPICredentials],
+    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>
+  >,
+  'get_all_transactions' : ActorMethod<
+    [],
+    Array<[string, LandRegistryTransactionRecord]>
+  >,
+  'get_land_registry_stats' : ActorMethod<[string, Period], LandRegistryStats>,
+  'get_land_registry_status' : ActorMethod<
+    [],
+    [] | [
+      {
+        'lastValidated' : bigint,
+        'apiEndpoint' : string,
+        'environment' : Environment,
+      }
+    ]
+  >,
+  '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,
+      string,
+      string,
+      string,
+      string,
+      string,
+      NewOwnerInfo,
+      ConveyancerInfo,
+      bigint,
+      string,
+      string,
+      string,
+      string,
+      bigint,
+      bigint,
+    ],
+    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
+  >,
+  'transform' : ActorMethod<[TransformArgs], HttpResponse>,
+  'validate_land_registry_connection' : ActorMethod<[], Result>,
+  'verify_land_registry_receipt' : ActorMethod<[string], Result>,
+}
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];