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.
142 lines
4.4 KiB
C++
142 lines
4.4 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.
|
|
*/
|
|
|
|
/*
|
|
* AudiencePreview.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_AudiencePreview_H_
|
|
#define HANZO_MODEL_AudiencePreview_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include <cpprest/details/basic_types.h>
|
|
#include <vector>
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
|
|
|
|
class AudiencePreview
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
AudiencePreview();
|
|
virtual ~AudiencePreview();
|
|
|
|
/////////////////////////////////////////////
|
|
/// 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;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// AudiencePreview members
|
|
|
|
|
|
/// <summary>
|
|
/// Available is false when the roster or the warehouse could not be read; the counts are then zero because nothing was measured, not because the cohort is empty, and Reason says which read failed.
|
|
/// </summary>
|
|
bool isAvailable() const;
|
|
bool availableIsSet() const;
|
|
void unsetAvailable();
|
|
void setAvailable(bool value);
|
|
|
|
/// <summary>
|
|
/// Count is the cohort size: distinct warehouse identifiers for an event audience, mailable customers for an event-less (whole-org) one.
|
|
/// </summary>
|
|
int64_t getCount() const;
|
|
bool countIsSet() const;
|
|
void unsetCount();
|
|
void setCount(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Deliverable is how many de-duplicated mailboxes a send would reach. Two customers sharing an address count once, so it is <= Count.
|
|
/// </summary>
|
|
int64_t getDeliverable() const;
|
|
bool deliverableIsSet() const;
|
|
void unsetDeliverable();
|
|
void setDeliverable(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Reason is the error text of the read that failed: the org's roster could not be loaded (\"identity store unavailable…\"), or the cohort query had no warehouse to run against (\"analytics warehouse not configured\"). Absent when the evaluation succeeded, so its presence and Available=false are one fact seen twice.
|
|
/// </summary>
|
|
utility::string_t getReason() const;
|
|
bool reasonIsSet() const;
|
|
void unsetReason();
|
|
void setReason(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Sample is up to 1000 cohort IDENTIFIERS — never addresses, which product analytics does not hold. Empty for an event-less (whole-org) audience.
|
|
/// </summary>
|
|
std::vector<utility::string_t> getSample() const;
|
|
bool sampleIsSet() const;
|
|
void unsetSample();
|
|
void setSample(const std::vector<utility::string_t>& value);
|
|
|
|
/// <summary>
|
|
/// Source names where the cohort was read: the events table for an event audience, \"iam:<org>\" for the whole-org one.
|
|
/// </summary>
|
|
utility::string_t getSource() const;
|
|
bool sourceIsSet() const;
|
|
void unsetSource();
|
|
void setSource(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Unmatched is how many cohort identifiers named nobody on the org's roster and so have no address to mail. It is reported rather than hidden: it is the honest explanation for a cohort of 500 that mails 3. Always 0 for an event-less (whole-org) audience, which starts from the roster and has nothing to match.
|
|
/// </summary>
|
|
int64_t getUnmatched() const;
|
|
bool unmatchedIsSet() const;
|
|
void unsetUnmatched();
|
|
void setUnmatched(int64_t value);
|
|
|
|
|
|
protected:
|
|
bool m_Available;
|
|
bool m_AvailableIsSet;
|
|
|
|
int64_t m_Count;
|
|
bool m_CountIsSet;
|
|
|
|
int64_t m_Deliverable;
|
|
bool m_DeliverableIsSet;
|
|
|
|
utility::string_t m_Reason;
|
|
bool m_ReasonIsSet;
|
|
|
|
std::vector<utility::string_t> m_Sample;
|
|
bool m_SampleIsSet;
|
|
|
|
utility::string_t m_Source;
|
|
bool m_SourceIsSet;
|
|
|
|
int64_t m_Unmatched;
|
|
bool m_UnmatchedIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_AudiencePreview_H_ */
|