setValue method
Update the config value of an app.
This endpoint requires password confirmation.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
value
New value for the key.app
ID of the app.key
Key to update.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Value updated successfully
- 403: App or key is not allowed
See:
- $setValue_Request for the request send by this method.
- $setValue_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<AppConfigSetValueResponseApplicationJson, void>> setValue({
required String value,
required String app,
required String key,
bool? oCSAPIRequest,
}) async {
final _request = $setValue_Request(
value: value,
app: app,
key: key,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $setValue_Serializer();
final _rawResponse =
await _i1.ResponseConverter<AppConfigSetValueResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}