feat(client): support raw responses

Author: stainless-app[bot]

src/Core/Implementation/HasRawResponse.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Scrapegraphai\Core\Implementation;
+
+use Psr\Http\Message\ResponseInterface;
+
+class HasRawResponse
+{
+    public ResponseInterface $rawResponse;
+}

src/Crawl/CrawlGetResultsResponse.php

@@ -12,11 +12,15 @@
 
 /**
  * @phpstan-type crawl_get_results_response = array{
- *   result?: mixed|string|null,
- *   status?: value-of<Status>|null,
- *   taskID?: string|null,
+ *   result?: mixed|string,
+ *   status?: value-of<Status>,
+ *   taskID?: string,
  *   traceback?: string|null,
  * }
+ * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class CrawlGetResultsResponse implements BaseModel
 {

src/Crawl/CrawlStartParams/Rules.php

@@ -9,9 +9,7 @@
 use Scrapegraphai\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-type rules_alias = array{
- *   exclude?: list<string>|null, sameDomain?: bool|null
- * }
+ * @phpstan-type rules_alias = array{exclude?: list<string>, sameDomain?: bool}
  */
 final class Rules implements BaseModel
 {

src/Crawl/CrawlStartResponse.php

@@ -9,7 +9,11 @@
 use Scrapegraphai\Core\Contracts\BaseModel;
 
 /**
- * @phpstan-type crawl_start_response = array{taskID?: string|null}
+ * @phpstan-type crawl_start_response = array{taskID?: string}
+ * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class CrawlStartResponse implements BaseModel
 {

src/Credits/CreditGetResponse.php

@@ -10,8 +10,12 @@
 
 /**
  * @phpstan-type credit_get_response = array{
- *   remainingCredits?: int|null, totalCreditsUsed?: int|null
+ *   remainingCredits?: int, totalCreditsUsed?: int
  * }
+ * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class CreditGetResponse implements BaseModel
 {

src/Feedback/FeedbackSubmitResponse.php

@@ -10,11 +10,15 @@
 
 /**
  * @phpstan-type feedback_submit_response = array{
- *   feedbackID?: string|null,
- *   feedbackTimestamp?: \DateTimeInterface|null,
- *   message?: string|null,
- *   requestID?: string|null,
+ *   feedbackID?: string,
+ *   feedbackTimestamp?: \DateTimeInterface,
+ *   message?: string,
+ *   requestID?: string,
  * }
+ * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class FeedbackSubmitResponse implements BaseModel
 {

src/GenerateSchema/GenerateSchemaGetResponse/CompletedSchemaGenerationResponse.php

@@ -13,10 +13,10 @@
  * @phpstan-type completed_schema_generation_response = array{
  *   error?: string|null,
  *   generatedSchema?: mixed,
- *   refinedPrompt?: string|null,
- *   requestID?: string|null,
- *   status?: value-of<Status>|null,
- *   userPrompt?: string|null,
+ *   refinedPrompt?: string,
+ *   requestID?: string,
+ *   status?: value-of<Status>,
+ *   userPrompt?: string,
  * }
  */
 final class CompletedSchemaGenerationResponse implements BaseModel

src/GenerateSchema/GenerateSchemaGetResponse/FailedSchemaGenerationResponse.php

@@ -11,12 +11,12 @@
 
 /**
  * @phpstan-type failed_schema_generation_response = array{
- *   error?: string|null,
+ *   error?: string,
  *   generatedSchema?: mixed,
  *   refinedPrompt?: string|null,
- *   requestID?: string|null,
- *   status?: value-of<Status>|null,
- *   userPrompt?: string|null,
+ *   requestID?: string,
+ *   status?: value-of<Status>,
+ *   userPrompt?: string,
  * }
  */
 final class FailedSchemaGenerationResponse implements BaseModel

src/GenerateSchema/GenerateSchemaNewResponse.php

@@ -13,11 +13,15 @@
  * @phpstan-type generate_schema_new_response = array{
  *   error?: string|null,
  *   generatedSchema?: mixed,
- *   refinedPrompt?: string|null,
- *   requestID?: string|null,
- *   status?: value-of<Status>|null,
- *   userPrompt?: string|null,
+ *   refinedPrompt?: string,
+ *   requestID?: string,
+ *   status?: value-of<Status>,
+ *   userPrompt?: string,
  * }
+ * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class GenerateSchemaNewResponse implements BaseModel
 {

src/Healthz/HealthzCheckResponse.php

@@ -10,8 +10,12 @@
 
 /**
  * @phpstan-type healthz_check_response = array{
- *   services?: array<string, string>|null, status?: string|null
+ *   services?: array<string, string>, status?: string
  * }
+ * When used in a response, this type parameter can be used to define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class HealthzCheckResponse implements BaseModel
 {