Files
zeekay 189ce08e51 Regenerate against the document the deployment answers for
The projection these were generated from was a month old and predated the
compute migration, so every one of them described /v1/visor — which the API
serves at zero paths now. That is why a hand-written console client and a
generated one had drifted the same way at the same time.

No /v1/visor path survives here. The word still appears as a source-plane
value and inside gvisor and supervisor, which are not this rename.
2026-09-05 18:07:13 -07:00

98 lines
4.5 KiB
C++

/**
* Hanzo Cloud API
* The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
*
* The version of the OpenAPI document: v1
*
* NOTE: This class is auto generated by OpenAPI-Generator 7.14.0.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/*
* HelpApi.h
*
*
*/
#ifndef HANZO_API_HelpApi_H_
#define HANZO_API_HelpApi_H_
#include "hanzo/ApiClient.h"
#include "hanzo/model/HelpArticle.h"
#include "hanzo/model/HelpArticleList.h"
#include "hanzo/model/HelpCategoryList.h"
#include "hanzo/model/HelpTicketFiled.h"
#include "hanzo/model/HelpTicketIntake.h"
#include <cpprest/details/basic_types.h>
#include <boost/optional.hpp>
namespace hanzo {
namespace api {
using namespace hanzo::model;
class HelpApi
{
public:
explicit HelpApi( std::shared_ptr<const ApiClient> apiClient );
virtual ~HelpApi();
/// <summary>
/// Returns the public knowledge base: the help center&#39;s Published, publicly-visible articles as cards.
/// </summary>
/// <remarks>
/// Returns the public knowledge base: the help center&#39;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.
/// </remarks>
/// <param name="category">Category narrows the list to one knowledge-base section, matched against the article&#39;s category by exact name. Empty lists every section. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
/// <param name="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. (optional, default to 0L)</param>
pplx::task<std::shared_ptr<HelpArticleList>> getHelpArticles(
boost::optional<utility::string_t> category,
boost::optional<int64_t> limit
) const;
/// <summary>
/// Returns one public article by slug, with its body.
/// </summary>
/// <remarks>
/// Returns one public article by slug, with its body. A missing, Draft, or internal (non-public) article is 404 — fail-closed, so this route is no existence oracle for anything beyond \&quot;published and public\&quot;.
/// </remarks>
/// <param name="slug">Slug is the article&#39;s public identifier, from the path. It IS the document name in the help center&#39;s store.</param>
pplx::task<std::shared_ptr<HelpArticle>> getHelpArticlesBySlug(
utility::string_t slug
) const;
/// <summary>
/// Returns the knowledge-base sections for the public center&#39;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.
/// </summary>
/// <remarks>
/// Returns the knowledge-base sections for the public center&#39;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. A section with no public article is invisible; a center with no public articles has no sections, which is an empty list rather than an error.
/// </remarks>
pplx::task<std::shared_ptr<HelpCategoryList>> getHelpCategories(
) const;
/// <summary>
/// Files a customer support ticket into the public help center.
/// </summary>
/// <remarks>
/// Files a customer support ticket into the public help center. It creates the ticket (status Open, source portal) with the customer&#39;s message on the description, then records that same message as the opening entry of the ticket&#39;s conversation thread; the description carries it regardless, so failing to write that entry loses nothing. Answers 201 with an opaque reference. A deployment with no help center answers 404, one whose center has not installed the Help model answers 503, and a body over 64 KiB answers 413 — in that order, which is the order the route has always decided them in.
/// </remarks>
/// <param name="helpTicketIntake"></param>
pplx::task<std::shared_ptr<HelpTicketFiled>> postHelpTickets(
std::shared_ptr<HelpTicketIntake> helpTicketIntake
) const;
protected:
std::shared_ptr<const ApiClient> m_ApiClient;
};
}
}
#endif /* HANZO_API_HelpApi_H_ */