cgetArticlesByKnowledgeBase method

Future<Response<ArticlePagination>> cgetArticlesByKnowledgeBase({ required String xKeyclicApp, required String knowledgeBase, String? acceptLanguage, DateTime? xDateTime, String? xKeyclicAppPlatform, String? xKeyclicAppVersion, List<String>? orderLeftSquareBracketRightSquareBracket, DateTime? after, DateTime? before, String? section, List<String>? sectionsLeftSquareBracketRightSquareBracket, int? page, int? limit, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, })

Retrieve all Article resources.

Parameters:

• xKeyclicApp
• knowledgeBase - The identifier of the resource.
• acceptLanguage
• xDateTime
• xKeyclicAppPlatform
• xKeyclicAppVersion
• orderLeftSquareBracketRightSquareBracket
• after
• before
• section
• sectionsLeftSquareBracketRightSquareBracket
• 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 ArticlePagination as data Throws DioError if API call or serialization fails Keyclic API documentation. Also see Retrieve all Article resources. Documentation

Implementation

Future<Response<ArticlePagination>> cgetArticlesByKnowledgeBase({
  required String xKeyclicApp,
  required String knowledgeBase,
  String? acceptLanguage,
  DateTime? xDateTime,
  String? xKeyclicAppPlatform,
  String? xKeyclicAppVersion,
  List<String>? orderLeftSquareBracketRightSquareBracket,
  DateTime? after,
  DateTime? before,
  String? section,
  List<String>? sectionsLeftSquareBracketRightSquareBracket,
  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'/knowledge-bases/{knowledgeBase}/articles'
      .replaceAll('{' r'knowledgeBase' '}', knowledgeBase.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 (after != null) r'after': encodeQueryParameter(after),
    if (before != null) r'before': encodeQueryParameter(before),
    if (section != null) r'section': encodeQueryParameter(section),
    if (sectionsLeftSquareBracketRightSquareBracket != null)
      r'sections[]': encodeCollectionQueryParameter(
          sectionsLeftSquareBracketRightSquareBracket,
          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,
  );

  ArticlePagination responseData;

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

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