Files
zeekay 2872fb75b8 Regenerate: the AI surface says what it answers
288 of hanzoai/ai's 294 operations now declare a response, against 1 before.
GET /v1/models, POST /v1/chat/completions, /v1/embeddings, /v1/messages —
every address a client actually calls — used to reach this client untyped,
because cloud's relay carried an operation's sentence and dropped the shapes
it named. It carries both now.

Fleet-wide the document goes from 69% to 81% of operations declaring what
comes back, which is where the ~208 new models here come from.
2026-08-28 15:54:28 -07:00

180 lines
9.3 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.
*/
/*
* PlanApi.h
*
*
*/
#ifndef HANZO_API_PlanApi_H_
#define HANZO_API_PlanApi_H_
#include "hanzo/ApiClient.h"
#include "hanzo/AnyType.h"
#include "hanzo/model/PlanEntitlements.h"
#include "hanzo/model/PlanHealth.h"
#include "hanzo/model/PlanList.h"
#include "hanzo/model/PlanRegionList.h"
#include "hanzo/model/PlanResolution.h"
#include "hanzo/model/PlanSchemas.h"
#include "hanzo/model/PlanTierList.h"
#include "hanzo/model/PlanToolList.h"
#include "hanzo/model/PlanVocab.h"
#include <map>
#include <cpprest/details/basic_types.h>
#include <boost/optional.hpp>
namespace hanzo {
namespace api {
using namespace hanzo::model;
class PlanApi
{
public:
explicit PlanApi( std::shared_ptr<const ApiClient> apiClient );
virtual ~PlanApi();
/// <summary>
/// Returns the Hanzo cloud plan catalog: every cloud tier with its price, included capacity, limits and feature list, scoped to the caller&#39;s catalog.
/// </summary>
/// <remarks>
/// Returns the Hanzo cloud plan catalog: every cloud tier with its price, included capacity, limits and feature list, scoped to the caller&#39;s catalog. A reseller org sees its own overrides in place of the canonical records it has replaced, and the canonical record for every tier it has not.
/// </remarks>
pplx::task<std::shared_ptr<PlanList>> getPlan(
) const;
/// <summary>
/// Returns the blockchain RPC plan catalog: the tiers metered in monthly compute units, with their prices, limits and overage terms.
/// </summary>
/// <remarks>
/// Returns the blockchain RPC plan catalog: the tiers metered in monthly compute units, with their prices, limits and overage terms. It is the canonical catalog for every caller — these plans carry no reseller overrides.
/// </remarks>
pplx::task<std::shared_ptr<PlanList>> getPlanBlockchain(
) const;
/// <summary>
/// ListDNSPlans returns the DNS plan catalog: the tiers priced on zones, records per zone and queries per day.
/// </summary>
/// <remarks>
/// ListDNSPlans returns the DNS plan catalog: the tiers priced on zones, records per zone and queries per day. It is the canonical catalog for every caller — these plans carry no reseller overrides.
/// </remarks>
pplx::task<std::shared_ptr<PlanList>> getPlanDns(
) const;
/// <summary>
/// Returns what one plan GRANTS and not what it costs: the canonical namespaced entitlement block and the flat license-feature list derived from it.
/// </summary>
/// <remarks>
/// Returns what one plan GRANTS and not what it costs: the canonical namespaced entitlement block and the flat license-feature list derived from it. It is the entitlement half of ResolvePlan, over the same catalog and the same 404 for an id no catalog holds — the read a licensing or quota gate makes.
/// </remarks>
/// <param name="id">ID is the plan&#39;s catalog id or slug — \&quot;dev\&quot;, \&quot;max\&quot;, \&quot;team\&quot;, \&quot;rpc-growth\&quot;. Both are matched, so a slug resolves the plan it names. A withdrawn id still resolves for a renewal, which is why this takes an id rather than a ladder position.</param>
pplx::task<std::shared_ptr<PlanEntitlements>> getPlanEntitlementsById(
utility::string_t id
) const;
/// <summary>
/// ListGPUTiers returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPUs, host memory and hourly price.
/// </summary>
/// <remarks>
/// ListGPUTiers returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPUs, host memory and hourly price.
/// </remarks>
pplx::task<std::shared_ptr<PlanTierList>> getPlanGpu(
) const;
/// <summary>
/// Health reports that the plans subsystem is mounted and serving.
/// </summary>
/// <remarks>
/// Health reports that the plans subsystem is mounted and serving. It answers from the process itself and consults neither the catalog bundle nor the goja host, so it stays \&quot;ok\&quot; while either is degraded.
/// </remarks>
pplx::task<std::shared_ptr<PlanHealth>> getPlanHealth(
) const;
/// <summary>
/// Returns the published pricing policy: whether pricing is transparent, the revenue-sharing terms (idle compute resale and the open-source share) and the principles the catalog is priced by.
/// </summary>
/// <remarks>
/// Returns the published pricing policy: whether pricing is transparent, the revenue-sharing terms (idle compute resale and the open-source share) and the principles the catalog is priced by.
/// </remarks>
pplx::task<std::map<utility::string_t, std::shared_ptr<AnyType>>> getPlanPolicy(
) const;
/// <summary>
/// Returns the regions cloud capacity is offered in, each with its display name and physical location.
/// </summary>
/// <remarks>
/// Returns the regions cloud capacity is offered in, each with its display name and physical location.
/// </remarks>
pplx::task<std::shared_ptr<PlanRegionList>> getPlanRegions(
) const;
/// <summary>
/// Resolves one plan to everything a consumer of the catalog needs at once: its canonical entitlement block, the flat license-feature list a signed license carries, its billing reference, and the catalog it came from.
/// </summary>
/// <remarks>
/// Resolves one plan to everything a consumer of the catalog needs at once: its canonical entitlement block, the flat license-feature list a signed license carries, its billing reference, and the catalog it came from. The id may be the plan&#39;s id or its slug, and it is resolved against the caller&#39;s catalog, so a reseller&#39;s override wins over the canonical record. An id no catalog holds answers 404.
/// </remarks>
/// <param name="id">ID is the plan&#39;s catalog id or slug — \&quot;dev\&quot;, \&quot;max\&quot;, \&quot;team\&quot;, \&quot;rpc-growth\&quot;. Both are matched, so a slug resolves the plan it names. A withdrawn id still resolves for a renewal, which is why this takes an id rather than a ladder position.</param>
pplx::task<std::shared_ptr<PlanResolution>> getPlanResolveById(
utility::string_t id
) const;
/// <summary>
/// Returns the two JSON Schema documents this surface speaks: entitlements.schema.json, which declares every entitlement key with its type, unit and enum, and plan.schema.json, which a catalog plan record conforms to.
/// </summary>
/// <remarks>
/// Returns the two JSON Schema documents this surface speaks: entitlements.schema.json, which declares every entitlement key with its type, unit and enum, and plan.schema.json, which a catalog plan record conforms to.
/// </remarks>
pplx::task<std::shared_ptr<PlanSchemas>> getPlanSchema(
) const;
/// <summary>
/// Returns the block-storage price block: the price per GB per month and the volume size bounds a cloud plan may attach.
/// </summary>
/// <remarks>
/// Returns the block-storage price block: the price per GB per month and the volume size bounds a cloud plan may attach.
/// </remarks>
pplx::task<std::map<utility::string_t, std::shared_ptr<AnyType>>> getPlanStorage(
) const;
/// <summary>
/// Returns the subscription ladder — the personal and team tiers a customer buys to use the cloud, each with its monthly and annual price, seat rules, limits and billing reference.
/// </summary>
/// <remarks>
/// Returns the subscription ladder — the personal and team tiers a customer buys to use the cloud, each with its monthly and annual price, seat rules, limits and billing reference. Scoped to the caller&#39;s catalog.
/// </remarks>
pplx::task<std::shared_ptr<PlanList>> getPlanSubscriptions(
) const;
/// <summary>
/// Returns the per-use price of every metered tool — web search, code interpreter, image generation, speech — each with the unit it is billed in.
/// </summary>
/// <remarks>
/// Returns the per-use price of every metered tool — web search, code interpreter, image generation, speech — each with the unit it is billed in.
/// </remarks>
pplx::task<std::shared_ptr<PlanToolList>> getPlanTools(
) const;
/// <summary>
/// Returns the entitlement key vocabulary: every key with its namespace, JSON type, nullability, unit, enum and title, the list of namespaces, and the engine features a license can grant.
/// </summary>
/// <remarks>
/// Returns the entitlement key vocabulary: every key with its namespace, JSON type, nullability, unit, enum and title, the list of namespaces, and the engine features a license can grant. It is derived from entitlements.schema.json on every call, so it cannot fall behind the schema.
/// </remarks>
pplx::task<std::shared_ptr<PlanVocab>> getPlanVocab(
) const;
protected:
std::shared_ptr<const ApiClient> m_ApiClient;
};
}
}
#endif /* HANZO_API_PlanApi_H_ */