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

186 lines
5.7 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.
*/
/*
* Endpoint.h
*
*
*/
#ifndef HANZO_MODEL_Endpoint_H_
#define HANZO_MODEL_Endpoint_H_
#include <boost/optional.hpp>
#include "hanzo/ModelBase.h"
#include <cpprest/details/basic_types.h>
#include <vector>
namespace hanzo {
namespace model {
class Endpoint
: public ModelBase
{
public:
Endpoint();
virtual ~Endpoint();
/////////////////////////////////////////////
/// 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;
/////////////////////////////////////////////
/// Endpoint members
/// <summary>
/// CreatedAt is when the endpoint was registered, RFC3339 in UTC — stored in that spelling because it sorts as a string.
/// </summary>
utility::string_t getCreated() const;
bool createdIsSet() const;
void unsetCreated();
void setCreated(const utility::string_t& value);
/// <summary>
/// Deliveries7d is how many deliveries SETTLED in the trailing 7 days — the attempts that ended ok or failed, so a delivery still retrying is in neither counter yet. It is counted from the log at read time rather than stored, and it is filled only on a list or a get; a create answers 0 because there is no history, which is why it is never omitted.
/// </summary>
int64_t getDeliveries7d() const;
bool deliveries7dIsSet() const;
void unsetDeliveries7d();
void setDeliveries7d(int64_t value);
/// <summary>
/// Description is the operator&#39;s own label for the endpoint. Never sent anywhere.
/// </summary>
utility::string_t getDescription() const;
bool descriptionIsSet() const;
void unsetDescription();
void setDescription(const utility::string_t& value);
/// <summary>
/// Events are the subject patterns this endpoint subscribes to (\&quot;commerce.order.&gt;\&quot;). An EMPTY list means every event, not none.
/// </summary>
std::vector<utility::string_t> getEvents() const;
bool eventsIsSet() const;
void unsetEvents();
void setEvents(const std::vector<utility::string_t>& value);
/// <summary>
/// Failures7d is how many of those settled as failed — the subscriber never accepted it and no further attempt will be made. It is the numerator to Deliveries7d, over the same window.
/// </summary>
int64_t getFailures7d() const;
bool failures7dIsSet() const;
void unsetFailures7d();
void setFailures7d(int64_t value);
/// <summary>
/// ID is the endpoint&#39;s handle, server-minted and stable for its life. It is what every other route here addresses.
/// </summary>
utility::string_t getId() const;
bool idIsSet() const;
void unsetId();
void setId(const utility::string_t& value);
/// <summary>
/// Org is the tenant that owns the endpoint, taken from the validated principal rather than from any request field.
/// </summary>
utility::string_t getOrg() const;
bool orgIsSet() const;
void unsetOrg();
void setOrg(const utility::string_t& value);
/// <summary>
/// Secret is the HMAC-SHA256 signing key a subscriber recomputes the signature with. It is returned exactly ONCE, on create: a later read of the endpoint omits it, so a lost secret is replaced rather than recovered.
/// </summary>
utility::string_t getSecret() const;
bool secretIsSet() const;
void unsetSecret();
void setSecret(const utility::string_t& value);
/// <summary>
/// Status is \&quot;active\&quot; or \&quot;disabled\&quot; — nothing else is accepted. A disabled endpoint keeps its subscription and receives no deliveries, except a manual test send, which goes out anyway.
/// </summary>
utility::string_t getStatus() const;
bool statusIsSet() const;
void unsetStatus();
void setStatus(const utility::string_t& value);
/// <summary>
/// UpdatedAt is when its url, events, status or description last changed.
/// </summary>
utility::string_t getUpdated() const;
bool updatedIsSet() const;
void unsetUpdated();
void setUpdated(const utility::string_t& value);
/// <summary>
/// URL is where the POST goes. Changing it is the one edit that redirects an org&#39;s events, which is why it is never bindable from a query string.
/// </summary>
utility::string_t getUrl() const;
bool urlIsSet() const;
void unsetUrl();
void setUrl(const utility::string_t& value);
protected:
utility::string_t m_Created;
bool m_CreatedIsSet;
int64_t m_Deliveries7d;
bool m_Deliveries7dIsSet;
utility::string_t m_Description;
bool m_DescriptionIsSet;
std::vector<utility::string_t> m_Events;
bool m_EventsIsSet;
int64_t m_Failures7d;
bool m_Failures7dIsSet;
utility::string_t m_Id;
bool m_IdIsSet;
utility::string_t m_Org;
bool m_OrgIsSet;
utility::string_t m_Secret;
bool m_SecretIsSet;
utility::string_t m_Status;
bool m_StatusIsSet;
utility::string_t m_Updated;
bool m_UpdatedIsSet;
utility::string_t m_Url;
bool m_UrlIsSet;
};
}
}
#endif /* HANZO_MODEL_Endpoint_H_ */