cgetReportsByOrganization method

Future<Response<ReportPagination>> cgetReportsByOrganization({
  1. required String xKeyclicApp,
  2. required String organization,
  3. String? acceptLanguage,
  4. DateTime? xDateTime,
  5. String? xKeyclicAppPlatform,
  6. String? xKeyclicAppVersion,
  7. List<String>? orderLeftSquareBracketRightSquareBracket,
  8. String? archived,
  9. String? asset,
  10. List<String>? assetsLeftSquareBracketRightSquareBracket,
  11. String? assignedTo,
  12. List<String>? assignedTosLeftSquareBracketRightSquareBracket,
  13. String? batch,
  14. List<String>? batchesLeftSquareBracketRightSquareBracket,
  15. String? category,
  16. List<String>? categoriesLeftSquareBracketRightSquareBracket,
  17. String? createdBy,
  18. List<String>? createdBiesLeftSquareBracketRightSquareBracket,
  19. DateTime? afterDueBy,
  20. DateTime? after,
  21. DateTime? beforeDueBy,
  22. DateTime? before,
  23. String? deep,
  24. String? delegatedTo,
  25. List<String>? delegatedTosLeftSquareBracketRightSquareBracket,
  26. String? hasDocuments,
  27. String? isNull,
  28. String? leaf,
  29. String? level,
  30. String? managedBy,
  31. List<String>? managedBiesLeftSquareBracketRightSquareBracket,
  32. String? member,
  33. List<String>? membersLeftSquareBracketRightSquareBracket,
  34. String? operationStateAll,
  35. String? operationState,
  36. List<String>? operationStatesLeftSquareBracketRightSquareBracket,
  37. List<String>? organizationsLeftSquareBracketRightSquareBracket,
  38. String? phase,
  39. List<String>? phasesLeftSquareBracketRightSquareBracket,
  40. String? place,
  41. List<String>? placesLeftSquareBracketRightSquareBracket,
  42. String? priority,
  43. List<String>? prioritiesLeftSquareBracketRightSquareBracket,
  44. String? query,
  45. List<String>? ratingLeftSquareBracketRightSquareBracket,
  46. DateTime? scheduledAtAfter,
  47. DateTime? scheduledAtBefore,
  48. String? state,
  49. List<String>? statesLeftSquareBracketRightSquareBracket,
  50. List<String>? visibilityLeftSquareBracketRightSquareBracket,
  51. int? page,
  52. int? limit,
  53. CancelToken? cancelToken,
  54. Map<String, dynamic>? headers,
  55. Map<String, dynamic>? extra,
  56. ValidateStatus? validateStatus,
  57. ProgressCallback? onSendProgress,
  58. ProgressCallback? onReceiveProgress,
})

Retrieve all Report resources.

Parameters:

  • xKeyclicApp
  • organization - The identifier of the resource.
  • acceptLanguage
  • xDateTime
  • xKeyclicAppPlatform
  • xKeyclicAppVersion
  • orderLeftSquareBracketRightSquareBracket
  • archived
  • asset
  • assetsLeftSquareBracketRightSquareBracket
  • assignedTo
  • assignedTosLeftSquareBracketRightSquareBracket
  • batch
  • batchesLeftSquareBracketRightSquareBracket
  • category
  • categoriesLeftSquareBracketRightSquareBracket
  • createdBy
  • createdBiesLeftSquareBracketRightSquareBracket
  • afterDueBy
  • after
  • beforeDueBy
  • before
  • deep
  • delegatedTo
  • delegatedTosLeftSquareBracketRightSquareBracket
  • hasDocuments
  • isNull
  • leaf
  • level
  • managedBy
  • managedBiesLeftSquareBracketRightSquareBracket
  • member
  • membersLeftSquareBracketRightSquareBracket
  • operationStateAll
  • operationState
  • operationStatesLeftSquareBracketRightSquareBracket
  • organizationsLeftSquareBracketRightSquareBracket
  • phase
  • phasesLeftSquareBracketRightSquareBracket
  • place
  • placesLeftSquareBracketRightSquareBracket
  • priority
  • prioritiesLeftSquareBracketRightSquareBracket
  • query
  • ratingLeftSquareBracketRightSquareBracket
  • scheduledAtAfter
  • scheduledAtBefore
  • state
  • statesLeftSquareBracketRightSquareBracket
  • visibilityLeftSquareBracketRightSquareBracket
  • page - Page of the overview.
  • limit - Page of the overview.
  • 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 ReportPagination as data Throws DioError if API call or serialization fails Keyclic API documentation. Also see Retrieve all Report resources. Documentation

Implementation

Future<Response<ReportPagination>> cgetReportsByOrganization({
  required String xKeyclicApp,
  required String organization,
  String? acceptLanguage,
  DateTime? xDateTime,
  String? xKeyclicAppPlatform,
  String? xKeyclicAppVersion,
  List<String>? orderLeftSquareBracketRightSquareBracket,
  String? archived,
  String? asset,
  List<String>? assetsLeftSquareBracketRightSquareBracket,
  String? assignedTo,
  List<String>? assignedTosLeftSquareBracketRightSquareBracket,
  String? batch,
  List<String>? batchesLeftSquareBracketRightSquareBracket,
  String? category,
  List<String>? categoriesLeftSquareBracketRightSquareBracket,
  String? createdBy,
  List<String>? createdBiesLeftSquareBracketRightSquareBracket,
  DateTime? afterDueBy,
  DateTime? after,
  DateTime? beforeDueBy,
  DateTime? before,
  String? deep,
  String? delegatedTo,
  List<String>? delegatedTosLeftSquareBracketRightSquareBracket,
  String? hasDocuments,
  String? isNull,
  String? leaf,
  String? level,
  String? managedBy,
  List<String>? managedBiesLeftSquareBracketRightSquareBracket,
  String? member,
  List<String>? membersLeftSquareBracketRightSquareBracket,
  String? operationStateAll,
  String? operationState,
  List<String>? operationStatesLeftSquareBracketRightSquareBracket,
  List<String>? organizationsLeftSquareBracketRightSquareBracket,
  String? phase,
  List<String>? phasesLeftSquareBracketRightSquareBracket,
  String? place,
  List<String>? placesLeftSquareBracketRightSquareBracket,
  String? priority,
  List<String>? prioritiesLeftSquareBracketRightSquareBracket,
  String? query,
  List<String>? ratingLeftSquareBracketRightSquareBracket,
  DateTime? scheduledAtAfter,
  DateTime? scheduledAtBefore,
  String? state,
  List<String>? statesLeftSquareBracketRightSquareBracket,
  List<String>? visibilityLeftSquareBracketRightSquareBracket,
  int? page,
  int? limit,
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final String path = r'/organizations/{organization}/reports'
      .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 (orderLeftSquareBracketRightSquareBracket != null)
      r'order[]': encodeCollectionQueryParameter(
          orderLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    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 (batch != null) r'batch': encodeQueryParameter(batch),
    if (batchesLeftSquareBracketRightSquareBracket != null)
      r'batches[]': encodeCollectionQueryParameter(
          batchesLeftSquareBracketRightSquareBracket,
          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 (afterDueBy != null) r'afterDueBy': encodeQueryParameter(afterDueBy),
    if (after != null) r'after': encodeQueryParameter(after),
    if (beforeDueBy != null)
      r'beforeDueBy': encodeQueryParameter(beforeDueBy),
    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 (isNull != null) r'is_null': encodeQueryParameter(isNull),
    if (leaf != null) r'leaf': encodeQueryParameter(leaf),
    if (level != null) r'level': encodeQueryParameter(level),
    if (managedBy != null) r'managed_by': encodeQueryParameter(managedBy),
    if (managedBiesLeftSquareBracketRightSquareBracket != null)
      r'managed_bies[]': encodeCollectionQueryParameter(
          managedBiesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (member != null) r'member': encodeQueryParameter(member),
    if (membersLeftSquareBracketRightSquareBracket != null)
      r'members[]': encodeCollectionQueryParameter(
          membersLeftSquareBracketRightSquareBracket,
          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 (organizationsLeftSquareBracketRightSquareBracket != null)
      r'organizations[]': encodeCollectionQueryParameter(
          organizationsLeftSquareBracketRightSquareBracket,
          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 (query != null) r'query': encodeQueryParameter(query),
    if (ratingLeftSquareBracketRightSquareBracket != null)
      r'rating[]': encodeCollectionQueryParameter(
          ratingLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (scheduledAtAfter != null)
      r'scheduled_at_after': encodeQueryParameter(scheduledAtAfter),
    if (scheduledAtBefore != null)
      r'scheduled_at_before': encodeQueryParameter(scheduledAtBefore),
    if (state != null) r'state': encodeQueryParameter(state),
    if (statesLeftSquareBracketRightSquareBracket != null)
      r'states[]': encodeCollectionQueryParameter(
          statesLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (visibilityLeftSquareBracketRightSquareBracket != null)
      r'visibility[]': encodeCollectionQueryParameter(
          visibilityLeftSquareBracketRightSquareBracket,
          format: ListFormat.multi),
    if (page != null) r'page': encodeQueryParameter(page),
    if (limit != null) r'limit': encodeQueryParameter(limit),
  };

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

  ReportPagination responseData;

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

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