authentik/packages/client-go/model_consent_challenge.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 ConsentChallenge type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &ConsentChallenge{}

// ConsentChallenge Challenge info for consent screens
type ConsentChallenge struct {
	FlowInfo              *ContextualFlowInfo       `json:"flow_info,omitempty"`
	Component             *string                   `json:"component,omitempty"`
	ResponseErrors        *map[string][]ErrorDetail `json:"response_errors,omitempty"`
	PendingUser           string                    `json:"pending_user"`
	PendingUserAvatar     string                    `json:"pending_user_avatar"`
	HeaderText            *string                   `json:"header_text,omitempty"`
	Permissions           []ConsentPermission       `json:"permissions"`
	AdditionalPermissions []ConsentPermission       `json:"additional_permissions"`
	Token                 string                    `json:"token"`
	AdditionalProperties  map[string]interface{}
}

type _ConsentChallenge ConsentChallenge

// NewConsentChallenge instantiates a new ConsentChallenge 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 NewConsentChallenge(pendingUser string, pendingUserAvatar string, permissions []ConsentPermission, additionalPermissions []ConsentPermission, token string) *ConsentChallenge {
	this := ConsentChallenge{}
	var component string = "ak-stage-consent"
	this.Component = &component
	this.PendingUser = pendingUser
	this.PendingUserAvatar = pendingUserAvatar
	this.Permissions = permissions
	this.AdditionalPermissions = additionalPermissions
	this.Token = token
	return &this
}

// NewConsentChallengeWithDefaults instantiates a new ConsentChallenge 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 NewConsentChallengeWithDefaults() *ConsentChallenge {
	this := ConsentChallenge{}
	var component string = "ak-stage-consent"
	this.Component = &component
	return &this
}

// GetFlowInfo returns the FlowInfo field value if set, zero value otherwise.
func (o *ConsentChallenge) GetFlowInfo() ContextualFlowInfo {
	if o == nil || IsNil(o.FlowInfo) {
		var ret ContextualFlowInfo
		return ret
	}
	return *o.FlowInfo
}

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

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

	return false
}

// SetFlowInfo gets a reference to the given ContextualFlowInfo and assigns it to the FlowInfo field.
func (o *ConsentChallenge) SetFlowInfo(v ContextualFlowInfo) {
	o.FlowInfo = &v
}

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

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

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

	return false
}

// SetComponent gets a reference to the given string and assigns it to the Component field.
func (o *ConsentChallenge) SetComponent(v string) {
	o.Component = &v
}

// GetResponseErrors returns the ResponseErrors field value if set, zero value otherwise.
func (o *ConsentChallenge) GetResponseErrors() map[string][]ErrorDetail {
	if o == nil || IsNil(o.ResponseErrors) {
		var ret map[string][]ErrorDetail
		return ret
	}
	return *o.ResponseErrors
}

// GetResponseErrorsOk returns a tuple with the ResponseErrors field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *ConsentChallenge) GetResponseErrorsOk() (*map[string][]ErrorDetail, bool) {
	if o == nil || IsNil(o.ResponseErrors) {
		return nil, false
	}
	return o.ResponseErrors, true
}

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

	return false
}

// SetResponseErrors gets a reference to the given map[string][]ErrorDetail and assigns it to the ResponseErrors field.
func (o *ConsentChallenge) SetResponseErrors(v map[string][]ErrorDetail) {
	o.ResponseErrors = &v
}

// GetPendingUser returns the PendingUser field value
func (o *ConsentChallenge) GetPendingUser() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.PendingUser
}

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

// SetPendingUser sets field value
func (o *ConsentChallenge) SetPendingUser(v string) {
	o.PendingUser = v
}

// GetPendingUserAvatar returns the PendingUserAvatar field value
func (o *ConsentChallenge) GetPendingUserAvatar() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.PendingUserAvatar
}

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

// SetPendingUserAvatar sets field value
func (o *ConsentChallenge) SetPendingUserAvatar(v string) {
	o.PendingUserAvatar = v
}

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

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

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

	return false
}

// SetHeaderText gets a reference to the given string and assigns it to the HeaderText field.
func (o *ConsentChallenge) SetHeaderText(v string) {
	o.HeaderText = &v
}

// GetPermissions returns the Permissions field value
func (o *ConsentChallenge) GetPermissions() []ConsentPermission {
	if o == nil {
		var ret []ConsentPermission
		return ret
	}

	return o.Permissions
}

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

// SetPermissions sets field value
func (o *ConsentChallenge) SetPermissions(v []ConsentPermission) {
	o.Permissions = v
}

// GetAdditionalPermissions returns the AdditionalPermissions field value
func (o *ConsentChallenge) GetAdditionalPermissions() []ConsentPermission {
	if o == nil {
		var ret []ConsentPermission
		return ret
	}

	return o.AdditionalPermissions
}

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

// SetAdditionalPermissions sets field value
func (o *ConsentChallenge) SetAdditionalPermissions(v []ConsentPermission) {
	o.AdditionalPermissions = v
}

// GetToken returns the Token field value
func (o *ConsentChallenge) GetToken() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Token
}

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

// SetToken sets field value
func (o *ConsentChallenge) SetToken(v string) {
	o.Token = v
}

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

func (o ConsentChallenge) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	if !IsNil(o.FlowInfo) {
		toSerialize["flow_info"] = o.FlowInfo
	}
	if !IsNil(o.Component) {
		toSerialize["component"] = o.Component
	}
	if !IsNil(o.ResponseErrors) {
		toSerialize["response_errors"] = o.ResponseErrors
	}
	toSerialize["pending_user"] = o.PendingUser
	toSerialize["pending_user_avatar"] = o.PendingUserAvatar
	if !IsNil(o.HeaderText) {
		toSerialize["header_text"] = o.HeaderText
	}
	toSerialize["permissions"] = o.Permissions
	toSerialize["additional_permissions"] = o.AdditionalPermissions
	toSerialize["token"] = o.Token

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

	return toSerialize, nil
}

func (o *ConsentChallenge) 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{
		"pending_user",
		"pending_user_avatar",
		"permissions",
		"additional_permissions",
		"token",
	}

	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)
		}
	}

	varConsentChallenge := _ConsentChallenge{}

	err = json.Unmarshal(data, &varConsentChallenge)

	if err != nil {
		return err
	}

	*o = ConsentChallenge(varConsentChallenge)

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

	if err = json.Unmarshal(data, &additionalProperties); err == nil {
		delete(additionalProperties, "flow_info")
		delete(additionalProperties, "component")
		delete(additionalProperties, "response_errors")
		delete(additionalProperties, "pending_user")
		delete(additionalProperties, "pending_user_avatar")
		delete(additionalProperties, "header_text")
		delete(additionalProperties, "permissions")
		delete(additionalProperties, "additional_permissions")
		delete(additionalProperties, "token")
		o.AdditionalProperties = additionalProperties
	}

	return err
}

type NullableConsentChallenge struct {
	value *ConsentChallenge
	isSet bool
}

func (v NullableConsentChallenge) Get() *ConsentChallenge {
	return v.value
}

func (v *NullableConsentChallenge) Set(val *ConsentChallenge) {
	v.value = val
	v.isSet = true
}

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

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

func NewNullableConsentChallenge(val *ConsentChallenge) *NullableConsentChallenge {
	return &NullableConsentChallenge{value: val, isSet: true}
}

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

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