Files
zeekay 645325a641 regenerate from cloud 939b09d4
The projection was 113 commits behind the document it claims to describe, and
`generate.py --all --check` reported every one of the thirteen clients DRIFTED —
the same +19 models in each, because they all fell behind the same emission.

Regenerated in place from hanzo-inc/cloud openapi.yaml at 939b09d4
(sha256 087024f6…), which is the only description of this API that cannot name a
route the binary does not serve. `--check` is clean across all thirteen after.

.spec-lock moved with the code. The generator READS that file and never writes
it — hanzoai/ci`s lane does — so a hand run leaves every lock naming the previous
document. A lock that disagrees with the tree beside it is worse than no lock:
the next `--check` without `--spec` fetches what production serves, compares it
to a digest that was already wrong, and reports drift that is really staleness.
2026-08-24 23:32:53 -07:00

227 lines
13 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.
*/
/*
* TrustApi.h
*
*
*/
#ifndef HANZO_API_TrustApi_H_
#define HANZO_API_TrustApi_H_
#include "hanzo/ApiClient.h"
#include "hanzo/AnyType.h"
#include "hanzo/model/Centre.h"
#include "hanzo/model/ClauseCoverage.h"
#include "hanzo/model/ControlList.h"
#include "hanzo/model/Dropped.h"
#include "hanzo/model/FaqList.h"
#include "hanzo/model/FrameworkList.h"
#include "hanzo/model/PolicyList.h"
#include "hanzo/model/SectionWrite.h"
#include "hanzo/model/SubprocessorList.h"
#include "hanzo/model/TrustCoverage.h"
#include "hanzo/model/TrustDocuments.h"
#include "hanzo/model/UpdateList.h"
#include "hanzo/model/Written.h"
#include <cpprest/details/basic_types.h>
#include <boost/optional.hpp>
namespace hanzo {
namespace api {
using namespace hanzo::model;
class TrustApi
{
public:
explicit TrustApi( std::shared_ptr<const ApiClient> apiClient );
virtual ~TrustApi();
/// <summary>
/// Removes one record from a section of your organization&#39;s trust centre.
/// </summary>
/// <remarks>
/// Removes one record from a section of your organization&#39;s trust centre. A record that is not there is a 404, never a silent success. A control that belongs to the deployment&#39;s own inventory is removed by a commit, not by a request.
/// </remarks>
/// <param name="kind">Kind is the section — profile, control, document, subprocessor, policy, faq, update or risk. Anything else is not found. The URL is the authority: a value here is bound from the path, which zip binds last.</param>
/// <param name="id">ID is the record&#39;s id within that section. The single-valued sections (profile, risk) hold one record whatever id is named.</param>
pplx::task<std::shared_ptr<Dropped>> deleteTrustByKindById(
utility::string_t kind,
utility::string_t id
) const;
/// <summary>
/// Reads YOUR organization&#39;s whole trust centre, including the addresses of your own gated documents.
/// </summary>
/// <remarks>
/// Reads YOUR organization&#39;s whole trust centre, including the addresses of your own gated documents. Same shape as the published endpoint; the difference is that this one is resolved from your validated bearer and shows you your own artifacts.
/// </remarks>
pplx::task<std::shared_ptr<Centre>> getTrust(
) const;
/// <summary>
/// Lists every control your organization publishes, with the counts.
/// </summary>
/// <remarks>
/// Lists every control your organization publishes, with the counts. A control names what it asserts, the mechanism behind it, the repository and file where that mechanism is enforced, how it is verified, and the framework clauses it maps to. Status is automated, partial or absent — and an absent one still names the clause it would satisfy, which is a roadmap, while never moving a coverage number.
/// </remarks>
pplx::task<std::shared_ptr<ControlList>> getTrustControls(
) const;
/// <summary>
/// Reads one control by id.
/// </summary>
/// <remarks>
/// Reads one control by id.
/// </remarks>
/// <param name="id">ID is the control&#39;s id, dotted lowercase — \&quot;iam.pkce.s256\&quot;.</param>
pplx::task<std::shared_ptr<AnyType>> getTrustControlsById(
utility::string_t id
) const;
/// <summary>
/// Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because \&quot;12 of 20\&quot; is not a fact until you know what the 20 are.
/// </summary>
/// <remarks>
/// Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because \&quot;12 of 20\&quot; is not a fact until you know what the 20 are. Nothing here is a verdict. There is no boolean, and a control that only a person has read counts one rung weaker than it claims to be, because only a check that can FAIL is evidence.
/// </remarks>
pplx::task<std::shared_ptr<TrustCoverage>> getTrustCoverage(
) const;
/// <summary>
/// Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.
/// </summary>
/// <remarks>
/// Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.
/// </remarks>
/// <param name="framework">Framework is the framework id — \&quot;soc2\&quot;, \&quot;iso27001\&quot;, \&quot;nist80053\&quot;.</param>
pplx::task<std::shared_ptr<ClauseCoverage>> getTrustCoverageByFramework(
utility::string_t framework
) const;
/// <summary>
/// Lists your organization&#39;s documents.
/// </summary>
/// <remarks>
/// Lists your organization&#39;s documents. Because this is your own centre, a gated artifact carries its address here; through the published endpoint it does not.
/// </remarks>
pplx::task<std::shared_ptr<TrustDocuments>> getTrustDocuments(
) const;
/// <summary>
/// Reads the audit rows that stand behind one control, over a window.
/// </summary>
/// <remarks>
/// Reads the audit rows that stand behind one control, over a window. The inventory decides what evidences what: a control names the audit actions that are its trail, and this resolves the control id to those actions and reads them. So evidence cannot drift from the inventory, and it is scoped to your own organization — the query carries no organization field for a caller to fill in. A control that nothing in the trail evidences says so plainly rather than answering an empty page, because an empty page reads like a clean quarter. A deployment with no audit store answers 501 and says the trail was not read, for the same reason.
/// </remarks>
/// <param name="control">Control is the control id whose trail to read. Required. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
/// <param name="from">From is the inclusive lower bound, an RFC 3339 date or instant (\&quot;2026-01-01\&quot; or \&quot;2026-01-01T00:00:00Z\&quot;). Empty leaves it unbounded. A malformed bound is refused rather than silently widening the window. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
/// <param name="to">To is the upper bound, same form and same tolerance. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
/// <param name="limit">Limit caps the rows returned, 1..1000, default 100. It is a string because an unparseable value is refused rather than read as zero. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
pplx::task<std::shared_ptr<AnyType>> getTrustEvidence(
boost::optional<utility::string_t> control,
boost::optional<utility::string_t> from,
boost::optional<utility::string_t> to,
boost::optional<utility::string_t> limit
) const;
/// <summary>
/// Lists your knowledge base — the questions a reviewer asks, answered once.
/// </summary>
/// <remarks>
/// Lists your knowledge base — the questions a reviewer asks, answered once.
/// </remarks>
pplx::task<std::shared_ptr<FaqList>> getTrustFaq(
) const;
/// <summary>
/// Lists the frameworks coverage is computed against, and how many clauses each publishes.
/// </summary>
/// <remarks>
/// Lists the frameworks coverage is computed against, and how many clauses each publishes. That count is the denominator of every coverage number, which is what keeps an uncovered clause visible instead of dropping out of the fraction.
/// </remarks>
pplx::task<std::shared_ptr<FrameworkList>> getTrustFrameworks(
) const;
/// <summary>
/// Lists your organization&#39;s published policies.
/// </summary>
/// <remarks>
/// Lists your organization&#39;s published policies.
/// </remarks>
pplx::task<std::shared_ptr<PolicyList>> getTrustPolicies(
) const;
/// <summary>
/// Reads your organization&#39;s trust-centre profile — the name, tagline and summary a visitor sees, whether the centre is published, and where to send somebody who wants a gated document.
/// </summary>
/// <remarks>
/// Reads your organization&#39;s trust-centre profile — the name, tagline and summary a visitor sees, whether the centre is published, and where to send somebody who wants a gated document.
/// </remarks>
pplx::task<std::shared_ptr<AnyType>> getTrustProfile(
) const;
/// <summary>
/// Reads a published trust centre — the whole thing in one answer: the organization&#39;s profile, its control inventory, coverage computed against each framework&#39;s whole published clause list, its documents, subprocessors, policies, knowledge base, updates and risk profile.
/// </summary>
/// <remarks>
/// Reads a published trust centre — the whole thing in one answer: the organization&#39;s profile, its control inventory, coverage computed against each framework&#39;s whole published clause list, its documents, subprocessors, policies, knowledge base, updates and risk profile. This is the PUBLIC endpoint and needs no credential, because a published trust centre is a public document. It answers only for an organization that has published one — an organization that has not is not found rather than empty, since an empty centre and a centre nobody meant to show read the same and are not the same thing. A gated document appears here with its title, its type and its date and NO address: the listing says the artifact exists and that reading it takes a grant. Nothing an independent auditor signed is ever released through this endpoint.
/// </remarks>
/// <param name="org">Org is the organization&#39;s slug — the name in its address.</param>
pplx::task<std::shared_ptr<Centre>> getTrustPublishedByOrg(
utility::string_t org
) const;
/// <summary>
/// Reads your risk profile — the label and value pairs describing what your organization handles and how.
/// </summary>
/// <remarks>
/// Reads your risk profile — the label and value pairs describing what your organization handles and how.
/// </remarks>
pplx::task<std::shared_ptr<AnyType>> getTrustRisk(
) const;
/// <summary>
/// Lists the third parties your organization sends data to, each naming what it is for.
/// </summary>
/// <remarks>
/// Lists the third parties your organization sends data to, each naming what it is for.
/// </remarks>
pplx::task<std::shared_ptr<SubprocessorList>> getTrustSubprocessors(
) const;
/// <summary>
/// Lists your trust-centre updates, newest as you ordered them.
/// </summary>
/// <remarks>
/// Lists your trust-centre updates, newest as you ordered them.
/// </remarks>
pplx::task<std::shared_ptr<UpdateList>> getTrustUpdates(
) const;
/// <summary>
/// Writes one record into a section of YOUR organization&#39;s trust centre — profile, control, document, subprocessor, policy, faq, update or risk.
/// </summary>
/// <remarks>
/// Writes one record into a section of YOUR organization&#39;s trust centre — profile, control, document, subprocessor, policy, faq, update or risk. A control written here is held to exactly the rule a control committed to the deployment&#39;s own inventory is held to, by the same validator: its prose may not claim a certificate and may not name a framework (a framework belongs in the mappings, where it arrives attached to a number), anything short of automated must say what is missing, and a mapping to a clause no framework declares is refused rather than scored as nothing. A document defaults to GATED. An artifact an independent auditor signed — a SOC 2 report, an ISO certificate, a penetration test, an auditor letter — cannot be made public at all; it is released through a grant. A self-assessment can, because the organization is the one attesting it. The deployment&#39;s OWN control inventory is governed in git and is not writable here: naming one of its ids is a conflict, not an overwrite.
/// </remarks>
/// <param name="kind">Kind is the section being written. The URL is the authority.</param>
/// <param name="id">ID is the record&#39;s id. Omit it on a create and one is minted; the single-valued sections (profile, risk) hold one record whatever is named.</param>
/// <param name="sectionWrite"></param>
pplx::task<std::shared_ptr<Written>> putTrustByKindById(
utility::string_t kind,
utility::string_t id,
std::shared_ptr<SectionWrite> sectionWrite
) const;
protected:
std::shared_ptr<const ApiClient> m_ApiClient;
};
}
}
#endif /* HANZO_API_TrustApi_H_ */