feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 15
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-863ddc13e032497459a639cf02a16349831dda7e39557cbd5ce33da34d086b02.yml
-openapi_spec_hash: f972aac9618fe8df340d96344b3d0578
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/brand-dev%2Fbrand.dev-737dbedd830e2c989387e90a9bb5baa3915306ecfef2e46b09d02cb1879f043c.yml
+openapi_spec_hash: 7bc21f4c6d5fd39c1a3b22626846ca87
 config_hash: 6f10592c7d0c3bafefc1271472283217

README.md

@@ -318,7 +318,9 @@ To set a custom timeout, configure the method call using the `timeout` method:
 ```java
 import com.branddev.api.models.brand.BrandRetrieveResponse;
 
-BrandRetrieveResponse brand = client.brand().retrieve(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());
+BrandRetrieveResponse brand = client.brand().retrieve(
+  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
+);
 ```
 
 Or configure the default for all method calls at the client level:
@@ -502,10 +504,9 @@ To forcibly omit a required parameter or property, pass [`JsonMissing`](brand-de
 
 ```java
 import com.branddev.api.core.JsonMissing;
-import com.branddev.api.models.brand.BrandAiProductsParams;
 import com.branddev.api.models.brand.BrandRetrieveParams;
 
-BrandRetrieveParams params = BrandAiProductsParams.builder()
+BrandRetrieveParams params = BrandRetrieveParams.builder()
     .domain(JsonMissing.of())
     .build();
 ```
@@ -583,7 +584,9 @@ Or configure the method call to validate the response using the `responseValidat
 ```java
 import com.branddev.api.models.brand.BrandRetrieveResponse;
 
-BrandRetrieveResponse brand = client.brand().retrieve(RequestOptions.builder().responseValidation(true).build());
+BrandRetrieveResponse brand = client.brand().retrieve(
+  params, RequestOptions.builder().responseValidation(true).build()
+);
 ```
 
 Or configure the default for all method calls at the client level:

brand-dev-java-core/src/main/kotlin/com/branddev/api/models/brand/BrandRetrieveParams.kt

@@ -5,6 +5,7 @@ package com.branddev.api.models.brand
 import com.branddev.api.core.Enum
 import com.branddev.api.core.JsonField
 import com.branddev.api.core.Params
+import com.branddev.api.core.checkRequired
 import com.branddev.api.core.http.Headers
 import com.branddev.api.core.http.QueryParams
 import com.branddev.api.errors.BrandDevInvalidDataException
@@ -16,7 +17,7 @@ import kotlin.jvm.optionals.getOrNull
 /** Retrieve logos, backdrops, colors, industry, description, and more from any domain */
 class BrandRetrieveParams
 private constructor(
-    private val domain: String?,
+    private val domain: String,
     private val forceLanguage: ForceLanguage?,
     private val maxSpeed: Boolean?,
     private val timeoutMs: Long?,
@@ -28,7 +29,7 @@ private constructor(
      * Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cannot be used
      * with name or ticker parameters.
      */
-    fun domain(): Optional<String> = Optional.ofNullable(domain)
+    fun domain(): String = domain
 
     /**
      * Optional parameter to force the language of the retrieved brand data. Works with all three
@@ -60,9 +61,14 @@ private constructor(
 
     companion object {
 
-        @JvmStatic fun none(): BrandRetrieveParams = builder().build()
-
-        /** Returns a mutable builder for constructing an instance of [BrandRetrieveParams]. */
+        /**
+         * Returns a mutable builder for constructing an instance of [BrandRetrieveParams].
+         *
+         * The following fields are required:
+         * ```java
+         * .domain()
+         * ```
+         */
         @JvmStatic fun builder() = Builder()
     }
 
@@ -90,10 +96,7 @@ private constructor(
          * Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cannot be
          * used with name or ticker parameters.
          */
-        fun domain(domain: String?) = apply { this.domain = domain }
-
-        /** Alias for calling [Builder.domain] with `domain.orElse(null)`. */
-        fun domain(domain: Optional<String>) = domain(domain.getOrNull())
+        fun domain(domain: String) = apply { this.domain = domain }
 
         /**
          * Optional parameter to force the language of the retrieved brand data. Works with all
@@ -243,10 +246,17 @@ private constructor(
          * Returns an immutable instance of [BrandRetrieveParams].
          *
          * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .domain()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
          */
         fun build(): BrandRetrieveParams =
             BrandRetrieveParams(
-                domain,
+                checkRequired("domain", domain),
                 forceLanguage,
                 maxSpeed,
                 timeoutMs,
@@ -260,7 +270,7 @@ private constructor(
     override fun _queryParams(): QueryParams =
         QueryParams.builder()
             .apply {
-                domain?.let { put("domain", it) }
+                put("domain", domain)
                 forceLanguage?.let { put("force_language", it.toString()) }
                 maxSpeed?.let { put("maxSpeed", it.toString()) }
                 timeoutMs?.let { put("timeoutMS", it.toString()) }

brand-dev-java-core/src/main/kotlin/com/branddev/api/services/async/BrandServiceAsync.kt

@@ -53,23 +53,15 @@ interface BrandServiceAsync {
     fun withOptions(modifier: Consumer<ClientOptions.Builder>): BrandServiceAsync
 
     /** Retrieve logos, backdrops, colors, industry, description, and more from any domain */
-    fun retrieve(): CompletableFuture<BrandRetrieveResponse> = retrieve(BrandRetrieveParams.none())
+    fun retrieve(params: BrandRetrieveParams): CompletableFuture<BrandRetrieveResponse> =
+        retrieve(params, RequestOptions.none())
 
     /** @see retrieve */
     fun retrieve(
-        params: BrandRetrieveParams = BrandRetrieveParams.none(),
+        params: BrandRetrieveParams,
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<BrandRetrieveResponse>
 
-    /** @see retrieve */
-    fun retrieve(
-        params: BrandRetrieveParams = BrandRetrieveParams.none()
-    ): CompletableFuture<BrandRetrieveResponse> = retrieve(params, RequestOptions.none())
-
-    /** @see retrieve */
-    fun retrieve(requestOptions: RequestOptions): CompletableFuture<BrandRetrieveResponse> =
-        retrieve(BrandRetrieveParams.none(), requestOptions)
-
     /**
      * Beta feature: Extract product information from a brand's website. Brand.dev will analyze the
      * website and return a list of products with details such as name, description, image, pricing,
@@ -290,26 +282,16 @@ interface BrandServiceAsync {
          * Returns a raw HTTP response for `get /brand/retrieve`, but is otherwise the same as
          * [BrandServiceAsync.retrieve].
          */
-        fun retrieve(): CompletableFuture<HttpResponseFor<BrandRetrieveResponse>> =
-            retrieve(BrandRetrieveParams.none())
-
-        /** @see retrieve */
         fun retrieve(
-            params: BrandRetrieveParams = BrandRetrieveParams.none(),
-            requestOptions: RequestOptions = RequestOptions.none(),
-        ): CompletableFuture<HttpResponseFor<BrandRetrieveResponse>>
-
-        /** @see retrieve */
-        fun retrieve(
-            params: BrandRetrieveParams = BrandRetrieveParams.none()
+            params: BrandRetrieveParams
         ): CompletableFuture<HttpResponseFor<BrandRetrieveResponse>> =
             retrieve(params, RequestOptions.none())
 
         /** @see retrieve */
         fun retrieve(
-            requestOptions: RequestOptions
-        ): CompletableFuture<HttpResponseFor<BrandRetrieveResponse>> =
-            retrieve(BrandRetrieveParams.none(), requestOptions)
+            params: BrandRetrieveParams,
+            requestOptions: RequestOptions = RequestOptions.none(),
+        ): CompletableFuture<HttpResponseFor<BrandRetrieveResponse>>
 
         /**
          * Returns a raw HTTP response for `post /brand/ai/products`, but is otherwise the same as

brand-dev-java-core/src/main/kotlin/com/branddev/api/services/blocking/BrandService.kt

@@ -53,22 +53,15 @@ interface BrandService {
     fun withOptions(modifier: Consumer<ClientOptions.Builder>): BrandService
 
     /** Retrieve logos, backdrops, colors, industry, description, and more from any domain */
-    fun retrieve(): BrandRetrieveResponse = retrieve(BrandRetrieveParams.none())
+    fun retrieve(params: BrandRetrieveParams): BrandRetrieveResponse =
+        retrieve(params, RequestOptions.none())
 
     /** @see retrieve */
     fun retrieve(
-        params: BrandRetrieveParams = BrandRetrieveParams.none(),
+        params: BrandRetrieveParams,
         requestOptions: RequestOptions = RequestOptions.none(),
     ): BrandRetrieveResponse
 
-    /** @see retrieve */
-    fun retrieve(params: BrandRetrieveParams = BrandRetrieveParams.none()): BrandRetrieveResponse =
-        retrieve(params, RequestOptions.none())
-
-    /** @see retrieve */
-    fun retrieve(requestOptions: RequestOptions): BrandRetrieveResponse =
-        retrieve(BrandRetrieveParams.none(), requestOptions)
-
     /**
      * Beta feature: Extract product information from a brand's website. Brand.dev will analyze the
      * website and return a list of products with details such as name, description, image, pricing,
@@ -273,27 +266,16 @@ interface BrandService {
          * [BrandService.retrieve].
          */
         @MustBeClosed
-        fun retrieve(): HttpResponseFor<BrandRetrieveResponse> =
-            retrieve(BrandRetrieveParams.none())
+        fun retrieve(params: BrandRetrieveParams): HttpResponseFor<BrandRetrieveResponse> =
+            retrieve(params, RequestOptions.none())
 
         /** @see retrieve */
         @MustBeClosed
         fun retrieve(
-            params: BrandRetrieveParams = BrandRetrieveParams.none(),
+            params: BrandRetrieveParams,
             requestOptions: RequestOptions = RequestOptions.none(),
         ): HttpResponseFor<BrandRetrieveResponse>
 
-        /** @see retrieve */
-        @MustBeClosed
-        fun retrieve(
-            params: BrandRetrieveParams = BrandRetrieveParams.none()
-        ): HttpResponseFor<BrandRetrieveResponse> = retrieve(params, RequestOptions.none())
-
-        /** @see retrieve */
-        @MustBeClosed
-        fun retrieve(requestOptions: RequestOptions): HttpResponseFor<BrandRetrieveResponse> =
-            retrieve(BrandRetrieveParams.none(), requestOptions)
-
         /**
          * Returns a raw HTTP response for `post /brand/ai/products`, but is otherwise the same as
          * [BrandService.aiProducts].

brand-dev-java-core/src/test/kotlin/com/branddev/api/models/brand/BrandRetrieveParamsTest.kt

@@ -43,10 +43,10 @@ internal class BrandRetrieveParamsTest {
 
     @Test
     fun queryParamsWithoutOptionalFields() {
-        val params = BrandRetrieveParams.builder().build()
+        val params = BrandRetrieveParams.builder().domain("domain").build()
 
         val queryParams = params._queryParams()
 
-        assertThat(queryParams).isEqualTo(QueryParams.builder().build())
+        assertThat(queryParams).isEqualTo(QueryParams.builder().put("domain", "domain").build())
     }
 }