GuideApi class

Constructors

GuideApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

deleteGuideCurriculum() → Future<CurriculumView?>
Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture.
deleteGuideCurriculumWithHttpInfo() → Future<Response>
Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture.
getGuide() → Future<OverviewView?>
Overview 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.
getGuideActions() → Future<ActionsView?>
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.
getGuideActionsWithHttpInfo() → Future<Response>
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.
getGuideAnalytics() → Future<AnalyticsView?>
Analytics returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from it.
getGuideAnalyticsWithHttpInfo() → Future<Response>
Analytics returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from it.
getGuideBlueprint() → Future<BlueprintView?>
Returns the FULL authored brand blueprint — every principle, section, step, strategy and template WITH its enabled flag made explicit, including the disabled items the org-facing reads never see — plus the active version number, the brand key it is stored under and the item counts.
getGuideBlueprintVersions() → Future<BlueprintVersionsView?>
Returns the brand blueprint's version history — every stored version's number and edit time, newest first — which is the point-in-time-recovery and audit trail behind the authoring plane.
getGuideBlueprintVersionsWithHttpInfo() → Future<Response>
Returns the brand blueprint's version history — every stored version's number and edit time, newest first — which is the point-in-time-recovery and audit trail behind the authoring plane.
getGuideBlueprintWithHttpInfo() → Future<Response>
Returns the FULL authored brand blueprint — every principle, section, step, strategy and template WITH its enabled flag made explicit, including the disabled items the org-facing reads never see — plus the active version number, the brand key it is stored under and the item counts.
getGuideCurriculum() → Future<CurriculumView?>
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.
getGuideCurriculumWithHttpInfo() → Future<Response>
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.
getGuideProfile() → Future<ProfileResponse?>
Profile returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and the org's own key metrics.
getGuideProfileWithHttpInfo() → Future<Response>
Profile returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and the org's own key metrics.
getGuideStrategies({String? category, String? stage, String? workload}) → Future<CorpusView?>
Strategies 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).
getGuideStrategiesWithHttpInfo({String? category, String? stage, String? workload}) → Future<Response>
Strategies 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).
getGuideSuggest() → Future<SuggestResponse?>
Suggest 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.
getGuideSuggestWithHttpInfo() → Future<Response>
Suggest 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.
getGuideWithHttpInfo() → Future<Response>
Overview 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.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patchGuideBlueprintByCollectionById(String collection, String id) → Future<void>
Edit — or retire — one item of the brand blueprint
patchGuideBlueprintByCollectionByIdWithHttpInfo(String collection, String id) → Future<Response>
Edit — or retire — one item of the brand blueprint
postGuideChat(ChatRequest chatRequest) → Future<ChatResponse?>
Chat 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.
postGuideChatWithHttpInfo(ChatRequest chatRequest) → Future<Response>
Chat 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.
postGuideStepsByIdDo(String id) → Future<void>
Have the Business AI actually do the step for you
postGuideStepsByIdDone(String id) → Future<OverviewView?>
Marks one step of the caller org's journey complete and returns the refreshed journey.
postGuideStepsByIdDoneWithHttpInfo(String id) → Future<Response>
Marks one step of the caller org's journey complete and returns the refreshed journey.
postGuideStepsByIdDoWithHttpInfo(String id) → Future<Response>
Have the Business AI actually do the step for you
postGuideStepsByIdReset(String id) → Future<OverviewView?>
Returns one step of the caller org's journey to todo — clearing a manual mark or a skip — and returns the refreshed journey.
postGuideStepsByIdResetWithHttpInfo(String id) → Future<Response>
Returns one step of the caller org's journey to todo — clearing a manual mark or a skip — and returns the refreshed journey.
postGuideStepsByIdSkip(String id) → Future<OverviewView?>
Marks one step of the caller org's journey skipped and returns the refreshed journey.
postGuideStepsByIdSkipWithHttpInfo(String id) → Future<Response>
Marks one step of the caller org's journey skipped and returns the refreshed journey.
postGuideStepsByIdStart(String id) → Future<OverviewView?>
Marks one step of the caller org's journey in progress and returns the refreshed journey.
postGuideStepsByIdStartWithHttpInfo(String id) → Future<Response>
Marks one step of the caller org's journey in progress and returns the refreshed journey.
putGuideBlueprint() → Future<void>
Publish a new version of the brand blueprint
putGuideBlueprintWithHttpInfo() → Future<Response>
Publish a new version of the brand blueprint
putGuideCurriculum() → Future<void>
Replace your org's journey with a curriculum you author
putGuideCurriculumWithHttpInfo() → Future<Response>
Replace your org's journey with a curriculum you author
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited