touchProvider method

Future<DynamiteResponse<ReferenceApiTouchProviderResponseApplicationJson, void>> touchProvider({
  1. required String providerId,
  2. int? timestamp,
  3. bool? oCSAPIRequest,
})

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:

  • timestamp Timestamp of the last usage.
  • 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:

  • touchProviderRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<ReferenceApiTouchProviderResponseApplicationJson, void>> touchProvider({
  required String providerId,
  int? timestamp,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = touchProviderRaw(
    providerId: providerId,
    timestamp: timestamp,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}