feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 45
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-d31af54a2b29a3535df6342584c2511b59a10a7c11c9c983f1cf209199c6ed0e.yml
-openapi_spec_hash: 6643320491f28a8bca49846e1b718c70
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-47c01c819b97af4a1a342357c958d7072f88f43bfdc5885462f9330dcf99773c.yml
+openapi_spec_hash: 15b236a1f536d8fb2e4356ea57de0836
 config_hash: 53778a0b839c4f6ad34fbba051f5e8a6

finch-java-core/src/main/kotlin/com/tryfinch/api/models/IndividualInDirectory.kt

@@ -10,6 +10,7 @@ import com.tryfinch.api.core.ExcludeMissing
 import com.tryfinch.api.core.JsonField
 import com.tryfinch.api.core.JsonMissing
 import com.tryfinch.api.core.JsonValue
+import com.tryfinch.api.core.checkRequired
 import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Collections
 import java.util.Objects
@@ -46,10 +47,10 @@ private constructor(
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company.
      *
-     * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
-     *   server responded with an unexpected value).
+     * @throws FinchInvalidDataException 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(): Optional<String> = id.getOptional("id")
+    fun id(): String = id.getRequired("id")
 
     /**
      * The department object.
@@ -164,20 +165,33 @@ private constructor(
 
     companion object {
 
-        /** Returns a mutable builder for constructing an instance of [IndividualInDirectory]. */
+        /**
+         * Returns a mutable builder for constructing an instance of [IndividualInDirectory].
+         *
+         * The following fields are required:
+         * ```java
+         * .id()
+         * .department()
+         * .firstName()
+         * .isActive()
+         * .lastName()
+         * .manager()
+         * .middleName()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }
 
     /** A builder for [IndividualInDirectory]. */
     class Builder internal constructor() {
 
-        private var id: JsonField<String> = JsonMissing.of()
-        private var department: JsonField<Department> = JsonMissing.of()
-        private var firstName: JsonField<String> = JsonMissing.of()
-        private var isActive: JsonField<Boolean> = JsonMissing.of()
-        private var lastName: JsonField<String> = JsonMissing.of()
-        private var manager: JsonField<Manager> = JsonMissing.of()
-        private var middleName: JsonField<String> = JsonMissing.of()
+        private var id: JsonField<String>? = null
+        private var department: JsonField<Department>? = null
+        private var firstName: JsonField<String>? = null
+        private var isActive: JsonField<Boolean>? = null
+        private var lastName: JsonField<String>? = null
+        private var manager: JsonField<Manager>? = null
+        private var middleName: JsonField<String>? = null
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
@@ -321,16 +335,29 @@ private constructor(
          * Returns an immutable instance of [IndividualInDirectory].
          *
          * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .id()
+         * .department()
+         * .firstName()
+         * .isActive()
+         * .lastName()
+         * .manager()
+         * .middleName()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
          */
         fun build(): IndividualInDirectory =
             IndividualInDirectory(
-                id,
-                department,
-                firstName,
-                isActive,
-                lastName,
-                manager,
-                middleName,
+                checkRequired("id", id),
+                checkRequired("department", department),
+                checkRequired("firstName", firstName),
+                checkRequired("isActive", isActive),
+                checkRequired("lastName", lastName),
+                checkRequired("manager", manager),
+                checkRequired("middleName", middleName),
                 additionalProperties.toMutableMap(),
             )
     }
@@ -534,10 +561,10 @@ private constructor(
         /**
          * A stable Finch `id` (UUID v4) for an individual in the company.
          *
-         * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
-         *   server responded with an unexpected value).
+         * @throws FinchInvalidDataException 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(): Optional<String> = id.getOptional("id")
+        fun id(): String = id.getRequired("id")
 
         /**
          * Returns the raw JSON value of [id].
@@ -560,14 +587,21 @@ private constructor(
 
         companion object {
 
-            /** Returns a mutable builder for constructing an instance of [Manager]. */
+            /**
+             * Returns a mutable builder for constructing an instance of [Manager].
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
         /** A builder for [Manager]. */
         class Builder internal constructor() {
 
-            private var id: JsonField<String> = JsonMissing.of()
+            private var id: JsonField<String>? = null
             private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
             @JvmSynthetic
@@ -611,8 +645,16 @@ private constructor(
              * Returns an immutable instance of [Manager].
              *
              * Further updates to this [Builder] will not mutate the returned instance.
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * ```
+             *
+             * @throws IllegalStateException if any required field is unset.
              */
-            fun build(): Manager = Manager(id, additionalProperties.toMutableMap())
+            fun build(): Manager =
+                Manager(checkRequired("id", id), additionalProperties.toMutableMap())
         }
 
         private var validated: Boolean = false

finch-java-core/src/main/kotlin/com/tryfinch/api/models/Paging.kt

@@ -10,23 +10,32 @@ import com.tryfinch.api.core.ExcludeMissing
 import com.tryfinch.api.core.JsonField
 import com.tryfinch.api.core.JsonMissing
 import com.tryfinch.api.core.JsonValue
+import com.tryfinch.api.core.checkRequired
 import com.tryfinch.api.errors.FinchInvalidDataException
 import java.util.Collections
 import java.util.Objects
 import java.util.Optional
 
 class Paging
 private constructor(
-    private val count: JsonField<Long>,
     private val offset: JsonField<Long>,
+    private val count: JsonField<Long>,
     private val additionalProperties: MutableMap<String, JsonValue>,
 ) {
 
     @JsonCreator
     private constructor(
-        @JsonProperty("count") @ExcludeMissing count: JsonField<Long> = JsonMissing.of(),
         @JsonProperty("offset") @ExcludeMissing offset: JsonField<Long> = JsonMissing.of(),
-    ) : this(count, offset, mutableMapOf())
+        @JsonProperty("count") @ExcludeMissing count: JsonField<Long> = JsonMissing.of(),
+    ) : this(offset, count, mutableMapOf())
+
+    /**
+     * The current start index of the returned list of elements
+     *
+     * @throws FinchInvalidDataException 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 offset(): Long = offset.getRequired("offset")
 
     /**
      * The total number of elements for the entire query (not just the given page)
@@ -37,12 +46,11 @@ private constructor(
     fun count(): Optional<Long> = count.getOptional("count")
 
     /**
-     * The current start index of the returned list of elements
+     * Returns the raw JSON value of [offset].
      *
-     * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
-     *   server responded with an unexpected value).
+     * Unlike [offset], this method doesn't throw if the JSON field has an unexpected type.
      */
-    fun offset(): Optional<Long> = offset.getOptional("offset")
+    @JsonProperty("offset") @ExcludeMissing fun _offset(): JsonField<Long> = offset
 
     /**
      * Returns the raw JSON value of [count].
@@ -51,13 +59,6 @@ private constructor(
      */
     @JsonProperty("count") @ExcludeMissing fun _count(): JsonField<Long> = count
 
-    /**
-     * Returns the raw JSON value of [offset].
-     *
-     * Unlike [offset], this method doesn't throw if the JSON field has an unexpected type.
-     */
-    @JsonProperty("offset") @ExcludeMissing fun _offset(): JsonField<Long> = offset
-
     @JsonAnySetter
     private fun putAdditionalProperty(key: String, value: JsonValue) {
         additionalProperties.put(key, value)
@@ -72,45 +73,52 @@ private constructor(
 
     companion object {
 
-        /** Returns a mutable builder for constructing an instance of [Paging]. */
+        /**
+         * Returns a mutable builder for constructing an instance of [Paging].
+         *
+         * The following fields are required:
+         * ```java
+         * .offset()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }
 
     /** A builder for [Paging]. */
     class Builder internal constructor() {
 
+        private var offset: JsonField<Long>? = null
         private var count: JsonField<Long> = JsonMissing.of()
-        private var offset: JsonField<Long> = JsonMissing.of()
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
         internal fun from(paging: Paging) = apply {
-            count = paging.count
             offset = paging.offset
+            count = paging.count
             additionalProperties = paging.additionalProperties.toMutableMap()
         }
 
-        /** The total number of elements for the entire query (not just the given page) */
-        fun count(count: Long) = count(JsonField.of(count))
+        /** The current start index of the returned list of elements */
+        fun offset(offset: Long) = offset(JsonField.of(offset))
 
         /**
-         * Sets [Builder.count] to an arbitrary JSON value.
+         * Sets [Builder.offset] to an arbitrary JSON value.
          *
-         * You should usually call [Builder.count] with a well-typed [Long] value instead. This
+         * You should usually call [Builder.offset] with a well-typed [Long] value instead. This
          * method is primarily for setting the field to an undocumented or not yet supported value.
          */
-        fun count(count: JsonField<Long>) = apply { this.count = count }
+        fun offset(offset: JsonField<Long>) = apply { this.offset = offset }
 
-        /** The current start index of the returned list of elements */
-        fun offset(offset: Long) = offset(JsonField.of(offset))
+        /** The total number of elements for the entire query (not just the given page) */
+        fun count(count: Long) = count(JsonField.of(count))
 
         /**
-         * Sets [Builder.offset] to an arbitrary JSON value.
+         * Sets [Builder.count] to an arbitrary JSON value.
          *
-         * You should usually call [Builder.offset] with a well-typed [Long] value instead. This
+         * You should usually call [Builder.count] with a well-typed [Long] value instead. This
          * method is primarily for setting the field to an undocumented or not yet supported value.
          */
-        fun offset(offset: JsonField<Long>) = apply { this.offset = offset }
+        fun count(count: JsonField<Long>) = apply { this.count = count }
 
         fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
             this.additionalProperties.clear()
@@ -135,8 +143,16 @@ private constructor(
          * Returns an immutable instance of [Paging].
          *
          * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .offset()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
          */
-        fun build(): Paging = Paging(count, offset, additionalProperties.toMutableMap())
+        fun build(): Paging =
+            Paging(checkRequired("offset", offset), count, additionalProperties.toMutableMap())
     }
 
     private var validated: Boolean = false
@@ -146,8 +162,8 @@ private constructor(
             return@apply
         }
 
-        count()
         offset()
+        count()
         validated = true
     }
 
@@ -166,22 +182,22 @@ private constructor(
      */
     @JvmSynthetic
     internal fun validity(): Int =
-        (if (count.asKnown().isPresent) 1 else 0) + (if (offset.asKnown().isPresent) 1 else 0)
+        (if (offset.asKnown().isPresent) 1 else 0) + (if (count.asKnown().isPresent) 1 else 0)
 
     override fun equals(other: Any?): Boolean {
         if (this === other) {
             return true
         }
 
-        return /* spotless:off */ other is Paging && count == other.count && offset == other.offset && additionalProperties == other.additionalProperties /* spotless:on */
+        return /* spotless:off */ other is Paging && offset == other.offset && count == other.count && additionalProperties == other.additionalProperties /* spotless:on */
     }
 
     /* spotless:off */
-    private val hashCode: Int by lazy { Objects.hash(count, offset, additionalProperties) }
+    private val hashCode: Int by lazy { Objects.hash(offset, count, additionalProperties) }
     /* spotless:on */
 
     override fun hashCode(): Int = hashCode
 
     override fun toString() =
-        "Paging{count=$count, offset=$offset, additionalProperties=$additionalProperties}"
+        "Paging{offset=$offset, count=$count, additionalProperties=$additionalProperties}"
 }

finch-java-core/src/test/kotlin/com/tryfinch/api/models/DocumentListResponseTest.kt

@@ -22,7 +22,7 @@ internal class DocumentListResponseTest {
                         .year(0.0)
                         .build()
                 )
-                .paging(Paging.builder().count(0L).offset(0L).build())
+                .paging(Paging.builder().offset(0L).count(0L).build())
                 .build()
 
         assertThat(documentListResponse.documents())
@@ -36,7 +36,7 @@ internal class DocumentListResponseTest {
                     .build()
             )
         assertThat(documentListResponse.paging())
-            .isEqualTo(Paging.builder().count(0L).offset(0L).build())
+            .isEqualTo(Paging.builder().offset(0L).count(0L).build())
     }
 
     @Test
@@ -53,7 +53,7 @@ internal class DocumentListResponseTest {
                         .year(0.0)
                         .build()
                 )
-                .paging(Paging.builder().count(0L).offset(0L).build())
+                .paging(Paging.builder().offset(0L).count(0L).build())
                 .build()
 
         val roundtrippedDocumentListResponse =