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

// CaptchaChallenge Site public key
type CaptchaChallenge 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"`
	SiteKey              string                    `json:"site_key"`
	JsUrl                string                    `json:"js_url"`
	Interactive          bool                      `json:"interactive"`
	AdditionalProperties map[string]interface{}
}

type _CaptchaChallenge CaptchaChallenge

// NewCaptchaChallenge instantiates a new CaptchaChallenge 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 NewCaptchaChallenge(pendingUser string, pendingUserAvatar string, siteKey string, jsUrl string, interactive bool) *CaptchaChallenge {
	this := CaptchaChallenge{}
	var component string = "ak-stage-captcha"
	this.Component = &component
	this.PendingUser = pendingUser
	this.PendingUserAvatar = pendingUserAvatar
	this.SiteKey = siteKey
	this.JsUrl = jsUrl
	this.Interactive = interactive
	return &this
}

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

// GetFlowInfo returns the FlowInfo field value if set, zero value otherwise.
func (o *CaptchaChallenge) 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 *CaptchaChallenge) 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 *CaptchaChallenge) 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 *CaptchaChallenge) SetFlowInfo(v ContextualFlowInfo) {
	o.FlowInfo = &v
}

// GetComponent returns the Component field value if set, zero value otherwise.
func (o *CaptchaChallenge) 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 *CaptchaChallenge) 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 *CaptchaChallenge) 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 *CaptchaChallenge) SetComponent(v string) {
	o.Component = &v
}

// GetResponseErrors returns the ResponseErrors field value if set, zero value otherwise.
func (o *CaptchaChallenge) 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 *CaptchaChallenge) 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 *CaptchaChallenge) 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 *CaptchaChallenge) SetResponseErrors(v map[string][]ErrorDetail) {
	o.ResponseErrors = &v
}

// GetPendingUser returns the PendingUser field value
func (o *CaptchaChallenge) 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 *CaptchaChallenge) GetPendingUserOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.PendingUser, true
}

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

// GetPendingUserAvatar returns the PendingUserAvatar field value
func (o *CaptchaChallenge) 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 *CaptchaChallenge) GetPendingUserAvatarOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.PendingUserAvatar, true
}

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

// GetSiteKey returns the SiteKey field value
func (o *CaptchaChallenge) GetSiteKey() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.SiteKey
}

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

// SetSiteKey sets field value
func (o *CaptchaChallenge) SetSiteKey(v string) {
	o.SiteKey = v
}

// GetJsUrl returns the JsUrl field value
func (o *CaptchaChallenge) GetJsUrl() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.JsUrl
}

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

// SetJsUrl sets field value
func (o *CaptchaChallenge) SetJsUrl(v string) {
	o.JsUrl = v
}

// GetInteractive returns the Interactive field value
func (o *CaptchaChallenge) GetInteractive() bool {
	if o == nil {
		var ret bool
		return ret
	}

	return o.Interactive
}

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

// SetInteractive sets field value
func (o *CaptchaChallenge) SetInteractive(v bool) {
	o.Interactive = v
}

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

func (o CaptchaChallenge) 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
	toSerialize["site_key"] = o.SiteKey
	toSerialize["js_url"] = o.JsUrl
	toSerialize["interactive"] = o.Interactive

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

	return toSerialize, nil
}

func (o *CaptchaChallenge) 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",
		"site_key",
		"js_url",
		"interactive",
	}

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

	varCaptchaChallenge := _CaptchaChallenge{}

	err = json.Unmarshal(data, &varCaptchaChallenge)

	if err != nil {
		return err
	}

	*o = CaptchaChallenge(varCaptchaChallenge)

	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, "site_key")
		delete(additionalProperties, "js_url")
		delete(additionalProperties, "interactive")
		o.AdditionalProperties = additionalProperties
	}

	return err
}

type NullableCaptchaChallenge struct {
	value *CaptchaChallenge
	isSet bool
}

func (v NullableCaptchaChallenge) Get() *CaptchaChallenge {
	return v.value
}

func (v *NullableCaptchaChallenge) Set(val *CaptchaChallenge) {
	v.value = val
	v.isSet = true
}

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

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

func NewNullableCaptchaChallenge(val *CaptchaChallenge) *NullableCaptchaChallenge {
	return &NullableCaptchaChallenge{value: val, isSet: true}
}

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

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