// File generated from our OpenAPI spec by Stainless.

package com.openai.models.responses

import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.core.JsonGenerator
import com.fasterxml.jackson.core.ObjectCodec
import com.fasterxml.jackson.databind.JsonNode
import com.fasterxml.jackson.databind.SerializerProvider
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.module.kotlin.jacksonTypeRef
import com.openai.core.BaseDeserializer
import com.openai.core.BaseSerializer
import com.openai.core.Enum
import com.openai.core.ExcludeMissing
import com.openai.core.JsonField
import com.openai.core.JsonMissing
import com.openai.core.JsonValue
import com.openai.core.checkKnown
import com.openai.core.checkRequired
import com.openai.core.getOrThrow
import com.openai.core.toImmutable
import com.openai.errors.OpenAIInvalidDataException
import java.util.Collections
import java.util.Objects
import java.util.Optional
import kotlin.jvm.optionals.getOrNull

/** The output of a shell tool call that was emitted. */
class ResponseFunctionShellToolCallOutput
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
private constructor(
    private val id: JsonField<String>,
    private val callId: JsonField<String>,
    private val maxOutputLength: JsonField<Long>,
    private val output: JsonField<List<Output>>,
    private val status: JsonField<Status>,
    private val type: JsonValue,
    private val createdBy: JsonField<String>,
    private val additionalProperties: MutableMap<String, JsonValue>,
) {

    @JsonCreator
    private constructor(
        @JsonProperty("id") @ExcludeMissing id: JsonField<String> = JsonMissing.of(),
        @JsonProperty("call_id") @ExcludeMissing callId: JsonField<String> = JsonMissing.of(),
        @JsonProperty("max_output_length")
        @ExcludeMissing
        maxOutputLength: JsonField<Long> = JsonMissing.of(),
        @JsonProperty("output") @ExcludeMissing output: JsonField<List<Output>> = JsonMissing.of(),
        @JsonProperty("status") @ExcludeMissing status: JsonField<Status> = JsonMissing.of(),
        @JsonProperty("type") @ExcludeMissing type: JsonValue = JsonMissing.of(),
        @JsonProperty("created_by") @ExcludeMissing createdBy: JsonField<String> = JsonMissing.of(),
    ) : this(id, callId, maxOutputLength, output, status, type, createdBy, mutableMapOf())

    /**
     * The unique ID of the shell call output. Populated when this item is returned via API.
     *
     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
     */
    fun id(): String = id.getRequired("id")

    /**
     * The unique ID of the shell tool call generated by the model.
     *
     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
     */
    fun callId(): String = callId.getRequired("call_id")

    /**
     * The maximum length of the shell command output. This is generated by the model and should be
     * passed back with the raw output.
     *
     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
     *   server responded with an unexpected value).
     */
    fun maxOutputLength(): Optional<Long> = maxOutputLength.getOptional("max_output_length")

    /**
     * An array of shell call output contents
     *
     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
     */
    fun output(): List<Output> = output.getRequired("output")

    /**
     * The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`.
     *
     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
     */
    fun status(): Status = status.getRequired("status")

    /**
     * The type of the shell call output. Always `shell_call_output`.
     *
     * Expected to always return the following:
     * ```java
     * JsonValue.from("shell_call_output")
     * ```
     *
     * However, this method can be useful for debugging and logging (e.g. if the server responded
     * with an unexpected value).
     */
    @JsonProperty("type") @ExcludeMissing fun _type(): JsonValue = type

    /**
     * The identifier of the actor that created the item.
     *
     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
     *   server responded with an unexpected value).
     */
    fun createdBy(): Optional<String> = createdBy.getOptional("created_by")

    /**
     * Returns the raw JSON value of [id].
     *
     * Unlike [id], this method doesn't throw if the JSON field has an unexpected type.
     */
    @JsonProperty("id") @ExcludeMissing fun _id(): JsonField<String> = id

    /**
     * Returns the raw JSON value of [callId].
     *
     * Unlike [callId], this method doesn't throw if the JSON field has an unexpected type.
     */
    @JsonProperty("call_id") @ExcludeMissing fun _callId(): JsonField<String> = callId

    /**
     * Returns the raw JSON value of [maxOutputLength].
     *
     * Unlike [maxOutputLength], this method doesn't throw if the JSON field has an unexpected type.
     */
    @JsonProperty("max_output_length")
    @ExcludeMissing
    fun _maxOutputLength(): JsonField<Long> = maxOutputLength

    /**
     * Returns the raw JSON value of [output].
     *
     * Unlike [output], this method doesn't throw if the JSON field has an unexpected type.
     */
    @JsonProperty("output") @ExcludeMissing fun _output(): JsonField<List<Output>> = output

    /**
     * Returns the raw JSON value of [status].
     *
     * Unlike [status], this method doesn't throw if the JSON field has an unexpected type.
     */
    @JsonProperty("status") @ExcludeMissing fun _status(): JsonField<Status> = status

    /**
     * Returns the raw JSON value of [createdBy].
     *
     * Unlike [createdBy], this method doesn't throw if the JSON field has an unexpected type.
     */
    @JsonProperty("created_by") @ExcludeMissing fun _createdBy(): JsonField<String> = createdBy

    @JsonAnySetter
    private fun putAdditionalProperty(key: String, value: JsonValue) {
        additionalProperties.put(key, value)
    }

    @JsonAnyGetter
    @ExcludeMissing
    fun _additionalProperties(): Map<String, JsonValue> =
        Collections.unmodifiableMap(additionalProperties)

    fun toBuilder() = Builder().from(this)

    companion object {

        /**
         * Returns a mutable builder for constructing an instance of
         * [ResponseFunctionShellToolCallOutput].
         *
         * The following fields are required:
         * ```java
         * .id()
         * .callId()
         * .maxOutputLength()
         * .output()
         * .status()
         * ```
         */
        @JvmStatic fun builder() = Builder()
    }

    /** A builder for [ResponseFunctionShellToolCallOutput]. */
    class Builder internal constructor() {

        private var id: JsonField<String>? = null
        private var callId: JsonField<String>? = null
        private var maxOutputLength: JsonField<Long>? = null
        private var output: JsonField<MutableList<Output>>? = null
        private var status: JsonField<Status>? = null
        private var type: JsonValue = JsonValue.from("shell_call_output")
        private var createdBy: JsonField<String> = JsonMissing.of()
        private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()

        @JvmSynthetic
        internal fun from(
            responseFunctionShellToolCallOutput: ResponseFunctionShellToolCallOutput
        ) = apply {
            id = responseFunctionShellToolCallOutput.id
            callId = responseFunctionShellToolCallOutput.callId
            maxOutputLength = responseFunctionShellToolCallOutput.maxOutputLength
            output = responseFunctionShellToolCallOutput.output.map { it.toMutableList() }
            status = responseFunctionShellToolCallOutput.status
            type = responseFunctionShellToolCallOutput.type
            createdBy = responseFunctionShellToolCallOutput.createdBy
            additionalProperties =
                responseFunctionShellToolCallOutput.additionalProperties.toMutableMap()
        }

        /** The unique ID of the shell call output. Populated when this item is returned via API. */
        fun id(id: String) = id(JsonField.of(id))

        /**
         * Sets [Builder.id] to an arbitrary JSON value.
         *
         * You should usually call [Builder.id] with a well-typed [String] value instead. This
         * method is primarily for setting the field to an undocumented or not yet supported value.
         */
        fun id(id: JsonField<String>) = apply { this.id = id }

        /** The unique ID of the shell tool call generated by the model. */
        fun callId(callId: String) = callId(JsonField.of(callId))

        /**
         * Sets [Builder.callId] to an arbitrary JSON value.
         *
         * You should usually call [Builder.callId] with a well-typed [String] value instead. This
         * method is primarily for setting the field to an undocumented or not yet supported value.
         */
        fun callId(callId: JsonField<String>) = apply { this.callId = callId }

        /**
         * The maximum length of the shell command output. This is generated by the model and should
         * be passed back with the raw output.
         */
        fun maxOutputLength(maxOutputLength: Long?) =
            maxOutputLength(JsonField.ofNullable(maxOutputLength))

        /**
         * Alias for [Builder.maxOutputLength].
         *
         * This unboxed primitive overload exists for backwards compatibility.
         */
        fun maxOutputLength(maxOutputLength: Long) = maxOutputLength(maxOutputLength as Long?)

        /** Alias for calling [Builder.maxOutputLength] with `maxOutputLength.orElse(null)`. */
        fun maxOutputLength(maxOutputLength: Optional<Long>) =
            maxOutputLength(maxOutputLength.getOrNull())

        /**
         * Sets [Builder.maxOutputLength] to an arbitrary JSON value.
         *
         * You should usually call [Builder.maxOutputLength] with a well-typed [Long] value instead.
         * This method is primarily for setting the field to an undocumented or not yet supported
         * value.
         */
        fun maxOutputLength(maxOutputLength: JsonField<Long>) = apply {
            this.maxOutputLength = maxOutputLength
        }

        /** An array of shell call output contents */
        fun output(output: List<Output>) = output(JsonField.of(output))

        /**
         * Sets [Builder.output] to an arbitrary JSON value.
         *
         * You should usually call [Builder.output] with a well-typed `List<Output>` value instead.
         * This method is primarily for setting the field to an undocumented or not yet supported
         * value.
         */
        fun output(output: JsonField<List<Output>>) = apply {
            this.output = output.map { it.toMutableList() }
        }

        /**
         * Adds a single [Output] to [Builder.output].
         *
         * @throws IllegalStateException if the field was previously set to a non-list.
         */
        fun addOutput(output: Output) = apply {
            this.output =
                (this.output ?: JsonField.of(mutableListOf())).also {
                    checkKnown("output", it).add(output)
                }
        }

        /**
         * The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`.
         */
        fun status(status: Status) = status(JsonField.of(status))

        /**
         * Sets [Builder.status] to an arbitrary JSON value.
         *
         * You should usually call [Builder.status] with a well-typed [Status] value instead. This
         * method is primarily for setting the field to an undocumented or not yet supported value.
         */
        fun status(status: JsonField<Status>) = apply { this.status = status }

        /**
         * Sets the field to an arbitrary JSON value.
         *
         * It is usually unnecessary to call this method because the field defaults to the
         * following:
         * ```java
         * JsonValue.from("shell_call_output")
         * ```
         *
         * This method is primarily for setting the field to an undocumented or not yet supported
         * value.
         */
        fun type(type: JsonValue) = apply { this.type = type }

        /** The identifier of the actor that created the item. */
        fun createdBy(createdBy: String) = createdBy(JsonField.of(createdBy))

        /**
         * Sets [Builder.createdBy] to an arbitrary JSON value.
         *
         * You should usually call [Builder.createdBy] with a well-typed [String] value instead.
         * This method is primarily for setting the field to an undocumented or not yet supported
         * value.
         */
        fun createdBy(createdBy: JsonField<String>) = apply { this.createdBy = createdBy }

        fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
            this.additionalProperties.clear()
            putAllAdditionalProperties(additionalProperties)
        }

        fun putAdditionalProperty(key: String, value: JsonValue) = apply {
            additionalProperties.put(key, value)
        }

        fun putAllAdditionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
            this.additionalProperties.putAll(additionalProperties)
        }

        fun removeAdditionalProperty(key: String) = apply { additionalProperties.remove(key) }

        fun removeAllAdditionalProperties(keys: Set<String>) = apply {
            keys.forEach(::removeAdditionalProperty)
        }

        /**
         * Returns an immutable instance of [ResponseFunctionShellToolCallOutput].
         *
         * Further updates to this [Builder] will not mutate the returned instance.
         *
         * The following fields are required:
         * ```java
         * .id()
         * .callId()
         * .maxOutputLength()
         * .output()
         * .status()
         * ```
         *
         * @throws IllegalStateException if any required field is unset.
         */
        fun build(): ResponseFunctionShellToolCallOutput =
            ResponseFunctionShellToolCallOutput(
                checkRequired("id", id),
                checkRequired("callId", callId),
                checkRequired("maxOutputLength", maxOutputLength),
                checkRequired("output", output).map { it.toImmutable() },
                checkRequired("status", status),
                type,
                createdBy,
                additionalProperties.toMutableMap(),
            )
    }

    private var validated: Boolean = false

    /**
     * Validates that the types of all values in this object match their expected types recursively.
     *
     * This method is _not_ forwards compatible with new types from the API for existing fields.
     *
     * @throws OpenAIInvalidDataException if any value type in this object doesn't match its
     *   expected type.
     */
    fun validate(): ResponseFunctionShellToolCallOutput = apply {
        if (validated) {
            return@apply
        }

        id()
        callId()
        maxOutputLength()
        output().forEach { it.validate() }
        status().validate()
        _type().let {
            if (it != JsonValue.from("shell_call_output")) {
                throw OpenAIInvalidDataException("'type' is invalid, received $it")
            }
        }
        createdBy()
        validated = true
    }

    fun isValid(): Boolean =
        try {
            validate()
            true
        } catch (e: OpenAIInvalidDataException) {
            false
        }

    /**
     * Returns a score indicating how many valid values are contained in this object recursively.
     *
     * Used for best match union deserialization.
     */
    @JvmSynthetic
    internal fun validity(): Int =
        (if (id.asKnown().isPresent) 1 else 0) +
            (if (callId.asKnown().isPresent) 1 else 0) +
            (if (maxOutputLength.asKnown().isPresent) 1 else 0) +
            (output.asKnown().getOrNull()?.sumOf { it.validity().toInt() } ?: 0) +
            (status.asKnown().getOrNull()?.validity() ?: 0) +
            type.let { if (it == JsonValue.from("shell_call_output")) 1 else 0 } +
            (if (createdBy.asKnown().isPresent) 1 else 0)

    /** The content of a shell tool call output that was emitted. */
    class Output
    @JsonCreator(mode = JsonCreator.Mode.DISABLED)
    private constructor(
        private val outcome: JsonField<Outcome>,
        private val stderr: JsonField<String>,
        private val stdout: JsonField<String>,
        private val createdBy: JsonField<String>,
        private val additionalProperties: MutableMap<String, JsonValue>,
    ) {

        @JsonCreator
        private constructor(
            @JsonProperty("outcome") @ExcludeMissing outcome: JsonField<Outcome> = JsonMissing.of(),
            @JsonProperty("stderr") @ExcludeMissing stderr: JsonField<String> = JsonMissing.of(),
            @JsonProperty("stdout") @ExcludeMissing stdout: JsonField<String> = JsonMissing.of(),
            @JsonProperty("created_by")
            @ExcludeMissing
            createdBy: JsonField<String> = JsonMissing.of(),
        ) : this(outcome, stderr, stdout, createdBy, mutableMapOf())

        /**
         * Represents either an exit outcome (with an exit code) or a timeout outcome for a shell
         * call output chunk.
         *
         * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
         *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
         */
        fun outcome(): Outcome = outcome.getRequired("outcome")

        /**
         * The standard error output that was captured.
         *
         * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
         *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
         */
        fun stderr(): String = stderr.getRequired("stderr")

        /**
         * The standard output that was captured.
         *
         * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
         *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
         */
        fun stdout(): String = stdout.getRequired("stdout")

        /**
         * The identifier of the actor that created the item.
         *
         * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
         *   server responded with an unexpected value).
         */
        fun createdBy(): Optional<String> = createdBy.getOptional("created_by")

        /**
         * Returns the raw JSON value of [outcome].
         *
         * Unlike [outcome], this method doesn't throw if the JSON field has an unexpected type.
         */
        @JsonProperty("outcome") @ExcludeMissing fun _outcome(): JsonField<Outcome> = outcome

        /**
         * Returns the raw JSON value of [stderr].
         *
         * Unlike [stderr], this method doesn't throw if the JSON field has an unexpected type.
         */
        @JsonProperty("stderr") @ExcludeMissing fun _stderr(): JsonField<String> = stderr

        /**
         * Returns the raw JSON value of [stdout].
         *
         * Unlike [stdout], this method doesn't throw if the JSON field has an unexpected type.
         */
        @JsonProperty("stdout") @ExcludeMissing fun _stdout(): JsonField<String> = stdout

        /**
         * Returns the raw JSON value of [createdBy].
         *
         * Unlike [createdBy], this method doesn't throw if the JSON field has an unexpected type.
         */
        @JsonProperty("created_by") @ExcludeMissing fun _createdBy(): JsonField<String> = createdBy

        @JsonAnySetter
        private fun putAdditionalProperty(key: String, value: JsonValue) {
            additionalProperties.put(key, value)
        }

        @JsonAnyGetter
        @ExcludeMissing
        fun _additionalProperties(): Map<String, JsonValue> =
            Collections.unmodifiableMap(additionalProperties)

        fun toBuilder() = Builder().from(this)

        companion object {

            /**
             * Returns a mutable builder for constructing an instance of [Output].
             *
             * The following fields are required:
             * ```java
             * .outcome()
             * .stderr()
             * .stdout()
             * ```
             */
            @JvmStatic fun builder() = Builder()
        }

        /** A builder for [Output]. */
        class Builder internal constructor() {

            private var outcome: JsonField<Outcome>? = null
            private var stderr: JsonField<String>? = null
            private var stdout: JsonField<String>? = null
            private var createdBy: JsonField<String> = JsonMissing.of()
            private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()

            @JvmSynthetic
            internal fun from(output: Output) = apply {
                outcome = output.outcome
                stderr = output.stderr
                stdout = output.stdout
                createdBy = output.createdBy
                additionalProperties = output.additionalProperties.toMutableMap()
            }

            /**
             * Represents either an exit outcome (with an exit code) or a timeout outcome for a
             * shell call output chunk.
             */
            fun outcome(outcome: Outcome) = outcome(JsonField.of(outcome))

            /**
             * Sets [Builder.outcome] to an arbitrary JSON value.
             *
             * You should usually call [Builder.outcome] with a well-typed [Outcome] value instead.
             * This method is primarily for setting the field to an undocumented or not yet
             * supported value.
             */
            fun outcome(outcome: JsonField<Outcome>) = apply { this.outcome = outcome }

            /** Alias for calling [outcome] with `Outcome.ofTimeout()`. */
            fun outcomeTimeout() = outcome(Outcome.ofTimeout())

            /** Alias for calling [outcome] with `Outcome.ofExit(exit)`. */
            fun outcome(exit: Outcome.Exit) = outcome(Outcome.ofExit(exit))

            /**
             * Alias for calling [outcome] with the following:
             * ```java
             * Outcome.Exit.builder()
             *     .exitCode(exitCode)
             *     .build()
             * ```
             */
            fun exitOutcome(exitCode: Long) =
                outcome(Outcome.Exit.builder().exitCode(exitCode).build())

            /** The standard error output that was captured. */
            fun stderr(stderr: String) = stderr(JsonField.of(stderr))

            /**
             * Sets [Builder.stderr] to an arbitrary JSON value.
             *
             * You should usually call [Builder.stderr] with a well-typed [String] value instead.
             * This method is primarily for setting the field to an undocumented or not yet
             * supported value.
             */
            fun stderr(stderr: JsonField<String>) = apply { this.stderr = stderr }

            /** The standard output that was captured. */
            fun stdout(stdout: String) = stdout(JsonField.of(stdout))

            /**
             * Sets [Builder.stdout] to an arbitrary JSON value.
             *
             * You should usually call [Builder.stdout] with a well-typed [String] value instead.
             * This method is primarily for setting the field to an undocumented or not yet
             * supported value.
             */
            fun stdout(stdout: JsonField<String>) = apply { this.stdout = stdout }

            /** The identifier of the actor that created the item. */
            fun createdBy(createdBy: String) = createdBy(JsonField.of(createdBy))

            /**
             * Sets [Builder.createdBy] to an arbitrary JSON value.
             *
             * You should usually call [Builder.createdBy] with a well-typed [String] value instead.
             * This method is primarily for setting the field to an undocumented or not yet
             * supported value.
             */
            fun createdBy(createdBy: JsonField<String>) = apply { this.createdBy = createdBy }

            fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
                this.additionalProperties.clear()
                putAllAdditionalProperties(additionalProperties)
            }

            fun putAdditionalProperty(key: String, value: JsonValue) = apply {
                additionalProperties.put(key, value)
            }

            fun putAllAdditionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
                this.additionalProperties.putAll(additionalProperties)
            }

            fun removeAdditionalProperty(key: String) = apply { additionalProperties.remove(key) }

            fun removeAllAdditionalProperties(keys: Set<String>) = apply {
                keys.forEach(::removeAdditionalProperty)
            }

            /**
             * Returns an immutable instance of [Output].
             *
             * Further updates to this [Builder] will not mutate the returned instance.
             *
             * The following fields are required:
             * ```java
             * .outcome()
             * .stderr()
             * .stdout()
             * ```
             *
             * @throws IllegalStateException if any required field is unset.
             */
            fun build(): Output =
                Output(
                    checkRequired("outcome", outcome),
                    checkRequired("stderr", stderr),
                    checkRequired("stdout", stdout),
                    createdBy,
                    additionalProperties.toMutableMap(),
                )
        }

        private var validated: Boolean = false

        /**
         * Validates that the types of all values in this object match their expected types
         * recursively.
         *
         * This method is _not_ forwards compatible with new types from the API for existing fields.
         *
         * @throws OpenAIInvalidDataException if any value type in this object doesn't match its
         *   expected type.
         */
        fun validate(): Output = apply {
            if (validated) {
                return@apply
            }

            outcome().validate()
            stderr()
            stdout()
            createdBy()
            validated = true
        }

        fun isValid(): Boolean =
            try {
                validate()
                true
            } catch (e: OpenAIInvalidDataException) {
                false
            }

        /**
         * Returns a score indicating how many valid values are contained in this object
         * recursively.
         *
         * Used for best match union deserialization.
         */
        @JvmSynthetic
        internal fun validity(): Int =
            (outcome.asKnown().getOrNull()?.validity() ?: 0) +
                (if (stderr.asKnown().isPresent) 1 else 0) +
                (if (stdout.asKnown().isPresent) 1 else 0) +
                (if (createdBy.asKnown().isPresent) 1 else 0)

        /**
         * Represents either an exit outcome (with an exit code) or a timeout outcome for a shell
         * call output chunk.
         */
        @JsonDeserialize(using = Outcome.Deserializer::class)
        @JsonSerialize(using = Outcome.Serializer::class)
        class Outcome
        private constructor(
            private val timeout: JsonValue? = null,
            private val exit: Exit? = null,
            private val _json: JsonValue? = null,
        ) {

            /** Indicates that the shell call exceeded its configured time limit. */
            fun timeout(): Optional<JsonValue> = Optional.ofNullable(timeout)

            /** Indicates that the shell commands finished and returned an exit code. */
            fun exit(): Optional<Exit> = Optional.ofNullable(exit)

            fun isTimeout(): Boolean = timeout != null

            fun isExit(): Boolean = exit != null

            /** Indicates that the shell call exceeded its configured time limit. */
            fun asTimeout(): JsonValue = timeout.getOrThrow("timeout")

            /** Indicates that the shell commands finished and returned an exit code. */
            fun asExit(): Exit = exit.getOrThrow("exit")

            fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)

            /**
             * Maps this instance's current variant to a value of type [T] using the given
             * [visitor].
             *
             * Note that this method is _not_ forwards compatible with new variants from the API,
             * unless [visitor] overrides [Visitor.unknown]. To handle variants not known to this
             * version of the SDK gracefully, consider overriding [Visitor.unknown]:
             * ```java
             * import com.openai.core.JsonValue;
             * import java.util.Optional;
             *
             * Optional<String> result = outcome.accept(new Outcome.Visitor<Optional<String>>() {
             *     @Override
             *     public Optional<String> visitTimeout(JsonValue timeout) {
             *         return Optional.of(timeout.toString());
             *     }
             *
             *     // ...
             *
             *     @Override
             *     public Optional<String> unknown(JsonValue json) {
             *         // Or inspect the `json`.
             *         return Optional.empty();
             *     }
             * });
             * ```
             *
             * @throws OpenAIInvalidDataException if [Visitor.unknown] is not overridden in
             *   [visitor] and the current variant is unknown.
             */
            fun <T> accept(visitor: Visitor<T>): T =
                when {
                    timeout != null -> visitor.visitTimeout(timeout)
                    exit != null -> visitor.visitExit(exit)
                    else -> visitor.unknown(_json)
                }

            private var validated: Boolean = false

            /**
             * Validates that the types of all values in this object match their expected types
             * recursively.
             *
             * This method is _not_ forwards compatible with new types from the API for existing
             * fields.
             *
             * @throws OpenAIInvalidDataException if any value type in this object doesn't match its
             *   expected type.
             */
            fun validate(): Outcome = apply {
                if (validated) {
                    return@apply
                }

                accept(
                    object : Visitor<Unit> {
                        override fun visitTimeout(timeout: JsonValue) {
                            timeout.let {
                                if (it != JsonValue.from(mapOf("type" to "timeout"))) {
                                    throw OpenAIInvalidDataException(
                                        "'timeout' is invalid, received $it"
                                    )
                                }
                            }
                        }

                        override fun visitExit(exit: Exit) {
                            exit.validate()
                        }
                    }
                )
                validated = true
            }

            fun isValid(): Boolean =
                try {
                    validate()
                    true
                } catch (e: OpenAIInvalidDataException) {
                    false
                }

            /**
             * Returns a score indicating how many valid values are contained in this object
             * recursively.
             *
             * Used for best match union deserialization.
             */
            @JvmSynthetic
            internal fun validity(): Int =
                accept(
                    object : Visitor<Int> {
                        override fun visitTimeout(timeout: JsonValue) =
                            timeout.let {
                                if (it == JsonValue.from(mapOf("type" to "timeout"))) 1 else 0
                            }

                        override fun visitExit(exit: Exit) = exit.validity()

                        override fun unknown(json: JsonValue?) = 0
                    }
                )

            override fun equals(other: Any?): Boolean {
                if (this === other) {
                    return true
                }

                return other is Outcome && timeout == other.timeout && exit == other.exit
            }

            override fun hashCode(): Int = Objects.hash(timeout, exit)

            override fun toString(): String =
                when {
                    timeout != null -> "Outcome{timeout=$timeout}"
                    exit != null -> "Outcome{exit=$exit}"
                    _json != null -> "Outcome{_unknown=$_json}"
                    else -> throw IllegalStateException("Invalid Outcome")
                }

            companion object {

                /** Indicates that the shell call exceeded its configured time limit. */
                @JvmStatic
                fun ofTimeout() = Outcome(timeout = JsonValue.from(mapOf("type" to "timeout")))

                /** Indicates that the shell commands finished and returned an exit code. */
                @JvmStatic fun ofExit(exit: Exit) = Outcome(exit = exit)
            }

            /**
             * An interface that defines how to map each variant of [Outcome] to a value of type
             * [T].
             */
            interface Visitor<out T> {

                /** Indicates that the shell call exceeded its configured time limit. */
                fun visitTimeout(timeout: JsonValue): T

                /** Indicates that the shell commands finished and returned an exit code. */
                fun visitExit(exit: Exit): T

                /**
                 * Maps an unknown variant of [Outcome] to a value of type [T].
                 *
                 * An instance of [Outcome] can contain an unknown variant if it was deserialized
                 * from data that doesn't match any known variant. For example, if the SDK is on an
                 * older version than the API, then the API may respond with new variants that the
                 * SDK is unaware of.
                 *
                 * @throws OpenAIInvalidDataException in the default implementation.
                 */
                fun unknown(json: JsonValue?): T {
                    throw OpenAIInvalidDataException("Unknown Outcome: $json")
                }
            }

            internal class Deserializer : BaseDeserializer<Outcome>(Outcome::class) {

                override fun ObjectCodec.deserialize(node: JsonNode): Outcome {
                    val json = JsonValue.fromJsonNode(node)
                    val type = json.asObject().getOrNull()?.get("type")?.asString()?.getOrNull()

                    when (type) {
                        "timeout" -> {
                            return tryDeserialize(node, jacksonTypeRef<JsonValue>())
                                ?.let { Outcome(timeout = it, _json = json) }
                                ?.takeIf { it.isValid() } ?: Outcome(_json = json)
                        }
                        "exit" -> {
                            return tryDeserialize(node, jacksonTypeRef<Exit>())?.let {
                                Outcome(exit = it, _json = json)
                            } ?: Outcome(_json = json)
                        }
                    }

                    return Outcome(_json = json)
                }
            }

            internal class Serializer : BaseSerializer<Outcome>(Outcome::class) {

                override fun serialize(
                    value: Outcome,
                    generator: JsonGenerator,
                    provider: SerializerProvider,
                ) {
                    when {
                        value.timeout != null -> generator.writeObject(value.timeout)
                        value.exit != null -> generator.writeObject(value.exit)
                        value._json != null -> generator.writeObject(value._json)
                        else -> throw IllegalStateException("Invalid Outcome")
                    }
                }
            }

            /** Indicates that the shell commands finished and returned an exit code. */
            class Exit
            @JsonCreator(mode = JsonCreator.Mode.DISABLED)
            private constructor(
                private val exitCode: JsonField<Long>,
                private val type: JsonValue,
                private val additionalProperties: MutableMap<String, JsonValue>,
            ) {

                @JsonCreator
                private constructor(
                    @JsonProperty("exit_code")
                    @ExcludeMissing
                    exitCode: JsonField<Long> = JsonMissing.of(),
                    @JsonProperty("type") @ExcludeMissing type: JsonValue = JsonMissing.of(),
                ) : this(exitCode, type, mutableMapOf())

                /**
                 * Exit code from the shell process.
                 *
                 * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
                 *   unexpectedly missing or null (e.g. if the server responded with an unexpected
                 *   value).
                 */
                fun exitCode(): Long = exitCode.getRequired("exit_code")

                /**
                 * The outcome type. Always `exit`.
                 *
                 * Expected to always return the following:
                 * ```java
                 * JsonValue.from("exit")
                 * ```
                 *
                 * However, this method can be useful for debugging and logging (e.g. if the server
                 * responded with an unexpected value).
                 */
                @JsonProperty("type") @ExcludeMissing fun _type(): JsonValue = type

                /**
                 * Returns the raw JSON value of [exitCode].
                 *
                 * Unlike [exitCode], this method doesn't throw if the JSON field has an unexpected
                 * type.
                 */
                @JsonProperty("exit_code")
                @ExcludeMissing
                fun _exitCode(): JsonField<Long> = exitCode

                @JsonAnySetter
                private fun putAdditionalProperty(key: String, value: JsonValue) {
                    additionalProperties.put(key, value)
                }

                @JsonAnyGetter
                @ExcludeMissing
                fun _additionalProperties(): Map<String, JsonValue> =
                    Collections.unmodifiableMap(additionalProperties)

                fun toBuilder() = Builder().from(this)

                companion object {

                    /**
                     * Returns a mutable builder for constructing an instance of [Exit].
                     *
                     * The following fields are required:
                     * ```java
                     * .exitCode()
                     * ```
                     */
                    @JvmStatic fun builder() = Builder()
                }

                /** A builder for [Exit]. */
                class Builder internal constructor() {

                    private var exitCode: JsonField<Long>? = null
                    private var type: JsonValue = JsonValue.from("exit")
                    private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()

                    @JvmSynthetic
                    internal fun from(exit: Exit) = apply {
                        exitCode = exit.exitCode
                        type = exit.type
                        additionalProperties = exit.additionalProperties.toMutableMap()
                    }

                    /** Exit code from the shell process. */
                    fun exitCode(exitCode: Long) = exitCode(JsonField.of(exitCode))

                    /**
                     * Sets [Builder.exitCode] to an arbitrary JSON value.
                     *
                     * You should usually call [Builder.exitCode] with a well-typed [Long] value
                     * instead. This method is primarily for setting the field to an undocumented or
                     * not yet supported value.
                     */
                    fun exitCode(exitCode: JsonField<Long>) = apply { this.exitCode = exitCode }

                    /**
                     * Sets the field to an arbitrary JSON value.
                     *
                     * It is usually unnecessary to call this method because the field defaults to
                     * the following:
                     * ```java
                     * JsonValue.from("exit")
                     * ```
                     *
                     * This method is primarily for setting the field to an undocumented or not yet
                     * supported value.
                     */
                    fun type(type: JsonValue) = apply { this.type = type }

                    fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
                        this.additionalProperties.clear()
                        putAllAdditionalProperties(additionalProperties)
                    }

                    fun putAdditionalProperty(key: String, value: JsonValue) = apply {
                        additionalProperties.put(key, value)
                    }

                    fun putAllAdditionalProperties(additionalProperties: Map<String, JsonValue>) =
                        apply {
                            this.additionalProperties.putAll(additionalProperties)
                        }

                    fun removeAdditionalProperty(key: String) = apply {
                        additionalProperties.remove(key)
                    }

                    fun removeAllAdditionalProperties(keys: Set<String>) = apply {
                        keys.forEach(::removeAdditionalProperty)
                    }

                    /**
                     * Returns an immutable instance of [Exit].
                     *
                     * Further updates to this [Builder] will not mutate the returned instance.
                     *
                     * The following fields are required:
                     * ```java
                     * .exitCode()
                     * ```
                     *
                     * @throws IllegalStateException if any required field is unset.
                     */
                    fun build(): Exit =
                        Exit(
                            checkRequired("exitCode", exitCode),
                            type,
                            additionalProperties.toMutableMap(),
                        )
                }

                private var validated: Boolean = false

                /**
                 * Validates that the types of all values in this object match their expected types
                 * recursively.
                 *
                 * This method is _not_ forwards compatible with new types from the API for existing
                 * fields.
                 *
                 * @throws OpenAIInvalidDataException if any value type in this object doesn't match
                 *   its expected type.
                 */
                fun validate(): Exit = apply {
                    if (validated) {
                        return@apply
                    }

                    exitCode()
                    _type().let {
                        if (it != JsonValue.from("exit")) {
                            throw OpenAIInvalidDataException("'type' is invalid, received $it")
                        }
                    }
                    validated = true
                }

                fun isValid(): Boolean =
                    try {
                        validate()
                        true
                    } catch (e: OpenAIInvalidDataException) {
                        false
                    }

                /**
                 * Returns a score indicating how many valid values are contained in this object
                 * recursively.
                 *
                 * Used for best match union deserialization.
                 */
                @JvmSynthetic
                internal fun validity(): Int =
                    (if (exitCode.asKnown().isPresent) 1 else 0) +
                        type.let { if (it == JsonValue.from("exit")) 1 else 0 }

                override fun equals(other: Any?): Boolean {
                    if (this === other) {
                        return true
                    }

                    return other is Exit &&
                        exitCode == other.exitCode &&
                        type == other.type &&
                        additionalProperties == other.additionalProperties
                }

                private val hashCode: Int by lazy {
                    Objects.hash(exitCode, type, additionalProperties)
                }

                override fun hashCode(): Int = hashCode

                override fun toString() =
                    "Exit{exitCode=$exitCode, type=$type, additionalProperties=$additionalProperties}"
            }
        }

        override fun equals(other: Any?): Boolean {
            if (this === other) {
                return true
            }

            return other is Output &&
                outcome == other.outcome &&
                stderr == other.stderr &&
                stdout == other.stdout &&
                createdBy == other.createdBy &&
                additionalProperties == other.additionalProperties
        }

        private val hashCode: Int by lazy {
            Objects.hash(outcome, stderr, stdout, createdBy, additionalProperties)
        }

        override fun hashCode(): Int = hashCode

        override fun toString() =
            "Output{outcome=$outcome, stderr=$stderr, stdout=$stdout, createdBy=$createdBy, additionalProperties=$additionalProperties}"
    }

    /** The status of the shell call output. One of `in_progress`, `completed`, or `incomplete`. */
    class Status @JsonCreator private constructor(private val value: JsonField<String>) : Enum {

        /**
         * Returns this class instance's raw value.
         *
         * This is usually only useful if this instance was deserialized from data that doesn't
         * match any known member, and you want to know that value. For example, if the SDK is on an
         * older version than the API, then the API may respond with new members that the SDK is
         * unaware of.
         */
        @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField<String> = value

        companion object {

            @JvmField val IN_PROGRESS = of("in_progress")

            @JvmField val COMPLETED = of("completed")

            @JvmField val INCOMPLETE = of("incomplete")

            @JvmStatic fun of(value: String) = Status(JsonField.of(value))
        }

        /** An enum containing [Status]'s known values. */
        enum class Known {
            IN_PROGRESS,
            COMPLETED,
            INCOMPLETE,
        }

        /**
         * An enum containing [Status]'s known values, as well as an [_UNKNOWN] member.
         *
         * An instance of [Status] can contain an unknown value in a couple of cases:
         * - It was deserialized from data that doesn't match any known member. For example, if the
         *   SDK is on an older version than the API, then the API may respond with new members that
         *   the SDK is unaware of.
         * - It was constructed with an arbitrary value using the [of] method.
         */
        enum class Value {
            IN_PROGRESS,
            COMPLETED,
            INCOMPLETE,
            /** An enum member indicating that [Status] was instantiated with an unknown value. */
            _UNKNOWN,
        }

        /**
         * Returns an enum member corresponding to this class instance's value, or [Value._UNKNOWN]
         * if the class was instantiated with an unknown value.
         *
         * Use the [known] method instead if you're certain the value is always known or if you want
         * to throw for the unknown case.
         */
        fun value(): Value =
            when (this) {
                IN_PROGRESS -> Value.IN_PROGRESS
                COMPLETED -> Value.COMPLETED
                INCOMPLETE -> Value.INCOMPLETE
                else -> Value._UNKNOWN
            }

        /**
         * Returns an enum member corresponding to this class instance's value.
         *
         * Use the [value] method instead if you're uncertain the value is always known and don't
         * want to throw for the unknown case.
         *
         * @throws OpenAIInvalidDataException if this class instance's value is a not a known
         *   member.
         */
        fun known(): Known =
            when (this) {
                IN_PROGRESS -> Known.IN_PROGRESS
                COMPLETED -> Known.COMPLETED
                INCOMPLETE -> Known.INCOMPLETE
                else -> throw OpenAIInvalidDataException("Unknown Status: $value")
            }

        /**
         * Returns this class instance's primitive wire representation.
         *
         * This differs from the [toString] method because that method is primarily for debugging
         * and generally doesn't throw.
         *
         * @throws OpenAIInvalidDataException if this class instance's value does not have the
         *   expected primitive type.
         */
        fun asString(): String =
            _value().asString().orElseThrow { OpenAIInvalidDataException("Value is not a String") }

        private var validated: Boolean = false

        /**
         * Validates that the types of all values in this object match their expected types
         * recursively.
         *
         * This method is _not_ forwards compatible with new types from the API for existing fields.
         *
         * @throws OpenAIInvalidDataException if any value type in this object doesn't match its
         *   expected type.
         */
        fun validate(): Status = apply {
            if (validated) {
                return@apply
            }

            known()
            validated = true
        }

        fun isValid(): Boolean =
            try {
                validate()
                true
            } catch (e: OpenAIInvalidDataException) {
                false
            }

        /**
         * Returns a score indicating how many valid values are contained in this object
         * recursively.
         *
         * Used for best match union deserialization.
         */
        @JvmSynthetic internal fun validity(): Int = if (value() == Value._UNKNOWN) 0 else 1

        override fun equals(other: Any?): Boolean {
            if (this === other) {
                return true
            }

            return other is Status && value == other.value
        }

        override fun hashCode() = value.hashCode()

        override fun toString() = value.toString()
    }

    override fun equals(other: Any?): Boolean {
        if (this === other) {
            return true
        }

        return other is ResponseFunctionShellToolCallOutput &&
            id == other.id &&
            callId == other.callId &&
            maxOutputLength == other.maxOutputLength &&
            output == other.output &&
            status == other.status &&
            type == other.type &&
            createdBy == other.createdBy &&
            additionalProperties == other.additionalProperties
    }

    private val hashCode: Int by lazy {
        Objects.hash(
            id,
            callId,
            maxOutputLength,
            output,
            status,
            type,
            createdBy,
            additionalProperties,
        )
    }

    override fun hashCode(): Int = hashCode

    override fun toString() =
        "ResponseFunctionShellToolCallOutput{id=$id, callId=$callId, maxOutputLength=$maxOutputLength, output=$output, status=$status, type=$type, createdBy=$createdBy, additionalProperties=$additionalProperties}"
}
