marlowe_client 0.0.5

HTTP client for the Marlowe Runtime REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

# Rust API client for marlowe_client

REST API for Marlowe Runtime


## 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: 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*

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


## Documentation For Models

 - [AccountTokenTupleInner](docs/AccountTokenTupleInner.md)
 - [Action](docs/Action.md)
 - [ActionObject](docs/ActionObject.md)
 - [Add](docs/Add.md)
 - [AddObject](docs/AddObject.md)
 - [AddressAndMetadata](docs/AddressAndMetadata.md)
 - [And](docs/And.md)
 - [AndObject](docs/AndObject.md)
 - [ApplicableInputs](docs/ApplicableInputs.md)
 - [ApplyInputsResponse](docs/ApplyInputsResponse.md)
 - [ApplyInputsResponseLinks](docs/ApplyInputsResponseLinks.md)
 - [ApplyInputsTxEnvelope](docs/ApplyInputsTxEnvelope.md)
 - [Assert](docs/Assert.md)
 - [AssertFail](docs/AssertFail.md)
 - [AssertObject](docs/AssertObject.md)
 - [AssetId](docs/AssetId.md)
 - [Assets](docs/Assets.md)
 - [BlockHeader](docs/BlockHeader.md)
 - [Bound](docs/Bound.md)
 - [CanChoose](docs/CanChoose.md)
 - [CanDeposit](docs/CanDeposit.md)
 - [CanNotify](docs/CanNotify.md)
 - [Case](docs/Case.md)
 - [CaseMerkleizedThen](docs/CaseMerkleizedThen.md)
 - [CaseMerkleizedThenObject](docs/CaseMerkleizedThenObject.md)
 - [CaseObject](docs/CaseObject.md)
 - [CaseThen](docs/CaseThen.md)
 - [CaseThenObject](docs/CaseThenObject.md)
 - [ChoiceAction](docs/ChoiceAction.md)
 - [ChoiceActionObject](docs/ChoiceActionObject.md)
 - [ChoiceContinuationInput](docs/ChoiceContinuationInput.md)
 - [ChoiceId](docs/ChoiceId.md)
 - [ChoiceIdObject](docs/ChoiceIdObject.md)
 - [ChoiceInput](docs/ChoiceInput.md)
 - [ChooseFor](docs/ChooseFor.md)
 - [ChooseForObject](docs/ChooseForObject.md)
 - [Close](docs/Close.md)
 - [CloseObject](docs/CloseObject.md)
 - [ContinuationInput](docs/ContinuationInput.md)
 - [Contract](docs/Contract.md)
 - [ContractHeader](docs/ContractHeader.md)
 - [ContractObject](docs/ContractObject.md)
 - [ContractSourceIds](docs/ContractSourceIds.md)
 - [ContractState](docs/ContractState.md)
 - [CreateContractResponse](docs/CreateContractResponse.md)
 - [CreateContractResponseLinks](docs/CreateContractResponseLinks.md)
 - [CreateTxBodyEnvelope](docs/CreateTxBodyEnvelope.md)
 - [CreateTxEnvelope](docs/CreateTxEnvelope.md)
 - [DepositAction](docs/DepositAction.md)
 - [DepositActionObject](docs/DepositActionObject.md)
 - [DepositContinuationInput](docs/DepositContinuationInput.md)
 - [DepositInput](docs/DepositInput.md)
 - [Divide](docs/Divide.md)
 - [DivideObject](docs/DivideObject.md)
 - [Equal](docs/Equal.md)
 - [EqualObject](docs/EqualObject.md)
 - [ExBudget](docs/ExBudget.md)
 - [GetContractResponse](docs/GetContractResponse.md)
 - [GetContractResponseLinks](docs/GetContractResponseLinks.md)
 - [GetContractsResponse](docs/GetContractsResponse.md)
 - [GetContractsResponseResultsInner](docs/GetContractsResponseResultsInner.md)
 - [GetContractsResponseResultsInnerLinks](docs/GetContractsResponseResultsInnerLinks.md)
 - [GetPayoutResponse](docs/GetPayoutResponse.md)
 - [GetPayoutResponseLinks](docs/GetPayoutResponseLinks.md)
 - [GetPayoutsResponse](docs/GetPayoutsResponse.md)
 - [GetPayoutsResponseResultsInner](docs/GetPayoutsResponseResultsInner.md)
 - [GetPayoutsResponseResultsInnerLinks](docs/GetPayoutsResponseResultsInnerLinks.md)
 - [GetTransactionResponse](docs/GetTransactionResponse.md)
 - [GetTransactionResponseLinks](docs/GetTransactionResponseLinks.md)
 - [GetTransactionsResponse](docs/GetTransactionsResponse.md)
 - [GetTransactionsResponseResultsInner](docs/GetTransactionsResponseResultsInner.md)
 - [GetWithdrawalsResponse](docs/GetWithdrawalsResponse.md)
 - [GetWithdrawalsResponseResultsInner](docs/GetWithdrawalsResponseResultsInner.md)
 - [GetWithdrawalsResponseResultsInnerLinks](docs/GetWithdrawalsResponseResultsInnerLinks.md)
 - [Greater](docs/Greater.md)
 - [GreaterObject](docs/GreaterObject.md)
 - [GreaterOrEqual](docs/GreaterOrEqual.md)
 - [GreaterOrEqualObject](docs/GreaterOrEqualObject.md)
 - [If](docs/If.md)
 - [IfObject](docs/IfObject.md)
 - [IfValue](docs/IfValue.md)
 - [IfValueObject](docs/IfValueObject.md)
 - [Input](docs/Input.md)
 - [IntervalError](docs/IntervalError.md)
 - [IntervalInPast](docs/IntervalInPast.md)
 - [IntervalInPastIntervalInPastError](docs/IntervalInPastIntervalInPastError.md)
 - [InvalidInterval](docs/InvalidInterval.md)
 - [InvalidIntervalInvalidInterval](docs/InvalidIntervalInvalidInterval.md)
 - [LabelRef](docs/LabelRef.md)
 - [LabelledObject](docs/LabelledObject.md)
 - [LabelledObjectValue](docs/LabelledObjectValue.md)
 - [Lesser](docs/Lesser.md)
 - [LesserObject](docs/LesserObject.md)
 - [LesserOrEqual](docs/LesserOrEqual.md)
 - [LesserOrEqualObject](docs/LesserOrEqualObject.md)
 - [Let](docs/Let.md)
 - [LetObject](docs/LetObject.md)
 - [MarloweState](docs/MarloweState.md)
 - [MarloweStateAccountsInnerInner](docs/MarloweStateAccountsInnerInner.md)
 - [MarloweStateBoundValuesInnerInner](docs/MarloweStateBoundValuesInnerInner.md)
 - [MarloweStateChoicesInnerInner](docs/MarloweStateChoicesInnerInner.md)
 - [MarloweVersion](docs/MarloweVersion.md)
 - [Metadata](docs/Metadata.md)
 - [MetadataAndRecipients](docs/MetadataAndRecipients.md)
 - [MetadataAndScript](docs/MetadataAndScript.md)
 - [Minus](docs/Minus.md)
 - [MinusObject](docs/MinusObject.md)
 - [Multiply](docs/Multiply.md)
 - [MultiplyObject](docs/MultiplyObject.md)
 - [Negate](docs/Negate.md)
 - [NegateObject](docs/NegateObject.md)
 - [Next](docs/Next.md)
 - [NonPositiveDeposit](docs/NonPositiveDeposit.md)
 - [NonPositivePayment](docs/NonPositivePayment.md)
 - [Not](docs/Not.md)
 - [NotObject](docs/NotObject.md)
 - [NotifyAction](docs/NotifyAction.md)
 - [NotifyActionObject](docs/NotifyActionObject.md)
 - [NotifyInput](docs/NotifyInput.md)
 - [Observation](docs/Observation.md)
 - [ObservationObject](docs/ObservationObject.md)
 - [Or](docs/Or.md)
 - [OrObject](docs/OrObject.md)
 - [PartialPayment](docs/PartialPayment.md)
 - [Party](docs/Party.md)
 - [PartyAddress](docs/PartyAddress.md)
 - [PartyObject](docs/PartyObject.md)
 - [PartyRoleName](docs/PartyRoleName.md)
 - [Pay](docs/Pay.md)
 - [PayObject](docs/PayObject.md)
 - [PayToAccount](docs/PayToAccount.md)
 - [PayToAccountObject](docs/PayToAccountObject.md)
 - [PayToParty](docs/PayToParty.md)
 - [PayToPartyObject](docs/PayToPartyObject.md)
 - [Payee](docs/Payee.md)
 - [PayeeObject](docs/PayeeObject.md)
 - [Payment](docs/Payment.md)
 - [Payout](docs/Payout.md)
 - [PayoutHeader](docs/PayoutHeader.md)
 - [PayoutState](docs/PayoutState.md)
 - [PayoutStatus](docs/PayoutStatus.md)
 - [PlutusPeriodAddress](docs/PlutusPeriodAddress.md)
 - [PlutusPeriodCredential](docs/PlutusPeriodCredential.md)
 - [PlutusPeriodStakingCredential](docs/PlutusPeriodStakingCredential.md)
 - [PostContractSourceResponse](docs/PostContractSourceResponse.md)
 - [PostContractsRequest](docs/PostContractsRequest.md)
 - [PostContractsRequestContract](docs/PostContractsRequestContract.md)
 - [PostTransactionsRequest](docs/PostTransactionsRequest.md)
 - [PostWithdrawalsRequest](docs/PostWithdrawalsRequest.md)
 - [PubKeyCredential](docs/PubKeyCredential.md)
 - [RoleTokenConfig](docs/RoleTokenConfig.md)
 - [RolesConfig](docs/RolesConfig.md)
 - [SafetyError](docs/SafetyError.md)
 - [ScriptCredential](docs/ScriptCredential.md)
 - [StakingHash](docs/StakingHash.md)
 - [StakingPointer](docs/StakingPointer.md)
 - [TextEnvelope](docs/TextEnvelope.md)
 - [TimeInterval](docs/TimeInterval.md)
 - [Token](docs/Token.md)
 - [TokenInAccount](docs/TokenInAccount.md)
 - [TokenInAccountObject](docs/TokenInAccountObject.md)
 - [TokenMetadata](docs/TokenMetadata.md)
 - [TokenMetadataFile](docs/TokenMetadataFile.md)
 - [TokenObject](docs/TokenObject.md)
 - [Transaction](docs/Transaction.md)
 - [TransactionError](docs/TransactionError.md)
 - [TransactionErrorOneOf](docs/TransactionErrorOneOf.md)
 - [TransactionInput](docs/TransactionInput.md)
 - [TransactionInputTxInterval](docs/TransactionInputTxInterval.md)
 - [TransactionOutput](docs/TransactionOutput.md)
 - [TransactionWarning](docs/TransactionWarning.md)
 - [Tx](docs/Tx.md)
 - [TxHeader](docs/TxHeader.md)
 - [TxOutputError](docs/TxOutputError.md)
 - [TxOutputSuccess](docs/TxOutputSuccess.md)
 - [TxStatus](docs/TxStatus.md)
 - [UseValue](docs/UseValue.md)
 - [Value](docs/Value.md)
 - [ValueObject](docs/ValueObject.md)
 - [ValueOfChoice](docs/ValueOfChoice.md)
 - [ValueOfChoiceObject](docs/ValueOfChoiceObject.md)
 - [VariableShadowing](docs/VariableShadowing.md)
 - [When](docs/When.md)
 - [WhenObject](docs/WhenObject.md)
 - [WithdrawPayoutsResponse](docs/WithdrawPayoutsResponse.md)
 - [WithdrawTxBodyEnvelope](docs/WithdrawTxBodyEnvelope.md)
 - [WithdrawTxEnvelope](docs/WithdrawTxEnvelope.md)
 - [Withdrawal](docs/Withdrawal.md)
 - [WithdrawalHeader](docs/WithdrawalHeader.md)


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

```
cargo doc --open
```