chore: add additional php doc tags

Author: stainless-app[bot]

.gitignore

@@ -1,11 +1,11 @@
-*.swo
-*.swp
+composer.lock
+docs/
 .idea/
 .php-cs-fixer.cache
 .php-cs-fixer.php
-.phpdoc/
 .phpunit.cache
-composer.lock
 phpunit.xml
 playground/
+*.swo
+*.swp
 vendor/

composer.json

@@ -44,6 +44,7 @@
     "symfony/http-client": "^7"
   },
   "scripts": {
+    "build:docs": "curl --etag-save ./vendor/ag.etags --etag-compare ./vendor/ag.etags --create-dirs --remote-name --output-dir ./vendor/bin --no-progress-meter -- https://github.com/ApiGen/ApiGen/releases/latest/download/apigen.phar && php ./vendor/bin/apigen.phar --output docs -- src",
     "lint": "./scripts/lint",
     "test": "./scripts/test"
   }

src/CasGenerator/CasGeneratorGenerateCasParams.php

@@ -14,6 +14,8 @@
  * 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.
  *
+ * @see CasParser\CasGenerator->generateCas
+ *
  * @phpstan-type cas_generator_generate_cas_params = array{
  *   email: string,
  *   fromDate: string,

src/CasParser/CasParserCamsKfintechParams.php

@@ -13,6 +13,8 @@
  * 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.
  *
+ * @see CasParser\CasParser->camsKfintech
+ *
  * @phpstan-type cas_parser_cams_kfintech_params = array{
  *   password?: string, pdfFile?: string, pdfURL?: string
  * }

src/CasParser/CasParserCdslParams.php

@@ -13,6 +13,8 @@
  * 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.
  *
+ * @see CasParser\CasParser->cdsl
+ *
  * @phpstan-type cas_parser_cdsl_params = array{
  *   password?: string, pdfFile?: string, pdfURL?: string
  * }

src/CasParser/CasParserNsdlParams.php

@@ -13,6 +13,8 @@
  * 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.
  *
+ * @see CasParser\CasParser->nsdl
+ *
  * @phpstan-type cas_parser_nsdl_params = array{
  *   password?: string, pdfFile?: string, pdfURL?: string
  * }

src/CasParser/CasParserSmartParseParams.php

@@ -13,6 +13,8 @@
  * 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.
  *
+ * @see CasParser\CasParser->smartParse
+ *
  * @phpstan-type cas_parser_smart_parse_params = array{
  *   password?: string, pdfFile?: string, pdfURL?: string
  * }

src/Client.php

@@ -12,8 +12,14 @@ class Client extends BaseClient
 {
     public string $apiKey;
 
+    /**
+     * @api
+     */
     public CasParserService $casParser;
 
+    /**
+     * @api
+     */
     public CasGeneratorService $casGenerator;
 
     public function __construct(?string $apiKey = null, ?string $baseUrl = null)

src/Core/ServiceContracts/CasGeneratorContract.php

@@ -13,6 +13,8 @@
 interface CasGeneratorContract
 {
     /**
+     * @api
+     *
      * @param string $email Email address to receive the CAS document
      * @param string $fromDate Start date for the CAS period (format YYYY-MM-DD)
      * @param string $password Password to protect the generated CAS PDF

src/Core/ServiceContracts/CasParserContract.php

@@ -12,6 +12,8 @@
 interface CasParserContract
 {
     /**
+     * @api
+     *
      * @param string $password Password for the PDF file (if required)
      * @param string $pdfFile Base64 encoded CAS PDF file
      * @param string $pdfURL URL to the CAS PDF file
@@ -24,6 +26,8 @@ public function camsKfintech(
     ): UnifiedResponse;
 
     /**
+     * @api
+     *
      * @param string $password Password for the PDF file (if required)
      * @param string $pdfFile Base64 encoded CAS PDF file
      * @param string $pdfURL URL to the CAS PDF file
@@ -36,6 +40,8 @@ public function cdsl(
     ): UnifiedResponse;
 
     /**
+     * @api
+     *
      * @param string $password Password for the PDF file (if required)
      * @param string $pdfFile Base64 encoded CAS PDF file
      * @param string $pdfURL URL to the CAS PDF file
@@ -48,6 +54,8 @@ public function nsdl(
     ): UnifiedResponse;
 
     /**
+     * @api
+     *
      * @param string $password Password for the PDF file (if required)
      * @param string $pdfFile Base64 encoded CAS PDF file
      * @param string $pdfURL URL to the CAS PDF file