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

130 lines
3.8 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.
*/
/*
* ChannelMetric.h
*
*
*/
#ifndef HANZO_MODEL_ChannelMetric_H_
#define HANZO_MODEL_ChannelMetric_H_
#include <boost/optional.hpp>
#include "hanzo/ModelBase.h"
#include <cpprest/details/basic_types.h>
namespace hanzo {
namespace model {
class ChannelMetric
: public ModelBase
{
public:
ChannelMetric();
virtual ~ChannelMetric();
/////////////////////////////////////////////
/// 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;
/////////////////////////////////////////////
/// ChannelMetric members
/// <summary>
/// ExternalID is the provider-side id of the execution the spend belongs to. Absent until the channel has launched.
/// </summary>
utility::string_t getExternalId() const;
bool externalIdIsSet() const;
void unsetExternalId();
void setExternalId(const utility::string_t& value);
/// <summary>
/// Kind is which channel this row is: paid, organic or email. It is also the row&#39;s identity — a campaign carries at most one channel per kind.
/// </summary>
utility::string_t getKind() const;
bool kindIsSet() const;
void unsetKind();
void setKind(const utility::string_t& value);
/// <summary>
/// Platform is the provider the spend was read from: meta, google, x, instagram, or the email provider.
/// </summary>
utility::string_t getPlatform() const;
bool platformIsSet() const;
void unsetPlatform();
void setPlatform(const utility::string_t& value);
/// <summary>
/// SpendCents is what the provider itself reports this channel spent, in CENTS. 0 when the channel never launched, when no executor is wired for it, or when the read failed — SpendError tells the last case apart from a genuine zero.
/// </summary>
int64_t getSpendCents() const;
bool spendCentsIsSet() const;
void unsetSpendCents();
void setSpendCents(int64_t value);
/// <summary>
/// SpendError is why this channel&#39;s spend could not be read (connector not connected, provider error), as one secret-free line. Present only on failure; the campaign total then simply omits this channel rather than failing.
/// </summary>
utility::string_t getSpendError() const;
bool spendErrorIsSet() const;
void unsetSpendError();
void setSpendError(const utility::string_t& value);
/// <summary>
/// Status is the channel&#39;s launch state on the campaign — pending, live, paused, failed or unavailable. Only a live channel is asked for its spend at all.
/// </summary>
utility::string_t getStatus() const;
bool statusIsSet() const;
void unsetStatus();
void setStatus(const utility::string_t& value);
protected:
utility::string_t m_ExternalId;
bool m_ExternalIdIsSet;
utility::string_t m_Kind;
bool m_KindIsSet;
utility::string_t m_Platform;
bool m_PlatformIsSet;
int64_t m_SpendCents;
bool m_SpendCentsIsSet;
utility::string_t m_SpendError;
bool m_SpendErrorIsSet;
utility::string_t m_Status;
bool m_StatusIsSet;
};
}
}
#endif /* HANZO_MODEL_ChannelMetric_H_ */