mirror of
https://github.com/hanzo-cpp/sdk.git
synced 2026-11-20 19:55:32 +00:00
The projection was 113 commits behind the document it claims to describe, and `generate.py --all --check` reported every one of the thirteen clients DRIFTED — the same +19 models in each, because they all fell behind the same emission. Regenerated in place from hanzo-inc/cloud openapi.yaml at 939b09d4 (sha256 087024f6…), which is the only description of this API that cannot name a route the binary does not serve. `--check` is clean across all thirteen after. .spec-lock moved with the code. The generator READS that file and never writes it — hanzoai/ci`s lane does — so a hand run leaves every lock naming the previous document. A lock that disagrees with the tree beside it is worse than no lock: the next `--check` without `--spec` fetches what production serves, compares it to a digest that was already wrong, and reports drift that is really staleness.
109 lines
5.3 KiB
C++
109 lines
5.3 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.
|
|
*/
|
|
|
|
/*
|
|
* DestinationApi.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_API_DestinationApi_H_
|
|
#define HANZO_API_DestinationApi_H_
|
|
|
|
|
|
|
|
#include "hanzo/ApiClient.h"
|
|
|
|
#include "hanzo/AnyType.h"
|
|
#include "hanzo/model/DestinationDisconnected.h"
|
|
#include "hanzo/model/DestinationList.h"
|
|
#include "hanzo/model/DestinationStatus.h"
|
|
#include "hanzo/model/DestinationTest.h"
|
|
#include <map>
|
|
#include <cpprest/details/basic_types.h>
|
|
#include <boost/optional.hpp>
|
|
|
|
namespace hanzo {
|
|
namespace api {
|
|
|
|
using namespace hanzo::model;
|
|
|
|
|
|
|
|
class DestinationApi
|
|
{
|
|
public:
|
|
|
|
explicit DestinationApi( std::shared_ptr<const ApiClient> apiClient );
|
|
|
|
virtual ~DestinationApi();
|
|
|
|
/// <summary>
|
|
/// Forgets a destination for the caller's org: every credential held in KMS, then the stored config.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Forgets a destination for the caller's org: every credential held in KMS, then the stored config. Idempotent, and it requires org admin.
|
|
/// </remarks>
|
|
/// <param name="platform">Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights | analytics.</param>
|
|
pplx::task<std::shared_ptr<DestinationDisconnected>> deleteDestinationByPlatform(
|
|
utility::string_t platform
|
|
) const;
|
|
/// <summary>
|
|
/// Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<DestinationList>> getDestination(
|
|
) const;
|
|
/// <summary>
|
|
/// Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now. A platform this deployment does not carry is not found.
|
|
/// </remarks>
|
|
/// <param name="platform">Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights | analytics.</param>
|
|
pplx::task<std::shared_ptr<DestinationStatus>> getDestinationByPlatform(
|
|
utility::string_t platform
|
|
) const;
|
|
/// <summary>
|
|
/// Connect one conversion destination for your org, or update the one you have
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Stores the addressed platform's non-secret ids (its measurement, pixel or dataset ids) and seals its API credential into KMS under a path scoped to the caller's own org, then answers the same status card the read routes do — with live telling you whether the credential actually resolves right now. The body's property NAMES are the platform's own: each field the platform declares, plus each secret under its camelCase name, so the accepted keys differ per platform and a missing REQUIRED field is refused. Connecting is an ORG ADMIN action — a validated member without the admin bit gets 403 — and it fails closed with 503 when the KMS master key is unavailable rather than persisting a destination whose secret was never sealed. The secret itself never appears in the response, in the store, or in a log line; only its NAME is ever published. Set enabled to false to keep the connection but stop the analytics fan-out to it.
|
|
/// </remarks>
|
|
/// <param name="platform"></param>
|
|
/// <param name="requestBody"> (optional)</param>
|
|
pplx::task<std::shared_ptr<DestinationStatus>> postDestinationByPlatform(
|
|
utility::string_t platform,
|
|
boost::optional<std::map<utility::string_t, std::shared_ptr<AnyType>>> requestBody
|
|
) const;
|
|
/// <summary>
|
|
/// Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said. A send the platform refuses is reported as data — {\"ok\": false, \"error\": …} at 200 — so the console shows the platform's own words rather than an error about Hanzo. It requires org admin.
|
|
/// </remarks>
|
|
/// <param name="platform">Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights | analytics.</param>
|
|
pplx::task<std::shared_ptr<DestinationTest>> postDestinationByPlatformTest(
|
|
utility::string_t platform
|
|
) const;
|
|
|
|
protected:
|
|
std::shared_ptr<const ApiClient> m_ApiClient;
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_API_DestinationApi_H_ */
|
|
|