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

177 lines
5.6 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.
*/
/*
* CampaignRecord.h
*
*
*/
#ifndef HANZO_MODEL_CampaignRecord_H_
#define HANZO_MODEL_CampaignRecord_H_
#include <boost/optional.hpp>
#include "hanzo/ModelBase.h"
#include <cpprest/details/basic_types.h>
#include "hanzo/model/ChannelSpec.h"
#include <vector>
namespace hanzo {
namespace model {
class ChannelSpec;
class CampaignRecord
: public ModelBase
{
public:
CampaignRecord();
virtual ~CampaignRecord();
/////////////////////////////////////////////
/// 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;
/////////////////////////////////////////////
/// CampaignRecord members
/// <summary>
/// Audience is an opaque reference to the segment this campaign targets. It is stored and echoed but not yet handed to the executors — a channel targets through the provider account it runs under — so it is documentation for now. Absent when never set.
/// </summary>
utility::string_t getAudience() const;
bool audienceIsSet() const;
void unsetAudience();
void setAudience(const utility::string_t& value);
/// <summary>
/// Budget is the campaign&#39;s total budget in CENTS, handed to each executor as the budget for its channel. 0 means none was set.
/// </summary>
int64_t getBudget() const;
bool budgetIsSet() const;
void unsetBudget();
void setBudget(int64_t value);
/// <summary>
/// Channels are the fan-out targets, at most one per kind and at most 12, each carrying its own post-launch state. Empty means nothing to launch, which is what makes a launch of this campaign a 400.
/// </summary>
std::vector<std::shared_ptr<ChannelSpec>> getChannels() const;
bool channelsIsSet() const;
void unsetChannels();
void setChannels(const std::vector<std::shared_ptr<ChannelSpec>>& value);
/// <summary>
/// Content is the ordered creative set, at most 32, empty entries dropped. Content[0] is the creative that runs; the rest are A/B variants a wired experiment can assign per launch.
/// </summary>
std::vector<utility::string_t> getContent() const;
bool contentIsSet() const;
void unsetContent();
void setContent(const std::vector<utility::string_t>& value);
/// <summary>
/// CreatedAt is when the campaign was created, in unix seconds. Server-set.
/// </summary>
int64_t getCreatedAt() const;
bool createdAtIsSet() const;
void unsetCreatedAt();
void setCreatedAt(int64_t value);
/// <summary>
/// ID is the campaign&#39;s server-minted handle — \&quot;cmp_\&quot; and 128 random bits — and the id every other campaign call is addressed by. Never read off the wire: a create that sends one has it ignored.
/// </summary>
utility::string_t getId() const;
bool idIsSet() const;
void unsetId();
void setId(const utility::string_t& value);
/// <summary>
/// Name is the campaign&#39;s display name. Required on write, trimmed, and capped at 2048 characters.
/// </summary>
utility::string_t getName() const;
bool nameIsSet() const;
void unsetName();
void setName(const utility::string_t& value);
/// <summary>
/// ScheduleAt is when the campaign should run, in unix seconds. 0 (absent) means launch immediately. It is passed to each executor; nothing in this service wakes up to launch it for you.
/// </summary>
int64_t getScheduleAt() const;
bool scheduleAtIsSet() const;
void unsetScheduleAt();
void setScheduleAt(int64_t value);
/// <summary>
/// Status is the lifecycle state, server-owned and never accepted from a caller. Four values actually occur: draft (inert and fully mutable — nothing is sent and no budget is committed), live, paused and failed. After a fan-out live means AT LEAST ONE channel launched — read the channel rows for the rest — and failed means none did.
/// </summary>
utility::string_t getStatus() const;
bool statusIsSet() const;
void unsetStatus();
void setStatus(const utility::string_t& value);
/// <summary>
/// UpdatedAt is the last write in unix seconds — an edit, a launch or a pause. Server-set on every save.
/// </summary>
int64_t getUpdatedAt() const;
bool updatedAtIsSet() const;
void unsetUpdatedAt();
void setUpdatedAt(int64_t value);
protected:
utility::string_t m_Audience;
bool m_AudienceIsSet;
int64_t m_Budget;
bool m_BudgetIsSet;
std::vector<std::shared_ptr<ChannelSpec>> m_Channels;
bool m_ChannelsIsSet;
std::vector<utility::string_t> m_Content;
bool m_ContentIsSet;
int64_t m_CreatedAt;
bool m_CreatedAtIsSet;
utility::string_t m_Id;
bool m_IdIsSet;
utility::string_t m_Name;
bool m_NameIsSet;
int64_t m_ScheduleAt;
bool m_ScheduleAtIsSet;
utility::string_t m_Status;
bool m_StatusIsSet;
int64_t m_UpdatedAt;
bool m_UpdatedAtIsSet;
};
}
}
#endif /* HANZO_MODEL_CampaignRecord_H_ */