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

308 lines
19 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.
*/
/*
* CompanyApi.h
*
*
*/
#ifndef HANZO_API_CompanyApi_H_
#define HANZO_API_CompanyApi_H_
#include "hanzo/ApiClient.h"
#include "hanzo/model/AdvanceIn.h"
#include "hanzo/model/BeginIn.h"
#include "hanzo/model/DecisionIn.h"
#include "hanzo/model/DeckOut.h"
#include "hanzo/model/EIN.h"
#include "hanzo/model/EinIn.h"
#include "hanzo/model/EsignCompleteIn.h"
#include "hanzo/model/EsignOut.h"
#include "hanzo/model/FormationView.h"
#include "hanzo/model/FoundersIn.h"
#include "hanzo/HttpContent.h"
#include "hanzo/model/ImportCapTableIn.h"
#include "hanzo/model/ImportCapTableOut.h"
#include "hanzo/model/ImportDocumentsIn.h"
#include "hanzo/model/ImportDocumentsOut.h"
#include "hanzo/model/KycRefreshOut.h"
#include "hanzo/model/KycStartOut.h"
#include "hanzo/model/RegisterCounts.h"
#include "hanzo/model/RegisterPage.h"
#include "hanzo/model/ReviewQueue.h"
#include "hanzo/model/RoundInput.h"
#include "hanzo/model/RoundOut.h"
#include "hanzo/model/SafeIn.h"
#include "hanzo/model/SafeOut.h"
#include "hanzo/model/StructureIn.h"
#include "hanzo/model/Tariff.h"
#include "hanzo/model/TariffIn.h"
#include <cpprest/details/basic_types.h>
#include <boost/optional.hpp>
namespace hanzo {
namespace api {
using namespace hanzo::model;
class CompanyApi
{
public:
explicit CompanyApi( std::shared_ptr<const ApiClient> apiClient );
virtual ~CompanyApi();
/// <summary>
/// Get returns the caller org&#39;s formation and the stages reachable from it, or 404 when the org has not begun one.
/// </summary>
/// <remarks>
/// Get returns the caller org&#39;s formation and the stages reachable from it, or 404 when the org has not begun one.
/// </remarks>
pplx::task<std::shared_ptr<FormationView>> getCompany(
) const;
/// <summary>
/// Returns the platform&#39;s whole formation register, newest activity first — every org&#39;s formation, not the caller&#39;s.
/// </summary>
/// <remarks>
/// Returns the platform&#39;s whole formation register, newest activity first — every org&#39;s formation, not the caller&#39;s. It is a Hanzo platform operation: a caller who is not a platform reviewer gets 403. Filter by stage and structure, page with limit and offset. An unknown stage is refused with 400 rather than returning a silently empty page.
/// </remarks>
/// <param name="stage">Stage keeps only formations at that stage. Empty means any. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
/// <param name="structure">Structure keeps only formations of that entity kind. Empty means any. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
/// <param name="limit">Limit bounds the page; 0 or less means the default of 200. (optional, default to 0L)</param>
/// <param name="offset">Offset skips that many rows. (optional, default to 0L)</param>
pplx::task<std::shared_ptr<RegisterPage>> getCompanyRegister(
boost::optional<utility::string_t> stage,
boost::optional<utility::string_t> structure,
boost::optional<int64_t> limit,
boost::optional<int64_t> offset
) const;
/// <summary>
/// Counts the platform&#39;s formations by stage — the register&#39;s shape in one read, so a queue that is growing is visible as a number rather than inferred by paging the list.
/// </summary>
/// <remarks>
/// Counts the platform&#39;s formations by stage — the register&#39;s shape in one read, so a queue that is growing is visible as a number rather than inferred by paging the list. A Hanzo platform operation: a caller who is not a platform reviewer gets 403.
/// </remarks>
pplx::task<std::shared_ptr<RegisterCounts>> getCompanyRegisterSummary(
) const;
/// <summary>
/// Reports the founders whose KYC is not yet settled, oldest formation first, so the queue drains in the order founders have been waiting.
/// </summary>
/// <remarks>
/// Reports the founders whose KYC is not yet settled, oldest formation first, so the queue drains in the order founders have been waiting. A Hanzo platform operation: a caller who is not a platform reviewer gets 403. It only says who is waiting; the decision itself is POST /v1/company/kyc/decision.
/// </remarks>
/// <param name="limit">Limit bounds how many formations are scanned; 0 or less means the default of 200. (optional, default to 0L)</param>
pplx::task<std::shared_ptr<ReviewQueue>> getCompanyReview(
boost::optional<int64_t> limit
) const;
/// <summary>
/// Begin starts the org&#39;s one formation and returns it with the stages reachable from it.
/// </summary>
/// <remarks>
/// Begin starts the org&#39;s one formation and returns it with the stages reachable from it. It is idempotent: an org that already has a formation gets that one back with 200, while a first call creates it and answers 201.
/// </remarks>
/// <param name="beginIn"></param>
pplx::task<std::shared_ptr<FormationView>> postCompany(
std::shared_ptr<BeginIn> beginIn
) const;
/// <summary>
/// Advance runs the ONE guarded transition of the formation machine.
/// </summary>
/// <remarks>
/// Advance runs the ONE guarded transition of the formation machine. It is the only endpoint between stages: the actions populate data, this decides ordering. An edge the machine does not define answers 409; an edge whose guard is not yet satisfied answers 422 naming what is missing. Reaching the terminal &#x60;company&#x60; stage also records the incorporation on the canonical cap table, and that must succeed before the transition is persisted.
/// </remarks>
/// <param name="advanceIn"></param>
pplx::task<std::shared_ptr<FormationView>> postCompanyAdvance(
std::shared_ptr<AdvanceIn> advanceIn
) const;
/// <summary>
/// Renders the formation documents for the chosen structure and jurisdiction, ingests each into the org&#39;s data room, and submits the state filing through the filing client.
/// </summary>
/// <remarks>
/// Renders the formation documents for the chosen structure and jurisdiction, ingests each into the org&#39;s data room, and submits the state filing through the filing client. With no filing partner wired the filing is recorded honestly as \&quot;manual\&quot; — no filing id is fabricated. Available only at the documents stage.
/// </remarks>
pplx::task<std::shared_ptr<FormationView>> postCompanyDocuments(
) const;
/// <summary>
/// Opens the EIN application and answers what it owes.
/// </summary>
/// <remarks>
/// Opens the EIN application and answers what it owes. The answer states whether it can be filed ONLINE, because that is the fact deciding whether the customer waits a sitting or several weeks — and it names each form with what that form is for, so nobody has to already know what an SS-4 is to understand why they are signing one.
/// </remarks>
/// <param name="einIn"></param>
pplx::task<std::shared_ptr<EIN>> postCompanyEin(
std::shared_ptr<EinIn> einIn
) const;
/// <summary>
/// Sends the generated formation documents for signature by every founder and records the provider&#39;s reference on the formation.
/// </summary>
/// <remarks>
/// Sends the generated formation documents for signature by every founder and records the provider&#39;s reference on the formation. Available only at the esign stage.
/// </remarks>
pplx::task<std::shared_ptr<EsignOut>> postCompanyEsign(
) const;
/// <summary>
/// Records whether the formation documents have been signed.
/// </summary>
/// <remarks>
/// Records whether the formation documents have been signed. It consults the e-signature provider, which a real provider&#39;s webhook drives; the signal is idempotent. An explicit &#x60;signed&#x60; in the request overrides the provider&#39;s answer, which is the manual path for the stub provider that never self-completes.
/// </remarks>
/// <param name="esignCompleteIn"></param>
pplx::task<std::shared_ptr<FormationView>> postCompanyEsignComplete(
std::shared_ptr<EsignCompleteIn> esignCompleteIn
) const;
/// <summary>
/// Replaces the formation&#39;s founders.
/// </summary>
/// <remarks>
/// Replaces the formation&#39;s founders. Each founder needs a name, an email and an equity share in basis points; every founder is (re)set to pending KYC, so a previously settled decision does not survive a change of the list.
/// </remarks>
/// <param name="foundersIn"></param>
pplx::task<std::shared_ptr<FormationView>> postCompanyFounders(
std::shared_ptr<FoundersIn> foundersIn
) const;
/// <summary>
/// Share a pitch deck in the org&#39;s data room
/// </summary>
/// <remarks>
/// Stores the request body as a document in the caller org&#39;s data room and answers with the data room id to reference it by. The deck is RAW BYTES of whatever content type is sent — a PDF, a slide export — not a JSON document: the Content-Type header is carried through to the data room as given, and &#x60;?name&#x3D;&#x60; names the document, defaulting to &#x60;pitch-deck&#x60;. Scoped to the caller&#39;s validated org, and only after incorporation: a formation still short of stage &#x60;company&#x60; is refused 409 and an org that never began one is 404. The route is registered AHEAD of the surface&#39;s JSON body cap deliberately, so a deck&#39;s size ceiling is the edge&#39;s rather than the cap meant for small structured records. An empty body is 400; a data room that will not take the bytes is 502.
/// </remarks>
/// <param name="body"> (optional)</param>
pplx::task<std::shared_ptr<DeckOut>> postCompanyFundraiseDeck(
boost::optional<std::shared_ptr<HttpContent>> body
) const;
/// <summary>
/// Records a fundraising round on the org&#39;s canonical cap table.
/// </summary>
/// <remarks>
/// Records a fundraising round on the org&#39;s canonical cap table. Available only after incorporation (stage company); roundType defaults to PRICED.
/// </remarks>
/// <param name="roundInput"></param>
pplx::task<std::shared_ptr<RoundOut>> postCompanyFundraiseRound(
std::shared_ptr<RoundInput> roundInput
) const;
/// <summary>
/// Raises an e-signature request over documents already in the org&#39;s data room — a SAFE, a convertible note, or any other fundraising paper.
/// </summary>
/// <remarks>
/// Raises an e-signature request over documents already in the org&#39;s data room — a SAFE, a convertible note, or any other fundraising paper. Available only after incorporation (stage company).
/// </remarks>
/// <param name="safeIn"></param>
pplx::task<std::shared_ptr<SafeOut>> postCompanyFundraiseSafe(
std::shared_ptr<SafeIn> safeIn
) const;
/// <summary>
/// Seeds the canonical cap table with the founding allocation (stakeholders, a common share class, issued shares) and anchors the deterministic equity-genesis root on-chain.
/// </summary>
/// <remarks>
/// Seeds the canonical cap table with the founding allocation (stakeholders, a common share class, issued shares) and anchors the deterministic equity-genesis root on-chain. It is idempotent: once a root is recorded the cap table is NOT re-seeded, which would double-issue founder share certificates. The root is persisted even when the on-chain submit fails, because the root is the tamper-evident witness and must not be recomputed on retry. Available only at the genesis stage.
/// </remarks>
pplx::task<std::shared_ptr<FormationView>> postCompanyGenesis(
) const;
/// <summary>
/// Reads an existing company&#39;s cap table from a Google Sheet and adds its stakeholders to the canonical cap table.
/// </summary>
/// <remarks>
/// Reads an existing company&#39;s cap table from a Google Sheet and adds its stakeholders to the canonical cap table. The first row is a header and columns are matched by name (case-insensitive): name and email are required, type/relationship/institution optional. A sheet without name and email columns, or with no usable data rows, is refused with 400. Available only at the import stage.
/// </remarks>
/// <param name="importCapTableIn"></param>
pplx::task<std::shared_ptr<ImportCapTableOut>> postCompanyImportCaptable(
std::shared_ptr<ImportCapTableIn> importCapTableIn
) const;
/// <summary>
/// Ingests an existing company&#39;s corporate documents from a Google Drive folder into the org&#39;s data room.
/// </summary>
/// <remarks>
/// Ingests an existing company&#39;s corporate documents from a Google Drive folder into the org&#39;s data room. The import is shallow — sub-folders are skipped, not walked — and available only at the import stage.
/// </remarks>
/// <param name="importDocumentsIn"></param>
pplx::task<std::shared_ptr<ImportDocumentsOut>> postCompanyImportDocuments(
std::shared_ptr<ImportDocumentsIn> importDocumentsIn
) const;
/// <summary>
/// StartKYC opens an identity-verification session for every founder with the wired provider and records each session&#39;s reference on the formation.
/// </summary>
/// <remarks>
/// StartKYC opens an identity-verification session for every founder with the wired provider and records each session&#39;s reference on the formation. A start is never a decision: any terminal status the provider reports at inquiry time is clamped back to pending, so the payment gate can never open here. A terminal status arrives only from POST /v1/company/kyc/refresh (the provider) or POST /v1/company/kyc/decision (a Hanzo platform reviewer).
/// </remarks>
pplx::task<std::shared_ptr<KycStartOut>> postCompanyKyc(
) const;
/// <summary>
/// DecideKYC records a privileged reviewer&#39;s MANUAL decision on a founder&#39;s KYC — the human-in-the-loop path, and the ONLY route to a pass when no real provider is wired.
/// </summary>
/// <remarks>
/// DecideKYC records a privileged reviewer&#39;s MANUAL decision on a founder&#39;s KYC — the human-in-the-loop path, and the ONLY route to a pass when no real provider is wired. It produces a DISTINCT reviewer_confirmed, never a provider \&quot;verified\&quot;. Because Hanzo forms the entity and carries the formation KYC/AML obligation, the reviewer is a HANZO platform reviewer (SuperAdmin), and the decision is ATTRIBUTED to them.
/// </remarks>
/// <param name="decisionIn"></param>
pplx::task<std::shared_ptr<FormationView>> postCompanyKycDecision(
std::shared_ptr<DecisionIn> decisionIn
) const;
/// <summary>
/// RefreshKYC reconciles each pending founder&#39;s KYC with the WIRED provider — the PULL path to a provider-reported terminal status.
/// </summary>
/// <remarks>
/// RefreshKYC reconciles each pending founder&#39;s KYC with the WIRED provider — the PULL path to a provider-reported terminal status. For the manual provider the check stays pending; for a real provider it reflects the settled decision, ATTRIBUTED to the provider. It NEVER trusts a client-asserted status — the status comes from the PROVIDER — so a client cannot force a pass here, and an already-passing founder (e.g. a reviewer confirmation) is left untouched.
/// </remarks>
pplx::task<std::shared_ptr<KycRefreshOut>> postCompanyKycRefresh(
) const;
/// <summary>
/// Charges the caller&#39;s own org the one-time Hanzo Company formation fee.
/// </summary>
/// <remarks>
/// Charges the caller&#39;s own org the one-time Hanzo Company formation fee. It is $999 unless the deployment sets another, and the answer is the formation record carrying its paid flag and the charge reference. It takes no body: the org is the validated tenant and the amount is the platform&#39;s, never the caller&#39;s to assert. IDEMPOTENT on the formation rather than on the request: an already-paid formation answers 200 with the same record and is not charged again, so a retry or a double-clicked button costs nothing. Available only at the &#x60;payment&#x60; stage (409 anywhere else) and only for an org that has begun a formation (404 otherwise). A denial answers the fleet-wide billing contract — 402 insufficient_balance, 402 spend_cap_exceeded, 503 balance_unavailable — carried by cloud.Denied, which is the money wire&#39;s own {\&quot;error\&quot;:{\&quot;code\&quot;,\&quot;message\&quot;}} body rather than a second vocabulary invented for this surface. The gate is the LAST thing it does, after the stage check and the paid short-circuit, so a caller the machine is about to refuse is never charged. That ordering is why the gate cannot lift into middleware, where it would run first. Both facts are pinned: TestPaymentDenialWire, TestPaymentChargesLast.
/// </remarks>
pplx::task<std::shared_ptr<FormationView>> postCompanyPayment(
) const;
/// <summary>
/// Skip marks the org as already incorporated and moves it onto the import path, so an existing company brings its documents and cap table in instead of forming a new entity.
/// </summary>
/// <remarks>
/// Skip marks the org as already incorporated and moves it onto the import path, so an existing company brings its documents and cap table in instead of forming a new entity. Available only at the structure stage.
/// </remarks>
pplx::task<std::shared_ptr<FormationView>> postCompanySkip(
) const;
/// <summary>
/// Itemises what a formation costs before anyone commits to it.
/// </summary>
/// <remarks>
/// Itemises what a formation costs before anyone commits to it. It answers what is due now and what recurs, as separate figures, and marks the state&#39;s filing fee as money we collect and remit rather than keep. A caller can therefore show a payer the whole bill — which is the point of quoting at all, and was impossible while the fee was one number in an error string. A jurisdiction whose filing fee this deployment has not been told REFUSES, naming the setting that fixes it. Quoting our half as though it were the total is the one answer that would be worse than no answer.
/// </remarks>
/// <param name="tariffIn"></param>
pplx::task<std::shared_ptr<Tariff>> postCompanyTariff(
std::shared_ptr<TariffIn> tariffIn
) const;
/// <summary>
/// Records the entity kind, the state of formation and the proposed name.
/// </summary>
/// <remarks>
/// Records the entity kind, the state of formation and the proposed name. Available only at the structure stage; an unknown structure or jurisdiction, or an empty name, is refused with 400.
/// </remarks>
/// <param name="structureIn"></param>
pplx::task<std::shared_ptr<FormationView>> putCompanyStructure(
std::shared_ptr<StructureIn> structureIn
) const;
protected:
std::shared_ptr<const ApiClient> m_ApiClient;
};
}
}
#endif /* HANZO_API_CompanyApi_H_ */