feat(client): use with for constructors

Author: stainless-app[bot]

README.md

@@ -50,7 +50,7 @@ $client = new Client(
   environment: "environment_1",
 );
 
-$params = SmartscraperCreateParams::from(
+$params = SmartscraperCreateParams::with(
   userPrompt: "Extract the product name, price, and description"
 );
 $completedSmartscraper = $client->smartscraper->create($params);
@@ -68,11 +68,11 @@ When the library is unable to connect to the API, or if the API returns a non-su
 use Scrapegraphai\Errors\APIConnectionError;
 use Scrapegraphai\Smartscraper\SmartscraperCreateParams;
 
+$params = SmartscraperCreateParams::with(
+  userPrompt: "Extract the product name, price, and description"
+);
 try {
-    $params = SmartscraperCreateParams::from(
-      userPrompt: "Extract the product name, price, and description"
-    );
-    $Smartscraper = $client->smartscraper->create($params);
+  $Smartscraper = $client->smartscraper->create($params);
 } catch (APIConnectionError $e) {
     echo "The server could not be reached", PHP_EOL;
     var_dump($e->getPrevious());
@@ -117,12 +117,11 @@ use Scrapegraphai\Smartscraper\SmartscraperCreateParams;
 
 // Configure the default for all requests:
 $client = new Client(maxRetries: 0);
-$params = SmartscraperCreateParams::from(
+$params = SmartscraperCreateParams::with(
   userPrompt: "Extract the product name, price, and description"
 );
 
-// Or, configure per-request:
-$result = $client
+// Or, configure per-request:$result = $client
   ->smartscraper
   ->create($params, new RequestOptions(maxRetries: 5));
 ```
@@ -143,7 +142,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 use Scrapegraphai\RequestOptions;
 use Scrapegraphai\Smartscraper\SmartscraperCreateParams;
 
-$params = SmartscraperCreateParams::from(
+$params = SmartscraperCreateParams::with(
   userPrompt: "Extract the product name, price, and description"
 );
 $completedSmartscraper = $client

src/Crawl/CrawlStartParams.php

@@ -83,6 +83,20 @@ final class CrawlStartParams implements BaseModel
     #[Api(optional: true)]
     public ?bool $sitemap;
 
+    /**
+     * `new CrawlStartParams()` is missing required properties by the API.
+     *
+     * To enforce required parameters use
+     * ```
+     * CrawlStartParams::with(url: ...)
+     * ```
+     *
+     * Otherwise ensure the following setters are called
+     *
+     * ```
+     * (new CrawlStartParams)->withURL(...)
+     * ```
+     */
     public function __construct()
     {
         self::introspect();
@@ -94,7 +108,7 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      */
-    public static function from(
+    public static function with(
         string $url,
         ?int $depth = null,
         ?bool $extractionMode = null,
@@ -124,87 +138,96 @@ public static function from(
     /**
      * Starting URL for crawling.
      */
-    public function setURL(string $url): self
+    public function withURL(string $url): self
     {
-        $this->url = $url;
+        $obj = clone $this;
+        $obj->url = $url;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Maximum crawl depth from starting URL.
      */
-    public function setDepth(int $depth): self
+    public function withDepth(int $depth): self
     {
-        $this->depth = $depth;
+        $obj = clone $this;
+        $obj->depth = $depth;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Use AI extraction (true) or markdown conversion (false).
      */
-    public function setExtractionMode(bool $extractionMode): self
+    public function withExtractionMode(bool $extractionMode): self
     {
-        $this->extractionMode = $extractionMode;
+        $obj = clone $this;
+        $obj->extractionMode = $extractionMode;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Maximum number of pages to crawl.
      */
-    public function setMaxPages(int $maxPages): self
+    public function withMaxPages(int $maxPages): self
     {
-        $this->maxPages = $maxPages;
+        $obj = clone $this;
+        $obj->maxPages = $maxPages;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Extraction prompt (required if extraction_mode is true).
      */
-    public function setPrompt(?string $prompt): self
+    public function withPrompt(?string $prompt): self
     {
-        $this->prompt = $prompt;
+        $obj = clone $this;
+        $obj->prompt = $prompt;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Enable heavy JavaScript rendering.
      */
-    public function setRenderHeavyJs(bool $renderHeavyJs): self
+    public function withRenderHeavyJs(bool $renderHeavyJs): self
     {
-        $this->renderHeavyJs = $renderHeavyJs;
+        $obj = clone $this;
+        $obj->renderHeavyJs = $renderHeavyJs;
 
-        return $this;
+        return $obj;
     }
 
-    public function setRules(Rules $rules): self
+    public function withRules(Rules $rules): self
     {
-        $this->rules = $rules;
+        $obj = clone $this;
+        $obj->rules = $rules;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Output schema for extraction.
      */
-    public function setSchema(mixed $schema): self
+    public function withSchema(mixed $schema): self
     {
-        $this->schema = $schema;
+        $obj = clone $this;
+        $obj->schema = $schema;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Use sitemap for crawling.
      */
-    public function setSitemap(bool $sitemap): self
+    public function withSitemap(bool $sitemap): self
     {
-        $this->sitemap = $sitemap;
+        $obj = clone $this;
+        $obj->sitemap = $sitemap;
 
-        return $this;
+        return $obj;
     }
 }

src/Crawl/CrawlStartParams/Rules.php

@@ -43,7 +43,7 @@ public function __construct()
      *
      * @param null|list<string> $exclude
      */
-    public static function from(
+    public static function with(
         ?array $exclude = null,
         ?bool $sameDomain = null
     ): self {
@@ -60,20 +60,22 @@ public static function from(
      *
      * @param list<string> $exclude
      */
-    public function setExclude(array $exclude): self
+    public function withExclude(array $exclude): self
     {
-        $this->exclude = $exclude;
+        $obj = clone $this;
+        $obj->exclude = $exclude;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Restrict crawling to same domain.
      */
-    public function setSameDomain(bool $sameDomain): self
+    public function withSameDomain(bool $sameDomain): self
     {
-        $this->sameDomain = $sameDomain;
+        $obj = clone $this;
+        $obj->sameDomain = $sameDomain;
 
-        return $this;
+        return $obj;
     }
 }

src/Feedback/FeedbackSubmitParams.php

@@ -39,6 +39,20 @@ final class FeedbackSubmitParams implements BaseModel
     #[Api('feedback_text', optional: true)]
     public ?string $feedbackText;
 
+    /**
+     * `new FeedbackSubmitParams()` is missing required properties by the API.
+     *
+     * To enforce required parameters use
+     * ```
+     * FeedbackSubmitParams::with(rating: ..., requestID: ...)
+     * ```
+     *
+     * Otherwise ensure the following setters are called
+     *
+     * ```
+     * (new FeedbackSubmitParams)->withRating(...)->withRequestID(...)
+     * ```
+     */
     public function __construct()
     {
         self::introspect();
@@ -50,7 +64,7 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      */
-    public static function from(
+    public static function with(
         int $rating,
         string $requestID,
         ?string $feedbackText = null
@@ -68,30 +82,33 @@ public static function from(
     /**
      * Rating score.
      */
-    public function setRating(int $rating): self
+    public function withRating(int $rating): self
     {
-        $this->rating = $rating;
+        $obj = clone $this;
+        $obj->rating = $rating;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Request to provide feedback for.
      */
-    public function setRequestID(string $requestID): self
+    public function withRequestID(string $requestID): self
     {
-        $this->requestID = $requestID;
+        $obj = clone $this;
+        $obj->requestID = $requestID;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Optional feedback comments.
      */
-    public function setFeedbackText(?string $feedbackText): self
+    public function withFeedbackText(?string $feedbackText): self
     {
-        $this->feedbackText = $feedbackText;
+        $obj = clone $this;
+        $obj->feedbackText = $feedbackText;
 
-        return $this;
+        return $obj;
     }
 }

src/GenerateSchema/GenerateSchemaCreateParams.php

@@ -32,6 +32,20 @@ final class GenerateSchemaCreateParams implements BaseModel
     #[Api('existing_schema', optional: true)]
     public mixed $existingSchema;
 
+    /**
+     * `new GenerateSchemaCreateParams()` is missing required properties by the API.
+     *
+     * To enforce required parameters use
+     * ```
+     * GenerateSchemaCreateParams::with(userPrompt: ...)
+     * ```
+     *
+     * Otherwise ensure the following setters are called
+     *
+     * ```
+     * (new GenerateSchemaCreateParams)->withUserPrompt(...)
+     * ```
+     */
     public function __construct()
     {
         self::introspect();
@@ -43,7 +57,7 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      */
-    public static function from(
+    public static function with(
         string $userPrompt,
         mixed $existingSchema = null
     ): self {
@@ -59,20 +73,22 @@ public static function from(
     /**
      * Natural language description of desired schema.
      */
-    public function setUserPrompt(string $userPrompt): self
+    public function withUserPrompt(string $userPrompt): self
     {
-        $this->userPrompt = $userPrompt;
+        $obj = clone $this;
+        $obj->userPrompt = $userPrompt;
 
-        return $this;
+        return $obj;
     }
 
     /**
      * Existing schema to modify or extend.
      */
-    public function setExistingSchema(mixed $existingSchema): self
+    public function withExistingSchema(mixed $existingSchema): self
     {
-        $this->existingSchema = $existingSchema;
+        $obj = clone $this;
+        $obj->existingSchema = $existingSchema;
 
-        return $this;
+        return $obj;
     }
 }