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.
140 lines
4.0 KiB
C++
140 lines
4.0 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.
|
|
*/
|
|
|
|
/*
|
|
* Funnel.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_Funnel_H_
|
|
#define HANZO_MODEL_Funnel_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
|
|
|
|
class Funnel
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
Funnel();
|
|
virtual ~Funnel();
|
|
|
|
/////////////////////////////////////////////
|
|
/// 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;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// Funnel members
|
|
|
|
|
|
/// <summary>
|
|
/// Available separates \"this org has no traffic\" from \"we could not ask\". False means the warehouse was unreachable or the org has emitted nothing at all, and every count below is then a placeholder zero rather than a measurement — a caller must read this before reading any of them.
|
|
/// </summary>
|
|
bool isAvailable() const;
|
|
bool availableIsSet() const;
|
|
void unsetAvailable();
|
|
void setAvailable(bool value);
|
|
|
|
/// <summary>
|
|
/// Orders counts completed orders in the window — purchases, not carts started.
|
|
/// </summary>
|
|
int64_t getOrders() const;
|
|
bool ordersIsSet() const;
|
|
void unsetOrders();
|
|
void setOrders(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Pageviews counts page events in the window, one per view rather than per person, so a single visitor reading ten pages counts ten.
|
|
/// </summary>
|
|
int64_t getPageviews() const;
|
|
bool pageviewsIsSet() const;
|
|
void unsetPageviews();
|
|
void setPageviews(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Revenue is the sum of the amounts those orders reported, in whatever currency the beacon stamped on them (major units, e.g. 49.5 for $49.50) — NOT cents, and not converted to a single currency. Contrast revenueCents on the profile, which is the money of record.
|
|
/// </summary>
|
|
double getRevenue() const;
|
|
bool revenueIsSet() const;
|
|
void unsetRevenue();
|
|
void setRevenue(double value);
|
|
|
|
/// <summary>
|
|
/// Signups counts completed signups in the window, the step where an anonymous visitor becomes somebody with an account.
|
|
/// </summary>
|
|
int64_t getSignups() const;
|
|
bool signupsIsSet() const;
|
|
void unsetSignups();
|
|
void setSignups(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Visitors is the number of DISTINCT people seen in the window, counted by the beacon's distinct id — so it is unique visitors, not sessions and not views.
|
|
/// </summary>
|
|
int64_t getVisitors() const;
|
|
bool visitorsIsSet() const;
|
|
void unsetVisitors();
|
|
void setVisitors(int64_t value);
|
|
|
|
/// <summary>
|
|
/// WindowDays is the length of the trailing window every count covers, so a reader knows whether 40 signups is a month or a day.
|
|
/// </summary>
|
|
int64_t getWindowDays() const;
|
|
bool windowDaysIsSet() const;
|
|
void unsetWindowDays();
|
|
void setWindowDays(int64_t value);
|
|
|
|
|
|
protected:
|
|
bool m_Available;
|
|
bool m_AvailableIsSet;
|
|
|
|
int64_t m_Orders;
|
|
bool m_OrdersIsSet;
|
|
|
|
int64_t m_Pageviews;
|
|
bool m_PageviewsIsSet;
|
|
|
|
double m_Revenue;
|
|
bool m_RevenueIsSet;
|
|
|
|
int64_t m_Signups;
|
|
bool m_SignupsIsSet;
|
|
|
|
int64_t m_Visitors;
|
|
bool m_VisitorsIsSet;
|
|
|
|
int64_t m_WindowDays;
|
|
bool m_WindowDaysIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_Funnel_H_ */
|