chore: document parameter object usage

Author: stainless-app[bot]

src/Crawl/CrawlStartParams.php

@@ -11,10 +11,21 @@
 use Scrapegraphai\Crawl\CrawlStartParams\Rules;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new CrawlStartParams); // set properties as needed
+ * $client->crawl->start(...$params->toArray());
+ * ```
  * Initiate comprehensive website crawling with sitemap support.
  * Supports both AI extraction mode and markdown conversion mode.
  * Returns a task ID for async processing.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->crawl->start(...$params->toArray());`
+ *
  * @see Scrapegraphai\Crawl->start
  *
  * @phpstan-type crawl_start_params = array{

src/Feedback/FeedbackSubmitParams.php

@@ -10,8 +10,19 @@
 use Scrapegraphai\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new FeedbackSubmitParams); // set properties as needed
+ * $client->feedback->submit(...$params->toArray());
+ * ```
  * Submit feedback for a specific request.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->feedback->submit(...$params->toArray());`
+ *
  * @see Scrapegraphai\Feedback->submit
  *
  * @phpstan-type feedback_submit_params = array{

src/GenerateSchema/GenerateSchemaCreateParams.php

@@ -10,9 +10,20 @@
 use Scrapegraphai\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new GenerateSchemaCreateParams); // set properties as needed
+ * $client->generateSchema->create(...$params->toArray());
+ * ```
  * Generate or modify JSON schemas based on natural language descriptions.
  * Can create new schemas or extend existing ones.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->generateSchema->create(...$params->toArray());`
+ *
  * @see Scrapegraphai\GenerateSchema->create
  *
  * @phpstan-type generate_schema_create_params = array{

src/Markdownify/MarkdownifyConvertParams.php

@@ -10,8 +10,19 @@
 use Scrapegraphai\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new MarkdownifyConvertParams); // set properties as needed
+ * $client->markdownify->convert(...$params->toArray());
+ * ```
  * Convert web page content to clean Markdown format.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->markdownify->convert(...$params->toArray());`
+ *
  * @see Scrapegraphai\Markdownify->convert
  *
  * @phpstan-type markdownify_convert_params = array{

src/Searchscraper/SearchscraperCreateParams.php

@@ -10,9 +10,20 @@
 use Scrapegraphai\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new SearchscraperCreateParams); // set properties as needed
+ * $client->searchscraper->create(...$params->toArray());
+ * ```
  * Performs web search, selects relevant URLs, and extracts structured data from multiple websites.
  * Uses LLM to refine search queries and merge results from different sources.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->searchscraper->create(...$params->toArray());`
+ *
  * @see Scrapegraphai\Searchscraper->create
  *
  * @phpstan-type searchscraper_create_params = array{

src/Smartscraper/SmartscraperCreateParams.php

@@ -10,9 +10,20 @@
 use Scrapegraphai\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new SmartscraperCreateParams); // set properties as needed
+ * $client->smartscraper->create(...$params->toArray());
+ * ```
  * Main scraping endpoint with LLM-powered content analysis. Supports various fetching providers,
  * infinite scrolling, pagination, and custom output schemas.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->smartscraper->create(...$params->toArray());`
+ *
  * @see Scrapegraphai\Smartscraper->create
  *
  * @phpstan-type smartscraper_create_params = array{