chore(internal): swap from getNullable to getOptional (#406)

Author: stainless-app[bot]

openai-java-core/src/main/kotlin/com/openai/core/Values.kt

@@ -132,11 +132,11 @@ sealed class JsonField<out T : Any> {
         }
 
     @JvmSynthetic
-    internal fun getNullable(name: String): T? =
+    internal fun getOptional(name: String): Optional<@UnsafeVariance T> =
         when (this) {
-            is KnownValue -> value
-            is JsonMissing -> null
-            is JsonNull -> null
+            is KnownValue -> Optional.of(value)
+            is JsonMissing,
+            is JsonNull -> Optional.empty()
             else -> throw OpenAIInvalidDataException("`$name` is invalid, received $this")
         }
 

openai-java-core/src/main/kotlin/com/openai/models/ErrorObject.kt

@@ -38,7 +38,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun code(): Optional<String> = Optional.ofNullable(code.getNullable("code"))
+    fun code(): Optional<String> = code.getOptional("code")
 
     /**
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
@@ -50,7 +50,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun param(): Optional<String> = Optional.ofNullable(param.getNullable("param"))
+    fun param(): Optional<String> = param.getOptional("param")
 
     /**
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is

openai-java-core/src/main/kotlin/com/openai/models/FunctionDefinition.kt

@@ -54,8 +54,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun description(): Optional<String> =
-        Optional.ofNullable(description.getNullable("description"))
+    fun description(): Optional<String> = description.getOptional("description")
 
     /**
      * The parameters the functions accepts, described as a JSON Schema object. See the
@@ -68,8 +67,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun parameters(): Optional<FunctionParameters> =
-        Optional.ofNullable(parameters.getNullable("parameters"))
+    fun parameters(): Optional<FunctionParameters> = parameters.getOptional("parameters")
 
     /**
      * Whether to enable strict schema adherence when generating the function call. If set to true,
@@ -80,7 +78,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun strict(): Optional<Boolean> = Optional.ofNullable(strict.getNullable("strict"))
+    fun strict(): Optional<Boolean> = strict.getOptional("strict")
 
     /**
      * Returns the raw JSON value of [name].

openai-java-core/src/main/kotlin/com/openai/models/Reasoning.kt

@@ -50,7 +50,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun effort(): Optional<ReasoningEffort> = Optional.ofNullable(effort.getNullable("effort"))
+    fun effort(): Optional<ReasoningEffort> = effort.getOptional("effort")
 
     /**
      * **computer_use_preview only**
@@ -62,7 +62,7 @@ private constructor(
      *   server responded with an unexpected value).
      */
     fun generateSummary(): Optional<GenerateSummary> =
-        Optional.ofNullable(generateSummary.getNullable("generate_summary"))
+        generateSummary.getOptional("generate_summary")
 
     /**
      * Returns the raw JSON value of [effort].

openai-java-core/src/main/kotlin/com/openai/models/ResponseFormatJsonSchema.kt

@@ -241,8 +241,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun description(): Optional<String> =
-            Optional.ofNullable(description.getNullable("description"))
+        fun description(): Optional<String> = description.getOptional("description")
 
         /**
          * The schema for the response format, described as a JSON Schema object. Learn how to build
@@ -251,7 +250,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun schema(): Optional<Schema> = Optional.ofNullable(schema.getNullable("schema"))
+        fun schema(): Optional<Schema> = schema.getOptional("schema")
 
         /**
          * Whether to enable strict schema adherence when generating the output. If set to true, the
@@ -262,7 +261,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun strict(): Optional<Boolean> = Optional.ofNullable(strict.getNullable("strict"))
+        fun strict(): Optional<Boolean> = strict.getOptional("strict")
 
         /**
          * Returns the raw JSON value of [name].

openai-java-core/src/main/kotlin/com/openai/models/audio/speech/SpeechCreateParams.kt

@@ -488,8 +488,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun instructions(): Optional<String> =
-            Optional.ofNullable(instructions.getNullable("instructions"))
+        fun instructions(): Optional<String> = instructions.getOptional("instructions")
 
         /**
          * The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and
@@ -499,7 +498,7 @@ private constructor(
          *   server responded with an unexpected value).
          */
         fun responseFormat(): Optional<ResponseFormat> =
-            Optional.ofNullable(responseFormat.getNullable("response_format"))
+            responseFormat.getOptional("response_format")
 
         /**
          * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the
@@ -508,7 +507,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun speed(): Optional<Double> = Optional.ofNullable(speed.getNullable("speed"))
+        fun speed(): Optional<Double> = speed.getOptional("speed")
 
         /**
          * Returns the raw JSON value of [input].

openai-java-core/src/main/kotlin/com/openai/models/audio/transcriptions/Transcription.kt

@@ -51,7 +51,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun logprobs(): Optional<List<Logprob>> = Optional.ofNullable(logprobs.getNullable("logprobs"))
+    fun logprobs(): Optional<List<Logprob>> = logprobs.getOptional("logprobs")
 
     /**
      * Returns the raw JSON value of [text].
@@ -239,23 +239,23 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun token(): Optional<String> = Optional.ofNullable(token.getNullable("token"))
+        fun token(): Optional<String> = token.getOptional("token")
 
         /**
          * The bytes of the token.
          *
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun bytes(): Optional<List<Double>> = Optional.ofNullable(bytes.getNullable("bytes"))
+        fun bytes(): Optional<List<Double>> = bytes.getOptional("bytes")
 
         /**
          * The log probability of the token.
          *
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun logprob(): Optional<Double> = Optional.ofNullable(logprob.getNullable("logprob"))
+        fun logprob(): Optional<Double> = logprob.getOptional("logprob")
 
         /**
          * Returns the raw JSON value of [token].

openai-java-core/src/main/kotlin/com/openai/models/audio/transcriptions/TranscriptionCreateParams.kt

@@ -573,8 +573,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun include(): Optional<List<TranscriptionInclude>> =
-            Optional.ofNullable(include.value.getNullable("include"))
+        fun include(): Optional<List<TranscriptionInclude>> = include.value.getOptional("include")
 
         /**
          * The language of the input audio. Supplying the input language in
@@ -584,8 +583,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun language(): Optional<String> =
-            Optional.ofNullable(language.value.getNullable("language"))
+        fun language(): Optional<String> = language.value.getOptional("language")
 
         /**
          * An optional text to guide the model's style or continue a previous audio segment. The
@@ -595,7 +593,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun prompt(): Optional<String> = Optional.ofNullable(prompt.value.getNullable("prompt"))
+        fun prompt(): Optional<String> = prompt.value.getOptional("prompt")
 
         /**
          * The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`,
@@ -606,7 +604,7 @@ private constructor(
          *   server responded with an unexpected value).
          */
         fun responseFormat(): Optional<AudioResponseFormat> =
-            Optional.ofNullable(responseFormat.value.getNullable("response_format"))
+            responseFormat.value.getOptional("response_format")
 
         /**
          * The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output
@@ -618,8 +616,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun temperature(): Optional<Double> =
-            Optional.ofNullable(temperature.value.getNullable("temperature"))
+        fun temperature(): Optional<Double> = temperature.value.getOptional("temperature")
 
         /**
          * The timestamp granularities to populate for this transcription. `response_format` must be
@@ -631,7 +628,7 @@ private constructor(
          *   server responded with an unexpected value).
          */
         fun timestampGranularities(): Optional<List<TimestampGranularity>> =
-            Optional.ofNullable(timestampGranularities.value.getNullable("timestamp_granularities"))
+            timestampGranularities.value.getOptional("timestamp_granularities")
 
         /**
          * Returns the raw multipart value of [file].

openai-java-core/src/main/kotlin/com/openai/models/audio/transcriptions/TranscriptionTextDeltaEvent.kt

@@ -71,7 +71,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun logprobs(): Optional<List<Logprob>> = Optional.ofNullable(logprobs.getNullable("logprobs"))
+    fun logprobs(): Optional<List<Logprob>> = logprobs.getOptional("logprobs")
 
     /**
      * Returns the raw JSON value of [delta].
@@ -282,23 +282,23 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun token(): Optional<String> = Optional.ofNullable(token.getNullable("token"))
+        fun token(): Optional<String> = token.getOptional("token")
 
         /**
          * The bytes that were used to generate the log probability.
          *
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun bytes(): Optional<List<JsonValue>> = Optional.ofNullable(bytes.getNullable("bytes"))
+        fun bytes(): Optional<List<JsonValue>> = bytes.getOptional("bytes")
 
         /**
          * The log probability of the token.
          *
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun logprob(): Optional<Double> = Optional.ofNullable(logprob.getNullable("logprob"))
+        fun logprob(): Optional<Double> = logprob.getOptional("logprob")
 
         /**
          * Returns the raw JSON value of [token].

openai-java-core/src/main/kotlin/com/openai/models/audio/transcriptions/TranscriptionTextDoneEvent.kt

@@ -71,7 +71,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun logprobs(): Optional<List<Logprob>> = Optional.ofNullable(logprobs.getNullable("logprobs"))
+    fun logprobs(): Optional<List<Logprob>> = logprobs.getOptional("logprobs")
 
     /**
      * Returns the raw JSON value of [text].
@@ -282,23 +282,23 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun token(): Optional<String> = Optional.ofNullable(token.getNullable("token"))
+        fun token(): Optional<String> = token.getOptional("token")
 
         /**
          * The bytes that were used to generate the log probability.
          *
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun bytes(): Optional<List<JsonValue>> = Optional.ofNullable(bytes.getNullable("bytes"))
+        fun bytes(): Optional<List<JsonValue>> = bytes.getOptional("bytes")
 
         /**
          * The log probability of the token.
          *
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun logprob(): Optional<Double> = Optional.ofNullable(logprob.getNullable("logprob"))
+        fun logprob(): Optional<Double> = logprob.getOptional("logprob")
 
         /**
          * Returns the raw JSON value of [token].

openai-java-core/src/main/kotlin/com/openai/models/audio/transcriptions/TranscriptionVerbose.kt

@@ -75,16 +75,15 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun segments(): Optional<List<TranscriptionSegment>> =
-        Optional.ofNullable(segments.getNullable("segments"))
+    fun segments(): Optional<List<TranscriptionSegment>> = segments.getOptional("segments")
 
     /**
      * Extracted words and their corresponding timestamps.
      *
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun words(): Optional<List<TranscriptionWord>> = Optional.ofNullable(words.getNullable("words"))
+    fun words(): Optional<List<TranscriptionWord>> = words.getOptional("words")
 
     /**
      * Returns the raw JSON value of [duration].

openai-java-core/src/main/kotlin/com/openai/models/audio/translations/TranslationCreateParams.kt

@@ -435,7 +435,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun prompt(): Optional<String> = Optional.ofNullable(prompt.value.getNullable("prompt"))
+        fun prompt(): Optional<String> = prompt.value.getOptional("prompt")
 
         /**
          * The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`,
@@ -445,7 +445,7 @@ private constructor(
          *   server responded with an unexpected value).
          */
         fun responseFormat(): Optional<ResponseFormat> =
-            Optional.ofNullable(responseFormat.value.getNullable("response_format"))
+            responseFormat.value.getOptional("response_format")
 
         /**
          * The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output
@@ -457,8 +457,7 @@ private constructor(
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
          */
-        fun temperature(): Optional<Double> =
-            Optional.ofNullable(temperature.value.getNullable("temperature"))
+        fun temperature(): Optional<Double> = temperature.value.getOptional("temperature")
 
         /**
          * Returns the raw multipart value of [file].

openai-java-core/src/main/kotlin/com/openai/models/audio/translations/TranslationVerbose.kt

@@ -69,8 +69,7 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
-    fun segments(): Optional<List<TranscriptionSegment>> =
-        Optional.ofNullable(segments.getNullable("segments"))
+    fun segments(): Optional<List<TranscriptionSegment>> = segments.getOptional("segments")
 
     /**
      * Returns the raw JSON value of [duration].