getUserTermsOfService method

Future<Response<UserTermsOfService>> getUserTermsOfService({ required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, })

Fetches user's latest terms of service action if the latest action was for acceptance. Will be deprecated in v6.0 Fetches user's latest terms of service action if the latest action was for acceptance. Minimum server version: 5.6 ##### Permissions Must be logged in as the user being acted on.

Parameters:

• userId - User GUID
• cancelToken - A CancelToken that can be used to cancel the operation
• headers - Can be used to add additional headers to the request
• extras - Can be used to add flags to the request
• validateStatus - A ValidateStatus callback that can be used to determine request success based on the HTTP status of the response
• onSendProgress - A ProgressCallback that can be used to get the send progress
• onReceiveProgress - A ProgressCallback that can be used to get the receive progress

Returns a Future containing a Response with a UserTermsOfService as data Throws DioError if API call or serialization fails

Implementation

Future<Response<UserTermsOfService>> getUserTermsOfService({
  required String userId,
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final _path = r'/users/{user_id}/terms_of_service'.replaceAll('{' r'user_id' '}', userId.toString());
  final _options = Options(
    method: r'GET',
    headers: <String, dynamic>{
      ...?headers,
    },
    extra: <String, dynamic>{
      'secure': <Map<String, String>>[
        {
          'type': 'http',
          'scheme': 'bearer',
          'name': 'bearerAuth',
        },
      ],
      ...?extra,
    },
    validateStatus: validateStatus,
  );

  final _response = await _dio.request<Object>(
    _path,
    options: _options,
    cancelToken: cancelToken,
    onSendProgress: onSendProgress,
    onReceiveProgress: onReceiveProgress,
  );

  UserTermsOfService _responseData;

  try {
    const _responseType = FullType(UserTermsOfService);
    _responseData = _serializers.deserialize(
      _response.data!,
      specifiedType: _responseType,
    ) as UserTermsOfService;

  } catch (error, stackTrace) {
    throw DioError(
      requestOptions: _response.requestOptions,
      response: _response,
      type: DioErrorType.other,
      error: error,
    )..stackTrace = stackTrace;
  }

  return Response<UserTermsOfService>(
    data: _responseData,
    headers: _response.headers,
    isRedirect: _response.isRedirect,
    requestOptions: _response.requestOptions,
    redirects: _response.redirects,
    statusCode: _response.statusCode,
    statusMessage: _response.statusMessage,
    extra: _response.extra,
  );
}