# Rust API client for ark-rest
Combined Ark Service, Indexer, Admin, Signer Manager, and Wallet API
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 0.7.0
- Generator version: 7.14.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
## Installation
Put the package under your project folder in a directory named `ark-rest` and add the following to `Cargo.toml` under `[dependencies]`:
```
ark-rest = { path = "./ark-rest" }
```
## Documentation for API Endpoints
All URIs are relative to _http://localhost_
| _ArkServiceApi_ | [**ark_service_confirm_registration**](docs/ArkServiceApi.md#ark_service_confirm_registration) | **POST** /v1/batch/ack | |
| _ArkServiceApi_ | [**ark_service_delete_intent**](docs/ArkServiceApi.md#ark_service_delete_intent) | **POST** /v1/batch/deleteIntent | |
| _ArkServiceApi_ | [**ark_service_estimate_intent_fee**](docs/ArkServiceApi.md#ark_service_estimate_intent_fee) | **POST** /v1/batch/estimateFee | |
| _ArkServiceApi_ | [**ark_service_finalize_tx**](docs/ArkServiceApi.md#ark_service_finalize_tx) | **POST** /v1/tx/finalize | |
| _ArkServiceApi_ | [**ark_service_get_event_stream**](docs/ArkServiceApi.md#ark_service_get_event_stream) | **GET** /v1/batch/events | |
| _ArkServiceApi_ | [**ark_service_get_info**](docs/ArkServiceApi.md#ark_service_get_info) | **GET** /v1/info | |
| _ArkServiceApi_ | [**ark_service_get_pending_tx**](docs/ArkServiceApi.md#ark_service_get_pending_tx) | **POST** /v1/tx/pending | |
| _ArkServiceApi_ | [**ark_service_get_transactions_stream**](docs/ArkServiceApi.md#ark_service_get_transactions_stream) | **GET** /v1/txs | |
| _ArkServiceApi_ | [**ark_service_register_intent**](docs/ArkServiceApi.md#ark_service_register_intent) | **POST** /v1/batch/registerIntent | |
| _ArkServiceApi_ | [**ark_service_submit_signed_forfeit_txs**](docs/ArkServiceApi.md#ark_service_submit_signed_forfeit_txs) | **POST** /v1/batch/submitForfeitTxs | |
| _ArkServiceApi_ | [**ark_service_submit_tree_nonces**](docs/ArkServiceApi.md#ark_service_submit_tree_nonces) | **POST** /v1/batch/tree/submitNonces | |
| _ArkServiceApi_ | [**ark_service_submit_tree_signatures**](docs/ArkServiceApi.md#ark_service_submit_tree_signatures) | **POST** /v1/batch/tree/submitSignatures | |
| _ArkServiceApi_ | [**ark_service_submit_tx**](docs/ArkServiceApi.md#ark_service_submit_tx) | **POST** /v1/tx/submit | |
| _IndexerServiceApi_ | [**indexer_service_get_batch_sweep_transactions**](docs/IndexerServiceApi.md#indexer_service_get_batch_sweep_transactions) | **GET** /v1/indexer/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/sweepTxs | |
| _IndexerServiceApi_ | [**indexer_service_get_commitment_tx**](docs/IndexerServiceApi.md#indexer_service_get_commitment_tx) | **GET** /v1/indexer/commitmentTx/{txid} | |
| _IndexerServiceApi_ | [**indexer_service_get_connectors**](docs/IndexerServiceApi.md#indexer_service_get_connectors) | **GET** /v1/indexer/commitmentTx/{txid}/connectors | |
| _IndexerServiceApi_ | [**indexer_service_get_forfeit_txs**](docs/IndexerServiceApi.md#indexer_service_get_forfeit_txs) | **GET** /v1/indexer/commitmentTx/{txid}/forfeitTxs | |
| _IndexerServiceApi_ | [**indexer_service_get_subscription**](docs/IndexerServiceApi.md#indexer_service_get_subscription) | **GET** /v1/indexer/script/subscription/{subscription_id} | |
| _IndexerServiceApi_ | [**indexer_service_get_virtual_txs**](docs/IndexerServiceApi.md#indexer_service_get_virtual_txs) | **GET** /v1/indexer/virtualTx/{txids} | |
| _IndexerServiceApi_ | [**indexer_service_get_vtxo_chain**](docs/IndexerServiceApi.md#indexer_service_get_vtxo_chain) | **GET** /v1/indexer/vtxo/{outpoint.txid}/{outpoint.vout}/chain | |
| _IndexerServiceApi_ | [**indexer_service_get_vtxo_tree**](docs/IndexerServiceApi.md#indexer_service_get_vtxo_tree) | **GET** /v1/indexer/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/tree | |
| _IndexerServiceApi_ | [**indexer_service_get_vtxo_tree_leaves**](docs/IndexerServiceApi.md#indexer_service_get_vtxo_tree_leaves) | **GET** /v1/indexer/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/tree/leaves | |
| _IndexerServiceApi_ | [**indexer_service_get_vtxos**](docs/IndexerServiceApi.md#indexer_service_get_vtxos) | **GET** /v1/indexer/vtxos | |
| _IndexerServiceApi_ | [**indexer_service_subscribe_for_scripts**](docs/IndexerServiceApi.md#indexer_service_subscribe_for_scripts) | **POST** /v1/indexer/script/subscribe | |
| _IndexerServiceApi_ | [**indexer_service_unsubscribe_for_scripts**](docs/IndexerServiceApi.md#indexer_service_unsubscribe_for_scripts) | **POST** /v1/indexer/script/unsubscribe | |
| _SignerManagerServiceApi_ | [**signer_manager_service_load_signer**](docs/SignerManagerServiceApi.md#signer_manager_service_load_signer) | **POST** /v1/admin/signer | |
| _WalletInitializerServiceApi_ | [**wallet_initializer_service_create**](docs/WalletInitializerServiceApi.md#wallet_initializer_service_create) | **POST** /v1/admin/wallet/create | |
| _WalletInitializerServiceApi_ | [**wallet_initializer_service_gen_seed**](docs/WalletInitializerServiceApi.md#wallet_initializer_service_gen_seed) | **GET** /v1/admin/wallet/seed | |
| _WalletInitializerServiceApi_ | [**wallet_initializer_service_get_status**](docs/WalletInitializerServiceApi.md#wallet_initializer_service_get_status) | **GET** /v1/admin/wallet/status | |
| _WalletInitializerServiceApi_ | [**wallet_initializer_service_restore**](docs/WalletInitializerServiceApi.md#wallet_initializer_service_restore) | **POST** /v1/admin/wallet/restore | |
| _WalletInitializerServiceApi_ | [**wallet_initializer_service_unlock**](docs/WalletInitializerServiceApi.md#wallet_initializer_service_unlock) | **POST** /v1/admin/wallet/unlock | |
| _WalletServiceApi_ | [**wallet_service_derive_address**](docs/WalletServiceApi.md#wallet_service_derive_address) | **GET** /v1/admin/wallet/address | |
| _WalletServiceApi_ | [**wallet_service_get_balance**](docs/WalletServiceApi.md#wallet_service_get_balance) | **GET** /v1/admin/wallet/balance | |
| _WalletServiceApi_ | [**wallet_service_lock**](docs/WalletServiceApi.md#wallet_service_lock) | **POST** /v1/admin/wallet/lock | |
| _WalletServiceApi_ | [**wallet_service_withdraw**](docs/WalletServiceApi.md#wallet_service_withdraw) | **POST** /v1/admin/wallet/withdraw | |
## Documentation For Models
- [Any](docs/Any.md)
- [Balance](docs/Balance.md)
- [BatchFailedEvent](docs/BatchFailedEvent.md)
- [BatchFinalizationEvent](docs/BatchFinalizationEvent.md)
- [BatchFinalizedEvent](docs/BatchFinalizedEvent.md)
- [BatchStartedEvent](docs/BatchStartedEvent.md)
- [ConfirmRegistrationRequest](docs/ConfirmRegistrationRequest.md)
- [CreateRequest](docs/CreateRequest.md)
- [DeleteIntentRequest](docs/DeleteIntentRequest.md)
- [DeprecatedSigner](docs/DeprecatedSigner.md)
- [DeriveAddressResponse](docs/DeriveAddressResponse.md)
- [ErrorDetails](docs/ErrorDetails.md)
- [EstimateIntentFeeRequest](docs/EstimateIntentFeeRequest.md)
- [EstimateIntentFeeResponse](docs/EstimateIntentFeeResponse.md)
- [FeeInfo](docs/FeeInfo.md)
- [FinalizeTxRequest](docs/FinalizeTxRequest.md)
- [GenSeedResponse](docs/GenSeedResponse.md)
- [GetBalanceResponse](docs/GetBalanceResponse.md)
- [GetBatchSweepTransactionsRequest](docs/GetBatchSweepTransactionsRequest.md)
- [GetBatchSweepTransactionsResponse](docs/GetBatchSweepTransactionsResponse.md)
- [GetCommitmentTxRequest](docs/GetCommitmentTxRequest.md)
- [GetCommitmentTxResponse](docs/GetCommitmentTxResponse.md)
- [GetConnectorsRequest](docs/GetConnectorsRequest.md)
- [GetConnectorsResponse](docs/GetConnectorsResponse.md)
- [GetEventStreamRequest](docs/GetEventStreamRequest.md)
- [GetEventStreamResponse](docs/GetEventStreamResponse.md)
- [GetForfeitTxsRequest](docs/GetForfeitTxsRequest.md)
- [GetForfeitTxsResponse](docs/GetForfeitTxsResponse.md)
- [GetInfoResponse](docs/GetInfoResponse.md)
- [GetPendingTxRequest](docs/GetPendingTxRequest.md)
- [GetPendingTxResponse](docs/GetPendingTxResponse.md)
- [GetStatusResponse](docs/GetStatusResponse.md)
- [GetSubscriptionRequest](docs/GetSubscriptionRequest.md)
- [GetSubscriptionResponse](docs/GetSubscriptionResponse.md)
- [GetTransactionsStreamResponse](docs/GetTransactionsStreamResponse.md)
- [GetVirtualTxsRequest](docs/GetVirtualTxsRequest.md)
- [GetVirtualTxsResponse](docs/GetVirtualTxsResponse.md)
- [GetVtxoChainRequest](docs/GetVtxoChainRequest.md)
- [GetVtxoChainResponse](docs/GetVtxoChainResponse.md)
- [GetVtxoTreeLeavesRequest](docs/GetVtxoTreeLeavesRequest.md)
- [GetVtxoTreeLeavesResponse](docs/GetVtxoTreeLeavesResponse.md)
- [GetVtxoTreeRequest](docs/GetVtxoTreeRequest.md)
- [GetVtxoTreeResponse](docs/GetVtxoTreeResponse.md)
- [GetVtxosRequest](docs/GetVtxosRequest.md)
- [GetVtxosResponse](docs/GetVtxosResponse.md)
- [IndexerBatch](docs/IndexerBatch.md)
- [IndexerChain](docs/IndexerChain.md)
- [IndexerChainedTxType](docs/IndexerChainedTxType.md)
- [IndexerNode](docs/IndexerNode.md)
- [IndexerOutpoint](docs/IndexerOutpoint.md)
- [IndexerPageRequest](docs/IndexerPageRequest.md)
- [IndexerPageResponse](docs/IndexerPageResponse.md)
- [IndexerSubscriptionEvent](docs/IndexerSubscriptionEvent.md)
- [IndexerTxData](docs/IndexerTxData.md)
- [IndexerTxHistoryRecord](docs/IndexerTxHistoryRecord.md)
- [IndexerTxType](docs/IndexerTxType.md)
- [IndexerVtxo](docs/IndexerVtxo.md)
- [Input](docs/Input.md)
- [Intent](docs/Intent.md)
- [IntentFeeInfo](docs/IntentFeeInfo.md)
- [LoadSignerRequest](docs/LoadSignerRequest.md)
- [Outpoint](docs/Outpoint.md)
- [PendingTx](docs/PendingTx.md)
- [RegisterIntentRequest](docs/RegisterIntentRequest.md)
- [RegisterIntentResponse](docs/RegisterIntentResponse.md)
- [RestoreRequest](docs/RestoreRequest.md)
- [ScheduledSession](docs/ScheduledSession.md)
- [Status](docs/Status.md)
- [SubmitSignedForfeitTxsRequest](docs/SubmitSignedForfeitTxsRequest.md)
- [SubmitTreeNoncesRequest](docs/SubmitTreeNoncesRequest.md)
- [SubmitTreeSignaturesRequest](docs/SubmitTreeSignaturesRequest.md)
- [SubmitTxRequest](docs/SubmitTxRequest.md)
- [SubmitTxResponse](docs/SubmitTxResponse.md)
- [SubscribeForScriptsRequest](docs/SubscribeForScriptsRequest.md)
- [SubscribeForScriptsResponse](docs/SubscribeForScriptsResponse.md)
- [Tapscripts](docs/Tapscripts.md)
- [TreeNoncesAggregatedEvent](docs/TreeNoncesAggregatedEvent.md)
- [TreeNoncesEvent](docs/TreeNoncesEvent.md)
- [TreeSignatureEvent](docs/TreeSignatureEvent.md)
- [TreeSigningStartedEvent](docs/TreeSigningStartedEvent.md)
- [TreeTxEvent](docs/TreeTxEvent.md)
- [TxData](docs/TxData.md)
- [TxNotification](docs/TxNotification.md)
- [UnlockRequest](docs/UnlockRequest.md)
- [UnsubscribeForScriptsRequest](docs/UnsubscribeForScriptsRequest.md)
- [Vtxo](docs/Vtxo.md)
- [WithdrawRequest](docs/WithdrawRequest.md)
- [WithdrawResponse](docs/WithdrawResponse.md)
To get access to the crate's generated documentation, use:
```
cargo doc --open
```
## Author