docs: note required fields in builder javadoc (#298)

Author: stainless-app[bot]

orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClient.kt

@@ -18,6 +18,7 @@ class OrbOkHttpClient private constructor() {
 
     companion object {
 
+        /** Returns a mutable builder for constructing an instance of [OrbOkHttpClient]. */
         @JvmStatic fun builder() = Builder()
 
         @JvmStatic fun fromEnv(): OrbClient = builder().fromEnv().build()

orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClientAsync.kt

@@ -18,6 +18,7 @@ class OrbOkHttpClientAsync private constructor() {
 
     companion object {
 
+        /** Returns a mutable builder for constructing an instance of [OrbOkHttpClientAsync]. */
         @JvmStatic fun builder() = Builder()
 
         @JvmStatic fun fromEnv(): OrbClientAsync = builder().fromEnv().build()

orb-java-core/src/main/kotlin/com/withorb/api/core/ClientOptions.kt

@@ -33,6 +33,15 @@ private constructor(
 
         const val PRODUCTION_URL = "https://api.withorb.com/v1"
 
+        /**
+         * Returns a mutable builder for constructing an instance of [ClientOptions].
+         *
+         * The following fields are required:
+         * ```java
+         * .httpClient()
+         * .apiKey()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
 
         @JvmStatic fun fromEnv(): ClientOptions = builder().fromEnv().build()

orb-java-core/src/main/kotlin/com/withorb/api/core/Timeout.kt

@@ -60,6 +60,7 @@ private constructor(
 
         @JvmStatic fun default() = builder().build()
 
+        /** Returns a mutable builder for constructing an instance of [Timeout]. */
         @JvmStatic fun builder() = Builder()
     }
 

orb-java-core/src/main/kotlin/com/withorb/api/errors/OrbError.kt

@@ -27,6 +27,7 @@ private constructor(
 
     companion object {
 
+        /** Returns a mutable builder for constructing an instance of [OrbError]. */
         @JvmStatic fun builder() = Builder()
     }
 

orb-java-core/src/main/kotlin/com/withorb/api/models/Alert.kt

@@ -154,6 +154,23 @@ private constructor(
 
     companion object {
 
+        /**
+         * Returns a mutable builder for constructing an instance of [Alert].
+         *
+         * The following fields are required:
+         * ```java
+         * .id()
+         * .createdAt()
+         * .currency()
+         * .customer()
+         * .enabled()
+         * .metric()
+         * .plan()
+         * .subscription()
+         * .thresholds()
+         * .type()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }
 
@@ -358,6 +375,15 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Customer].
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * .externalCustomerId()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
@@ -467,6 +493,14 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Metric].
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
@@ -598,6 +632,17 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Plan].
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * .externalPlanId()
+             * .name()
+             * .planVersion()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
@@ -742,6 +787,14 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Subscription].
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
@@ -846,6 +899,14 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Threshold].
+             *
+             * The following fields are required:
+             * ```java
+             * .value()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertCreateForCustomerParams.kt

@@ -135,6 +135,15 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Body].
+             *
+             * The following fields are required:
+             * ```java
+             * .currency()
+             * .type()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
@@ -237,6 +246,16 @@ private constructor(
 
     companion object {
 
+        /**
+         * Returns a mutable builder for constructing an instance of [AlertCreateForCustomerParams].
+         *
+         * The following fields are required:
+         * ```java
+         * .customerId()
+         * .currency()
+         * .type()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }
 
@@ -572,6 +591,14 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Threshold].
+             *
+             * The following fields are required:
+             * ```java
+             * .value()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertCreateForExternalCustomerParams.kt

@@ -135,6 +135,15 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Body].
+             *
+             * The following fields are required:
+             * ```java
+             * .currency()
+             * .type()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
@@ -237,6 +246,17 @@ private constructor(
 
     companion object {
 
+        /**
+         * Returns a mutable builder for constructing an instance of
+         * [AlertCreateForExternalCustomerParams].
+         *
+         * The following fields are required:
+         * ```java
+         * .externalCustomerId()
+         * .currency()
+         * .type()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }
 
@@ -577,6 +597,14 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Threshold].
+             *
+             * The following fields are required:
+             * ```java
+             * .value()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertCreateForSubscriptionParams.kt

@@ -138,6 +138,15 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Body].
+             *
+             * The following fields are required:
+             * ```java
+             * .thresholds()
+             * .type()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 
@@ -238,6 +247,17 @@ private constructor(
 
     companion object {
 
+        /**
+         * Returns a mutable builder for constructing an instance of
+         * [AlertCreateForSubscriptionParams].
+         *
+         * The following fields are required:
+         * ```java
+         * .subscriptionId()
+         * .thresholds()
+         * .type()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }
 
@@ -459,6 +479,14 @@ private constructor(
 
         companion object {
 
+            /**
+             * Returns a mutable builder for constructing an instance of [Threshold].
+             *
+             * The following fields are required:
+             * ```java
+             * .value()
+             * ```
+             */
             @JvmStatic fun builder() = Builder()
         }
 

orb-java-core/src/main/kotlin/com/withorb/api/models/AlertDisableParams.kt

@@ -61,6 +61,14 @@ private constructor(
 
     companion object {
 
+        /**
+         * Returns a mutable builder for constructing an instance of [AlertDisableParams].
+         *
+         * The following fields are required:
+         * ```java
+         * .alertConfigurationId()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }