@console-wallet/dapp-sdk 0.0.22 → 0.0.24

package/dist/esm/api/generated-wallet-api.d.ts

@@ -25,6 +25,19 @@ export interface BalanceDTO {
     total_locked_coin: string;
     total_unlocked_coin: string;
 }
+export interface CreateSettingBodyDTO {
+    key: string;
+    value: string;
+}
+export interface CreateSettingResponseDTO {
+    /** @format date-time */
+    createdAt: string;
+    id: number;
+    key: string;
+    /** @format date-time */
+    updatedAt: string;
+    value: string;
+}
 export interface CreateTapDTO {
     amount: string;
     partyId: string;
@@ -32,7 +45,7 @@ export interface CreateTapDTO {
 }
 export interface GetOffersSearchResponseDTO {
     data: OfferDTO[];
-    next_cursor: string | null;
+    next_cursor?: string | null;
 }
 export interface GetPartyDetailsResponseDTO {
     amulets: AmuletDTO;
@@ -61,26 +74,37 @@ export interface GetPendingTransactionsResponseDTO {
     items: object[];
 }
 export interface GetPricesResponseDTO {
-    current: string | null;
-    one_day_ago: string | null;
-    one_month_ago: string | null;
-    one_week_ago: string | null;
-    one_year_ago: string | null;
-    start_of_day: string | null;
+    current?: string | null;
+    one_day_ago?: string | null;
+    one_month_ago?: string | null;
+    one_week_ago?: string | null;
+    one_year_ago?: string | null;
+    start_of_day?: string | null;
+}
+export interface GetSettingsResponseDTO {
+    items: SettingResponseDTO[];
 }
 export interface GetTokenTransfersByPartyResponseDTO {
     data: TokenTransferItemDTO[];
-    next_cursor: string | null;
+    next_cursor?: string | null;
 }
 export interface GetTransferDetailsResponseDTO {
-    data: TransferAllocationResponseDTO | TransferInstructionResponseDTO | TransferPreApprovedInstructionResponseDTO | TransferOtherResponseDTO;
+    data: TransferDetailsDataDTO;
+}
+export interface GetTransferPreApprovalResponseDTO {
+    contractId: string;
+    dso: string;
+    /** @format date-time */
+    expiresAt: string;
+    receiverId: string;
+    templateId: string;
 }
 export interface InstructionSummaryDTO {
     amount: string;
-    contract_id: string | null;
+    contract_id?: string | null;
     event_id: string;
     execute_before: string;
-    executed_at: string | null;
+    executed_at?: string | null;
     receiver: string;
     sender: string;
     status: string;
@@ -89,20 +113,44 @@ export interface ListUtxosResponseDTO {
     utxos: string[];
 }
 export interface MetadataDTO {
-    'splice.lfdecentralizedtrust.org/burned': string;
-    'splice.lfdecentralizedtrust.org/sender': string;
-    'splice.lfdecentralizedtrust.org/tx-kind': string;
+    "splice.lfdecentralizedtrust.org/burned"?: string | null;
+    "splice.lfdecentralizedtrust.org/sender"?: string | null;
+    "splice.lfdecentralizedtrust.org/tx-kind"?: string | null;
 }
 export interface OfferDTO {
     amount: string;
-    contract_id: string | null;
+    contract_id?: string | null;
     event_id: string;
+    external_cc_price?: string | null;
+    internal_cc_price?: string | null;
     offer_type: string;
+    provider_party_id: string;
     receiver_party_id: string;
     record_time: string;
     sender_party_id: string;
     status: string;
 }
+export interface PayloadResponseDTO {
+    category: string;
+    name: string;
+    subcategory: string;
+}
+export interface PrepareCancelTransferPreapprovalBodyDTO {
+    contractId: string;
+    partyId: string;
+    templateId: string;
+}
+export interface PrepareCancelTransferPreapprovalResponseDTO {
+    preparedSubmission: PreparedSubmissionResponseDTO;
+    submissionId: string;
+}
+export interface PrepareCreateTransferPreapprovalBodyDTO {
+    partyId: string;
+}
+export interface PrepareCreateTransferPreapprovalResponseDTO {
+    preparedSubmission: PreparedSubmissionResponseDTO;
+    submissionId: string;
+}
 export interface PrepareExternalPartyBodyDTO {
     partyHint?: string;
     publicKey: string;
@@ -111,7 +159,7 @@ export interface PrepareExternalPartyResponseDTO {
     preparedParty: PreparedExternalPartyResponseDTO;
 }
 export interface PrepareResolveTransferBodyDTO {
-    choice: 'Accept' | 'Reject' | 'Withdraw';
+    choice: "Accept" | "Reject" | "Withdraw";
     partyId: string;
     transferCid: string;
 }
@@ -122,30 +170,29 @@ export interface PrepareResolveTransferResponseDTO {
 export interface PrepareTransferBodyDTO {
     amount: string;
     /** @format date-time */
-    expiryDate: string;
+    expiryDate?: string;
+    memo?: string;
     receiver: string;
     sender: string;
 }
 export interface PrepareTransferResponseDTO {
-    hashingDetails: string;
+    hashingDetails: string | null;
     hashingSchemeVersion: string;
     preparedTransaction: string;
     preparedTransactionHash: string;
     submissionId: string;
 }
 export interface PreparedExternalPartyBodyDTO {
-    combinedHash: string;
-    namespace: string;
+    multiHash: string;
     partyId: string;
-    partyTransactions: string[];
-    txHashes: string[];
+    publicKeyFingerprint: string;
+    topologyTransactions: string[];
 }
 export interface PreparedExternalPartyResponseDTO {
-    combinedHash: string;
-    namespace: string;
+    multiHash: string;
     partyId: string;
-    partyTransactions: string[];
-    txHashes: string[];
+    publicKeyFingerprint: string;
+    topologyTransactions: string[];
 }
 export interface PreparedSubmissionBodyDTO {
     hashingDetails: string | null;
@@ -154,18 +201,54 @@ export interface PreparedSubmissionBodyDTO {
     preparedTransactionHash: string;
 }
 export interface PreparedSubmissionResponseDTO {
-    hashingDetails: string;
+    hashingDetails: string | null;
     hashingSchemeVersion: string;
     preparedTransaction: string;
     preparedTransactionHash: string;
 }
+export interface ProxyBodyDTO {
+    siteName: string;
+}
+export interface ProxyIndexerResponseDTO {
+    explore_prices?: GetPricesResponseDTO | null;
+    offers_search?: GetOffersSearchResponseDTO | null;
+    party_details?: GetPartyDetailsResponseDTO | null;
+    token_transfers_by_party?: GetTokenTransfersByPartyResponseDTO | null;
+    token_transfers_event_details?: GetTransferDetailsResponseDTO | null;
+}
 export interface ProxyRequestDTO {
-    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    method: "GET" | "POST" | "PUT" | "DELETE";
     path: string;
-    pathTemplate: '/explore/prices' | '/offers/search' | '/parties/{party_id}' | '/token-transfers/by-party' | '/api/v1/token-transfers/{event_id}';
+    pathTemplate: "/explore/prices" | "/offers/search" | "/parties/{party_id}" | "/token-transfers/by-party" | "/api/v1/token-transfers/{event_id}";
     payload?: string;
+    version?: "v1" | "v2";
+}
+export interface ProxyResponseDTO {
+    payload: PayloadResponseDTO;
+    status: "suspicous" | "dangerous" | "neutral" | "validated";
+    whitelistVersion: number;
+}
+export interface RequestInvitationBodyDTO {
+    comment: string;
+    email: string;
+}
+export interface RequestInvitationResponseDTO {
+    code?: string;
+    deliveryDate?: string;
+    status: "accepted" | "queued";
+}
+export interface SettingResponseDTO {
+    /** @format date-time */
+    createdAt: string;
+    id: number;
+    key: string;
+    /** @format date-time */
+    updatedAt: string;
+    value: string;
 }
 export interface SpentDTO {
+    external_cc_price?: string | null;
+    internal_cc_price?: string | null;
     receivers: SpentReceiverItemDTO[];
     sender_send: string;
     total_change_fee: string;
@@ -177,7 +260,29 @@ export interface SpentReceiverItemDTO {
     amount: string;
     receiver: string;
 }
+export interface SubmitCancelTransferPreapprovalBodyDTO {
+    partyId: string;
+    preparedSubmission: PreparedSubmissionBodyDTO;
+    publicKey: string;
+    signature: string;
+    submissionId: string;
+}
+export interface SubmitCancelTransferPreapprovalResponseDTO {
+    ledgerEnd: number;
+}
+export interface SubmitCreateTransferPreapprovalBodyDTO {
+    partyId: string;
+    preparedSubmission: PreparedSubmissionBodyDTO;
+    publicKey: string;
+    signature: string;
+    submissionId: string;
+}
+export interface SubmitCreateTransferPreapprovalResponseDTO {
+    ledgerEnd: number;
+}
 export interface SubmitExternalPartyBodyDTO {
+    /** Invitation code obtained via Invitations API */
+    invitationCode: string;
     preparedParty: PreparedExternalPartyBodyDTO;
     signedHash: string;
 }
@@ -190,11 +295,17 @@ export interface SubmitResolveTransferBodyDTO {
     signature: string;
     submissionId: string;
 }
+export interface SubmitResolveTransferResponseDTO {
+    ledgerEnd: number;
+}
 export interface SubmitTransferBodyDTO {
     preparedTransfer: PrepareTransferResponseDTO;
     publicKey: string;
     signature: string;
 }
+export interface SubmitTransferResponseDTO {
+    ledgerEnd: number;
+}
 export interface TokenTransferDataDTO {
     holding_fee: string;
     input_amount: string;
@@ -214,7 +325,7 @@ export interface TokenTransferItemDTO {
     transfer_type: string;
 }
 export interface TrafficStatusDTO {
-    last_updated: string | null;
+    last_updated?: string | null;
     total_consumed: number;
     total_limit: number;
     total_purchased: number;
@@ -222,38 +333,32 @@ export interface TrafficStatusDTO {
 }
 export interface TransferAllocationDTO {
     first_step: TransferStepDTO;
-    second_step: TransferStepDTO | null;
+    second_step?: TransferStepDTO | null;
     spent: SpentDTO;
     summary: AllocationSummaryDTO;
 }
-export interface TransferAllocationResponseDTO {
-    allocation: TransferAllocationDTO;
-}
 export type TransferDataReceiversDTO = object;
+export interface TransferDetailsDataDTO {
+    allocation?: TransferAllocationDTO | null;
+    instruction?: TransferInstructionDTO | null;
+    other?: TransferOtherDTO | null;
+    preapproved_instruction?: TransferPreApprovedInstructionDTO | null;
+}
 export interface TransferInstructionDTO {
     first_step: TransferStepDTO;
-    second_step: TransferStepDTO | null;
+    second_step?: TransferStepDTO | null;
     spent: SpentDTO;
     summary: InstructionSummaryDTO;
 }
-export interface TransferInstructionResponseDTO {
-    instruction: TransferInstructionDTO;
-}
 export interface TransferOtherDTO {
     finalized_step: TransferStepDTO;
     spent: SpentDTO;
 }
-export interface TransferOtherResponseDTO {
-    other: TransferOtherDTO;
-}
 export interface TransferPreApprovedInstructionDTO {
     finalized_step: TransferStepDTO;
     spent: SpentDTO;
     summary: InstructionSummaryDTO;
 }
-export interface TransferPreApprovedInstructionResponseDTO {
-    preapproved_instruction: TransferPreApprovedInstructionDTO;
-}
 export interface TransferStepDTO {
     event_id: string;
     record_time: string;
@@ -261,16 +366,29 @@ export interface TransferStepDTO {
     transfer_type: string;
     update_id: string;
 }
+export interface UpdateSettingBodyDTO {
+    key: string;
+    value: string;
+}
+export interface UpdateSettingResponseDTO {
+    /** @format date-time */
+    createdAt: string;
+    id: number;
+    key: string;
+    /** @format date-time */
+    updatedAt: string;
+    value: string;
+}
 export interface ValidatorLicenseDTO {
     active: boolean;
     amulet_balance: string;
-    contact: string | null;
+    contact?: string | null;
     contract_id: string;
     dso: string;
     first_round: number;
-    last_active_at: string | null;
+    last_active_at?: string | null;
     last_round: number;
-    metadata_last_update: string | null;
+    metadata_last_update?: string | null;
     miss_round: number;
     participated_updates_count: number;
     sponsor: string;
@@ -278,11 +396,20 @@ export interface ValidatorLicenseDTO {
     traffic_status: TrafficStatusDTO;
     transfers_count: number;
     validator_id: string;
-    version: string | null;
+    version?: string | null;
 }
-import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
+export interface VerifyInvitationBodyDTO {
+    code: string;
+}
+export interface VerifyInvitationResponseDTO {
+    valid: boolean;
+}
+export interface WaitForTxCompletionResponseDTO {
+    updateId: string;
+}
+import type { AxiosInstance, AxiosRequestConfig, ResponseType } from "axios";
 export type QueryParamsType = Record<string | number, any>;
-export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
+export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
     /** set parameter to `true` for call `securityWorker` for this request */
     secure?: boolean;
     /** request path */
@@ -296,8 +423,8 @@ export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'pa
     /** request body */
     body?: unknown;
 }
-export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
-export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
+export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
     securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
     secure?: boolean;
     format?: ResponseType;
@@ -345,14 +472,78 @@ export declare class WalletApi<SecurityDataType extends unknown> extends HttpCli
          * @request POST:/api/v1/external-party/submit
          */
         externalPartyControllerSubmitExternalParty: (data: SubmitExternalPartyBodyDTO, params?: RequestParams) => Promise<SubmitExternalPartyResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags invitations
+         * @name InvitationsControllerRequestInvitation
+         * @request POST:/api/v1/invitations/request
+         */
+        invitationsControllerRequestInvitation: (data: RequestInvitationBodyDTO, params?: RequestParams) => Promise<RequestInvitationResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags invitations
+         * @name InvitationsControllerVerifyInvitation
+         * @request POST:/api/v1/invitations/verification
+         */
+        invitationsControllerVerifyInvitation: (data: VerifyInvitationBodyDTO, params?: RequestParams) => Promise<VerifyInvitationResponseDTO>;
         /**
          * No description
          *
          * @tags proxy
-         * @name ProxyIndexerControllerProxy
+         * @name ProxyIndexerControllerProxyLegacy
          * @request POST:/api/v1/proxy/indexer
          */
-        proxyIndexerControllerProxy: (data: ProxyRequestDTO, params?: RequestParams) => Promise<GetOffersSearchResponseDTO | GetPartyDetailsResponseDTO | GetPricesResponseDTO | GetTokenTransfersByPartyResponseDTO | GetTransferDetailsResponseDTO>;
+        proxyIndexerControllerProxyLegacy: (data: ProxyRequestDTO, params?: RequestParams) => Promise<GetOffersSearchResponseDTO | GetPartyDetailsResponseDTO | GetPricesResponseDTO | GetTokenTransfersByPartyResponseDTO | GetTransferDetailsResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags proxy
+         * @name ProxyIndexerControllerProxyMapped
+         * @request POST:/api/v1/proxy/indexer/mapped
+         */
+        proxyIndexerControllerProxyMapped: (data: ProxyRequestDTO, params?: RequestParams) => Promise<ProxyIndexerResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags proxy
+         * @name ProxyW3AControllerProxy
+         * @request POST:/api/v1/proxy/phishing
+         */
+        proxyW3AControllerProxy: (data: ProxyBodyDTO, params?: RequestParams) => Promise<ProxyResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags settings
+         * @name SettingControllerCreateSetting
+         * @request POST:/api/v1/settings
+         */
+        settingControllerCreateSetting: (data: CreateSettingBodyDTO, params?: RequestParams) => Promise<CreateSettingResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags settings
+         * @name SettingControllerDeleteSetting
+         * @request DELETE:/api/v1/settings/{id}
+         */
+        settingControllerDeleteSetting: (id: number, params?: RequestParams) => Promise<void>;
+        /**
+         * No description
+         *
+         * @tags settings
+         * @name SettingControllerGetSettings
+         * @request GET:/api/v1/settings
+         */
+        settingControllerGetSettings: (params?: RequestParams) => Promise<GetSettingsResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags settings
+         * @name SettingControllerUpdateSetting
+         * @request PUT:/api/v1/settings/{id}
+         */
+        settingControllerUpdateSetting: (id: number, data: UpdateSettingBodyDTO, params?: RequestParams) => Promise<UpdateSettingResponseDTO>;
         /**
          * No description
          *
@@ -384,7 +575,17 @@ export declare class WalletApi<SecurityDataType extends unknown> extends HttpCli
         /**
          * No description
          *
-         * @tags token-standard
+         * @tags token-standard/transfer
+         * @name TransferControllerGetTransferPreApproval
+         * @request GET:/api/v1/token-standard/transfer/pre-approval
+         */
+        transferControllerGetTransferPreApproval: (query: {
+            partyId: string;
+        }, params?: RequestParams) => Promise<GetTransferPreApprovalResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags token-standard/transfer
          * @name TransferControllerPrepareResolveTransfer
          * @request POST:/api/v1/token-standard/transfer/resolve/prepare
          */
@@ -392,7 +593,7 @@ export declare class WalletApi<SecurityDataType extends unknown> extends HttpCli
         /**
          * No description
          *
-         * @tags token-standard
+         * @tags token-standard/transfer
          * @name TransferControllerPrepareTransfer
          * @request POST:/api/v1/token-standard/transfer/prepare
          */
@@ -400,18 +601,62 @@ export declare class WalletApi<SecurityDataType extends unknown> extends HttpCli
         /**
          * No description
          *
-         * @tags token-standard
+         * @tags token-standard/transfer
          * @name TransferControllerSubmitResolveTransfer
          * @request POST:/api/v1/token-standard/transfer/resolve/submit
          */
-        transferControllerSubmitResolveTransfer: (data: SubmitResolveTransferBodyDTO, params?: RequestParams) => Promise<void>;
+        transferControllerSubmitResolveTransfer: (data: SubmitResolveTransferBodyDTO, params?: RequestParams) => Promise<SubmitResolveTransferResponseDTO>;
         /**
          * No description
          *
-         * @tags token-standard
+         * @tags token-standard/transfer
          * @name TransferControllerSubmitTransfer
          * @request POST:/api/v1/token-standard/transfer/submit
          */
-        transferControllerSubmitTransfer: (data: SubmitTransferBodyDTO, params?: RequestParams) => Promise<void>;
+        transferControllerSubmitTransfer: (data: SubmitTransferBodyDTO, params?: RequestParams) => Promise<SubmitTransferResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags token-standard/transfer
+         * @name TransferControllerWaitForTxCompletion
+         * @request GET:/api/v1/token-standard/transfer/completion/wait
+         */
+        transferControllerWaitForTxCompletion: (query: {
+            commandId: string;
+            ledgerEnd: number;
+            partyId: string;
+        }, params?: RequestParams) => Promise<WaitForTxCompletionResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags token-standard/transfer
+         * @name TransferPreapprovalControllerPrepareCancelTransferPreapproval
+         * @request POST:/api/v1/token-standard/transfer/preapproval/cancel/prepare
+         */
+        transferPreapprovalControllerPrepareCancelTransferPreapproval: (data: PrepareCancelTransferPreapprovalBodyDTO, params?: RequestParams) => Promise<PrepareCancelTransferPreapprovalResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags token-standard/transfer
+         * @name TransferPreapprovalControllerPrepareCreateTransferPreapproval
+         * @request POST:/api/v1/token-standard/transfer/preapproval/create/prepare
+         */
+        transferPreapprovalControllerPrepareCreateTransferPreapproval: (data: PrepareCreateTransferPreapprovalBodyDTO, params?: RequestParams) => Promise<PrepareCreateTransferPreapprovalResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags token-standard/transfer
+         * @name TransferPreapprovalControllerSubmitCancelTransferPreapproval
+         * @request POST:/api/v1/token-standard/transfer/preapproval/cancel/submit
+         */
+        transferPreapprovalControllerSubmitCancelTransferPreapproval: (data: SubmitCancelTransferPreapprovalBodyDTO, params?: RequestParams) => Promise<SubmitCancelTransferPreapprovalResponseDTO>;
+        /**
+         * No description
+         *
+         * @tags token-standard/transfer
+         * @name TransferPreapprovalControllerSubmitCreateTransferPreapproval
+         * @request POST:/api/v1/token-standard/transfer/preapproval/create/submit
+         */
+        transferPreapprovalControllerSubmitCreateTransferPreapproval: (data: SubmitCreateTransferPreapprovalBodyDTO, params?: RequestParams) => Promise<SubmitCreateTransferPreapprovalResponseDTO>;
     };
 }