getAnalyticByOrganization method

Future<Response<Chart>> getAnalyticByOrganization({
  1. required String xKeyclicApp,
  2. required String organization,
  3. String? acceptLanguage,
  4. DateTime? xDateTime,
  5. String? xKeyclicAppPlatform,
  6. String? xKeyclicAppVersion,
  7. String? archived,
  8. String? asset,
  9. List<String>? assetsLeftSquareBracketRightSquareBracket,
  10. String? assignedTo,
  11. List<String>? assignedTosLeftSquareBracketRightSquareBracket,
  12. String? category,
  13. List<String>? categoriesLeftSquareBracketRightSquareBracket,
  14. String? createdBy,
  15. List<String>? createdBiesLeftSquareBracketRightSquareBracket,
  16. DateTime? after,
  17. DateTime? before,
  18. String? deep,
  19. String? delegatedTo,
  20. List<String>? delegatedTosLeftSquareBracketRightSquareBracket,
  21. String? hasDocuments,
  22. String? managedBy,
  23. List<String>? managedBiesLeftSquareBracketRightSquareBracket,
  24. String? operationStateAll,
  25. String? operationState,
  26. List<String>? operationStatesLeftSquareBracketRightSquareBracket,
  27. String? phase,
  28. List<String>? phasesLeftSquareBracketRightSquareBracket,
  29. String? place,
  30. List<String>? placesLeftSquareBracketRightSquareBracket,
  31. String? priority,
  32. List<String>? prioritiesLeftSquareBracketRightSquareBracket,
  33. List<String>? ratingLeftSquareBracketRightSquareBracket,
  34. String? state,
  35. List<String>? statesLeftSquareBracketRightSquareBracket,
  36. String? optionsLeftSquareBracketPropertyRightSquareBracket,
  37. String? optionsLeftSquareBracketSortRightSquareBracket,
  38. CancelToken? cancelToken,
  39. Map<String, dynamic>? headers,
  40. Map<String, dynamic>? extra,
  41. ValidateStatus? validateStatus,
  42. ProgressCallback? onSendProgress,
  43. ProgressCallback? onReceiveProgress,
})

Retrieve one Analytic resource.

Parameters:

  • xKeyclicApp
  • organization - The identifier of the resource.
  • acceptLanguage
  • xDateTime
  • xKeyclicAppPlatform
  • xKeyclicAppVersion
  • archived
  • asset
  • assetsLeftSquareBracketRightSquareBracket
  • assignedTo
  • assignedTosLeftSquareBracketRightSquareBracket
  • category
  • categoriesLeftSquareBracketRightSquareBracket
  • createdBy
  • createdBiesLeftSquareBracketRightSquareBracket
  • after
  • before
  • deep
  • delegatedTo
  • delegatedTosLeftSquareBracketRightSquareBracket
  • hasDocuments
  • managedBy
  • managedBiesLeftSquareBracketRightSquareBracket
  • operationStateAll
  • operationState
  • operationStatesLeftSquareBracketRightSquareBracket
  • phase
  • phasesLeftSquareBracketRightSquareBracket
  • place
  • placesLeftSquareBracketRightSquareBracket
  • priority
  • prioritiesLeftSquareBracketRightSquareBracket
  • ratingLeftSquareBracketRightSquareBracket
  • state
  • statesLeftSquareBracketRightSquareBracket
  • optionsLeftSquareBracketPropertyRightSquareBracket
  • optionsLeftSquareBracketSortRightSquareBracket
  • 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 Chart as data Throws DioError if API call or serialization fails Keyclic API documentation. Also see Retrieve one Analytic resource. Documentation

Implementation

Future<Response<Chart>> getAnalyticByOrganization({
  required String xKeyclicApp,
  required String organization,
  String? acceptLanguage,
  DateTime? xDateTime,
  String? xKeyclicAppPlatform,
  String? xKeyclicAppVersion,
  String? archived,
  String? asset,
  List<String>? assetsLeftSquareBracketRightSquareBracket,
  String? assignedTo,
  List<String>? assignedTosLeftSquareBracketRightSquareBracket,
  String? category,
  List<String>? categoriesLeftSquareBracketRightSquareBracket,
  String? createdBy,
  List<String>? createdBiesLeftSquareBracketRightSquareBracket,
  DateTime? after,
  DateTime? before,
  String? deep,
  String? delegatedTo,
  List<String>? delegatedTosLeftSquareBracketRightSquareBracket,
  String? hasDocuments,
  String? managedBy,
  List<String>? managedBiesLeftSquareBracketRightSquareBracket,
  String? operationStateAll,
  String? operationState,
  List<String>? operationStatesLeftSquareBracketRightSquareBracket,
  String? phase,
  List<String>? phasesLeftSquareBracketRightSquareBracket,
  String? place,
  List<String>? placesLeftSquareBracketRightSquareBracket,
  String? priority,
  List<String>? prioritiesLeftSquareBracketRightSquareBracket,
  List<String>? ratingLeftSquareBracketRightSquareBracket,
  String? state,
  List<String>? statesLeftSquareBracketRightSquareBracket,
  String? optionsLeftSquareBracketPropertyRightSquareBracket,
  String? optionsLeftSquareBracketSortRightSquareBracket,
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final String path = r'/organizations/{organization}/analytics'
      .replaceAll('{' r'organization' '}', organization.toString());
  final options = Options(
    method: r'GET',
    headers: <String, dynamic>{
      // to string ??
      if (acceptLanguage != null) r'accept-language': acceptLanguage,
      if (xDateTime != null) r'x-date-time': xDateTime,
      r'x-keyclic-app': xKeyclicApp,
      if (xKeyclicAppPlatform != null)
        r'x-keyclic-app-platform': xKeyclicAppPlatform,
      if (xKeyclicAppVersion != null)
        r'x-keyclic-app-version': xKeyclicAppVersion,
      ...?headers,
    },
    extra: <String, dynamic>{
      'secure': <Map<String, String>>[
        {
          'type': 'apiKey',
          'name': 'bearer',
          'keyName': 'Authorization',
          'where': 'header',
        },
      ],
      ...?extra,
    },
    validateStatus: validateStatus,
  );

  final queryParameters = <String, dynamic>{
    if (archived != null) r'archived': encodeQueryParameter(archived),
    if (asset != null) r'asset': encodeQueryParameter(asset),
    if (assetsLeftSquareBracketRightSquareBracket != null)
      r'assets[]': encodeCollectionQueryParameter(
          assetsLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (assignedTo != null) r'assigned_to': encodeQueryParameter(assignedTo),
    if (assignedTosLeftSquareBracketRightSquareBracket != null)
      r'assigned_tos[]': encodeCollectionQueryParameter(
          assignedTosLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (category != null) r'category': encodeQueryParameter(category),
    if (categoriesLeftSquareBracketRightSquareBracket != null)
      r'categories[]': encodeCollectionQueryParameter(
          categoriesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (createdBy != null) r'created_by': encodeQueryParameter(createdBy),
    if (createdBiesLeftSquareBracketRightSquareBracket != null)
      r'created_bies[]': encodeCollectionQueryParameter(
          createdBiesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (after != null) r'after': encodeQueryParameter(after),
    if (before != null) r'before': encodeQueryParameter(before),
    if (deep != null) r'deep': encodeQueryParameter(deep),
    if (delegatedTo != null)
      r'delegated_to': encodeQueryParameter(delegatedTo),
    if (delegatedTosLeftSquareBracketRightSquareBracket != null)
      r'delegated_tos[]': encodeCollectionQueryParameter(
          delegatedTosLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (hasDocuments != null)
      r'has_documents': encodeQueryParameter(hasDocuments),
    if (managedBy != null) r'managed_by': encodeQueryParameter(managedBy),
    if (managedBiesLeftSquareBracketRightSquareBracket != null)
      r'managed_bies[]': encodeCollectionQueryParameter(
          managedBiesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (operationStateAll != null)
      r'operation_state_all': encodeQueryParameter(operationStateAll),
    if (operationState != null)
      r'operation_state': encodeQueryParameter(operationState),
    if (operationStatesLeftSquareBracketRightSquareBracket != null)
      r'operation_states[]': encodeCollectionQueryParameter(
          operationStatesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (phase != null) r'phase': encodeQueryParameter(phase),
    if (phasesLeftSquareBracketRightSquareBracket != null)
      r'phases[]': encodeCollectionQueryParameter(
          phasesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (place != null) r'place': encodeQueryParameter(place),
    if (placesLeftSquareBracketRightSquareBracket != null)
      r'places[]': encodeCollectionQueryParameter(
          placesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (priority != null) r'priority': encodeQueryParameter(priority),
    if (prioritiesLeftSquareBracketRightSquareBracket != null)
      r'priorities[]': encodeCollectionQueryParameter(
          prioritiesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (ratingLeftSquareBracketRightSquareBracket != null)
      r'rating[]': encodeCollectionQueryParameter(
          ratingLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (state != null) r'state': encodeQueryParameter(state),
    if (statesLeftSquareBracketRightSquareBracket != null)
      r'states[]': encodeCollectionQueryParameter(
          statesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (optionsLeftSquareBracketPropertyRightSquareBracket != null)
      r'options[property]': encodeQueryParameter(
          optionsLeftSquareBracketPropertyRightSquareBracket),
    if (optionsLeftSquareBracketSortRightSquareBracket != null)
      r'options[sort]': encodeQueryParameter(
          optionsLeftSquareBracketSortRightSquareBracket),
  };

  final response = await _apiClient.dio.request<Object>(
    path,
    options: options,
    queryParameters: queryParameters,
    cancelToken: cancelToken,
    onSendProgress: onSendProgress,
    onReceiveProgress: onReceiveProgress,
  );

  Chart responseData;

  try {
    responseData =
        await _apiClient.deserializeAsync<Chart>(response.data!, 'Chart');
  } catch (error, stackTrace) {
    throw DioError(
      requestOptions: response.requestOptions,
      response: response,
      type: DioErrorType.other,
      error: error,
    )..stackTrace = stackTrace;
  }

  return Response<Chart>(
    data: responseData,
    headers: response.headers,
    isRedirect: response.isRedirect,
    requestOptions: response.requestOptions,
    redirects: response.redirects,
    statusCode: response.statusCode,
    statusMessage: response.statusMessage,
    extra: response.extra,
  );
}