touchProvider method

Future<DynamiteResponse<ReferenceApiTouchProviderResponseApplicationJson, void>> touchProvider({ required String providerId, bool? oCSAPIRequest, ReferenceApiTouchProviderRequestApplicationJson? $body, })

Touch a provider.

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:

• providerId ID of the provider.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Provider touched

See:

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

Implementation

Future<_i1.DynamiteResponse<ReferenceApiTouchProviderResponseApplicationJson, void>> touchProvider({
  required String providerId,
  bool? oCSAPIRequest,
  ReferenceApiTouchProviderRequestApplicationJson? $body,
}) async {
  final _request = $touchProvider_Request(
    providerId: providerId,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $touchProvider_Serializer();
  return _i1.ResponseConverter<ReferenceApiTouchProviderResponseApplicationJson, void>(_serializer)
      .convert(_response);
}