mirror of
https://github.com/hanzo-cpp/sdk.git
synced 2026-11-20 19:55:32 +00:00
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.
163 lines
5.0 KiB
C++
163 lines
5.0 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.
|
|
*/
|
|
|
|
/*
|
|
* SelfRank.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_SelfRank_H_
|
|
#define HANZO_MODEL_SelfRank_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include <cpprest/details/basic_types.h>
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
|
|
|
|
class SelfRank
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
SelfRank();
|
|
virtual ~SelfRank();
|
|
|
|
/////////////////////////////////////////////
|
|
/// ModelBase overrides
|
|
|
|
void validate() override;
|
|
|
|
web::json::value toJson() const override;
|
|
bool fromJson(const web::json::value& json) override;
|
|
|
|
void toMultipart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) const override;
|
|
bool fromMultiPart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) override;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// SelfRank members
|
|
|
|
|
|
/// <summary>
|
|
/// CostCents is the caller's own spend in whole US cents. Always populated — your own spend is never withheld from you — so here 0 really does mean zero.
|
|
/// </summary>
|
|
int64_t getCostCents() const;
|
|
bool costCentsIsSet() const;
|
|
void unsetCostCents();
|
|
void setCostCents(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Handle is how the caller appears on this board: their chosen handle, falling back to their username, on a user board; their org id on the global board. Present even when unlisted — this is the caller looking at themselves.
|
|
/// </summary>
|
|
utility::string_t getHandle() const;
|
|
bool handleIsSet() const;
|
|
void unsetHandle();
|
|
void setHandle(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Listed says whether the caller is publicly visible on this board: opted in on a user board, org opted in (or the viewer is a platform admin) on the global one. False is the prompt to offer the opt-in, and explains an unranked global self.
|
|
/// </summary>
|
|
bool isListed() const;
|
|
bool listedIsSet() const;
|
|
void unsetListed();
|
|
void setListed(bool value);
|
|
|
|
/// <summary>
|
|
/// Metric is whichever of the three values above the board was ranked by, so a client can compare the caller against the rows without re-reading the request. Metric <= 0 is exactly the case that leaves Ranked false.
|
|
/// </summary>
|
|
int64_t getMetric() const;
|
|
bool metricIsSet() const;
|
|
void unsetMetric();
|
|
void setMetric(int64_t value);
|
|
|
|
/// <summary>
|
|
/// OfTotal is the size of the universe Rank is out of — \"rank N of OfTotal\". On a user board that is the org's users with any usage in the window; on the global board it is every active org for a platform admin, and the count of opted-in orgs for everyone else.
|
|
/// </summary>
|
|
int64_t getOfTotal() const;
|
|
bool ofTotalIsSet() const;
|
|
void unsetOfTotal();
|
|
void setOfTotal(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Rank is the caller's 1-based standing, computed as (subjects whose windowed metric strictly exceeds the caller's) + 1. It is exact against the whole ranked universe, not just the returned page, so it can far exceed len(rows). Read it only when Ranked.
|
|
/// </summary>
|
|
int64_t getRank() const;
|
|
bool rankIsSet() const;
|
|
void unsetRank();
|
|
void setRank(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Ranked is false when the caller holds no position: they had no usage in the window, or (on the global board) their org has not opted into public listing and so is not ranked against a set it never joined. Rank is then 0 and means nothing.
|
|
/// </summary>
|
|
bool isRanked() const;
|
|
bool rankedIsSet() const;
|
|
void unsetRanked();
|
|
void setRanked(bool value);
|
|
|
|
/// <summary>
|
|
/// Requests is the caller's own request count in the window, 0 if they were idle.
|
|
/// </summary>
|
|
int64_t getRequests() const;
|
|
bool requestsIsSet() const;
|
|
void unsetRequests();
|
|
void setRequests(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Tokens is the caller's own prompt+completion tokens in the window.
|
|
/// </summary>
|
|
int64_t getTokens() const;
|
|
bool tokensIsSet() const;
|
|
void unsetTokens();
|
|
void setTokens(int64_t value);
|
|
|
|
|
|
protected:
|
|
int64_t m_CostCents;
|
|
bool m_CostCentsIsSet;
|
|
|
|
utility::string_t m_Handle;
|
|
bool m_HandleIsSet;
|
|
|
|
bool m_Listed;
|
|
bool m_ListedIsSet;
|
|
|
|
int64_t m_Metric;
|
|
bool m_MetricIsSet;
|
|
|
|
int64_t m_OfTotal;
|
|
bool m_OfTotalIsSet;
|
|
|
|
int64_t m_Rank;
|
|
bool m_RankIsSet;
|
|
|
|
bool m_Ranked;
|
|
bool m_RankedIsSet;
|
|
|
|
int64_t m_Requests;
|
|
bool m_RequestsIsSet;
|
|
|
|
int64_t m_Tokens;
|
|
bool m_TokensIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_SelfRank_H_ */
|