Files
sdk/api_guide.go

1730 lines
62 KiB
Go

/*
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/.
API version: v1
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package hanzoai
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// GuideAPIService GuideAPI service
type GuideAPIService service
type GuideAPIDeleteGuideCurriculumRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIDeleteGuideCurriculumRequest) Execute() (*GuideCurriculumView, *http.Response, error) {
return r.ApiService.DeleteGuideCurriculumExecute(r)
}
/*
DeleteGuideCurriculum Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture.
Clears the caller org's curriculum override and returns the
journey it falls back to — the brand blueprint, else the embedded fixture.
Clearing an org that never set one is a no-op that answers the same default.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIDeleteGuideCurriculumRequest
*/
func (a *GuideAPIService) DeleteGuideCurriculum(ctx context.Context) GuideAPIDeleteGuideCurriculumRequest {
return GuideAPIDeleteGuideCurriculumRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideCurriculumView
func (a *GuideAPIService) DeleteGuideCurriculumExecute(r GuideAPIDeleteGuideCurriculumRequest) (*GuideCurriculumView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideCurriculumView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.DeleteGuideCurriculum")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/curriculum"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIGetGuideRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIGetGuideRequest) Execute() (*GuideOverviewView, *http.Response, error) {
return r.ApiService.GetGuideExecute(r)
}
/*
GetGuide Returns the caller org's launch journey: the active curriculum's version and title, every step with its state, whether it is available, what blocks it and whether the Business AI can run it, the done/total/percent progress with the next step to take, and the org's analytics funnel folded in.
Returns the caller org's launch journey: the active curriculum's
version and title, every step with its state, whether it is available, what
blocks it and whether the Business AI can run it, the done/total/percent
progress with the next step to take, and the org's analytics funnel folded in.
Auto-detect runs first, so a step the org has already completed elsewhere reads
done without anyone marking it.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIGetGuideRequest
*/
func (a *GuideAPIService) GetGuide(ctx context.Context) GuideAPIGetGuideRequest {
return GuideAPIGetGuideRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideOverviewView
func (a *GuideAPIService) GetGuideExecute(r GuideAPIGetGuideRequest) (*GuideOverviewView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideOverviewView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.GetGuide")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIGetGuideActionsRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIGetGuideActionsRequest) Execute() (*GuideActionsView, *http.Response, error) {
return r.ApiService.GetGuideActionsExecute(r)
}
/*
GetGuideActions Returns the caller org's Business AI action ledger, most recent first: every \"do it for me\" tool call, the arguments it ran with, its result and whether it succeeded.
Returns the caller org's Business AI action ledger, most recent
first: every "do it for me" tool call, the arguments it ran with, its result and
whether it succeeded. It is the audit-visible record of what the agent did on
the org's behalf, and the backing state for the "acted" auto-detect signal.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIGetGuideActionsRequest
*/
func (a *GuideAPIService) GetGuideActions(ctx context.Context) GuideAPIGetGuideActionsRequest {
return GuideAPIGetGuideActionsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideActionsView
func (a *GuideAPIService) GetGuideActionsExecute(r GuideAPIGetGuideActionsRequest) (*GuideActionsView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideActionsView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.GetGuideActions")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/actions"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIGetGuideAnalyticsRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIGetGuideAnalyticsRequest) Execute() (*GuideAnalyticsView, *http.Response, error) {
return r.ApiService.GetGuideAnalyticsExecute(r)
}
/*
GetGuideAnalytics Returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from it.
Returns the caller org's funnel from the analytics lens plus the GTM
recommendations derived from it. It is the Business AI's data-grounded read —
what the funnel is doing, and the next-best action to move its weakest stage. An
unreachable or silent warehouse answers available=false, never a fabricated
number.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIGetGuideAnalyticsRequest
*/
func (a *GuideAPIService) GetGuideAnalytics(ctx context.Context) GuideAPIGetGuideAnalyticsRequest {
return GuideAPIGetGuideAnalyticsRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideAnalyticsView
func (a *GuideAPIService) GetGuideAnalyticsExecute(r GuideAPIGetGuideAnalyticsRequest) (*GuideAnalyticsView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideAnalyticsView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.GetGuideAnalytics")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/analytics"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIGetGuideCurriculumRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIGetGuideCurriculumRequest) Execute() (*GuideCurriculumView, *http.Response, error) {
return r.ApiService.GetGuideCurriculumExecute(r)
}
/*
GetGuideCurriculum Returns the journey the caller's org is actually running, and whether it comes from the org's OWN override (custom) or from the platform default — the brand blueprint, else the embedded fixture.
Returns the journey the caller's org is actually running, and
whether it comes from the org's OWN override (custom) or from the platform
default — the brand blueprint, else the embedded fixture.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIGetGuideCurriculumRequest
*/
func (a *GuideAPIService) GetGuideCurriculum(ctx context.Context) GuideAPIGetGuideCurriculumRequest {
return GuideAPIGetGuideCurriculumRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideCurriculumView
func (a *GuideAPIService) GetGuideCurriculumExecute(r GuideAPIGetGuideCurriculumRequest) (*GuideCurriculumView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideCurriculumView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.GetGuideCurriculum")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/curriculum"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIGetGuideProfileRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIGetGuideProfileRequest) Execute() (*GuideProfileResponse, *http.Response, error) {
return r.ApiService.GetGuideProfileExecute(r)
}
/*
GetGuideProfile Returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and the org's own key metrics.
Returns the caller org's OBSERVED growth profile — the signal set, the
classified growth stage, and the org's own key metrics. It is a pure READ,
recomputed from the org's CURRENT state each request (real-time by pull): it
reuses the reconcile path (snapshotFor runs the detectors) for launch progress
and runs the growth probes (observe) for the signals — it never caches, never
runs a billable effect, never targets another org. Org-scoped on the validated
principal; fail-closed without one. It PRODUCES the profile and classifies the
stage; it decides NO recommendation (that is a later surface).
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIGetGuideProfileRequest
*/
func (a *GuideAPIService) GetGuideProfile(ctx context.Context) GuideAPIGetGuideProfileRequest {
return GuideAPIGetGuideProfileRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideProfileResponse
func (a *GuideAPIService) GetGuideProfileExecute(r GuideAPIGetGuideProfileRequest) (*GuideProfileResponse, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideProfileResponse
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.GetGuideProfile")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/profile"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIGetGuideStrategiesRequest struct {
ctx context.Context
ApiService *GuideAPIService
category *string
stage *string
workload *string
}
// Category filters to tactics in exactly this category.
func (r GuideAPIGetGuideStrategiesRequest) Category(category string) GuideAPIGetGuideStrategiesRequest {
r.category = &category
return r
}
// Stage previews the corpus at a chosen growth stage (research|formed|launched|activated|scaling), overriding the org's observed one. An unknown value is ignored and the observed stage stands.
func (r GuideAPIGetGuideStrategiesRequest) Stage(stage string) GuideAPIGetGuideStrategiesRequest {
r.stage = &stage
return r
}
// Workload filters to tactics with exactly this workload.
func (r GuideAPIGetGuideStrategiesRequest) Workload(workload string) GuideAPIGetGuideStrategiesRequest {
r.workload = &workload
return r
}
func (r GuideAPIGetGuideStrategiesRequest) Execute() (*GuideCorpusView, *http.Response, error) {
return r.ApiService.GetGuideStrategiesExecute(r)
}
/*
GetGuideStrategies Returns the ENABLED tactics corpus for the caller's org: the tactics library narrowed by the explicit category/workload filters AND by the org's OBSERVED growth stage and capability signals (a tactic's tags are preconditions, so it surfaces only once the org can act on it).
Returns the ENABLED tactics corpus for the caller's org: the tactics
library narrowed by the explicit category/workload filters AND by the org's
OBSERVED growth stage and capability signals (a tactic's tags are
preconditions, so it surfaces only once the org can act on it). Passing stage
PREVIEWS the corpus at that stage instead of the observed one. The content is
shared platform data — no org's records — and the read is never a billable
effect.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIGetGuideStrategiesRequest
*/
func (a *GuideAPIService) GetGuideStrategies(ctx context.Context) GuideAPIGetGuideStrategiesRequest {
return GuideAPIGetGuideStrategiesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideCorpusView
func (a *GuideAPIService) GetGuideStrategiesExecute(r GuideAPIGetGuideStrategiesRequest) (*GuideCorpusView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideCorpusView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.GetGuideStrategies")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/strategies"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.category != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "category", r.category, "form", "")
}
if r.stage != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "stage", r.stage, "form", "")
}
if r.workload != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "workload", r.workload, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIGetGuideSuggestRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIGetGuideSuggestRequest) Execute() (*GuideSuggestResponse, *http.Response, error) {
return r.ApiService.GetGuideSuggestExecute(r)
}
/*
GetGuideSuggest Returns the caller org's next-best quests: the available, non-terminal steps of its journey ranked by how much downstream work each unblocks, each with the grounded reason it is a good next move and whether the Business AI can run it, plus the org's funnel and the GTM recommendations derived from it.
Returns the caller org's next-best quests: the available, non-terminal
steps of its journey ranked by how much downstream work each unblocks, each with
the grounded reason it is a good next move and whether the Business AI can run
it, plus the org's funnel and the GTM recommendations derived from it. A
best-effort AI narrative over exactly those quests and numbers is included when
an AI plane is wired. READ-ONLY: it advises and never runs a step — the only
executing path is POST /v1/guide/steps/{id}/do.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIGetGuideSuggestRequest
*/
func (a *GuideAPIService) GetGuideSuggest(ctx context.Context) GuideAPIGetGuideSuggestRequest {
return GuideAPIGetGuideSuggestRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideSuggestResponse
func (a *GuideAPIService) GetGuideSuggestExecute(r GuideAPIGetGuideSuggestRequest) (*GuideSuggestResponse, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideSuggestResponse
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.GetGuideSuggest")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/suggest"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIPostGuideChatRequest struct {
ctx context.Context
ApiService *GuideAPIService
guideChatRequest *GuideChatRequest
}
func (r GuideAPIPostGuideChatRequest) GuideChatRequest(guideChatRequest GuideChatRequest) GuideAPIPostGuideChatRequest {
r.guideChatRequest = &guideChatRequest
return r
}
func (r GuideAPIPostGuideChatRequest) Execute() (*GuideChatResponse, *http.Response, error) {
return r.ApiService.PostGuideChatExecute(r)
}
/*
PostGuideChat Answers a founder's question about their launch journey as the Business AI coach: it grounds the reply in the org's REAL progress, its ranked available quests and its analytics funnel, and returns those candidate quests alongside so the caller can act on one.
Answers a founder's question about their launch journey as the Business AI
coach: it grounds the reply in the org's REAL progress, its ranked available
quests and its analytics funnel, and returns those candidate quests alongside so
the caller can act on one. READ-ONLY — it advises and never runs a step, so it
cannot be talked into performing an action; the only executing path is POST
/v1/guide/steps/{id}/do. One AI completion per call, billed to the caller's own
payer.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIPostGuideChatRequest
*/
func (a *GuideAPIService) PostGuideChat(ctx context.Context) GuideAPIPostGuideChatRequest {
return GuideAPIPostGuideChatRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return GuideChatResponse
func (a *GuideAPIService) PostGuideChatExecute(r GuideAPIPostGuideChatRequest) (*GuideChatResponse, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideChatResponse
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.PostGuideChat")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/chat"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.guideChatRequest == nil {
return localVarReturnValue, nil, reportError("guideChatRequest is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.guideChatRequest
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIPostGuideStepsByIdDoRequest struct {
ctx context.Context
ApiService *GuideAPIService
id string
}
func (r GuideAPIPostGuideStepsByIdDoRequest) Execute() (*http.Response, error) {
return r.ApiService.PostGuideStepsByIdDoExecute(r)
}
/*
PostGuideStepsByIdDo Have the Business AI actually do the step for you
Executes one step of the caller org's journey through that principal's OWN tool plane and answers the action log — `{step, events, state}` — so the caller sees every tool call the agent made and where the step ended up. This is the ONE executing path in guide: suggest and chat advise, this acts, and the work is charged to the calling principal's ledger.
Ask for it live and the same actions arrive as Server-Sent Events instead, on either of two triggers — `Accept: text/event-stream` or `?stream=1`. The stream opens with a comment, emits one frame per action as it happens, and closes with an `end` frame carrying `ok` and the final state. The streamed run is detached and bounded at 120 seconds, so it finishes on its own clock once the response has begun.
An agent that FAILS is not a failed request: the JSON answer still comes back 200 with `error` beside the events it did manage, and the stream still ends with `ok:false`. The refusals are the ones before the agent runs — 409 with `{error, step, blockedBy}` for a step whose dependencies are unfinished, 404 for an id the journey does not contain, 401 without a principal and 403 without an org.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id
@return GuideAPIPostGuideStepsByIdDoRequest
*/
func (a *GuideAPIService) PostGuideStepsByIdDo(ctx context.Context, id string) GuideAPIPostGuideStepsByIdDoRequest {
return GuideAPIPostGuideStepsByIdDoRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
func (a *GuideAPIService) PostGuideStepsByIdDoExecute(r GuideAPIPostGuideStepsByIdDoRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.PostGuideStepsByIdDo")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/steps/{id}/do"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}
type GuideAPIPostGuideStepsByIdDoneRequest struct {
ctx context.Context
ApiService *GuideAPIService
id string
}
func (r GuideAPIPostGuideStepsByIdDoneRequest) Execute() (*GuideOverviewView, *http.Response, error) {
return r.ApiService.PostGuideStepsByIdDoneExecute(r)
}
/*
PostGuideStepsByIdDone Marks one step of the caller org's journey complete and returns the refreshed journey.
Marks one step of the caller org's journey complete and returns the
refreshed journey.
Dependency-GATED, exactly as start is: a step whose prerequisites are unfinished
is refused 409 carrying {error, step, blockedBy} naming what is in the way.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
@return GuideAPIPostGuideStepsByIdDoneRequest
*/
func (a *GuideAPIService) PostGuideStepsByIdDone(ctx context.Context, id string) GuideAPIPostGuideStepsByIdDoneRequest {
return GuideAPIPostGuideStepsByIdDoneRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return GuideOverviewView
func (a *GuideAPIService) PostGuideStepsByIdDoneExecute(r GuideAPIPostGuideStepsByIdDoneRequest) (*GuideOverviewView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideOverviewView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.PostGuideStepsByIdDone")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/steps/{id}/done"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIPostGuideStepsByIdResetRequest struct {
ctx context.Context
ApiService *GuideAPIService
id string
}
func (r GuideAPIPostGuideStepsByIdResetRequest) Execute() (*GuideOverviewView, *http.Response, error) {
return r.ApiService.PostGuideStepsByIdResetExecute(r)
}
/*
PostGuideStepsByIdReset Returns one step of the caller org's journey to todo — clearing a manual mark or a skip — and returns the refreshed journey.
Returns one step of the caller org's journey to todo — clearing a
manual mark or a skip — and returns the refreshed journey. Reset is never
dependency-gated. Auto-detect runs on the next read, so a step the org has in
fact completed elsewhere goes straight back to done.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
@return GuideAPIPostGuideStepsByIdResetRequest
*/
func (a *GuideAPIService) PostGuideStepsByIdReset(ctx context.Context, id string) GuideAPIPostGuideStepsByIdResetRequest {
return GuideAPIPostGuideStepsByIdResetRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return GuideOverviewView
func (a *GuideAPIService) PostGuideStepsByIdResetExecute(r GuideAPIPostGuideStepsByIdResetRequest) (*GuideOverviewView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideOverviewView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.PostGuideStepsByIdReset")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/steps/{id}/reset"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIPostGuideStepsByIdSkipRequest struct {
ctx context.Context
ApiService *GuideAPIService
id string
}
func (r GuideAPIPostGuideStepsByIdSkipRequest) Execute() (*GuideOverviewView, *http.Response, error) {
return r.ApiService.PostGuideStepsByIdSkipExecute(r)
}
/*
PostGuideStepsByIdSkip Marks one step of the caller org's journey skipped and returns the refreshed journey.
Marks one step of the caller org's journey skipped and returns the
refreshed journey. Skipping is never dependency-gated — the founder is
declaring the step does not apply to them — so a step whose dependencies are
unfinished can still be skipped, and a skipped step counts as terminal for
everything downstream of it.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
@return GuideAPIPostGuideStepsByIdSkipRequest
*/
func (a *GuideAPIService) PostGuideStepsByIdSkip(ctx context.Context, id string) GuideAPIPostGuideStepsByIdSkipRequest {
return GuideAPIPostGuideStepsByIdSkipRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return GuideOverviewView
func (a *GuideAPIService) PostGuideStepsByIdSkipExecute(r GuideAPIPostGuideStepsByIdSkipRequest) (*GuideOverviewView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideOverviewView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.PostGuideStepsByIdSkip")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/steps/{id}/skip"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIPostGuideStepsByIdStartRequest struct {
ctx context.Context
ApiService *GuideAPIService
id string
}
func (r GuideAPIPostGuideStepsByIdStartRequest) Execute() (*GuideOverviewView, *http.Response, error) {
return r.ApiService.PostGuideStepsByIdStartExecute(r)
}
/*
PostGuideStepsByIdStart Marks one step of the caller org's journey in progress and returns the refreshed journey.
Marks one step of the caller org's journey in progress and returns the
refreshed journey.
Dependency-GATED: a step whose prerequisites are unfinished is refused 409
carrying {error, step, blockedBy}, where blockedBy names the exact steps in the
way — enough to render the reason without asking again.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id ID is the step's id, as it appears in the journey (e.g. \"gsuite\").
@return GuideAPIPostGuideStepsByIdStartRequest
*/
func (a *GuideAPIService) PostGuideStepsByIdStart(ctx context.Context, id string) GuideAPIPostGuideStepsByIdStartRequest {
return GuideAPIPostGuideStepsByIdStartRequest{
ApiService: a,
ctx: ctx,
id: id,
}
}
// Execute executes the request
//
// @return GuideOverviewView
func (a *GuideAPIService) PostGuideStepsByIdStartExecute(r GuideAPIPostGuideStepsByIdStartRequest) (*GuideOverviewView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *GuideOverviewView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.PostGuideStepsByIdStart")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/steps/{id}/start"
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type GuideAPIPutGuideCurriculumRequest struct {
ctx context.Context
ApiService *GuideAPIService
}
func (r GuideAPIPutGuideCurriculumRequest) Execute() (*http.Response, error) {
return r.ApiService.PutGuideCurriculumExecute(r)
}
/*
PutGuideCurriculum Replace your org's journey with a curriculum you author
Sets the caller org's OWN curriculum — the per-customer override — and answers the journey now in force with `custom: true`. The body is a curriculum document, and it is accepted as YAML **or** JSON: that is the caller-visible reason this takes a raw body rather than a declared shape. Whatever the syntax, the CANONICAL parsed form is what is stored, so the document the engine runs never depends on how it was written.
Fail-closed: a body that does not parse, or parses but is not a valid journey (unique step ids, no dangling or cyclic dependencies), is 422 and NEVER becomes active — the org keeps the journey it had. Requires a validated org: 401 without a principal, 403 without an org. An empty body is 400 and one over 256 KiB is 413.
This is tier one only. It overrides nothing but this org's own journey; the shared brand blueprint is a different surface with a different gate. DELETE the same path to drop the override and fall back to it.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GuideAPIPutGuideCurriculumRequest
*/
func (a *GuideAPIService) PutGuideCurriculum(ctx context.Context) GuideAPIPutGuideCurriculumRequest {
return GuideAPIPutGuideCurriculumRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
func (a *GuideAPIService) PutGuideCurriculumExecute(r GuideAPIPutGuideCurriculumRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GuideAPIService.PutGuideCurriculum")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/guide/curriculum"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}