Files
sdk/model_guide_journey_step.go

535 lines
15 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 (
"encoding/json"
)
// checks if the GuideJourneyStep type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &GuideJourneyStep{}
// GuideJourneyStep struct for GuideJourneyStep
type GuideJourneyStep struct {
// Args are the tool's default arguments, merged under whatever the caller passes at run time, so a step ships with the arguments that make it work.
Args map[string]interface{} `json:"args,omitempty"`
// Dependencies are step ids that must be done/skipped before this step is available. The wire key is `deps` (the blueprint contract); the Go field keeps its descriptive name.
Deps []string `json:"deps,omitempty"`
// Detail is the juncture — what the Guide explains, or asks for, at this step.
Detail *string `json:"detail,omitempty"`
// Draft, when set, is the prompt the embedded AI answers first; its output is folded into one of Args before the tool runs, so the model writes the content and the tool only delivers it.
Draft *string `json:"draft,omitempty"`
// DraftInto names the argument the drafted text lands in. Empty means \"brief\".
DraftInto *string `json:"draftInto,omitempty"`
// Enabled is the admin on/off lever. A NIL pointer reads as ENABLED (absence == on): a legacy/org curriculum that omits the field keeps every step, and only an explicit `enabled: false` (an admin disable) drops a step from the journey. See on() in blueprint.go and the Blueprint.Curriculum() projection.
Enabled *bool `json:"enabled,omitempty"`
// ID is the stable slug the whole plane addresses this step by — the value in `deps`, in `next`, in the progress rows, and in the URL of every step route. Renaming it orphans an org's recorded progress for this step.
Id *string `json:"id,omitempty"`
// Section is the id of the phase this step groups under. A disabled section takes its steps out of the journey with it.
Section *string `json:"section,omitempty"`
// Signal, when set, names a machine detector (detect.go). When the detector reports the org's real state present, the step auto-marks done.
Signal *string `json:"signal,omitempty"`
// Title is the one-line quest as a person reads it in the checklist.
Title *string `json:"title,omitempty"`
// Tool, when set, names the MCP tool the Business AI runs for \"do it for me\". A step with no tool can only be completed by a person; it is the field the `automatable` flag on every projection of this step is derived from.
Tool *string `json:"tool,omitempty"`
AdditionalProperties map[string]interface{}
}
type _GuideJourneyStep GuideJourneyStep
// NewGuideJourneyStep instantiates a new GuideJourneyStep object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewGuideJourneyStep() *GuideJourneyStep {
this := GuideJourneyStep{}
return &this
}
// NewGuideJourneyStepWithDefaults instantiates a new GuideJourneyStep object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewGuideJourneyStepWithDefaults() *GuideJourneyStep {
this := GuideJourneyStep{}
return &this
}
// GetArgs returns the Args field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetArgs() map[string]interface{} {
if o == nil || IsNil(o.Args) {
var ret map[string]interface{}
return ret
}
return o.Args
}
// GetArgsOk returns a tuple with the Args field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetArgsOk() (map[string]interface{}, bool) {
if o == nil || IsNil(o.Args) {
return map[string]interface{}{}, false
}
return o.Args, true
}
// HasArgs returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasArgs() bool {
if o != nil && !IsNil(o.Args) {
return true
}
return false
}
// SetArgs gets a reference to the given map[string]interface{} and assigns it to the Args field.
func (o *GuideJourneyStep) SetArgs(v map[string]interface{}) {
o.Args = v
}
// GetDeps returns the Deps field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetDeps() []string {
if o == nil || IsNil(o.Deps) {
var ret []string
return ret
}
return o.Deps
}
// GetDepsOk returns a tuple with the Deps field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetDepsOk() ([]string, bool) {
if o == nil || IsNil(o.Deps) {
return nil, false
}
return o.Deps, true
}
// HasDeps returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasDeps() bool {
if o != nil && !IsNil(o.Deps) {
return true
}
return false
}
// SetDeps gets a reference to the given []string and assigns it to the Deps field.
func (o *GuideJourneyStep) SetDeps(v []string) {
o.Deps = v
}
// GetDetail returns the Detail field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetDetail() string {
if o == nil || IsNil(o.Detail) {
var ret string
return ret
}
return *o.Detail
}
// GetDetailOk returns a tuple with the Detail field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetDetailOk() (*string, bool) {
if o == nil || IsNil(o.Detail) {
return nil, false
}
return o.Detail, true
}
// HasDetail returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasDetail() bool {
if o != nil && !IsNil(o.Detail) {
return true
}
return false
}
// SetDetail gets a reference to the given string and assigns it to the Detail field.
func (o *GuideJourneyStep) SetDetail(v string) {
o.Detail = &v
}
// GetDraft returns the Draft field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetDraft() string {
if o == nil || IsNil(o.Draft) {
var ret string
return ret
}
return *o.Draft
}
// GetDraftOk returns a tuple with the Draft field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetDraftOk() (*string, bool) {
if o == nil || IsNil(o.Draft) {
return nil, false
}
return o.Draft, true
}
// HasDraft returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasDraft() bool {
if o != nil && !IsNil(o.Draft) {
return true
}
return false
}
// SetDraft gets a reference to the given string and assigns it to the Draft field.
func (o *GuideJourneyStep) SetDraft(v string) {
o.Draft = &v
}
// GetDraftInto returns the DraftInto field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetDraftInto() string {
if o == nil || IsNil(o.DraftInto) {
var ret string
return ret
}
return *o.DraftInto
}
// GetDraftIntoOk returns a tuple with the DraftInto field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetDraftIntoOk() (*string, bool) {
if o == nil || IsNil(o.DraftInto) {
return nil, false
}
return o.DraftInto, true
}
// HasDraftInto returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasDraftInto() bool {
if o != nil && !IsNil(o.DraftInto) {
return true
}
return false
}
// SetDraftInto gets a reference to the given string and assigns it to the DraftInto field.
func (o *GuideJourneyStep) SetDraftInto(v string) {
o.DraftInto = &v
}
// GetEnabled returns the Enabled field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetEnabled() bool {
if o == nil || IsNil(o.Enabled) {
var ret bool
return ret
}
return *o.Enabled
}
// GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetEnabledOk() (*bool, bool) {
if o == nil || IsNil(o.Enabled) {
return nil, false
}
return o.Enabled, true
}
// HasEnabled returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasEnabled() bool {
if o != nil && !IsNil(o.Enabled) {
return true
}
return false
}
// SetEnabled gets a reference to the given bool and assigns it to the Enabled field.
func (o *GuideJourneyStep) SetEnabled(v bool) {
o.Enabled = &v
}
// GetId returns the Id field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetId() string {
if o == nil || IsNil(o.Id) {
var ret string
return ret
}
return *o.Id
}
// GetIdOk returns a tuple with the Id field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetIdOk() (*string, bool) {
if o == nil || IsNil(o.Id) {
return nil, false
}
return o.Id, true
}
// HasId returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasId() bool {
if o != nil && !IsNil(o.Id) {
return true
}
return false
}
// SetId gets a reference to the given string and assigns it to the Id field.
func (o *GuideJourneyStep) SetId(v string) {
o.Id = &v
}
// GetSection returns the Section field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetSection() string {
if o == nil || IsNil(o.Section) {
var ret string
return ret
}
return *o.Section
}
// GetSectionOk returns a tuple with the Section field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetSectionOk() (*string, bool) {
if o == nil || IsNil(o.Section) {
return nil, false
}
return o.Section, true
}
// HasSection returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasSection() bool {
if o != nil && !IsNil(o.Section) {
return true
}
return false
}
// SetSection gets a reference to the given string and assigns it to the Section field.
func (o *GuideJourneyStep) SetSection(v string) {
o.Section = &v
}
// GetSignal returns the Signal field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetSignal() string {
if o == nil || IsNil(o.Signal) {
var ret string
return ret
}
return *o.Signal
}
// GetSignalOk returns a tuple with the Signal field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetSignalOk() (*string, bool) {
if o == nil || IsNil(o.Signal) {
return nil, false
}
return o.Signal, true
}
// HasSignal returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasSignal() bool {
if o != nil && !IsNil(o.Signal) {
return true
}
return false
}
// SetSignal gets a reference to the given string and assigns it to the Signal field.
func (o *GuideJourneyStep) SetSignal(v string) {
o.Signal = &v
}
// GetTitle returns the Title field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetTitle() string {
if o == nil || IsNil(o.Title) {
var ret string
return ret
}
return *o.Title
}
// GetTitleOk returns a tuple with the Title field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetTitleOk() (*string, bool) {
if o == nil || IsNil(o.Title) {
return nil, false
}
return o.Title, true
}
// HasTitle returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasTitle() bool {
if o != nil && !IsNil(o.Title) {
return true
}
return false
}
// SetTitle gets a reference to the given string and assigns it to the Title field.
func (o *GuideJourneyStep) SetTitle(v string) {
o.Title = &v
}
// GetTool returns the Tool field value if set, zero value otherwise.
func (o *GuideJourneyStep) GetTool() string {
if o == nil || IsNil(o.Tool) {
var ret string
return ret
}
return *o.Tool
}
// GetToolOk returns a tuple with the Tool field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *GuideJourneyStep) GetToolOk() (*string, bool) {
if o == nil || IsNil(o.Tool) {
return nil, false
}
return o.Tool, true
}
// HasTool returns a boolean if a field has been set.
func (o *GuideJourneyStep) HasTool() bool {
if o != nil && !IsNil(o.Tool) {
return true
}
return false
}
// SetTool gets a reference to the given string and assigns it to the Tool field.
func (o *GuideJourneyStep) SetTool(v string) {
o.Tool = &v
}
func (o GuideJourneyStep) MarshalJSON() ([]byte, error) {
toSerialize, err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o GuideJourneyStep) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.Args) {
toSerialize["args"] = o.Args
}
if !IsNil(o.Deps) {
toSerialize["deps"] = o.Deps
}
if !IsNil(o.Detail) {
toSerialize["detail"] = o.Detail
}
if !IsNil(o.Draft) {
toSerialize["draft"] = o.Draft
}
if !IsNil(o.DraftInto) {
toSerialize["draftInto"] = o.DraftInto
}
if !IsNil(o.Enabled) {
toSerialize["enabled"] = o.Enabled
}
if !IsNil(o.Id) {
toSerialize["id"] = o.Id
}
if !IsNil(o.Section) {
toSerialize["section"] = o.Section
}
if !IsNil(o.Signal) {
toSerialize["signal"] = o.Signal
}
if !IsNil(o.Title) {
toSerialize["title"] = o.Title
}
if !IsNil(o.Tool) {
toSerialize["tool"] = o.Tool
}
for key, value := range o.AdditionalProperties {
toSerialize[key] = value
}
return toSerialize, nil
}
func (o *GuideJourneyStep) UnmarshalJSON(data []byte) (err error) {
varGuideJourneyStep := _GuideJourneyStep{}
err = json.Unmarshal(data, &varGuideJourneyStep)
if err != nil {
return err
}
*o = GuideJourneyStep(varGuideJourneyStep)
additionalProperties := make(map[string]interface{})
if err = json.Unmarshal(data, &additionalProperties); err == nil {
delete(additionalProperties, "args")
delete(additionalProperties, "deps")
delete(additionalProperties, "detail")
delete(additionalProperties, "draft")
delete(additionalProperties, "draftInto")
delete(additionalProperties, "enabled")
delete(additionalProperties, "id")
delete(additionalProperties, "section")
delete(additionalProperties, "signal")
delete(additionalProperties, "title")
delete(additionalProperties, "tool")
o.AdditionalProperties = additionalProperties
}
return err
}
type NullableGuideJourneyStep struct {
value *GuideJourneyStep
isSet bool
}
func (v NullableGuideJourneyStep) Get() *GuideJourneyStep {
return v.value
}
func (v *NullableGuideJourneyStep) Set(val *GuideJourneyStep) {
v.value = val
v.isSet = true
}
func (v NullableGuideJourneyStep) IsSet() bool {
return v.isSet
}
func (v *NullableGuideJourneyStep) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableGuideJourneyStep(val *GuideJourneyStep) *NullableGuideJourneyStep {
return &NullableGuideJourneyStep{value: val, isSet: true}
}
func (v NullableGuideJourneyStep) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableGuideJourneyStep) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}