Files
sdk/include/hanzo/model/AffiliateStanding.h
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

232 lines
6.7 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.
*/
/*
* AffiliateStanding.h
*
*
*/
#ifndef HANZO_MODEL_AffiliateStanding_H_
#define HANZO_MODEL_AffiliateStanding_H_
#include <boost/optional.hpp>
#include "hanzo/ModelBase.h"
#include <cpprest/details/basic_types.h>
#include "hanzo/model/Remittance.h"
#include <vector>
namespace hanzo {
namespace model {
class Remittance;
class AffiliateStanding
: public ModelBase
{
public:
AffiliateStanding();
virtual ~AffiliateStanding();
/////////////////////////////////////////////
/// 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;
/////////////////////////////////////////////
/// AffiliateStanding members
/// <summary>
/// AccruedCents is lifetime commission accrued, in cents.
/// </summary>
int64_t getAccruedCents() const;
bool accruedCentsIsSet() const;
void unsetAccruedCents();
void setAccruedCents(int64_t value);
/// <summary>
/// Code is the minted referral code; empty until staff approve.
/// </summary>
utility::string_t getCode() const;
bool codeIsSet() const;
void unsetCode();
void setCode(const utility::string_t& value);
/// <summary>
/// DefaultRateBps is the direct rate a new affiliate would get, answered only to a caller that has not applied.
/// </summary>
int64_t getDefaultRateBps() const;
bool defaultRateBpsIsSet() const;
void unsetDefaultRateBps();
void setDefaultRateBps(int64_t value);
/// <summary>
/// Handle is the opt-in public leaderboard name; empty means opted out.
/// </summary>
utility::string_t getHandle() const;
bool handleIsSet() const;
void unsetHandle();
void setHandle(const utility::string_t& value);
/// <summary>
/// ID is the affiliate&#39;s server-minted handle, \&quot;aff_\&quot;-prefixed — what staff approve, suspend, re-rate and pay against. Absent until the org applies.
/// </summary>
utility::string_t getId() const;
bool idIsSet() const;
void unsetId();
void setId(const utility::string_t& value);
/// <summary>
/// IsAffiliate says whether the caller org has an affiliate record at all. It is the ONE field an org that never applied gets besides defaultRateBps: on false, read nothing else here — every other field is absent, not zero.
/// </summary>
bool isIsAffiliate() const;
bool isAffiliateIsSet() const;
void unsetIsAffiliate();
void setIsAffiliate(bool value);
/// <summary>
/// Link is the shareable ?aff URL; empty until a code is minted.
/// </summary>
utility::string_t getLink() const;
bool linkIsSet() const;
void unsetLink();
void setLink(const utility::string_t& value);
/// <summary>
/// MarginBps is the platform gross-margin fraction commission is a rate OF.
/// </summary>
int64_t getMarginBps() const;
bool marginBpsIsSet() const;
void unsetMarginBps();
void setMarginBps(int64_t value);
/// <summary>
/// PaidCents is lifetime commission already paid out, in cents.
/// </summary>
int64_t getPaidCents() const;
bool paidCentsIsSet() const;
void unsetPaidCents();
void setPaidCents(int64_t value);
/// <summary>
/// Payouts is the payout history, newest rows bounded.
/// </summary>
std::vector<std::shared_ptr<Remittance>> getPayouts() const;
bool payoutsIsSet() const;
void unsetPayouts();
void setPayouts(const std::vector<std::shared_ptr<Remittance>>& value);
/// <summary>
/// PendingCents is accrued minus paid — what the platform still owes.
/// </summary>
int64_t getPendingCents() const;
bool pendingCentsIsSet() const;
void unsetPendingCents();
void setPendingCents(int64_t value);
/// <summary>
/// RateBps is the affiliate&#39;s own direct commission rate, in basis points.
/// </summary>
int64_t getRateBps() const;
bool rateBpsIsSet() const;
void unsetRateBps();
void setRateBps(int64_t value);
/// <summary>
/// ReferredCount is how many orgs this affiliate has referred.
/// </summary>
int64_t getReferredCount() const;
bool referredCountIsSet() const;
void unsetReferredCount();
void setReferredCount(int64_t value);
/// <summary>
/// RequestedCode is the vanity code asked for at apply time — a request, not an allocation. Approval mints &#x60;code&#x60;, which may be a different slug if this one was already taken.
/// </summary>
utility::string_t getRequestedCode() const;
bool requestedCodeIsSet() const;
void unsetRequestedCode();
void setRequestedCode(const utility::string_t& value);
/// <summary>
/// Status is \&quot;applied\&quot;, \&quot;approved\&quot; or \&quot;suspended\&quot;. Only an approved affiliate has a code that resolves for attribution and accrues commission; suspended keeps what it already earned but stops earning more.
/// </summary>
utility::string_t getStatus() const;
bool statusIsSet() const;
void unsetStatus();
void setStatus(const utility::string_t& value);
protected:
int64_t m_AccruedCents;
bool m_AccruedCentsIsSet;
utility::string_t m_Code;
bool m_CodeIsSet;
int64_t m_DefaultRateBps;
bool m_DefaultRateBpsIsSet;
utility::string_t m_Handle;
bool m_HandleIsSet;
utility::string_t m_Id;
bool m_IdIsSet;
bool m_IsAffiliate;
bool m_IsAffiliateIsSet;
utility::string_t m_Link;
bool m_LinkIsSet;
int64_t m_MarginBps;
bool m_MarginBpsIsSet;
int64_t m_PaidCents;
bool m_PaidCentsIsSet;
std::vector<std::shared_ptr<Remittance>> m_Payouts;
bool m_PayoutsIsSet;
int64_t m_PendingCents;
bool m_PendingCentsIsSet;
int64_t m_RateBps;
bool m_RateBpsIsSet;
int64_t m_ReferredCount;
bool m_ReferredCountIsSet;
utility::string_t m_RequestedCode;
bool m_RequestedCodeIsSet;
utility::string_t m_Status;
bool m_StatusIsSet;
};
}
}
#endif /* HANZO_MODEL_AffiliateStanding_H_ */