fix(api): guarantee search descriptions and align response types (#1089)

Stainless-Generated-From: 7c35f68569d5bf7fec90ee8e651f7329920a5831

Author: stlc-bot

src/Brand/BrandGetResponse.php

@@ -13,48 +13,54 @@
 use ContextDev\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-import-type CacheMetadataShape from \ContextDev\Brand\BrandGetResponse\CacheMetadata
  * @phpstan-import-type BrandShape from \ContextDev\Brand\BrandGetResponse\Brand
+ * @phpstan-import-type CacheMetadataShape from \ContextDev\Brand\BrandGetResponse\CacheMetadata
  * @phpstan-import-type KeyMetadataShape from \ContextDev\Brand\BrandGetResponse\KeyMetadata
  *
  * @phpstan-type BrandGetResponseShape = array{
+ *   brand: Brand|BrandShape,
  *   cacheMetadata: CacheMetadata|CacheMetadataShape,
+ *   code: int,
  *   requestID: string,
- *   brand?: null|Brand|BrandShape,
- *   code?: int|null,
+ *   status: string,
  *   keyMetadata?: null|KeyMetadata|KeyMetadataShape,
  *   partial?: bool|null,
- *   status?: string|null,
  * }
  */
 final class BrandGetResponse implements BaseModel
 {
     /** @use SdkModel<BrandGetResponseShape> */
     use SdkModel;
 
+    /**
+     * Detailed brand information.
+     */
+    #[Required]
+    public Brand $brand;
+
     /**
      * Cache outcome for this response. Composite responses are hits only when every cache-controlled fetch contributing to the output was a hit; age_ms is the oldest contributing hit.
      */
     #[Required('cache_metadata')]
     public CacheMetadata $cacheMetadata;
 
     /**
-     * Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.
+     * HTTP status code.
      */
-    #[Required('request_id')]
-    public string $requestID;
+    #[Required]
+    public int $code;
 
     /**
-     * Detailed brand information.
+     * Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.
      */
-    #[Optional]
-    public ?Brand $brand;
+    #[Required('request_id')]
+    public string $requestID;
 
     /**
-     * HTTP status code.
+     * Status of the response, e.g., 'ok'.
      */
-    #[Optional]
-    public ?int $code;
+    #[Required]
+    public string $status;
 
     /**
      * Credit usage, included whenever a valid API key is provided.
@@ -68,24 +74,25 @@ final class BrandGetResponse implements BaseModel
     #[Optional]
     public ?bool $partial;
 
-    /**
-     * Status of the response, e.g., 'ok'.
-     */
-    #[Optional]
-    public ?string $status;
-
     /**
      * `new BrandGetResponse()` is missing required properties by the API.
      *
      * To enforce required parameters use
      * ```
-     * BrandGetResponse::with(cacheMetadata: ..., requestID: ...)
+     * BrandGetResponse::with(
+     *   brand: ..., cacheMetadata: ..., code: ..., requestID: ..., status: ...
+     * )
      * ```
      *
      * Otherwise ensure the following setters are called
      *
      * ```
-     * (new BrandGetResponse)->withCacheMetadata(...)->withRequestID(...)
+     * (new BrandGetResponse)
+     *   ->withBrand(...)
+     *   ->withCacheMetadata(...)
+     *   ->withCode(...)
+     *   ->withRequestID(...)
+     *   ->withStatus(...)
      * ```
      */
     public function __construct()
@@ -98,29 +105,42 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      *
+     * @param Brand|BrandShape $brand
      * @param CacheMetadata|CacheMetadataShape $cacheMetadata
-     * @param Brand|BrandShape|null $brand
      * @param KeyMetadata|KeyMetadataShape|null $keyMetadata
      */
     public static function with(
+        Brand|array $brand,
         CacheMetadata|array $cacheMetadata,
+        int $code,
         string $requestID,
-        Brand|array|null $brand = null,
-        ?int $code = null,
+        string $status,
         KeyMetadata|array|null $keyMetadata = null,
         ?bool $partial = null,
-        ?string $status = null,
     ): self {
         $self = new self;
 
+        $self['brand'] = $brand;
         $self['cacheMetadata'] = $cacheMetadata;
+        $self['code'] = $code;
         $self['requestID'] = $requestID;
+        $self['status'] = $status;
 
-        null !== $brand && $self['brand'] = $brand;
-        null !== $code && $self['code'] = $code;
         null !== $keyMetadata && $self['keyMetadata'] = $keyMetadata;
         null !== $partial && $self['partial'] = $partial;
-        null !== $status && $self['status'] = $status;
+
+        return $self;
+    }
+
+    /**
+     * Detailed brand information.
+     *
+     * @param Brand|BrandShape $brand
+     */
+    public function withBrand(Brand|array $brand): self
+    {
+        $self = clone $this;
+        $self['brand'] = $brand;
 
         return $self;
     }
@@ -139,36 +159,34 @@ public function withCacheMetadata(CacheMetadata|array $cacheMetadata): self
     }
 
     /**
-     * Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.
+     * HTTP status code.
      */
-    public function withRequestID(string $requestID): self
+    public function withCode(int $code): self
     {
         $self = clone $this;
-        $self['requestID'] = $requestID;
+        $self['code'] = $code;
 
         return $self;
     }
 
     /**
-     * Detailed brand information.
-     *
-     * @param Brand|BrandShape $brand
+     * Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.
      */
-    public function withBrand(Brand|array $brand): self
+    public function withRequestID(string $requestID): self
     {
         $self = clone $this;
-        $self['brand'] = $brand;
+        $self['requestID'] = $requestID;
 
         return $self;
     }
 
     /**
-     * HTTP status code.
+     * Status of the response, e.g., 'ok'.
      */
-    public function withCode(int $code): self
+    public function withStatus(string $status): self
     {
         $self = clone $this;
-        $self['code'] = $code;
+        $self['status'] = $status;
 
         return $self;
     }
@@ -196,15 +214,4 @@ public function withPartial(bool $partial): self
 
         return $self;
     }
-
-    /**
-     * Status of the response, e.g., 'ok'.
-     */
-    public function withStatus(string $status): self
-    {
-        $self = clone $this;
-        $self['status'] = $status;
-
-        return $self;
-    }
 }