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.
154 lines
5.7 KiB
C++
154 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.
|
|
*/
|
|
|
|
/*
|
|
* ChannelView.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_ChannelView_H_
|
|
#define HANZO_MODEL_ChannelView_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include <cpprest/details/basic_types.h>
|
|
#include "hanzo/model/Capabilities.h"
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
class Capabilities;
|
|
|
|
|
|
class ChannelView
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
ChannelView();
|
|
virtual ~ChannelView();
|
|
|
|
/////////////////////////////////////////////
|
|
/// 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;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// ChannelView members
|
|
|
|
|
|
/// <summary>
|
|
/// Account is the id-shaped fact about that connection: the lowercased external id integrations custodies for it — a Discord guild id, a Slack team (workspace) id, a Teams AAD tenant id, or the Telegram chat the org bound. Empty when not connected. Informational: the access policy keys on (org, channel), so exactly one account is representable per pair.
|
|
/// </summary>
|
|
utility::string_t getAccount() const;
|
|
bool accountIsSet() const;
|
|
void unsetAccount();
|
|
void setAccount(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// AccountLabel is the human label of that same account — the Discord guild name, the Slack team name, the Teams tenant name (falling back to the tenant id), the Telegram chat title. DISPLAY ONLY: never a key, and never swapped with Account, on any surface.
|
|
/// </summary>
|
|
utility::string_t getAccountLabel() const;
|
|
bool accountLabelIsSet() const;
|
|
void unsetAccountLabel();
|
|
void setAccountLabel(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Capabilities is what this transport renders natively — read it before composing a message that needs threading, media or interactive actions.
|
|
/// </summary>
|
|
std::shared_ptr<Capabilities> getCapabilities() const;
|
|
bool capabilitiesIsSet() const;
|
|
void unsetCapabilities();
|
|
void setCapabilities(const std::shared_ptr<Capabilities>& value);
|
|
|
|
/// <summary>
|
|
/// Connected is whether integrations holds a connection for (this org, this transport) — whether someone finished its connect flow. False leaves Account and AccountLabel empty, and a send is then refused downstream rather than here: by the transport's own binding check (403 for a Telegram chat this org has not bound, 409 for a Discord or Teams room with no inbound-learned route), or on Slack by the absent per-org bot token, which surfaces as 502.
|
|
/// </summary>
|
|
bool isConnected() const;
|
|
bool connectedIsSet() const;
|
|
void unsetConnected();
|
|
void setConnected(bool value);
|
|
|
|
/// <summary>
|
|
/// DMPolicy is how this org admits direct messages here: \"pairing\", \"allowlist\" or \"open\", defaulting to \"pairing\" when the org has never set one.
|
|
/// </summary>
|
|
utility::string_t getDmPolicy() const;
|
|
bool dmPolicyIsSet() const;
|
|
void unsetDmPolicy();
|
|
void setDmPolicy(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// GroupPolicy is how this org admits group and thread rooms here: \"open\", \"allowlist\" or \"disabled\", defaulting to \"open\". Both policy fields come back EMPTY — rather than the listing failing — when the policy cannot be read; GET /v1/channel/allowlist carries the same two with the entries they consult.
|
|
/// </summary>
|
|
utility::string_t getGroupPolicy() const;
|
|
bool groupPolicyIsSet() const;
|
|
void unsetGroupPolicy();
|
|
void setGroupPolicy(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// ID is the fixed transport identifier — discord, slack, teams, telegram or whatsapp — and the value every route on this surface names a channel by, including the `:channel` segment of the send path. The listing is always in that order.
|
|
/// </summary>
|
|
utility::string_t getId() const;
|
|
bool idIsSet() const;
|
|
void unsetId();
|
|
void setId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// PendingPairing counts the org's UNEXPIRED pairing requests on this channel: exactly the rows GET /v1/channel/pairing returns for it, one per person waiting on an admin. It never exceeds three — the pending cap per (org, channel) — and expired requests are not counted.
|
|
/// </summary>
|
|
int64_t getPendingPairing() const;
|
|
bool pendingPairingIsSet() const;
|
|
void unsetPendingPairing();
|
|
void setPendingPairing(int64_t value);
|
|
|
|
|
|
protected:
|
|
utility::string_t m_Account;
|
|
bool m_AccountIsSet;
|
|
|
|
utility::string_t m_AccountLabel;
|
|
bool m_AccountLabelIsSet;
|
|
|
|
std::shared_ptr<Capabilities> m_Capabilities;
|
|
bool m_CapabilitiesIsSet;
|
|
|
|
bool m_Connected;
|
|
bool m_ConnectedIsSet;
|
|
|
|
utility::string_t m_DmPolicy;
|
|
bool m_DmPolicyIsSet;
|
|
|
|
utility::string_t m_GroupPolicy;
|
|
bool m_GroupPolicyIsSet;
|
|
|
|
utility::string_t m_Id;
|
|
bool m_IdIsSet;
|
|
|
|
int64_t m_PendingPairing;
|
|
bool m_PendingPairingIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_ChannelView_H_ */
|