$translate_Request method

@experimental Request $translate_Request({ required String text, required String toLanguage, String? fromLanguage, bool? oCSAPIRequest, })

Translate a text.

Returns a DynamiteRequest backing the translate operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• text Text to be translated.
• fromLanguage Language to translate from.
• toLanguage Language to translate to.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Translated text returned
• 400: Language not detected or unable to translate
• 412: Translating is not possible
• 500

See:

• translate for a method executing this request and parsing the response.
• $translate_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $translate_Request({
  required String text,
  required String toLanguage,
  String? fromLanguage,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $text = _$jsonSerializers.serialize(text, specifiedType: const FullType(String));
  _parameters['text'] = $text;

  final $toLanguage = _$jsonSerializers.serialize(toLanguage, specifiedType: const FullType(String));
  _parameters['toLanguage'] = $toLanguage;

  final $fromLanguage = _$jsonSerializers.serialize(fromLanguage, specifiedType: const FullType(String));
  _parameters['fromLanguage'] = $fromLanguage;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/translation/translate{?text*,toLanguage*,fromLanguage*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}