HelpApi class

Constructors

HelpApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getHelpArticles({String? category, int? limit}) → Future<HelpArticleList?>
Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.
getHelpArticlesBySlug(String slug) → Future<HelpArticle?>
Returns one public article by slug, with its body.
getHelpArticlesBySlugWithHttpInfo(String slug) → Future<Response>
Returns one public article by slug, with its body.
getHelpArticlesWithHttpInfo({String? category, int? limit}) → Future<Response>
Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.
getHelpCategories() → Future<HelpCategoryList?>
Returns the knowledge-base sections for the public center's navigation — but ONLY the sections that front at least one Published, public article, so an internal (agent-only) category name or description never leaks.
getHelpCategoriesWithHttpInfo() → Future<Response>
Returns the knowledge-base sections for the public center's navigation — but ONLY the sections that front at least one Published, public article, so an internal (agent-only) category name or description never leaks.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postHelpTickets(HelpTicketIntake helpTicketIntake) → Future<HelpTicketFiled?>
Files a customer support ticket into the public help center.
postHelpTicketsWithHttpInfo(HelpTicketIntake helpTicketIntake) → Future<Response>
Files a customer support ticket into the public help center.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited