Files
zeekay 645325a641 regenerate from cloud 939b09d4
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.
2026-08-24 23:32:53 -07:00

140 lines
5.9 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.
*/
/*
* FlowApi.h
*
*
*/
#ifndef HANZO_API_FlowApi_H_
#define HANZO_API_FlowApi_H_
#include "hanzo/ApiClient.h"
#include "hanzo/AnyType.h"
#include "hanzo/model/FlowCreate.h"
#include "hanzo/model/FlowRun.h"
#include "hanzo/model/FlowStatus.h"
#include "hanzo/model/FlowUpdate.h"
#include <cpprest/details/basic_types.h>
#include <boost/optional.hpp>
namespace hanzo {
namespace api {
using namespace hanzo::model;
class FlowApi
{
public:
explicit FlowApi( std::shared_ptr<const ApiClient> apiClient );
virtual ~FlowApi();
/// <summary>
/// Deletes one of the caller&#39;s workflows and its runs.
/// </summary>
/// <remarks>
/// Deletes one of the caller&#39;s workflows and its runs. Ownership is verified first; a foreign id answers 404 and deletes nothing.
/// </remarks>
/// <param name="workflow">Workflow is the workflow&#39;s UUID, taken from the path.</param>
pplx::task<std::shared_ptr<AnyType>> deleteFlowWorkflowsByWorkflow(
utility::string_t workflow
) const;
/// <summary>
/// Runs reads one workflow&#39;s recorded runs: every component build with its result, keyed by component.
/// </summary>
/// <remarks>
/// Runs reads one workflow&#39;s recorded runs: every component build with its result, keyed by component. Ownership is verified first — run records never cross the org boundary.
/// </remarks>
/// <param name="workflow">Workflow is the UUID of the workflow whose run records to read. It rides the query string. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
pplx::task<std::shared_ptr<AnyType>> getFlowRuns(
boost::optional<utility::string_t> workflow
) const;
/// <summary>
/// Status reports whether the flow service is reachable and which version it runs.
/// </summary>
/// <remarks>
/// Status reports whether the flow service is reachable and which version it runs. It is the product&#39;s own /health and /v1/version composed — an honest lens for \&quot;is the workflow plane up\&quot;, never a fabricated ok.
/// </remarks>
pplx::task<std::shared_ptr<FlowStatus>> getFlowStatus(
) const;
/// <summary>
/// Workflows lists the caller&#39;s workflows, paged.
/// </summary>
/// <remarks>
/// Workflows lists the caller&#39;s workflows, paged. The list is scoped server-side to the org&#39;s project — the page can only ever hold the caller&#39;s own workflows.
/// </remarks>
/// <param name="page">Page is the 1-based page of workflows to return. (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
/// <param name="size">Size is how many workflows one page holds (the product caps it at 100). (optional, default to utility::conversions::to_string_t(&quot;&quot;))</param>
pplx::task<std::shared_ptr<AnyType>> getFlowWorkflows(
boost::optional<utility::string_t> page,
boost::optional<utility::string_t> size
) const;
/// <summary>
/// Workflow reads one of the caller&#39;s workflows — the full record, graph included.
/// </summary>
/// <remarks>
/// Workflow reads one of the caller&#39;s workflows — the full record, graph included. A workflow outside the caller&#39;s org answers 404, indistinguishable from one that does not exist.
/// </remarks>
/// <param name="workflow">Workflow is the workflow&#39;s UUID, taken from the path.</param>
pplx::task<std::shared_ptr<AnyType>> getFlowWorkflowsByWorkflow(
utility::string_t workflow
) const;
/// <summary>
/// Patches one of the caller&#39;s workflows: name, description, graph, or the locked flag — only the stated fields move.
/// </summary>
/// <remarks>
/// Patches one of the caller&#39;s workflows: name, description, graph, or the locked flag — only the stated fields move. Ownership is verified before the patch reaches the product.
/// </remarks>
/// <param name="workflow">Workflow is the workflow&#39;s UUID, taken from the path.</param>
/// <param name="flowUpdate"></param>
pplx::task<std::shared_ptr<AnyType>> patchFlowWorkflowsByWorkflow(
utility::string_t workflow,
std::shared_ptr<FlowUpdate> flowUpdate
) const;
/// <summary>
/// Run executes one of the caller&#39;s workflows synchronously: the graph runs in the flow service and the response carries the run&#39;s session and outputs.
/// </summary>
/// <remarks>
/// Run executes one of the caller&#39;s workflows synchronously: the graph runs in the flow service and the response carries the run&#39;s session and outputs. A graph whose components fail reports the product&#39;s own error. Runs are bounded by the product&#39;s five-minute sync ceiling.
/// </remarks>
/// <param name="flowRun"></param>
pplx::task<std::shared_ptr<AnyType>> postFlowRuns(
std::shared_ptr<FlowRun> flowRun
) const;
/// <summary>
/// Creates a workflow in the caller&#39;s org.
/// </summary>
/// <remarks>
/// Creates a workflow in the caller&#39;s org. The org&#39;s project id is pinned server-side from the validated principal — there is no field by which a caller could place a workflow in another org.
/// </remarks>
/// <param name="flowCreate"></param>
pplx::task<std::shared_ptr<AnyType>> postFlowWorkflows(
std::shared_ptr<FlowCreate> flowCreate
) const;
protected:
std::shared_ptr<const ApiClient> m_ApiClient;
};
}
}
#endif /* HANZO_API_FlowApi_H_ */