chore: simplify model initialization

stainless-app[bot] · stainless-app[bot] · commit 4a166fcc6584 · 2025-08-30T02:55:22.000Z
diff --git a/src/Core/Concerns/SdkModel.php b/src/Core/Concerns/SdkModel.php
@@ -50,6 +50,8 @@ public function __unserialize(array $data): void
     }
 
     /**
+     * @internal
+     *
      * @return array<string, mixed>
      */
     public function __debugInfo(): array
@@ -135,8 +137,6 @@ public function offsetExists(mixed $offset): bool
      * @internal
      *
      * @param key-of<Shape> $offset
-     *
-     * @return value-of<Shape>
      */
     public function &offsetGet(mixed $offset): mixed
     {
@@ -205,6 +205,8 @@ public function offsetUnset(mixed $offset): void
     }
 
     /**
+     * @internal
+     *
      * @return array<string, mixed>
      */
     public function jsonSerialize(): array
@@ -238,16 +240,10 @@ public static function converter(): Converter
     /**
      * @internal
      */
-    public static function introspect(): void
+    private function initialize(): void
     {
         static::converter();
-    }
 
-    /**
-     * @internal
-     */
-    private function unsetOptionalProperties(): void
-    {
         foreach (self::$converter->properties as $name => $info) {
             if ($info->optional) {
                 unset($this->{$name});
diff --git a/src/Core/Concerns/SdkPage.php b/src/Core/Concerns/SdkPage.php
@@ -70,7 +70,7 @@ public function getNextPage(): static
     }
 
     /**
-     * Generator yielding each page (instance of static).
+     * Iterator yielding each page (instance of static).
      *
      * @return \Generator<static>
      */
@@ -87,7 +87,7 @@ public function getIterator(): \Generator
     }
 
     /**
-     * Generator yielding each item across all pages.
+     * Iterator yielding each item across all pages.
      *
      * @return \Generator<Item>
      */
@@ -101,13 +101,17 @@ public function pagingEachItem(): \Generator
     }
 
     /**
+     * @internal
+     *
      * @param array<string, mixed> $data
      *
      * @return static<Item>
      */
     abstract public static function fromArray(array $data): static;
 
     /**
+     * @internal
+     *
      * @return array{normalized_request, RequestOptions}
      */
     abstract protected function nextRequest(): ?array;
diff --git a/src/Core/Services/CrawlService.php b/src/Core/Services/CrawlService.php
@@ -16,6 +16,9 @@
 
 final class CrawlService implements CrawlContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/CreditsService.php b/src/Core/Services/CreditsService.php
@@ -11,6 +11,9 @@
 
 final class CreditsService implements CreditsContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/FeedbackService.php b/src/Core/Services/FeedbackService.php
@@ -14,6 +14,9 @@
 
 final class FeedbackService implements FeedbackContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/GenerateSchemaService.php b/src/Core/Services/GenerateSchemaService.php
@@ -17,6 +17,9 @@
 
 final class GenerateSchemaService implements GenerateSchemaContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/HealthzService.php b/src/Core/Services/HealthzService.php
@@ -11,6 +11,9 @@
 
 final class HealthzService implements HealthzContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/MarkdownifyService.php b/src/Core/Services/MarkdownifyService.php
@@ -16,6 +16,9 @@
 
 final class MarkdownifyService implements MarkdownifyContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/SearchscraperService.php b/src/Core/Services/SearchscraperService.php
@@ -16,6 +16,9 @@
 
 final class SearchscraperService implements SearchscraperContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/SmartscraperService.php b/src/Core/Services/SmartscraperService.php
@@ -17,6 +17,9 @@
 
 final class SmartscraperService implements SmartscraperContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Core/Services/ValidateService.php b/src/Core/Services/ValidateService.php
@@ -11,6 +11,9 @@
 
 final class ValidateService implements ValidateContract
 {
+    /**
+     * @internal
+     */
     public function __construct(private Client $client) {}
 
     /**
diff --git a/src/Crawl/CrawlGetResultsResponse.php b/src/Crawl/CrawlGetResultsResponse.php
@@ -46,8 +46,7 @@ final class CrawlGetResultsResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Crawl/CrawlStartParams.php b/src/Crawl/CrawlStartParams.php
@@ -102,8 +102,7 @@ final class CrawlStartParams implements BaseModel
      */
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Crawl/CrawlStartParams/Rules.php b/src/Crawl/CrawlStartParams/Rules.php
@@ -34,8 +34,7 @@ final class Rules implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Crawl/CrawlStartResponse.php b/src/Crawl/CrawlStartResponse.php
@@ -24,8 +24,7 @@ final class CrawlStartResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Credits/CreditGetResponse.php b/src/Credits/CreditGetResponse.php
@@ -32,8 +32,7 @@ final class CreditGetResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Feedback/FeedbackSubmitParams.php b/src/Feedback/FeedbackSubmitParams.php
@@ -58,8 +58,7 @@ final class FeedbackSubmitParams implements BaseModel
      */
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Feedback/FeedbackSubmitResponse.php b/src/Feedback/FeedbackSubmitResponse.php
@@ -35,8 +35,7 @@ final class FeedbackSubmitResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/GenerateSchema/GenerateSchemaCreateParams.php b/src/GenerateSchema/GenerateSchemaCreateParams.php
@@ -53,8 +53,7 @@ final class GenerateSchemaCreateParams implements BaseModel
      */
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/GenerateSchema/GenerateSchemaGetResponse/CompletedSchemaGenerationResponse.php b/src/GenerateSchema/GenerateSchemaGetResponse/CompletedSchemaGenerationResponse.php
@@ -45,8 +45,7 @@ final class CompletedSchemaGenerationResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/GenerateSchema/GenerateSchemaGetResponse/FailedSchemaGenerationResponse.php b/src/GenerateSchema/GenerateSchemaGetResponse/FailedSchemaGenerationResponse.php
@@ -45,8 +45,7 @@ final class FailedSchemaGenerationResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/GenerateSchema/GenerateSchemaNewResponse.php b/src/GenerateSchema/GenerateSchemaNewResponse.php
@@ -51,8 +51,7 @@ final class GenerateSchemaNewResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Healthz/HealthzCheckResponse.php b/src/Healthz/HealthzCheckResponse.php
@@ -27,8 +27,7 @@ final class HealthzCheckResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Markdownify/CompletedMarkdownify.php b/src/Markdownify/CompletedMarkdownify.php
@@ -44,8 +44,7 @@ final class CompletedMarkdownify implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Markdownify/MarkdownifyConvertParams.php b/src/Markdownify/MarkdownifyConvertParams.php
@@ -58,8 +58,7 @@ final class MarkdownifyConvertParams implements BaseModel
      */
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Markdownify/MarkdownifyGetStatusResponse/FailedMarkdownifyResponse.php b/src/Markdownify/MarkdownifyGetStatusResponse/FailedMarkdownifyResponse.php
@@ -41,8 +41,7 @@ final class FailedMarkdownifyResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/RequestOptions.php b/src/RequestOptions.php
@@ -89,8 +89,7 @@ public function __construct(
         ?StreamFactoryInterface $streamFactory = null,
         ?RequestFactoryInterface $requestFactory = null,
     ) {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
 
         null !== $timeout && $this->timeout = $timeout;
         null !== $maxRetries && $this->maxRetries = $maxRetries;
diff --git a/src/Searchscraper/CompletedSearchScraper.php b/src/Searchscraper/CompletedSearchScraper.php
@@ -57,8 +57,7 @@ final class CompletedSearchScraper implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Searchscraper/SearchscraperCreateParams.php b/src/Searchscraper/SearchscraperCreateParams.php
@@ -66,8 +66,7 @@ final class SearchscraperCreateParams implements BaseModel
      */
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Searchscraper/SearchscraperGetStatusResponse/FailedSearchScraperResponse.php b/src/Searchscraper/SearchscraperGetStatusResponse/FailedSearchScraperResponse.php
@@ -50,8 +50,7 @@ final class FailedSearchScraperResponse implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Smartscraper/CompletedSmartscraper.php b/src/Smartscraper/CompletedSmartscraper.php
@@ -58,8 +58,7 @@ final class CompletedSmartscraper implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Smartscraper/FailedSmartscraper.php b/src/Smartscraper/FailedSmartscraper.php
@@ -48,8 +48,7 @@ final class FailedSmartscraper implements BaseModel
 
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Smartscraper/SmartscraperCreateParams.php b/src/Smartscraper/SmartscraperCreateParams.php
@@ -116,8 +116,7 @@ final class SmartscraperCreateParams implements BaseModel
      */
     public function __construct()
     {
-        self::introspect();
-        $this->unsetOptionalProperties();
+        $this->initialize();
     }
 
     /**
diff --git a/src/Validate/ValidateAPIKeyResponse.php b/src/Validate/ValidateAPIKeyResponse.php
diff --git a/tests/Core/TestModel.php b/tests/Core/TestModel.php

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public function getNextPage(): static`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`/**`
`73`		`- * Generator yielding each page (instance of static).`
	`73`	`+ * Iterator yielding each page (instance of static).`
`74`	`74`	`*`
`75`	`75`	`* @return \Generator<static>`
`76`	`76`	`*/`
`@@ -87,7 +87,7 @@ public function getIterator(): \Generator`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`/**`
`90`		`- * Generator yielding each item across all pages.`
	`90`	`+ * Iterator yielding each item across all pages.`
`91`	`91`	`*`
`92`	`92`	`* @return \Generator<Item>`
`93`	`93`	`*/`
`@@ -101,13 +101,17 @@ public function pagingEachItem(): \Generator`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`/**`
	`104`	`+ * @internal`
	`105`	`+ *`
`104`	`106`	`* @param array<string, mixed> $data`
`105`	`107`	`*`
`106`	`108`	`* @return static<Item>`
`107`	`109`	`*/`
`108`	`110`	`abstract public static function fromArray(array $data): static;`
`109`	`111`
`110`	`112`	`/**`
	`113`	`+ * @internal`
	`114`	`+ *`
`111`	`115`	`* @return array{normalized_request, RequestOptions}`
`112`	`116`	`*/`
`113`	`117`	`abstract protected function nextRequest(): ?array;`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@`
`16`	`16`
`17`	`17`	`final class CrawlService implements CrawlContract`
`18`	`18`	`{`
	`19`	`+ /**`
	`20`	`+ * @internal`
	`21`	`+ */`
`19`	`22`	`public function __construct(private Client $client) {}`
`20`	`23`
`21`	`24`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@`
`11`	`11`
`12`	`12`	`final class CreditsService implements CreditsContract`
`13`	`13`	`{`
	`14`	`+ /**`
	`15`	`+ * @internal`
	`16`	`+ */`
`14`	`17`	`public function __construct(private Client $client) {}`
`15`	`18`
`16`	`19`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@`
`14`	`14`
`15`	`15`	`final class FeedbackService implements FeedbackContract`
`16`	`16`	`{`
	`17`	`+ /**`
	`18`	`+ * @internal`
	`19`	`+ */`
`17`	`20`	`public function __construct(private Client $client) {}`
`18`	`21`
`19`	`22`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,9 @@`
`17`	`17`
`18`	`18`	`final class GenerateSchemaService implements GenerateSchemaContract`
`19`	`19`	`{`
	`20`	`+ /**`
	`21`	`+ * @internal`
	`22`	`+ */`
`20`	`23`	`public function __construct(private Client $client) {}`
`21`	`24`
`22`	`25`	`/**`