feat(client): add raw methods

Author: stainless-app[bot]

src/Crawl/CrawlGetResultsResponse.php

@@ -17,7 +17,7 @@
  *   taskID?: string,
  *   traceback?: string|null,
  * }
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/Crawl/CrawlStartResponse.php

@@ -10,7 +10,7 @@
 
 /**
  * @phpstan-type crawl_start_response = array{taskID?: string}
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/Credits/CreditGetResponse.php

@@ -12,7 +12,7 @@
  * @phpstan-type credit_get_response = array{
  *   remainingCredits?: int, totalCreditsUsed?: int
  * }
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/Feedback/FeedbackSubmitResponse.php

@@ -15,7 +15,7 @@
  *   message?: string,
  *   requestID?: string,
  * }
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/GenerateSchema/GenerateSchemaNewResponse.php

@@ -18,7 +18,7 @@
  *   status?: value-of<Status>,
  *   userPrompt?: string,
  * }
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/Healthz/HealthzCheckResponse.php

@@ -12,7 +12,7 @@
  * @phpstan-type healthz_check_response = array{
  *   services?: array<string, string>, status?: string
  * }
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/Markdownify/CompletedMarkdownify.php

@@ -17,7 +17,7 @@
  *   status?: value-of<Status>,
  *   websiteURL?: string,
  * }
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/Searchscraper/CompletedSearchScraper.php

@@ -19,7 +19,7 @@
  *   status?: value-of<Status>,
  *   userPrompt?: string,
  * }
- * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * When used in a response, this type parameter can define a $rawResponse property.
  * @template TRawResponse of object = object{}
  *
  * @mixin TRawResponse

src/ServiceContracts/CrawlContract.php

@@ -4,6 +4,7 @@
 
 namespace Scrapegraphai\ServiceContracts;
 
+use Scrapegraphai\Core\Exceptions\APIException;
 use Scrapegraphai\Core\Implementation\HasRawResponse;
 use Scrapegraphai\Crawl\CrawlGetResultsResponse;
 use Scrapegraphai\Crawl\CrawlStartParams\Rules;
@@ -18,12 +19,27 @@ interface CrawlContract
      * @api
      *
      * @return CrawlGetResultsResponse<HasRawResponse>
+     *
+     * @throws APIException
      */
     public function retrieveResults(
         string $taskID,
         ?RequestOptions $requestOptions = null
     ): CrawlGetResultsResponse;
 
+    /**
+     * @api
+     *
+     * @return CrawlGetResultsResponse<HasRawResponse>
+     *
+     * @throws APIException
+     */
+    public function retrieveResultsRaw(
+        string $taskID,
+        mixed $params,
+        ?RequestOptions $requestOptions = null
+    ): CrawlGetResultsResponse;
+
     /**
      * @api
      *
@@ -38,6 +54,8 @@ public function retrieveResults(
      * @param bool $sitemap Use sitemap for crawling
      *
      * @return CrawlStartResponse<HasRawResponse>
+     *
+     * @throws APIException
      */
     public function start(
         $url,
@@ -51,4 +69,18 @@ public function start(
         $sitemap = omit,
         ?RequestOptions $requestOptions = null,
     ): CrawlStartResponse;
+
+    /**
+     * @api
+     *
+     * @param array<string, mixed> $params
+     *
+     * @return CrawlStartResponse<HasRawResponse>
+     *
+     * @throws APIException
+     */
+    public function startRaw(
+        array $params,
+        ?RequestOptions $requestOptions = null
+    ): CrawlStartResponse;
 }

src/ServiceContracts/CreditsContract.php

@@ -4,6 +4,7 @@
 
 namespace Scrapegraphai\ServiceContracts;
 
+use Scrapegraphai\Core\Exceptions\APIException;
 use Scrapegraphai\Core\Implementation\HasRawResponse;
 use Scrapegraphai\Credits\CreditGetResponse;
 use Scrapegraphai\RequestOptions;
@@ -14,8 +15,22 @@ interface CreditsContract
      * @api
      *
      * @return CreditGetResponse<HasRawResponse>
+     *
+     * @throws APIException
      */
     public function retrieve(
         ?RequestOptions $requestOptions = null
     ): CreditGetResponse;
+
+    /**
+     * @api
+     *
+     * @return CreditGetResponse<HasRawResponse>
+     *
+     * @throws APIException
+     */
+    public function retrieveRaw(
+        mixed $params,
+        ?RequestOptions $requestOptions = null
+    ): CreditGetResponse;
 }