modify method
Future<DynamiteResponse<ConfigapiModifyResponseApplicationJson, void> >
modify({
- required ContentString<
BuiltMap< configData,String, JsonObject> > - required String configID,
- bool? oCSAPIRequest,
Modify a configuration.
This endpoint requires admin access.
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:
configData
New config.configID
ID of the config.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Config returned
- 400: Modifying config is not possible
- 404: Config not found
See:
- $modify_Request for the request send by this method.
- $modify_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ConfigapiModifyResponseApplicationJson, void>> modify({
required ContentString<BuiltMap<String, JsonObject>> configData,
required String configID,
bool? oCSAPIRequest,
}) async {
final _request = $modify_Request(
configData: configData,
configID: configID,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $modify_Serializer();
final _rawResponse =
await _i1.ResponseConverter<ConfigapiModifyResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}