getHelpArticlesWithHttpInfo method

Future<Response> getHelpArticlesWithHttpInfo({
  1. String? category,
  2. int? limit,
})

Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.

Returns the public knowledge base: the help center's Published, publicly-visible articles as cards. The org is server-fixed and the status/is_public filter is server-set, so neither the tenant nor the visibility can be widened by the caller. A deployment with no help center answers 404.

Note: This method returns the HTTP Response.

Parameters:

  • String category: Category narrows the list to one knowledge-base section, matched against the article's category by exact name. Empty lists every section.

  • int limit: Limit caps how many articles are returned. Anything that is not a positive integer uses 50, and values above 200 are clamped to 200.

Implementation

Future<Response> getHelpArticlesWithHttpInfo({ String? category, int? limit, }) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/help/articles';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (category != null) {
    queryParams.addAll(_queryParams('', 'category', category));
  }
  if (limit != null) {
    queryParams.addAll(_queryParams('', 'limit', limit));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}