authentik/packages/client-go/model_flow.go

/*
authentik

Making authentication simple.

API version: 2026.5.0-rc1
Contact: hello@goauthentik.io
*/

// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.

package api

import (
	"encoding/json"
	"fmt"
)

// checks if the Flow type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &Flow{}

// Flow Flow Serializer
type Flow struct {
	Pk                      string `json:"pk"`
	PolicybindingmodelPtrId string `json:"policybindingmodel_ptr_id"`
	Name                    string `json:"name"`
	// Visible in the URL.
	Slug string `json:"slug" validate:"regexp=^[-a-zA-Z0-9_]+$"`
	// Shown as the Title in Flow pages.
	Title string `json:"title"`
	// Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
	Designation FlowDesignationEnum `json:"designation"`
	// Background shown during execution
	Background *string `json:"background,omitempty"`
	// Get the URL to the background image
	BackgroundUrl        string             `json:"background_url"`
	BackgroundThemedUrls NullableThemedUrls `json:"background_themed_urls"`
	Stages               []string           `json:"stages"`
	Policies             []string           `json:"policies"`
	// Get count of cached flows
	CacheCount       int32             `json:"cache_count"`
	PolicyEngineMode *PolicyEngineMode `json:"policy_engine_mode,omitempty"`
	// Enable compatibility mode, increases compatibility with password managers on mobile devices.
	CompatibilityMode *bool `json:"compatibility_mode,omitempty"`
	// Get export URL for flow
	ExportUrl string          `json:"export_url"`
	Layout    *FlowLayoutEnum `json:"layout,omitempty"`
	// Configure what should happen when a flow denies access to a user.
	DeniedAction *DeniedActionEnum `json:"denied_action,omitempty"`
	// Required level of authentication and authorization to access a flow.
	Authentication       *AuthenticationEnum `json:"authentication,omitempty"`
	AdditionalProperties map[string]interface{}
}

type _Flow Flow

// NewFlow instantiates a new Flow 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 NewFlow(pk string, policybindingmodelPtrId string, name string, slug string, title string, designation FlowDesignationEnum, backgroundUrl string, backgroundThemedUrls NullableThemedUrls, stages []string, policies []string, cacheCount int32, exportUrl string) *Flow {
	this := Flow{}
	this.Pk = pk
	this.PolicybindingmodelPtrId = policybindingmodelPtrId
	this.Name = name
	this.Slug = slug
	this.Title = title
	this.Designation = designation
	this.BackgroundUrl = backgroundUrl
	this.BackgroundThemedUrls = backgroundThemedUrls
	this.Stages = stages
	this.Policies = policies
	this.CacheCount = cacheCount
	this.ExportUrl = exportUrl
	return &this
}

// NewFlowWithDefaults instantiates a new Flow 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 NewFlowWithDefaults() *Flow {
	this := Flow{}
	return &this
}

// GetPk returns the Pk field value
func (o *Flow) GetPk() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Pk
}

// GetPkOk returns a tuple with the Pk field value
// and a boolean to check if the value has been set.
func (o *Flow) GetPkOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Pk, true
}

// SetPk sets field value
func (o *Flow) SetPk(v string) {
	o.Pk = v
}

// GetPolicybindingmodelPtrId returns the PolicybindingmodelPtrId field value
func (o *Flow) GetPolicybindingmodelPtrId() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.PolicybindingmodelPtrId
}

// GetPolicybindingmodelPtrIdOk returns a tuple with the PolicybindingmodelPtrId field value
// and a boolean to check if the value has been set.
func (o *Flow) GetPolicybindingmodelPtrIdOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.PolicybindingmodelPtrId, true
}

// SetPolicybindingmodelPtrId sets field value
func (o *Flow) SetPolicybindingmodelPtrId(v string) {
	o.PolicybindingmodelPtrId = v
}

// GetName returns the Name field value
func (o *Flow) GetName() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Name
}

// GetNameOk returns a tuple with the Name field value
// and a boolean to check if the value has been set.
func (o *Flow) GetNameOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Name, true
}

// SetName sets field value
func (o *Flow) SetName(v string) {
	o.Name = v
}

// GetSlug returns the Slug field value
func (o *Flow) GetSlug() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Slug
}

// GetSlugOk returns a tuple with the Slug field value
// and a boolean to check if the value has been set.
func (o *Flow) GetSlugOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Slug, true
}

// SetSlug sets field value
func (o *Flow) SetSlug(v string) {
	o.Slug = v
}

// GetTitle returns the Title field value
func (o *Flow) GetTitle() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Title
}

// GetTitleOk returns a tuple with the Title field value
// and a boolean to check if the value has been set.
func (o *Flow) GetTitleOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Title, true
}

// SetTitle sets field value
func (o *Flow) SetTitle(v string) {
	o.Title = v
}

// GetDesignation returns the Designation field value
func (o *Flow) GetDesignation() FlowDesignationEnum {
	if o == nil {
		var ret FlowDesignationEnum
		return ret
	}

	return o.Designation
}

// GetDesignationOk returns a tuple with the Designation field value
// and a boolean to check if the value has been set.
func (o *Flow) GetDesignationOk() (*FlowDesignationEnum, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Designation, true
}

// SetDesignation sets field value
func (o *Flow) SetDesignation(v FlowDesignationEnum) {
	o.Designation = v
}

// GetBackground returns the Background field value if set, zero value otherwise.
func (o *Flow) GetBackground() string {
	if o == nil || IsNil(o.Background) {
		var ret string
		return ret
	}
	return *o.Background
}

// GetBackgroundOk returns a tuple with the Background field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Flow) GetBackgroundOk() (*string, bool) {
	if o == nil || IsNil(o.Background) {
		return nil, false
	}
	return o.Background, true
}

// HasBackground returns a boolean if a field has been set.
func (o *Flow) HasBackground() bool {
	if o != nil && !IsNil(o.Background) {
		return true
	}

	return false
}

// SetBackground gets a reference to the given string and assigns it to the Background field.
func (o *Flow) SetBackground(v string) {
	o.Background = &v
}

// GetBackgroundUrl returns the BackgroundUrl field value
func (o *Flow) GetBackgroundUrl() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.BackgroundUrl
}

// GetBackgroundUrlOk returns a tuple with the BackgroundUrl field value
// and a boolean to check if the value has been set.
func (o *Flow) GetBackgroundUrlOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.BackgroundUrl, true
}

// SetBackgroundUrl sets field value
func (o *Flow) SetBackgroundUrl(v string) {
	o.BackgroundUrl = v
}

// GetBackgroundThemedUrls returns the BackgroundThemedUrls field value
// If the value is explicit nil, the zero value for ThemedUrls will be returned
func (o *Flow) GetBackgroundThemedUrls() ThemedUrls {
	if o == nil || o.BackgroundThemedUrls.Get() == nil {
		var ret ThemedUrls
		return ret
	}

	return *o.BackgroundThemedUrls.Get()
}

// GetBackgroundThemedUrlsOk returns a tuple with the BackgroundThemedUrls field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *Flow) GetBackgroundThemedUrlsOk() (*ThemedUrls, bool) {
	if o == nil {
		return nil, false
	}
	return o.BackgroundThemedUrls.Get(), o.BackgroundThemedUrls.IsSet()
}

// SetBackgroundThemedUrls sets field value
func (o *Flow) SetBackgroundThemedUrls(v ThemedUrls) {
	o.BackgroundThemedUrls.Set(&v)
}

// GetStages returns the Stages field value
func (o *Flow) GetStages() []string {
	if o == nil {
		var ret []string
		return ret
	}

	return o.Stages
}

// GetStagesOk returns a tuple with the Stages field value
// and a boolean to check if the value has been set.
func (o *Flow) GetStagesOk() ([]string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Stages, true
}

// SetStages sets field value
func (o *Flow) SetStages(v []string) {
	o.Stages = v
}

// GetPolicies returns the Policies field value
func (o *Flow) GetPolicies() []string {
	if o == nil {
		var ret []string
		return ret
	}

	return o.Policies
}

// GetPoliciesOk returns a tuple with the Policies field value
// and a boolean to check if the value has been set.
func (o *Flow) GetPoliciesOk() ([]string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Policies, true
}

// SetPolicies sets field value
func (o *Flow) SetPolicies(v []string) {
	o.Policies = v
}

// GetCacheCount returns the CacheCount field value
func (o *Flow) GetCacheCount() int32 {
	if o == nil {
		var ret int32
		return ret
	}

	return o.CacheCount
}

// GetCacheCountOk returns a tuple with the CacheCount field value
// and a boolean to check if the value has been set.
func (o *Flow) GetCacheCountOk() (*int32, bool) {
	if o == nil {
		return nil, false
	}
	return &o.CacheCount, true
}

// SetCacheCount sets field value
func (o *Flow) SetCacheCount(v int32) {
	o.CacheCount = v
}

// GetPolicyEngineMode returns the PolicyEngineMode field value if set, zero value otherwise.
func (o *Flow) GetPolicyEngineMode() PolicyEngineMode {
	if o == nil || IsNil(o.PolicyEngineMode) {
		var ret PolicyEngineMode
		return ret
	}
	return *o.PolicyEngineMode
}

// GetPolicyEngineModeOk returns a tuple with the PolicyEngineMode field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Flow) GetPolicyEngineModeOk() (*PolicyEngineMode, bool) {
	if o == nil || IsNil(o.PolicyEngineMode) {
		return nil, false
	}
	return o.PolicyEngineMode, true
}

// HasPolicyEngineMode returns a boolean if a field has been set.
func (o *Flow) HasPolicyEngineMode() bool {
	if o != nil && !IsNil(o.PolicyEngineMode) {
		return true
	}

	return false
}

// SetPolicyEngineMode gets a reference to the given PolicyEngineMode and assigns it to the PolicyEngineMode field.
func (o *Flow) SetPolicyEngineMode(v PolicyEngineMode) {
	o.PolicyEngineMode = &v
}

// GetCompatibilityMode returns the CompatibilityMode field value if set, zero value otherwise.
func (o *Flow) GetCompatibilityMode() bool {
	if o == nil || IsNil(o.CompatibilityMode) {
		var ret bool
		return ret
	}
	return *o.CompatibilityMode
}

// GetCompatibilityModeOk returns a tuple with the CompatibilityMode field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Flow) GetCompatibilityModeOk() (*bool, bool) {
	if o == nil || IsNil(o.CompatibilityMode) {
		return nil, false
	}
	return o.CompatibilityMode, true
}

// HasCompatibilityMode returns a boolean if a field has been set.
func (o *Flow) HasCompatibilityMode() bool {
	if o != nil && !IsNil(o.CompatibilityMode) {
		return true
	}

	return false
}

// SetCompatibilityMode gets a reference to the given bool and assigns it to the CompatibilityMode field.
func (o *Flow) SetCompatibilityMode(v bool) {
	o.CompatibilityMode = &v
}

// GetExportUrl returns the ExportUrl field value
func (o *Flow) GetExportUrl() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.ExportUrl
}

// GetExportUrlOk returns a tuple with the ExportUrl field value
// and a boolean to check if the value has been set.
func (o *Flow) GetExportUrlOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.ExportUrl, true
}

// SetExportUrl sets field value
func (o *Flow) SetExportUrl(v string) {
	o.ExportUrl = v
}

// GetLayout returns the Layout field value if set, zero value otherwise.
func (o *Flow) GetLayout() FlowLayoutEnum {
	if o == nil || IsNil(o.Layout) {
		var ret FlowLayoutEnum
		return ret
	}
	return *o.Layout
}

// GetLayoutOk returns a tuple with the Layout field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Flow) GetLayoutOk() (*FlowLayoutEnum, bool) {
	if o == nil || IsNil(o.Layout) {
		return nil, false
	}
	return o.Layout, true
}

// HasLayout returns a boolean if a field has been set.
func (o *Flow) HasLayout() bool {
	if o != nil && !IsNil(o.Layout) {
		return true
	}

	return false
}

// SetLayout gets a reference to the given FlowLayoutEnum and assigns it to the Layout field.
func (o *Flow) SetLayout(v FlowLayoutEnum) {
	o.Layout = &v
}

// GetDeniedAction returns the DeniedAction field value if set, zero value otherwise.
func (o *Flow) GetDeniedAction() DeniedActionEnum {
	if o == nil || IsNil(o.DeniedAction) {
		var ret DeniedActionEnum
		return ret
	}
	return *o.DeniedAction
}

// GetDeniedActionOk returns a tuple with the DeniedAction field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Flow) GetDeniedActionOk() (*DeniedActionEnum, bool) {
	if o == nil || IsNil(o.DeniedAction) {
		return nil, false
	}
	return o.DeniedAction, true
}

// HasDeniedAction returns a boolean if a field has been set.
func (o *Flow) HasDeniedAction() bool {
	if o != nil && !IsNil(o.DeniedAction) {
		return true
	}

	return false
}

// SetDeniedAction gets a reference to the given DeniedActionEnum and assigns it to the DeniedAction field.
func (o *Flow) SetDeniedAction(v DeniedActionEnum) {
	o.DeniedAction = &v
}

// GetAuthentication returns the Authentication field value if set, zero value otherwise.
func (o *Flow) GetAuthentication() AuthenticationEnum {
	if o == nil || IsNil(o.Authentication) {
		var ret AuthenticationEnum
		return ret
	}
	return *o.Authentication
}

// GetAuthenticationOk returns a tuple with the Authentication field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Flow) GetAuthenticationOk() (*AuthenticationEnum, bool) {
	if o == nil || IsNil(o.Authentication) {
		return nil, false
	}
	return o.Authentication, true
}

// HasAuthentication returns a boolean if a field has been set.
func (o *Flow) HasAuthentication() bool {
	if o != nil && !IsNil(o.Authentication) {
		return true
	}

	return false
}

// SetAuthentication gets a reference to the given AuthenticationEnum and assigns it to the Authentication field.
func (o *Flow) SetAuthentication(v AuthenticationEnum) {
	o.Authentication = &v
}

func (o Flow) MarshalJSON() ([]byte, error) {
	toSerialize, err := o.ToMap()
	if err != nil {
		return []byte{}, err
	}
	return json.Marshal(toSerialize)
}

func (o Flow) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	toSerialize["pk"] = o.Pk
	toSerialize["policybindingmodel_ptr_id"] = o.PolicybindingmodelPtrId
	toSerialize["name"] = o.Name
	toSerialize["slug"] = o.Slug
	toSerialize["title"] = o.Title
	toSerialize["designation"] = o.Designation
	if !IsNil(o.Background) {
		toSerialize["background"] = o.Background
	}
	toSerialize["background_url"] = o.BackgroundUrl
	toSerialize["background_themed_urls"] = o.BackgroundThemedUrls.Get()
	toSerialize["stages"] = o.Stages
	toSerialize["policies"] = o.Policies
	toSerialize["cache_count"] = o.CacheCount
	if !IsNil(o.PolicyEngineMode) {
		toSerialize["policy_engine_mode"] = o.PolicyEngineMode
	}
	if !IsNil(o.CompatibilityMode) {
		toSerialize["compatibility_mode"] = o.CompatibilityMode
	}
	toSerialize["export_url"] = o.ExportUrl
	if !IsNil(o.Layout) {
		toSerialize["layout"] = o.Layout
	}
	if !IsNil(o.DeniedAction) {
		toSerialize["denied_action"] = o.DeniedAction
	}
	if !IsNil(o.Authentication) {
		toSerialize["authentication"] = o.Authentication
	}

	for key, value := range o.AdditionalProperties {
		toSerialize[key] = value
	}

	return toSerialize, nil
}

func (o *Flow) UnmarshalJSON(data []byte) (err error) {
	// This validates that all required properties are included in the JSON object
	// by unmarshalling the object into a generic map with string keys and checking
	// that every required field exists as a key in the generic map.
	requiredProperties := []string{
		"pk",
		"policybindingmodel_ptr_id",
		"name",
		"slug",
		"title",
		"designation",
		"background_url",
		"background_themed_urls",
		"stages",
		"policies",
		"cache_count",
		"export_url",
	}

	allProperties := make(map[string]interface{})

	err = json.Unmarshal(data, &allProperties)

	if err != nil {
		return err
	}

	for _, requiredProperty := range requiredProperties {
		if _, exists := allProperties[requiredProperty]; !exists {
			return fmt.Errorf("no value given for required property %v", requiredProperty)
		}
	}

	varFlow := _Flow{}

	err = json.Unmarshal(data, &varFlow)

	if err != nil {
		return err
	}

	*o = Flow(varFlow)

	additionalProperties := make(map[string]interface{})

	if err = json.Unmarshal(data, &additionalProperties); err == nil {
		delete(additionalProperties, "pk")
		delete(additionalProperties, "policybindingmodel_ptr_id")
		delete(additionalProperties, "name")
		delete(additionalProperties, "slug")
		delete(additionalProperties, "title")
		delete(additionalProperties, "designation")
		delete(additionalProperties, "background")
		delete(additionalProperties, "background_url")
		delete(additionalProperties, "background_themed_urls")
		delete(additionalProperties, "stages")
		delete(additionalProperties, "policies")
		delete(additionalProperties, "cache_count")
		delete(additionalProperties, "policy_engine_mode")
		delete(additionalProperties, "compatibility_mode")
		delete(additionalProperties, "export_url")
		delete(additionalProperties, "layout")
		delete(additionalProperties, "denied_action")
		delete(additionalProperties, "authentication")
		o.AdditionalProperties = additionalProperties
	}

	return err
}

type NullableFlow struct {
	value *Flow
	isSet bool
}

func (v NullableFlow) Get() *Flow {
	return v.value
}

func (v *NullableFlow) Set(val *Flow) {
	v.value = val
	v.isSet = true
}

func (v NullableFlow) IsSet() bool {
	return v.isSet
}

func (v *NullableFlow) Unset() {
	v.value = nil
	v.isSet = false
}

func NewNullableFlow(val *Flow) *NullableFlow {
	return &NullableFlow{value: val, isSet: true}
}

func (v NullableFlow) MarshalJSON() ([]byte, error) {
	return json.Marshal(v.value)
}

func (v *NullableFlow) UnmarshalJSON(src []byte) error {
	v.isSet = true
	return json.Unmarshal(src, &v.value)
}