fix(client): elide null named parameters

stainless-app[bot] · stainless-app[bot] · commit 7297553957c8 · 2025-08-21T04:05:03.000Z
diff --git a/README.md b/README.md
@@ -55,7 +55,6 @@ $client = new Client(
 $completedSmartscraper = $client->smartscraper->create(
   userPrompt: "Extract the product name, price, and description"
 );
-
 var_dump($completedSmartscraper->request_id);
 ```
 
diff --git a/src/Client.php b/src/Client.php
@@ -5,15 +5,15 @@
 namespace Scrapegraphai;
 
 use Scrapegraphai\Core\BaseClient;
-use Scrapegraphai\Crawl\CrawlService;
-use Scrapegraphai\Credits\CreditsService;
-use Scrapegraphai\Feedback\FeedbackService;
-use Scrapegraphai\GenerateSchema\GenerateSchemaService;
-use Scrapegraphai\Healthz\HealthzService;
-use Scrapegraphai\Markdownify\MarkdownifyService;
-use Scrapegraphai\Searchscraper\SearchscraperService;
-use Scrapegraphai\Smartscraper\SmartscraperService;
-use Scrapegraphai\Validate\ValidateService;
+use Scrapegraphai\Services\CrawlService;
+use Scrapegraphai\Services\CreditsService;
+use Scrapegraphai\Services\FeedbackService;
+use Scrapegraphai\Services\GenerateSchemaService;
+use Scrapegraphai\Services\HealthzService;
+use Scrapegraphai\Services\MarkdownifyService;
+use Scrapegraphai\Services\SearchscraperService;
+use Scrapegraphai\Services\SmartscraperService;
+use Scrapegraphai\Services\ValidateService;
 
 class Client extends BaseClient
 {
diff --git a/src/Core/Util.php b/src/Core/Util.php
@@ -349,6 +349,23 @@ public static function decodeContent(MessageInterface $rsp): mixed
         return self::streamIterator($body);
     }
 
+    /**
+     * @param array<string, mixed> $arr
+     * @param list<string> $keys
+     *
+     * @return array<string, mixed>
+     */
+    public static function array_filter_null(array $arr, array $keys): array
+    {
+        foreach ($keys as $key) {
+            if (array_key_exists($key, $arr) && is_null($arr[$key])) {
+                unset($arr[$key]);
+            }
+        }
+
+        return $arr;
+    }
+
     /**
      * @param list<callable> $closing
      *
diff --git a/src/Services/CrawlService.php b/src/Services/CrawlService.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Crawl;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\CrawlContract;
 use Scrapegraphai\Core\Conversion;
+use Scrapegraphai\Core\Util;
+use Scrapegraphai\Crawl\CrawlStartParams;
 use Scrapegraphai\Crawl\CrawlStartParams\Rules;
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\Crawl\CrawlGetResultsResponse;
@@ -60,19 +62,33 @@ public function start(
         $sitemap = null,
         ?RequestOptions $requestOptions = null,
     ): CrawlStartResponse {
-        [$parsed, $options] = CrawlStartParams::parseRequest(
+        $args = [
+            'url' => $url,
+            'depth' => $depth,
+            'extractionMode' => $extractionMode,
+            'maxPages' => $maxPages,
+            'prompt' => $prompt,
+            'renderHeavyJs' => $renderHeavyJs,
+            'rules' => $rules,
+            'schema' => $schema,
+            'sitemap' => $sitemap,
+        ];
+        $args = Util::array_filter_null(
+            $args,
             [
-                'url' => $url,
-                'depth' => $depth,
-                'extractionMode' => $extractionMode,
-                'maxPages' => $maxPages,
-                'prompt' => $prompt,
-                'renderHeavyJs' => $renderHeavyJs,
-                'rules' => $rules,
-                'schema' => $schema,
-                'sitemap' => $sitemap,
+                'depth',
+                'extractionMode',
+                'maxPages',
+                'prompt',
+                'renderHeavyJs',
+                'rules',
+                'schema',
+                'sitemap',
             ],
-            $requestOptions,
+        );
+        [$parsed, $options] = CrawlStartParams::parseRequest(
+            $args,
+            $requestOptions
         );
         $resp = $this->client->request(
             method: 'post',
diff --git a/src/Services/CreditsService.php b/src/Services/CreditsService.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Credits;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\CreditsContract;
diff --git a/src/Services/FeedbackService.php b/src/Services/FeedbackService.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Feedback;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\FeedbackContract;
 use Scrapegraphai\Core\Conversion;
+use Scrapegraphai\Core\Util;
+use Scrapegraphai\Feedback\FeedbackSubmitParams;
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\Feedback\FeedbackSubmitResponse;
 
@@ -27,13 +29,15 @@ public function submit(
         $feedbackText = null,
         ?RequestOptions $requestOptions = null,
     ): FeedbackSubmitResponse {
+        $args = [
+            'rating' => $rating,
+            'requestID' => $requestID,
+            'feedbackText' => $feedbackText,
+        ];
+        $args = Util::array_filter_null($args, ['feedbackText']);
         [$parsed, $options] = FeedbackSubmitParams::parseRequest(
-            [
-                'rating' => $rating,
-                'requestID' => $requestID,
-                'feedbackText' => $feedbackText,
-            ],
-            $requestOptions,
+            $args,
+            $requestOptions
         );
         $resp = $this->client->request(
             method: 'post',
diff --git a/src/Services/GenerateSchemaService.php b/src/Services/GenerateSchemaService.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\GenerateSchema;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\GenerateSchemaContract;
 use Scrapegraphai\Core\Conversion;
+use Scrapegraphai\Core\Util;
+use Scrapegraphai\GenerateSchema\GenerateSchemaCreateParams;
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\GenerateSchema\GenerateSchemaGetResponse;
 use Scrapegraphai\Responses\GenerateSchema\GenerateSchemaGetResponse\CompletedSchemaGenerationResponse;
@@ -29,9 +31,11 @@ public function create(
         $existingSchema = null,
         ?RequestOptions $requestOptions = null
     ): GenerateSchemaNewResponse {
+        $args = ['userPrompt' => $userPrompt, 'existingSchema' => $existingSchema];
+        $args = Util::array_filter_null($args, ['existingSchema']);
         [$parsed, $options] = GenerateSchemaCreateParams::parseRequest(
-            ['userPrompt' => $userPrompt, 'existingSchema' => $existingSchema],
-            $requestOptions,
+            $args,
+            $requestOptions
         );
         $resp = $this->client->request(
             method: 'post',
diff --git a/src/Services/HealthzService.php b/src/Services/HealthzService.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Healthz;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\HealthzContract;
diff --git a/src/Services/MarkdownifyService.php b/src/Services/MarkdownifyService.php
@@ -2,11 +2,14 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Markdownify;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\MarkdownifyContract;
 use Scrapegraphai\Core\Conversion;
+use Scrapegraphai\Core\Util;
+use Scrapegraphai\Markdownify\CompletedMarkdownify;
+use Scrapegraphai\Markdownify\MarkdownifyConvertParams;
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\Markdownify\MarkdownifyGetStatusResponse;
 use Scrapegraphai\Responses\Markdownify\MarkdownifyGetStatusResponse\FailedMarkdownifyResponse;
@@ -28,9 +31,13 @@ public function convert(
         $steps = null,
         ?RequestOptions $requestOptions = null,
     ): CompletedMarkdownify {
+        $args = [
+            'websiteURL' => $websiteURL, 'headers' => $headers, 'steps' => $steps,
+        ];
+        $args = Util::array_filter_null($args, ['headers', 'steps']);
         [$parsed, $options] = MarkdownifyConvertParams::parseRequest(
-            ['websiteURL' => $websiteURL, 'headers' => $headers, 'steps' => $steps],
-            $requestOptions,
+            $args,
+            $requestOptions
         );
         $resp = $this->client->request(
             method: 'post',
diff --git a/src/Services/SearchscraperService.php b/src/Services/SearchscraperService.php
@@ -2,14 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Searchscraper;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\SearchscraperContract;
 use Scrapegraphai\Core\Conversion;
+use Scrapegraphai\Core\Util;
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\Searchscraper\SearchscraperGetStatusResponse;
 use Scrapegraphai\Responses\Searchscraper\SearchscraperGetStatusResponse\FailedSearchScraperResponse;
+use Scrapegraphai\Searchscraper\CompletedSearchScraper;
+use Scrapegraphai\Searchscraper\SearchscraperCreateParams;
 
 final class SearchscraperService implements SearchscraperContract
 {
@@ -31,14 +34,19 @@ public function create(
         $outputSchema = null,
         ?RequestOptions $requestOptions = null,
     ): CompletedSearchScraper {
+        $args = [
+            'userPrompt' => $userPrompt,
+            'headers' => $headers,
+            'numResults' => $numResults,
+            'outputSchema' => $outputSchema,
+        ];
+        $args = Util::array_filter_null(
+            $args,
+            ['headers', 'numResults', 'outputSchema']
+        );
         [$parsed, $options] = SearchscraperCreateParams::parseRequest(
-            [
-                'userPrompt' => $userPrompt,
-                'headers' => $headers,
-                'numResults' => $numResults,
-                'outputSchema' => $outputSchema,
-            ],
-            $requestOptions,
+            $args,
+            $requestOptions
         );
         $resp = $this->client->request(
             method: 'post',
diff --git a/src/Services/SmartscraperService.php b/src/Services/SmartscraperService.php
@@ -2,14 +2,18 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Smartscraper;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\SmartscraperContract;
 use Scrapegraphai\Core\Conversion;
+use Scrapegraphai\Core\Util;
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Responses\Smartscraper\SmartscraperGetResponse;
 use Scrapegraphai\Responses\Smartscraper\SmartscraperListResponse;
+use Scrapegraphai\Smartscraper\CompletedSmartscraper;
+use Scrapegraphai\Smartscraper\FailedSmartscraper;
+use Scrapegraphai\Smartscraper\SmartscraperCreateParams;
 
 final class SmartscraperService implements SmartscraperContract
 {
@@ -43,20 +47,35 @@ public function create(
         $websiteURL = null,
         ?RequestOptions $requestOptions = null,
     ): CompletedSmartscraper {
-        [$parsed, $options] = SmartscraperCreateParams::parseRequest(
+        $args = [
+            'userPrompt' => $userPrompt,
+            'cookies' => $cookies,
+            'headers' => $headers,
+            'numberOfScrolls' => $numberOfScrolls,
+            'outputSchema' => $outputSchema,
+            'renderHeavyJs' => $renderHeavyJs,
+            'steps' => $steps,
+            'totalPages' => $totalPages,
+            'websiteHTML' => $websiteHTML,
+            'websiteURL' => $websiteURL,
+        ];
+        $args = Util::array_filter_null(
+            $args,
             [
-                'userPrompt' => $userPrompt,
-                'cookies' => $cookies,
-                'headers' => $headers,
-                'numberOfScrolls' => $numberOfScrolls,
-                'outputSchema' => $outputSchema,
-                'renderHeavyJs' => $renderHeavyJs,
-                'steps' => $steps,
-                'totalPages' => $totalPages,
-                'websiteHTML' => $websiteHTML,
-                'websiteURL' => $websiteURL,
+                'cookies',
+                'headers',
+                'numberOfScrolls',
+                'outputSchema',
+                'renderHeavyJs',
+                'steps',
+                'totalPages',
+                'websiteHTML',
+                'websiteURL',
             ],
-            $requestOptions,
+        );
+        [$parsed, $options] = SmartscraperCreateParams::parseRequest(
+            $args,
+            $requestOptions
         );
         $resp = $this->client->request(
             method: 'post',
diff --git a/src/Services/ValidateService.php b/src/Services/ValidateService.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Scrapegraphai\Validate;
+namespace Scrapegraphai\Services;
 
 use Scrapegraphai\Client;
 use Scrapegraphai\Contracts\ValidateContract;
diff --git a/tests/Resources/CrawlTest.php b/tests/Resources/CrawlTest.php
@@ -6,7 +6,6 @@
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 use Scrapegraphai\Client;
-use Scrapegraphai\Crawl\CrawlStartParams\Rules;
 use Tests\UnsupportedMockTests;
 
 /**
@@ -58,17 +57,7 @@ public function testStartWithOptionalParams(): void
             $this->markTestSkipped('Prism tests are disabled');
         }
 
-        $result = $this->client->crawl->start(
-            url: 'https://example.com',
-            depth: 0,
-            extractionMode: true,
-            maxPages: 1,
-            prompt: 'prompt',
-            renderHeavyJs: true,
-            rules: (new Rules)->withExclude(['string'])->withSameDomain(true),
-            schema: (object) [],
-            sitemap: true,
-        );
+        $result = $this->client->crawl->start(url: 'https://example.com');
 
         $this->assertTrue(true); // @phpstan-ignore-line
     }
diff --git a/tests/Resources/FeedbackTest.php b/tests/Resources/FeedbackTest.php
@@ -50,8 +50,7 @@ public function testSubmitWithOptionalParams(): void
 
         $result = $this->client->feedback->submit(
             rating: 0,
-            requestID: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-            feedbackText: 'feedback_text',
+            requestID: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'
         );
 
         $this->assertTrue(true); // @phpstan-ignore-line
diff --git a/tests/Resources/GenerateSchemaTest.php b/tests/Resources/GenerateSchemaTest.php
diff --git a/tests/Resources/MarkdownifyTest.php b/tests/Resources/MarkdownifyTest.php
diff --git a/tests/Resources/SearchscraperTest.php b/tests/Resources/SearchscraperTest.php
diff --git a/tests/Resources/SmartscraperTest.php b/tests/Resources/SmartscraperTest.php
