Rust API client for marlowe_client

REST API for Marlowe Runtime

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 0.0.5.1
• Package version: 0.0.5.1
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named marlowe_client and add the following to Cargo.toml under [dependencies]:

marlowe_client = { path = "./marlowe_client" }

Documentation for API Endpoints

All URIs are relative to https://marlowe-runtime-preprod-web.scdev.aws.iohkdev.io

DefaultApi | apply_inputs_to_contract | POST /contracts/{contractId}/transactions | Apply inputs to contract DefaultApi | create_contract | POST /contracts | Create a new contract DefaultApi | create_contract_sources | POST /contracts/sources | Upload contract sources DefaultApi | get_contract_by_id | GET /contracts/{contractId} | Get contract by ID DefaultApi | get_contract_source_adjacency | GET /contracts/sources/{contractSourceId}/adjacency | Get adjacent contract source IDs by ID DefaultApi | get_contract_source_by_id | GET /contracts/sources/{contractSourceId} | Get contract source by ID DefaultApi | get_contract_source_closure | GET /contracts/sources/{contractSourceId}/closure | Get contract source closure by ID DefaultApi | get_contract_transaction_by_id | GET /contracts/{contractId}/transactions/{transactionId} | Get contract transaction by ID DefaultApi | get_contracts | GET /contracts | Get contracts DefaultApi | get_next_steps_for_contract | GET /contracts/{contractId}/next | Get next contract steps DefaultApi | get_payout_by_id | GET /payouts/{payoutId} | Get payout by ID DefaultApi | get_payouts | GET /payouts | Get role payouts DefaultApi | get_transactions_for_contract | GET /contracts/{contractId}/transactions | Get transactions for contract DefaultApi | get_withdrawal_by_id | GET /withdrawals/{withdrawalId} | Get withdrawal by ID DefaultApi | get_withdrawals | GET /withdrawals | Get withdrawals DefaultApi | healthcheck | GET /healthcheck | Test server status DefaultApi | submit_contract | PUT /contracts/{contractId} | Submit contract to chain DefaultApi | submit_contract_transaction | PUT /contracts/{contractId}/transactions/{transactionId} | Submit contract input application DefaultApi | submit_withdrawal | PUT /withdrawals/{withdrawalId} | Submit payout withdrawal DefaultApi | withdraw_payouts | POST /withdrawals | Withdraw payouts

Documentation For Models

• AccountTokenTupleInner

• Action

• ActionObject

• Add

• AddObject

• AddressAndMetadata

• And

• AndObject

• ApplicableInputs

• ApplyInputsResponse

• ApplyInputsResponseLinks

• ApplyInputsTxEnvelope

• Assert

• AssertFail

• AssertObject

• AssetId

• Assets

• BlockHeader

• Bound

• CanChoose

• CanDeposit

• CanNotify

• Case

• CaseMerkleizedThen

• CaseMerkleizedThenObject

• CaseObject

• CaseThen

• CaseThenObject

• ChoiceAction

• ChoiceActionObject

• ChoiceContinuationInput

• ChoiceId

• ChoiceIdObject

• ChoiceInput

• ChooseFor

• ChooseForObject

• Close

• CloseObject

• ContinuationInput

• Contract

• ContractHeader

• ContractObject

• ContractSourceIds

• ContractState

• CreateContractResponse

• CreateContractResponseLinks

• CreateTxBodyEnvelope

• CreateTxEnvelope

• DepositAction

• DepositActionObject

• DepositContinuationInput

• DepositInput

• Divide

• DivideObject

• Equal

• EqualObject

• ExBudget

• GetContractResponse

• GetContractResponseLinks

• GetContractsResponse

• GetContractsResponseResultsInner

• GetContractsResponseResultsInnerLinks

• GetPayoutResponse

• GetPayoutResponseLinks

• GetPayoutsResponse

• GetPayoutsResponseResultsInner

• GetPayoutsResponseResultsInnerLinks

• GetTransactionResponse

• GetTransactionResponseLinks

• GetTransactionsResponse

• GetTransactionsResponseResultsInner

• GetWithdrawalsResponse

• GetWithdrawalsResponseResultsInner

• GetWithdrawalsResponseResultsInnerLinks

• Greater

• GreaterObject

• GreaterOrEqual

• GreaterOrEqualObject

• If

• IfObject

• IfValue

• IfValueObject

• Input

• IntervalError

• IntervalInPast

• IntervalInPastIntervalInPastError

• InvalidInterval

• InvalidIntervalInvalidInterval

• LabelRef

• LabelledObject

• LabelledObjectValue

• Lesser

• LesserObject

• LesserOrEqual

• LesserOrEqualObject

• Let

• LetObject

• MarloweState

• MarloweStateAccountsInnerInner

• MarloweStateBoundValuesInnerInner

• MarloweStateChoicesInnerInner

• MarloweVersion

• Metadata

• MetadataAndRecipients

• MetadataAndScript

• Minus

• MinusObject

• Multiply

• MultiplyObject

• Negate

• NegateObject

• Next

• NonPositiveDeposit

• NonPositivePayment

• Not

• NotObject

• NotifyAction

• NotifyActionObject

• NotifyInput

• Observation

• ObservationObject

• Or

• OrObject

• PartialPayment

• Party

• PartyAddress

• PartyObject

• PartyRoleName

• Pay

• PayObject

• PayToAccount

• PayToAccountObject

• PayToParty

• PayToPartyObject

• Payee

• PayeeObject

• Payment

• Payout

• PayoutHeader

• PayoutState

• PayoutStatus

• PlutusPeriodAddress

• PlutusPeriodCredential

• PlutusPeriodStakingCredential

• PostContractSourceResponse

• PostContractsRequest

• PostContractsRequestContract

• PostTransactionsRequest

• PostWithdrawalsRequest

• PubKeyCredential

• RoleTokenConfig

• RolesConfig

• SafetyError

• ScriptCredential

• StakingHash

• StakingPointer

• TextEnvelope

• TimeInterval

• Token

• TokenInAccount

• TokenInAccountObject

• TokenMetadata

• TokenMetadataFile

• TokenObject

• Transaction

• TransactionError

• TransactionErrorOneOf

• TransactionInput

• TransactionInputTxInterval

• TransactionOutput

• TransactionWarning

• Tx

• TxHeader

• TxOutputError

• TxOutputSuccess

• TxStatus

• UseValue

• Value

• ValueObject

• ValueOfChoice

• ValueOfChoiceObject

• VariableShadowing

• When

• WhenObject

• WithdrawPayoutsResponse

• WithdrawTxBodyEnvelope

• WithdrawTxEnvelope

• Withdrawal

• WithdrawalHeader

To get access to the crate's generated documentation, use:

cargo doc --open