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

174 lines
4.9 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.
*/
/*
* Campaign.h
*
*
*/
#ifndef HANZO_MODEL_Campaign_H_
#define HANZO_MODEL_Campaign_H_
#include <boost/optional.hpp>
#include "hanzo/ModelBase.h"
#include <cpprest/details/basic_types.h>
namespace hanzo {
namespace model {
class Campaign
: public ModelBase
{
public:
Campaign();
virtual ~Campaign();
/////////////////////////////////////////////
/// 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;
/////////////////////////////////////////////
/// Campaign members
/// <summary>
/// Budget is what the campaign is allowed to cost, in USD cents. A negative value is clamped to 0; nothing enforces the ceiling here.
/// </summary>
int64_t getBudget() const;
bool budgetIsSet() const;
void unsetBudget();
void setBudget(int64_t value);
/// <summary>
/// Channel is the delivery surface: email, sms, social, meta, google or tiktok. Empty means email.
/// </summary>
utility::string_t getChannel() const;
bool channelIsSet() const;
void unsetChannel();
void setChannel(const utility::string_t& value);
/// <summary>
/// CreatedAt is unix seconds when the campaign was registered. Server-assigned and never rewritten — an update leaves it as it was.
/// </summary>
int64_t getCreatedAt() const;
bool createdAtIsSet() const;
void unsetCreatedAt();
void setCreatedAt(int64_t value);
/// <summary>
/// ID is the server-assigned campaign id (\&quot;camp_\&quot; + 128 random bits).
/// </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 label. Required, trimmed, capped at 1024 bytes.
/// </summary>
utility::string_t getName() const;
bool nameIsSet() const;
void unsetName();
void setName(const utility::string_t& value);
/// <summary>
/// Objective is the free-text goal (\&quot;signups\&quot;), capped at 1024 bytes.
/// </summary>
utility::string_t getObjective() const;
bool objectiveIsSet() const;
void unsetObjective();
void setObjective(const utility::string_t& value);
/// <summary>
/// ScheduledAt is the unix send time; 0 means unscheduled. Setting it on a campaign with no explicit status makes that status \&quot;scheduled\&quot;.
/// </summary>
int64_t getScheduledAt() const;
bool scheduledAtIsSet() const;
void unsetScheduledAt();
void setScheduledAt(int64_t value);
/// <summary>
/// Spend is what the campaign has cost so far, in USD cents, clamped to &gt;&#x3D; 0. The CALLER owns it: no send, ad buy or invoice moves it, so it changes only when create or update carries a new value. It is summed across the org&#39;s campaigns into GET /v1/marketing/summary.
/// </summary>
int64_t getSpend() const;
bool spendIsSet() const;
void unsetSpend();
void setSpend(int64_t value);
/// <summary>
/// Status is the lifecycle: draft, scheduled, active, paused or completed. Empty means draft.
/// </summary>
utility::string_t getStatus() const;
bool statusIsSet() const;
void unsetStatus();
void setStatus(const utility::string_t& value);
/// <summary>
/// UpdatedAt is unix seconds of the last write. Server-assigned on create and on every update or schedule change, and the campaign list is ordered by it, newest first.
/// </summary>
int64_t getUpdatedAt() const;
bool updatedAtIsSet() const;
void unsetUpdatedAt();
void setUpdatedAt(int64_t value);
protected:
int64_t m_Budget;
bool m_BudgetIsSet;
utility::string_t m_Channel;
bool m_ChannelIsSet;
int64_t m_CreatedAt;
bool m_CreatedAtIsSet;
utility::string_t m_Id;
bool m_IdIsSet;
utility::string_t m_Name;
bool m_NameIsSet;
utility::string_t m_Objective;
bool m_ObjectiveIsSet;
int64_t m_ScheduledAt;
bool m_ScheduledAtIsSet;
int64_t m_Spend;
bool m_SpendIsSet;
utility::string_t m_Status;
bool m_StatusIsSet;
int64_t m_UpdatedAt;
bool m_UpdatedAtIsSet;
};
}
}
#endif /* HANZO_MODEL_Campaign_H_ */