feat!: remove confusing toArray() alias to __serialize() in favour of toProperties()

Author: stainless-app[bot]

src/CasGenerator/CasGeneratorGenerateCasParams.php

@@ -11,20 +11,9 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
- * An object containing the method's parameters.
- * Example usage:
- * ```
- * $params = (new CasGeneratorGenerateCasParams); // set properties as needed
- * $client->casGenerator->generateCas(...$params->toArray());
- * ```
  * This endpoint generates CAS (Consolidated Account Statement) documents by submitting a mailback request to the specified CAS authority.
  * Currently only supports KFintech, with plans to support CAMS, CDSL, and NSDL in the future.
  *
- * @method toArray()
- *   Returns the parameters as an associative array suitable for passing to the client method.
- *
- *   `$client->casGenerator->generateCas(...$params->toArray());`
- *
  * @see CasParser\CasGenerator->generateCas
  *
  * @phpstan-type cas_generator_generate_cas_params = array{

src/CasParser/CasParserCamsKfintechParams.php

@@ -10,20 +10,9 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
- * An object containing the method's parameters.
- * Example usage:
- * ```
- * $params = (new CasParserCamsKfintechParams); // set properties as needed
- * $client->casParser->camsKfintech(...$params->toArray());
- * ```
  * This endpoint specifically parses CAMS/KFintech CAS (Consolidated Account Statement) PDF files and returns data in a unified format.
  * Use this endpoint when you know the PDF is from CAMS or KFintech.
  *
- * @method toArray()
- *   Returns the parameters as an associative array suitable for passing to the client method.
- *
- *   `$client->casParser->camsKfintech(...$params->toArray());`
- *
  * @see CasParser\CasParser->camsKfintech
  *
  * @phpstan-type cas_parser_cams_kfintech_params = array{

src/CasParser/CasParserCdslParams.php

@@ -10,20 +10,9 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
- * An object containing the method's parameters.
- * Example usage:
- * ```
- * $params = (new CasParserCdslParams); // set properties as needed
- * $client->casParser->cdsl(...$params->toArray());
- * ```
  * This endpoint specifically parses CDSL CAS (Consolidated Account Statement) PDF files and returns data in a unified format.
  * Use this endpoint when you know the PDF is from CDSL.
  *
- * @method toArray()
- *   Returns the parameters as an associative array suitable for passing to the client method.
- *
- *   `$client->casParser->cdsl(...$params->toArray());`
- *
  * @see CasParser\CasParser->cdsl
  *
  * @phpstan-type cas_parser_cdsl_params = array{

src/CasParser/CasParserNsdlParams.php

@@ -10,20 +10,9 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
- * An object containing the method's parameters.
- * Example usage:
- * ```
- * $params = (new CasParserNsdlParams); // set properties as needed
- * $client->casParser->nsdl(...$params->toArray());
- * ```
  * This endpoint specifically parses NSDL CAS (Consolidated Account Statement) PDF files and returns data in a unified format.
  * Use this endpoint when you know the PDF is from NSDL.
  *
- * @method toArray()
- *   Returns the parameters as an associative array suitable for passing to the client method.
- *
- *   `$client->casParser->nsdl(...$params->toArray());`
- *
  * @see CasParser\CasParser->nsdl
  *
  * @phpstan-type cas_parser_nsdl_params = array{

src/CasParser/CasParserSmartParseParams.php

@@ -10,20 +10,9 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
- * An object containing the method's parameters.
- * Example usage:
- * ```
- * $params = (new CasParserSmartParseParams); // set properties as needed
- * $client->casParser->smartParse(...$params->toArray());
- * ```
  * This endpoint parses CAS (Consolidated Account Statement) PDF files from NSDL, CDSL, or CAMS/KFintech and returns data in a unified format.
  * It auto-detects the CAS type and transforms the data into a consistent structure regardless of the source.
  *
- * @method toArray()
- *   Returns the parameters as an associative array suitable for passing to the client method.
- *
- *   `$client->casParser->smartParse(...$params->toArray());`
- *
  * @see CasParser\CasParser->smartParse
  *
  * @phpstan-type cas_parser_smart_parse_params = array{

src/Core/Concerns/SdkModel.php

@@ -32,9 +32,9 @@ trait SdkModel
      */
     public function __serialize(): array
     {
-        $rows = [...Util::get_object_vars($this), ...$this->_data]; // @phpstan-ignore-line
+        $properties = $this->toProperties(); // @phpstan-ignore-line
 
-        return array_map(static fn ($v) => self::serialize($v), array: $rows);
+        return array_map(static fn ($v) => self::serialize($v), array: $properties);
     }
 
     /**
@@ -98,11 +98,13 @@ public function __get(string $key): mixed
     }
 
     /**
+     * @internal
+     *
      * @return Shape
      */
-    public function toArray(): array
+    public function toProperties(): array
     {
-        return $this->__serialize(); // @phpstan-ignore-line
+        return [...Util::get_object_vars($this), ...$this->_data]; // @phpstan-ignore-line
     }
 
     /**
@@ -257,7 +259,7 @@ private function initialize(): void
     private static function serialize(mixed $value): mixed
     {
         if ($value instanceof BaseModel) {
-            return $value->toArray();
+            return $value->toProperties();
         }
 
         if (is_array($value)) {

src/Core/Contracts/BaseModel.php

@@ -14,5 +14,5 @@
 interface BaseModel extends \ArrayAccess, \JsonSerializable, \Stringable, ConverterSource
 {
     /** @return array<string, mixed> */
-    public function toArray(): array;
+    public function toProperties(): array;
 }

src/Core/Conversion/ModelOf.php

@@ -105,7 +105,7 @@ public function from(array $data): BaseModel
     public function dump(mixed $value, DumpState $state): mixed
     {
         if ($value instanceof BaseModel) {
-            $value = $value->toArray();
+            $value = $value->toProperties();
         }
 
         if (is_array($value)) {

src/RequestOptions.php

@@ -81,7 +81,7 @@ public function __construct()
      */
     public static function parse(RequestOptions|array|null ...$options): self
     {
-        $parsed = array_map(static fn ($o) => $o instanceof self ? $o->toArray() : $o ?? [], array: $options);
+        $parsed = array_map(static fn ($o) => $o instanceof self ? $o->toProperties() : $o ?? [], array: $options);
 
         return self::with(...array_merge(...$parsed)); // @phpstan-ignore-line
     }