setUserSetting method

Future<DynamiteResponse<SettingsSetUserSettingResponseApplicationJson, void>> setUserSetting({ required SettingsSetUserSettingKey key, SettingsSetUserSettingValue? value, SettingsSetUserSettingApiVersion? apiVersion, bool? oCSAPIRequest, })

Update user setting.

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:

• key Key to update.
• value New value for the key.
• apiVersion Defaults to "v1".
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: User setting updated successfully
• 400: Updating user setting is not possible

See:

• $setUserSetting_Request for the request send by this method.
• $setUserSetting_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<SettingsSetUserSettingResponseApplicationJson, void>> setUserSetting({
  required SettingsSetUserSettingKey key,
  SettingsSetUserSettingValue? value,
  SettingsSetUserSettingApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $setUserSetting_Request(
    key: key,
    value: value,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $setUserSetting_Serializer();
  final _rawResponse = await _i1.ResponseConverter<SettingsSetUserSettingResponseApplicationJson, void>(_serializer)
      .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}