diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 8dec9f0..f7222cd 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -17,3 +17,6 @@ jobs: - name: Check release environment run: | bash ./bin/check-release-environment + env: + PACKAGIST_USERNAME: ${{ secrets.CAS_PARSER_PACKAGIST_USERNAME || secrets.PACKAGIST_USERNAME }} + PACKAGIST_SAFE_KEY: ${{ secrets.CAS_PARSER_PACKAGIST_SAFE_KEY || secrets.PACKAGIST_SAFE_KEY }} diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 10f3091..6b7b74c 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.2.0" + ".": "0.3.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 92721c7..48b33b3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 5 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cas-parser%2Fcas-parser-b7fdba3d3f97c7debc22c7ca30b828bce81bcd64648df8c94029b27a3321ebb9.yml -openapi_spec_hash: 03f1315f1d32ada42445ca920f047dff +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cas-parser%2Fcas-parser-38618cc5c938e87eeacf4893d6a6ba4e6ef7da390e6283dc7b50b484a7b97165.yml +openapi_spec_hash: b9e439ecee904ded01aa34efdee88856 config_hash: cb5d75abef6264b5d86448caf7295afa diff --git a/CHANGELOG.md b/CHANGELOG.md index 57b6fa7..097e303 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,39 @@ # Changelog +## 0.3.0 (2026-01-01) + +Full Changelog: [v0.2.0...v0.3.0](https://github.com/CASParser/cas-parser-php/compare/v0.2.0...v0.3.0) + +### ⚠ BREAKING CHANGES + +* **client:** redesign methods +* remove confusing `toArray()` alias to `__serialize()` in favour of `toProperties()` + +### Features + +* **api:** api update ([90a131a](https://github.com/CASParser/cas-parser-php/commit/90a131ad218e94a908056b01fb8425ab8783bbd4)) +* **api:** api update ([da8b838](https://github.com/CASParser/cas-parser-php/commit/da8b83821dab28680f72e98a943af25df296e314)) +* **client:** redesign methods ([5bc4f8f](https://github.com/CASParser/cas-parser-php/commit/5bc4f8fbca8bd998535963059460dcc2285c479e)) +* remove confusing `toArray()` alias to `__serialize()` in favour of `toProperties()` ([84053c4](https://github.com/CASParser/cas-parser-php/commit/84053c4b32db33f341e5e9bf89f2aabe982a2695)) + + +### Bug Fixes + +* **ci:** release doctor workflow ([d7d0f00](https://github.com/CASParser/cas-parser-php/commit/d7d0f005e9022cce83d3316626e5746a3a02b694)) +* ensure auth methods return non-nullable arrays ([fd0ab3b](https://github.com/CASParser/cas-parser-php/commit/fd0ab3bb4232369f31350fb47d0aca4d916f5739)) +* inverted retry condition ([0112a9a](https://github.com/CASParser/cas-parser-php/commit/0112a9a50be77cb4681413034b3d88d791774f6c)) +* rename invalid types ([6b7a996](https://github.com/CASParser/cas-parser-php/commit/6b7a99682bfce707850bfddeb41d2474f109ba83)) + + +### Chores + +* add license ([7742369](https://github.com/CASParser/cas-parser-php/commit/7742369f0a91046a7aa843391627e8931c6280f8)) +* **client:** send metadata headers ([9a72241](https://github.com/CASParser/cas-parser-php/commit/9a72241ae57939ae08709709a26a87f1ad83d9e2)) +* **docs:** update readme formatting ([f992e92](https://github.com/CASParser/cas-parser-php/commit/f992e921cd7043ea562ad58fb01905bd2039fa50)) +* **internal:** codegen related update ([c124b7b](https://github.com/CASParser/cas-parser-php/commit/c124b7bdd9b7d6f7bbef3d386f9eb4038a6b20f3)) +* refactor methods ([e25fa02](https://github.com/CASParser/cas-parser-php/commit/e25fa02ca0d7d49d88f1859c99e2db925a74e722)) +* use pascal case for phpstan typedefs ([574d168](https://github.com/CASParser/cas-parser-php/commit/574d1680fbbaccfc4281a98e33d205f4d8a7e043)) + ## 0.2.0 (2025-09-13) Full Changelog: [v0.1.0...v0.2.0](https://github.com/CASParser/cas-parser-php/compare/v0.1.0...v0.2.0) diff --git a/LICENSE b/LICENSE index f1756ce..6bbb512 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2025 Cas Parser + Copyright 2026 Cas Parser Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 75f8882..0373ccf 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,11 @@ Parameters with a default value must be set by name. use CasParser\Client; -$client = new Client(apiKey: getenv("CAS_PARSER_API_KEY") ?: "My API Key"); +$client = new Client(apiKey: getenv('CAS_PARSER_API_KEY') ?: 'My API Key'); -$unifiedResponse = $client->casParser->smartParse(); +$unifiedResponse = $client->casParser->smartParse( + password: 'ABCDF', pdfURL: 'https://your-cas-pdf-url-here.com' +); var_dump($unifiedResponse->demat_accounts); ``` @@ -75,7 +77,7 @@ try { } catch (APIConnectionException $e) { echo "The server could not be reached", PHP_EOL; var_dump($e->getPrevious()); -} catch (RateLimitError $_) { +} catch (RateLimitError $e) { echo "A 429 status code was received; we should back off a bit.", PHP_EOL; } catch (APIStatusError $e) { echo "Another non-200-range status code was received", PHP_EOL; @@ -117,9 +119,10 @@ use CasParser\RequestOptions; $client = new Client(maxRetries: 0); // Or, configure per-request: - $result = $client->casParser->smartParse( - requestOptions: RequestOptions::with(maxRetries: 5) + password: 'ABCDF', + pdfURL: 'https://you-cas-pdf-url-here.com', + requestOptions: RequestOptions::with(maxRetries: 5), ); ``` @@ -139,14 +142,14 @@ Note: the `extra*` parameters of the same name overrides the documented paramete use CasParser\RequestOptions; $unifiedResponse = $client->casParser->smartParse( + password: 'ABCDF', + pdfURL: 'https://you-cas-pdf-url-here.com', requestOptions: RequestOptions::with( - extraQueryParams: ["my_query_parameter" => "value"], - extraBodyParams: ["my_body_parameter" => "value"], - extraHeaders: ["my-header" => "value"], + extraQueryParams: ['my_query_parameter' => 'value'], + extraBodyParams: ['my_body_parameter' => 'value'], + extraHeaders: ['my-header' => 'value'], ), ); - -var_dump($unifiedResponse["my_undocumented_property"]); ``` #### Undocumented request params diff --git a/composer.json b/composer.json index 7163498..d5990da 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,12 @@ { "$schema": "https://getcomposer.org/schema.json", + "license": "Apache-2.0", "autoload": { - "files": ["src/Core.php", "src/Client.php"], + "files": [ + "src/Core.php", + "src/Version.php", + "src/Client.php" + ], "psr-4": { "CasParser\\": "src/" } diff --git a/release-please-config.json b/release-please-config.json index 1891660..83bea62 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -61,6 +61,7 @@ ], "release-type": "php", "extra-files": [ - "README.md" + "README.md", + "src/Version.php" ] } \ No newline at end of file diff --git a/scripts/lint b/scripts/lint index 6d629c2..211ce90 100755 --- a/scripts/lint +++ b/scripts/lint @@ -5,4 +5,4 @@ set -e cd -- "$(dirname -- "$0")/.." echo "==> Running PHPStan" -exec -- ./vendor/bin/phpstan analyse --memory-limit=1G +exec -- ./vendor/bin/phpstan analyse --memory-limit=12G diff --git a/src/CasGenerator/CasGeneratorGenerateCasParams.php b/src/CasGenerator/CasGeneratorGenerateCasParams.php index 3f3de18..3a7cdec 100644 --- a/src/CasGenerator/CasGeneratorGenerateCasParams.php +++ b/src/CasGenerator/CasGeneratorGenerateCasParams.php @@ -5,65 +5,55 @@ namespace CasParser\CasGenerator; use CasParser\CasGenerator\CasGeneratorGenerateCasParams\CasAuthority; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; +use CasParser\Core\Attributes\Required; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Concerns\SdkParams; 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. + * @see CasParser\Services\CasGeneratorService::generateCas() * - * `$client->casGenerator->generateCas(...$params->toArray());` - * - * @see CasParser\CasGenerator->generateCas - * - * @phpstan-type cas_generator_generate_cas_params = array{ + * @phpstan-type CasGeneratorGenerateCasParamsShape = array{ * email: string, * fromDate: string, * password: string, * toDate: string, - * casAuthority?: CasAuthority|value-of, - * panNo?: string, + * casAuthority?: null|CasAuthority|value-of, + * panNo?: string|null, * } */ final class CasGeneratorGenerateCasParams implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; use SdkParams; /** * Email address to receive the CAS document. */ - #[Api] + #[Required] public string $email; /** * Start date for the CAS period (format YYYY-MM-DD). */ - #[Api('from_date')] + #[Required('from_date')] public string $fromDate; /** * Password to protect the generated CAS PDF. */ - #[Api] + #[Required] public string $password; /** * End date for the CAS period (format YYYY-MM-DD). */ - #[Api('to_date')] + #[Required('to_date')] public string $toDate; /** @@ -71,13 +61,13 @@ final class CasGeneratorGenerateCasParams implements BaseModel * * @var value-of|null $casAuthority */ - #[Api('cas_authority', enum: CasAuthority::class, optional: true)] + #[Optional('cas_authority', enum: CasAuthority::class)] public ?string $casAuthority; /** * PAN number (optional for some CAS authorities). */ - #[Api('pan_no', optional: true)] + #[Optional('pan_no')] public ?string $panNo; /** @@ -110,7 +100,7 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param CasAuthority|value-of $casAuthority + * @param CasAuthority|value-of|null $casAuthority */ public static function with( string $email, @@ -120,17 +110,17 @@ public static function with( CasAuthority|string|null $casAuthority = null, ?string $panNo = null, ): self { - $obj = new self; + $self = new self; - $obj->email = $email; - $obj->fromDate = $fromDate; - $obj->password = $password; - $obj->toDate = $toDate; + $self['email'] = $email; + $self['fromDate'] = $fromDate; + $self['password'] = $password; + $self['toDate'] = $toDate; - null !== $casAuthority && $obj->casAuthority = $casAuthority instanceof CasAuthority ? $casAuthority->value : $casAuthority; - null !== $panNo && $obj->panNo = $panNo; + null !== $casAuthority && $self['casAuthority'] = $casAuthority; + null !== $panNo && $self['panNo'] = $panNo; - return $obj; + return $self; } /** @@ -138,10 +128,10 @@ public static function with( */ public function withEmail(string $email): self { - $obj = clone $this; - $obj->email = $email; + $self = clone $this; + $self['email'] = $email; - return $obj; + return $self; } /** @@ -149,10 +139,10 @@ public function withEmail(string $email): self */ public function withFromDate(string $fromDate): self { - $obj = clone $this; - $obj->fromDate = $fromDate; + $self = clone $this; + $self['fromDate'] = $fromDate; - return $obj; + return $self; } /** @@ -160,10 +150,10 @@ public function withFromDate(string $fromDate): self */ public function withPassword(string $password): self { - $obj = clone $this; - $obj->password = $password; + $self = clone $this; + $self['password'] = $password; - return $obj; + return $self; } /** @@ -171,10 +161,10 @@ public function withPassword(string $password): self */ public function withToDate(string $toDate): self { - $obj = clone $this; - $obj->toDate = $toDate; + $self = clone $this; + $self['toDate'] = $toDate; - return $obj; + return $self; } /** @@ -184,10 +174,10 @@ public function withToDate(string $toDate): self */ public function withCasAuthority(CasAuthority|string $casAuthority): self { - $obj = clone $this; - $obj->casAuthority = $casAuthority instanceof CasAuthority ? $casAuthority->value : $casAuthority; + $self = clone $this; + $self['casAuthority'] = $casAuthority; - return $obj; + return $self; } /** @@ -195,9 +185,9 @@ public function withCasAuthority(CasAuthority|string $casAuthority): self */ public function withPanNo(string $panNo): self { - $obj = clone $this; - $obj->panNo = $panNo; + $self = clone $this; + $self['panNo'] = $panNo; - return $obj; + return $self; } } diff --git a/src/CasGenerator/CasGeneratorGenerateCasResponse.php b/src/CasGenerator/CasGeneratorGenerateCasResponse.php index 86298f8..365bf25 100644 --- a/src/CasGenerator/CasGeneratorGenerateCasResponse.php +++ b/src/CasGenerator/CasGeneratorGenerateCasResponse.php @@ -4,28 +4,24 @@ namespace CasParser\CasGenerator; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type cas_generator_generate_cas_response = array{ - * msg?: string, status?: string + * @phpstan-type CasGeneratorGenerateCasResponseShape = array{ + * msg?: string|null, status?: string|null * } - * When used in a response, this type parameter can define a $rawResponse property. - * @template TRawResponse of object = object{} - * - * @mixin TRawResponse */ final class CasGeneratorGenerateCasResponse implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; - #[Api(optional: true)] + #[Optional] public ?string $msg; - #[Api(optional: true)] + #[Optional] public ?string $status; public function __construct() @@ -40,27 +36,27 @@ public function __construct() */ public static function with(?string $msg = null, ?string $status = null): self { - $obj = new self; + $self = new self; - null !== $msg && $obj->msg = $msg; - null !== $status && $obj->status = $status; + null !== $msg && $self['msg'] = $msg; + null !== $status && $self['status'] = $status; - return $obj; + return $self; } public function withMsg(string $msg): self { - $obj = clone $this; - $obj->msg = $msg; + $self = clone $this; + $self['msg'] = $msg; - return $obj; + return $self; } public function withStatus(string $status): self { - $obj = clone $this; - $obj->status = $status; + $self = clone $this; + $self['status'] = $status; - return $obj; + return $self; } } diff --git a/src/CasParser/CasParserCamsKfintechParams.php b/src/CasParser/CasParserCamsKfintechParams.php index 8e09e3b..a894855 100644 --- a/src/CasParser/CasParserCamsKfintechParams.php +++ b/src/CasParser/CasParserCamsKfintechParams.php @@ -4,54 +4,43 @@ namespace CasParser\CasParser; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Concerns\SdkParams; 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. + * @see CasParser\Services\CasParserService::camsKfintech() * - * `$client->casParser->camsKfintech(...$params->toArray());` - * - * @see CasParser\CasParser->camsKfintech - * - * @phpstan-type cas_parser_cams_kfintech_params = array{ - * password?: string, pdfFile?: string, pdfURL?: string + * @phpstan-type CasParserCamsKfintechParamsShape = array{ + * password?: string|null, pdfFile?: string|null, pdfURL?: string|null * } */ final class CasParserCamsKfintechParams implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; use SdkParams; /** * Password for the PDF file (if required). */ - #[Api(optional: true)] + #[Optional] public ?string $password; /** * Base64 encoded CAS PDF file. */ - #[Api('pdf_file', optional: true)] + #[Optional('pdf_file')] public ?string $pdfFile; /** * URL to the CAS PDF file. */ - #[Api('pdf_url', optional: true)] + #[Optional('pdf_url')] public ?string $pdfURL; public function __construct() @@ -69,13 +58,13 @@ public static function with( ?string $pdfFile = null, ?string $pdfURL = null ): self { - $obj = new self; + $self = new self; - null !== $password && $obj->password = $password; - null !== $pdfFile && $obj->pdfFile = $pdfFile; - null !== $pdfURL && $obj->pdfURL = $pdfURL; + null !== $password && $self['password'] = $password; + null !== $pdfFile && $self['pdfFile'] = $pdfFile; + null !== $pdfURL && $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } /** @@ -83,10 +72,10 @@ public static function with( */ public function withPassword(string $password): self { - $obj = clone $this; - $obj->password = $password; + $self = clone $this; + $self['password'] = $password; - return $obj; + return $self; } /** @@ -94,10 +83,10 @@ public function withPassword(string $password): self */ public function withPdfFile(string $pdfFile): self { - $obj = clone $this; - $obj->pdfFile = $pdfFile; + $self = clone $this; + $self['pdfFile'] = $pdfFile; - return $obj; + return $self; } /** @@ -105,9 +94,9 @@ public function withPdfFile(string $pdfFile): self */ public function withPdfURL(string $pdfURL): self { - $obj = clone $this; - $obj->pdfURL = $pdfURL; + $self = clone $this; + $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } } diff --git a/src/CasParser/CasParserCdslParams.php b/src/CasParser/CasParserCdslParams.php index d48b9b2..0756764 100644 --- a/src/CasParser/CasParserCdslParams.php +++ b/src/CasParser/CasParserCdslParams.php @@ -4,54 +4,43 @@ namespace CasParser\CasParser; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Concerns\SdkParams; 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. + * @see CasParser\Services\CasParserService::cdsl() * - * `$client->casParser->cdsl(...$params->toArray());` - * - * @see CasParser\CasParser->cdsl - * - * @phpstan-type cas_parser_cdsl_params = array{ - * password?: string, pdfFile?: string, pdfURL?: string + * @phpstan-type CasParserCdslParamsShape = array{ + * password?: string|null, pdfFile?: string|null, pdfURL?: string|null * } */ final class CasParserCdslParams implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; use SdkParams; /** * Password for the PDF file (if required). */ - #[Api(optional: true)] + #[Optional] public ?string $password; /** * Base64 encoded CAS PDF file. */ - #[Api('pdf_file', optional: true)] + #[Optional('pdf_file')] public ?string $pdfFile; /** * URL to the CAS PDF file. */ - #[Api('pdf_url', optional: true)] + #[Optional('pdf_url')] public ?string $pdfURL; public function __construct() @@ -69,13 +58,13 @@ public static function with( ?string $pdfFile = null, ?string $pdfURL = null ): self { - $obj = new self; + $self = new self; - null !== $password && $obj->password = $password; - null !== $pdfFile && $obj->pdfFile = $pdfFile; - null !== $pdfURL && $obj->pdfURL = $pdfURL; + null !== $password && $self['password'] = $password; + null !== $pdfFile && $self['pdfFile'] = $pdfFile; + null !== $pdfURL && $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } /** @@ -83,10 +72,10 @@ public static function with( */ public function withPassword(string $password): self { - $obj = clone $this; - $obj->password = $password; + $self = clone $this; + $self['password'] = $password; - return $obj; + return $self; } /** @@ -94,10 +83,10 @@ public function withPassword(string $password): self */ public function withPdfFile(string $pdfFile): self { - $obj = clone $this; - $obj->pdfFile = $pdfFile; + $self = clone $this; + $self['pdfFile'] = $pdfFile; - return $obj; + return $self; } /** @@ -105,9 +94,9 @@ public function withPdfFile(string $pdfFile): self */ public function withPdfURL(string $pdfURL): self { - $obj = clone $this; - $obj->pdfURL = $pdfURL; + $self = clone $this; + $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } } diff --git a/src/CasParser/CasParserNsdlParams.php b/src/CasParser/CasParserNsdlParams.php index 98320b2..6221f30 100644 --- a/src/CasParser/CasParserNsdlParams.php +++ b/src/CasParser/CasParserNsdlParams.php @@ -4,54 +4,43 @@ namespace CasParser\CasParser; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Concerns\SdkParams; 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. + * @see CasParser\Services\CasParserService::nsdl() * - * `$client->casParser->nsdl(...$params->toArray());` - * - * @see CasParser\CasParser->nsdl - * - * @phpstan-type cas_parser_nsdl_params = array{ - * password?: string, pdfFile?: string, pdfURL?: string + * @phpstan-type CasParserNsdlParamsShape = array{ + * password?: string|null, pdfFile?: string|null, pdfURL?: string|null * } */ final class CasParserNsdlParams implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; use SdkParams; /** * Password for the PDF file (if required). */ - #[Api(optional: true)] + #[Optional] public ?string $password; /** * Base64 encoded CAS PDF file. */ - #[Api('pdf_file', optional: true)] + #[Optional('pdf_file')] public ?string $pdfFile; /** * URL to the CAS PDF file. */ - #[Api('pdf_url', optional: true)] + #[Optional('pdf_url')] public ?string $pdfURL; public function __construct() @@ -69,13 +58,13 @@ public static function with( ?string $pdfFile = null, ?string $pdfURL = null ): self { - $obj = new self; + $self = new self; - null !== $password && $obj->password = $password; - null !== $pdfFile && $obj->pdfFile = $pdfFile; - null !== $pdfURL && $obj->pdfURL = $pdfURL; + null !== $password && $self['password'] = $password; + null !== $pdfFile && $self['pdfFile'] = $pdfFile; + null !== $pdfURL && $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } /** @@ -83,10 +72,10 @@ public static function with( */ public function withPassword(string $password): self { - $obj = clone $this; - $obj->password = $password; + $self = clone $this; + $self['password'] = $password; - return $obj; + return $self; } /** @@ -94,10 +83,10 @@ public function withPassword(string $password): self */ public function withPdfFile(string $pdfFile): self { - $obj = clone $this; - $obj->pdfFile = $pdfFile; + $self = clone $this; + $self['pdfFile'] = $pdfFile; - return $obj; + return $self; } /** @@ -105,9 +94,9 @@ public function withPdfFile(string $pdfFile): self */ public function withPdfURL(string $pdfURL): self { - $obj = clone $this; - $obj->pdfURL = $pdfURL; + $self = clone $this; + $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } } diff --git a/src/CasParser/CasParserSmartParseParams.php b/src/CasParser/CasParserSmartParseParams.php index 525ebf1..eae6497 100644 --- a/src/CasParser/CasParserSmartParseParams.php +++ b/src/CasParser/CasParserSmartParseParams.php @@ -4,54 +4,43 @@ namespace CasParser\CasParser; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Concerns\SdkParams; 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. + * @see CasParser\Services\CasParserService::smartParse() * - * `$client->casParser->smartParse(...$params->toArray());` - * - * @see CasParser\CasParser->smartParse - * - * @phpstan-type cas_parser_smart_parse_params = array{ - * password?: string, pdfFile?: string, pdfURL?: string + * @phpstan-type CasParserSmartParseParamsShape = array{ + * password?: string|null, pdfFile?: string|null, pdfURL?: string|null * } */ final class CasParserSmartParseParams implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; use SdkParams; /** * Password for the PDF file (if required). */ - #[Api(optional: true)] + #[Optional] public ?string $password; /** * Base64 encoded CAS PDF file. */ - #[Api('pdf_file', optional: true)] + #[Optional('pdf_file')] public ?string $pdfFile; /** * URL to the CAS PDF file. */ - #[Api('pdf_url', optional: true)] + #[Optional('pdf_url')] public ?string $pdfURL; public function __construct() @@ -69,13 +58,13 @@ public static function with( ?string $pdfFile = null, ?string $pdfURL = null ): self { - $obj = new self; + $self = new self; - null !== $password && $obj->password = $password; - null !== $pdfFile && $obj->pdfFile = $pdfFile; - null !== $pdfURL && $obj->pdfURL = $pdfURL; + null !== $password && $self['password'] = $password; + null !== $pdfFile && $self['pdfFile'] = $pdfFile; + null !== $pdfURL && $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } /** @@ -83,10 +72,10 @@ public static function with( */ public function withPassword(string $password): self { - $obj = clone $this; - $obj->password = $password; + $self = clone $this; + $self['password'] = $password; - return $obj; + return $self; } /** @@ -94,10 +83,10 @@ public function withPassword(string $password): self */ public function withPdfFile(string $pdfFile): self { - $obj = clone $this; - $obj->pdfFile = $pdfFile; + $self = clone $this; + $self['pdfFile'] = $pdfFile; - return $obj; + return $self; } /** @@ -105,9 +94,9 @@ public function withPdfFile(string $pdfFile): self */ public function withPdfURL(string $pdfURL): self { - $obj = clone $this; - $obj->pdfURL = $pdfURL; + $self = clone $this; + $self['pdfURL'] = $pdfURL; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse.php b/src/CasParser/UnifiedResponse.php index 0eda57c..238d50d 100644 --- a/src/CasParser/UnifiedResponse.php +++ b/src/CasParser/UnifiedResponse.php @@ -9,48 +9,62 @@ use CasParser\CasParser\UnifiedResponse\Investor; use CasParser\CasParser\UnifiedResponse\Meta; use CasParser\CasParser\UnifiedResponse\MutualFund; +use CasParser\CasParser\UnifiedResponse\Np; use CasParser\CasParser\UnifiedResponse\Summary; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type unified_response = array{ - * dematAccounts?: list, - * insurance?: Insurance, - * investor?: Investor, - * meta?: Meta, - * mutualFunds?: list, - * summary?: Summary, - * } - * When used in a response, this type parameter can define a $rawResponse property. - * @template TRawResponse of object = object{} + * @phpstan-import-type DematAccountShape from \CasParser\CasParser\UnifiedResponse\DematAccount + * @phpstan-import-type InsuranceShape from \CasParser\CasParser\UnifiedResponse\Insurance + * @phpstan-import-type InvestorShape from \CasParser\CasParser\UnifiedResponse\Investor + * @phpstan-import-type MetaShape from \CasParser\CasParser\UnifiedResponse\Meta + * @phpstan-import-type MutualFundShape from \CasParser\CasParser\UnifiedResponse\MutualFund + * @phpstan-import-type NpShape from \CasParser\CasParser\UnifiedResponse\Np + * @phpstan-import-type SummaryShape from \CasParser\CasParser\UnifiedResponse\Summary * - * @mixin TRawResponse + * @phpstan-type UnifiedResponseShape = array{ + * dematAccounts?: list|null, + * insurance?: null|Insurance|InsuranceShape, + * investor?: null|Investor|InvestorShape, + * meta?: null|Meta|MetaShape, + * mutualFunds?: list|null, + * nps?: list|null, + * summary?: null|Summary|SummaryShape, + * } */ final class UnifiedResponse implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** @var list|null $dematAccounts */ - #[Api('demat_accounts', list: DematAccount::class, optional: true)] + #[Optional('demat_accounts', list: DematAccount::class)] public ?array $dematAccounts; - #[Api(optional: true)] + #[Optional] public ?Insurance $insurance; - #[Api(optional: true)] + #[Optional] public ?Investor $investor; - #[Api(optional: true)] + #[Optional] public ?Meta $meta; /** @var list|null $mutualFunds */ - #[Api('mutual_funds', list: MutualFund::class, optional: true)] + #[Optional('mutual_funds', list: MutualFund::class)] public ?array $mutualFunds; - #[Api(optional: true)] + /** + * List of NPS accounts. + * + * @var list|null $nps + */ + #[Optional(list: Np::class)] + public ?array $nps; + + #[Optional] public ?Summary $summary; public function __construct() @@ -63,80 +77,112 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param list $dematAccounts - * @param list $mutualFunds + * @param list|null $dematAccounts + * @param Insurance|InsuranceShape|null $insurance + * @param Investor|InvestorShape|null $investor + * @param Meta|MetaShape|null $meta + * @param list|null $mutualFunds + * @param list|null $nps + * @param Summary|SummaryShape|null $summary */ public static function with( ?array $dematAccounts = null, - ?Insurance $insurance = null, - ?Investor $investor = null, - ?Meta $meta = null, + Insurance|array|null $insurance = null, + Investor|array|null $investor = null, + Meta|array|null $meta = null, ?array $mutualFunds = null, - ?Summary $summary = null, + ?array $nps = null, + Summary|array|null $summary = null, ): self { - $obj = new self; + $self = new self; - null !== $dematAccounts && $obj->dematAccounts = $dematAccounts; - null !== $insurance && $obj->insurance = $insurance; - null !== $investor && $obj->investor = $investor; - null !== $meta && $obj->meta = $meta; - null !== $mutualFunds && $obj->mutualFunds = $mutualFunds; - null !== $summary && $obj->summary = $summary; + null !== $dematAccounts && $self['dematAccounts'] = $dematAccounts; + null !== $insurance && $self['insurance'] = $insurance; + null !== $investor && $self['investor'] = $investor; + null !== $meta && $self['meta'] = $meta; + null !== $mutualFunds && $self['mutualFunds'] = $mutualFunds; + null !== $nps && $self['nps'] = $nps; + null !== $summary && $self['summary'] = $summary; - return $obj; + return $self; } /** - * @param list $dematAccounts + * @param list $dematAccounts */ public function withDematAccounts(array $dematAccounts): self { - $obj = clone $this; - $obj->dematAccounts = $dematAccounts; + $self = clone $this; + $self['dematAccounts'] = $dematAccounts; - return $obj; + return $self; } - public function withInsurance(Insurance $insurance): self + /** + * @param Insurance|InsuranceShape $insurance + */ + public function withInsurance(Insurance|array $insurance): self { - $obj = clone $this; - $obj->insurance = $insurance; + $self = clone $this; + $self['insurance'] = $insurance; - return $obj; + return $self; } - public function withInvestor(Investor $investor): self + /** + * @param Investor|InvestorShape $investor + */ + public function withInvestor(Investor|array $investor): self { - $obj = clone $this; - $obj->investor = $investor; + $self = clone $this; + $self['investor'] = $investor; - return $obj; + return $self; } - public function withMeta(Meta $meta): self + /** + * @param Meta|MetaShape $meta + */ + public function withMeta(Meta|array $meta): self { - $obj = clone $this; - $obj->meta = $meta; + $self = clone $this; + $self['meta'] = $meta; - return $obj; + return $self; } /** - * @param list $mutualFunds + * @param list $mutualFunds */ public function withMutualFunds(array $mutualFunds): self { - $obj = clone $this; - $obj->mutualFunds = $mutualFunds; + $self = clone $this; + $self['mutualFunds'] = $mutualFunds; + + return $self; + } + + /** + * List of NPS accounts. + * + * @param list $nps + */ + public function withNps(array $nps): self + { + $self = clone $this; + $self['nps'] = $nps; - return $obj; + return $self; } - public function withSummary(Summary $summary): self + /** + * @param Summary|SummaryShape $summary + */ + public function withSummary(Summary|array $summary): self { - $obj = clone $this; - $obj->summary = $summary; + $self = clone $this; + $self['summary'] = $summary; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount.php b/src/CasParser/UnifiedResponse/DematAccount.php index 0c57e41..27961d4 100644 --- a/src/CasParser/UnifiedResponse/DematAccount.php +++ b/src/CasParser/UnifiedResponse/DematAccount.php @@ -7,43 +7,49 @@ use CasParser\CasParser\UnifiedResponse\DematAccount\AdditionalInfo; use CasParser\CasParser\UnifiedResponse\DematAccount\DematType; use CasParser\CasParser\UnifiedResponse\DematAccount\Holdings; -use CasParser\Core\Attributes\Api; +use CasParser\CasParser\UnifiedResponse\DematAccount\LinkedHolder; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type demat_account = array{ - * additionalInfo?: AdditionalInfo, - * boID?: string, - * clientID?: string, - * dematType?: value-of, - * dpID?: string, - * dpName?: string, - * holdings?: Holdings, - * value?: float, + * @phpstan-import-type AdditionalInfoShape from \CasParser\CasParser\UnifiedResponse\DematAccount\AdditionalInfo + * @phpstan-import-type HoldingsShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings + * @phpstan-import-type LinkedHolderShape from \CasParser\CasParser\UnifiedResponse\DematAccount\LinkedHolder + * + * @phpstan-type DematAccountShape = array{ + * additionalInfo?: null|AdditionalInfo|AdditionalInfoShape, + * boID?: string|null, + * clientID?: string|null, + * dematType?: null|DematType|value-of, + * dpID?: string|null, + * dpName?: string|null, + * holdings?: null|Holdings|HoldingsShape, + * linkedHolders?: list|null, + * value?: float|null, * } */ final class DematAccount implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the demat account type. */ - #[Api('additional_info', optional: true)] + #[Optional('additional_info')] public ?AdditionalInfo $additionalInfo; /** * Beneficiary Owner ID (primarily for CDSL). */ - #[Api('bo_id', optional: true)] + #[Optional('bo_id')] public ?string $boID; /** * Client ID. */ - #[Api('client_id', optional: true)] + #[Optional('client_id')] public ?string $clientID; /** @@ -51,28 +57,36 @@ final class DematAccount implements BaseModel * * @var value-of|null $dematType */ - #[Api('demat_type', enum: DematType::class, optional: true)] + #[Optional('demat_type', enum: DematType::class)] public ?string $dematType; /** * Depository Participant ID. */ - #[Api('dp_id', optional: true)] + #[Optional('dp_id')] public ?string $dpID; /** * Depository Participant name. */ - #[Api('dp_name', optional: true)] + #[Optional('dp_name')] public ?string $dpName; - #[Api(optional: true)] + #[Optional] public ?Holdings $holdings; + /** + * List of account holders linked to this demat account. + * + * @var list|null $linkedHolders + */ + #[Optional('linked_holders', list: LinkedHolder::class)] + public ?array $linkedHolders; + /** * Total value of the demat account. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -85,41 +99,49 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param DematType|value-of $dematType + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param DematType|value-of|null $dematType + * @param Holdings|HoldingsShape|null $holdings + * @param list|null $linkedHolders */ public static function with( - ?AdditionalInfo $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?string $boID = null, ?string $clientID = null, DematType|string|null $dematType = null, ?string $dpID = null, ?string $dpName = null, - ?Holdings $holdings = null, + Holdings|array|null $holdings = null, + ?array $linkedHolders = null, ?float $value = null, ): self { - $obj = new self; - - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $boID && $obj->boID = $boID; - null !== $clientID && $obj->clientID = $clientID; - null !== $dematType && $obj->dematType = $dematType instanceof DematType ? $dematType->value : $dematType; - null !== $dpID && $obj->dpID = $dpID; - null !== $dpName && $obj->dpName = $dpName; - null !== $holdings && $obj->holdings = $holdings; - null !== $value && $obj->value = $value; - - return $obj; + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $boID && $self['boID'] = $boID; + null !== $clientID && $self['clientID'] = $clientID; + null !== $dematType && $self['dematType'] = $dematType; + null !== $dpID && $self['dpID'] = $dpID; + null !== $dpName && $self['dpName'] = $dpName; + null !== $holdings && $self['holdings'] = $holdings; + null !== $linkedHolders && $self['linkedHolders'] = $linkedHolders; + null !== $value && $self['value'] = $value; + + return $self; } /** * Additional information specific to the demat account type. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(AdditionalInfo $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -127,10 +149,10 @@ public function withAdditionalInfo(AdditionalInfo $additionalInfo): self */ public function withBoID(string $boID): self { - $obj = clone $this; - $obj->boID = $boID; + $self = clone $this; + $self['boID'] = $boID; - return $obj; + return $self; } /** @@ -138,10 +160,10 @@ public function withBoID(string $boID): self */ public function withClientID(string $clientID): self { - $obj = clone $this; - $obj->clientID = $clientID; + $self = clone $this; + $self['clientID'] = $clientID; - return $obj; + return $self; } /** @@ -151,10 +173,10 @@ public function withClientID(string $clientID): self */ public function withDematType(DematType|string $dematType): self { - $obj = clone $this; - $obj->dematType = $dematType instanceof DematType ? $dematType->value : $dematType; + $self = clone $this; + $self['dematType'] = $dematType; - return $obj; + return $self; } /** @@ -162,10 +184,10 @@ public function withDematType(DematType|string $dematType): self */ public function withDpID(string $dpID): self { - $obj = clone $this; - $obj->dpID = $dpID; + $self = clone $this; + $self['dpID'] = $dpID; - return $obj; + return $self; } /** @@ -173,18 +195,34 @@ public function withDpID(string $dpID): self */ public function withDpName(string $dpName): self { - $obj = clone $this; - $obj->dpName = $dpName; + $self = clone $this; + $self['dpName'] = $dpName; - return $obj; + return $self; } - public function withHoldings(Holdings $holdings): self + /** + * @param Holdings|HoldingsShape $holdings + */ + public function withHoldings(Holdings|array $holdings): self + { + $self = clone $this; + $self['holdings'] = $holdings; + + return $self; + } + + /** + * List of account holders linked to this demat account. + * + * @param list $linkedHolders + */ + public function withLinkedHolders(array $linkedHolders): self { - $obj = clone $this; - $obj->holdings = $holdings; + $self = clone $this; + $self['linkedHolders'] = $linkedHolders; - return $obj; + return $self; } /** @@ -192,9 +230,9 @@ public function withHoldings(Holdings $holdings): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/AdditionalInfo.php index c7a8be5..0e7de05 100644 --- a/src/CasParser/UnifiedResponse/DematAccount/AdditionalInfo.php +++ b/src/CasParser/UnifiedResponse/DematAccount/AdditionalInfo.php @@ -4,57 +4,57 @@ namespace CasParser\CasParser\UnifiedResponse\DematAccount; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** * Additional information specific to the demat account type. * - * @phpstan-type additional_info = array{ - * boStatus?: string, - * boSubStatus?: string, - * boType?: string, - * bsda?: string, - * email?: string, - * linkedPans?: list, - * nominee?: string, - * status?: string, + * @phpstan-type AdditionalInfoShape = array{ + * boStatus?: string|null, + * boSubStatus?: string|null, + * boType?: string|null, + * bsda?: string|null, + * email?: string|null, + * linkedPans?: list|null, + * nominee?: string|null, + * status?: string|null, * } */ final class AdditionalInfo implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Beneficiary Owner status (CDSL). */ - #[Api('bo_status', optional: true)] + #[Optional('bo_status')] public ?string $boStatus; /** * Beneficiary Owner sub-status (CDSL). */ - #[Api('bo_sub_status', optional: true)] + #[Optional('bo_sub_status')] public ?string $boSubStatus; /** * Beneficiary Owner type (CDSL). */ - #[Api('bo_type', optional: true)] + #[Optional('bo_type')] public ?string $boType; /** * Basic Services Demat Account status (CDSL). */ - #[Api(optional: true)] + #[Optional] public ?string $bsda; /** * Email associated with the demat account (CDSL). */ - #[Api(optional: true)] + #[Optional] public ?string $email; /** @@ -62,19 +62,19 @@ final class AdditionalInfo implements BaseModel * * @var list|null $linkedPans */ - #[Api('linked_pans', list: 'string', optional: true)] + #[Optional('linked_pans', list: 'string')] public ?array $linkedPans; /** * Nominee details (CDSL). */ - #[Api(optional: true)] + #[Optional] public ?string $nominee; /** * Account status (CDSL). */ - #[Api(optional: true)] + #[Optional] public ?string $status; public function __construct() @@ -87,7 +87,7 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param list $linkedPans + * @param list|null $linkedPans */ public static function with( ?string $boStatus = null, @@ -99,18 +99,18 @@ public static function with( ?string $nominee = null, ?string $status = null, ): self { - $obj = new self; - - null !== $boStatus && $obj->boStatus = $boStatus; - null !== $boSubStatus && $obj->boSubStatus = $boSubStatus; - null !== $boType && $obj->boType = $boType; - null !== $bsda && $obj->bsda = $bsda; - null !== $email && $obj->email = $email; - null !== $linkedPans && $obj->linkedPans = $linkedPans; - null !== $nominee && $obj->nominee = $nominee; - null !== $status && $obj->status = $status; - - return $obj; + $self = new self; + + null !== $boStatus && $self['boStatus'] = $boStatus; + null !== $boSubStatus && $self['boSubStatus'] = $boSubStatus; + null !== $boType && $self['boType'] = $boType; + null !== $bsda && $self['bsda'] = $bsda; + null !== $email && $self['email'] = $email; + null !== $linkedPans && $self['linkedPans'] = $linkedPans; + null !== $nominee && $self['nominee'] = $nominee; + null !== $status && $self['status'] = $status; + + return $self; } /** @@ -118,10 +118,10 @@ public static function with( */ public function withBoStatus(string $boStatus): self { - $obj = clone $this; - $obj->boStatus = $boStatus; + $self = clone $this; + $self['boStatus'] = $boStatus; - return $obj; + return $self; } /** @@ -129,10 +129,10 @@ public function withBoStatus(string $boStatus): self */ public function withBoSubStatus(string $boSubStatus): self { - $obj = clone $this; - $obj->boSubStatus = $boSubStatus; + $self = clone $this; + $self['boSubStatus'] = $boSubStatus; - return $obj; + return $self; } /** @@ -140,10 +140,10 @@ public function withBoSubStatus(string $boSubStatus): self */ public function withBoType(string $boType): self { - $obj = clone $this; - $obj->boType = $boType; + $self = clone $this; + $self['boType'] = $boType; - return $obj; + return $self; } /** @@ -151,10 +151,10 @@ public function withBoType(string $boType): self */ public function withBsda(string $bsda): self { - $obj = clone $this; - $obj->bsda = $bsda; + $self = clone $this; + $self['bsda'] = $bsda; - return $obj; + return $self; } /** @@ -162,10 +162,10 @@ public function withBsda(string $bsda): self */ public function withEmail(string $email): self { - $obj = clone $this; - $obj->email = $email; + $self = clone $this; + $self['email'] = $email; - return $obj; + return $self; } /** @@ -175,10 +175,10 @@ public function withEmail(string $email): self */ public function withLinkedPans(array $linkedPans): self { - $obj = clone $this; - $obj->linkedPans = $linkedPans; + $self = clone $this; + $self['linkedPans'] = $linkedPans; - return $obj; + return $self; } /** @@ -186,10 +186,10 @@ public function withLinkedPans(array $linkedPans): self */ public function withNominee(string $nominee): self { - $obj = clone $this; - $obj->nominee = $nominee; + $self = clone $this; + $self['nominee'] = $nominee; - return $obj; + return $self; } /** @@ -197,9 +197,9 @@ public function withNominee(string $nominee): self */ public function withStatus(string $status): self { - $obj = clone $this; - $obj->status = $status; + $self = clone $this; + $self['status'] = $status; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings.php index eb3b0d1..7e286f0 100644 --- a/src/CasParser/UnifiedResponse/DematAccount/Holdings.php +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings.php @@ -9,46 +9,48 @@ use CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\DematMutualFund; use CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\Equity; use CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\GovernmentSecurity; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type holdings_alias = array{ - * aifs?: list, - * corporateBonds?: list, - * dematMutualFunds?: list, - * equities?: list, - * governmentSecurities?: list, + * @phpstan-import-type AifShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\Aif + * @phpstan-import-type CorporateBondShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\CorporateBond + * @phpstan-import-type DematMutualFundShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\DematMutualFund + * @phpstan-import-type EquityShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\Equity + * @phpstan-import-type GovernmentSecurityShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\GovernmentSecurity + * + * @phpstan-type HoldingsShape = array{ + * aifs?: list|null, + * corporateBonds?: list|null, + * dematMutualFunds?: list|null, + * equities?: list|null, + * governmentSecurities?: list|null, * } */ final class Holdings implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** @var list|null $aifs */ - #[Api(list: Aif::class, optional: true)] + #[Optional(list: Aif::class)] public ?array $aifs; /** @var list|null $corporateBonds */ - #[Api('corporate_bonds', list: CorporateBond::class, optional: true)] + #[Optional('corporate_bonds', list: CorporateBond::class)] public ?array $corporateBonds; /** @var list|null $dematMutualFunds */ - #[Api('demat_mutual_funds', list: DematMutualFund::class, optional: true)] + #[Optional('demat_mutual_funds', list: DematMutualFund::class)] public ?array $dematMutualFunds; /** @var list|null $equities */ - #[Api(list: Equity::class, optional: true)] + #[Optional(list: Equity::class)] public ?array $equities; /** @var list|null $governmentSecurities */ - #[Api( - 'government_securities', - list: GovernmentSecurity::class, - optional: true - )] + #[Optional('government_securities', list: GovernmentSecurity::class)] public ?array $governmentSecurities; public function __construct() @@ -61,11 +63,11 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param list $aifs - * @param list $corporateBonds - * @param list $dematMutualFunds - * @param list $equities - * @param list $governmentSecurities + * @param list|null $aifs + * @param list|null $corporateBonds + * @param list|null $dematMutualFunds + * @param list|null $equities + * @param list|null $governmentSecurities */ public static function with( ?array $aifs = null, @@ -74,69 +76,69 @@ public static function with( ?array $equities = null, ?array $governmentSecurities = null, ): self { - $obj = new self; + $self = new self; - null !== $aifs && $obj->aifs = $aifs; - null !== $corporateBonds && $obj->corporateBonds = $corporateBonds; - null !== $dematMutualFunds && $obj->dematMutualFunds = $dematMutualFunds; - null !== $equities && $obj->equities = $equities; - null !== $governmentSecurities && $obj->governmentSecurities = $governmentSecurities; + null !== $aifs && $self['aifs'] = $aifs; + null !== $corporateBonds && $self['corporateBonds'] = $corporateBonds; + null !== $dematMutualFunds && $self['dematMutualFunds'] = $dematMutualFunds; + null !== $equities && $self['equities'] = $equities; + null !== $governmentSecurities && $self['governmentSecurities'] = $governmentSecurities; - return $obj; + return $self; } /** - * @param list $aifs + * @param list $aifs */ public function withAifs(array $aifs): self { - $obj = clone $this; - $obj->aifs = $aifs; + $self = clone $this; + $self['aifs'] = $aifs; - return $obj; + return $self; } /** - * @param list $corporateBonds + * @param list $corporateBonds */ public function withCorporateBonds(array $corporateBonds): self { - $obj = clone $this; - $obj->corporateBonds = $corporateBonds; + $self = clone $this; + $self['corporateBonds'] = $corporateBonds; - return $obj; + return $self; } /** - * @param list $dematMutualFunds + * @param list $dematMutualFunds */ public function withDematMutualFunds(array $dematMutualFunds): self { - $obj = clone $this; - $obj->dematMutualFunds = $dematMutualFunds; + $self = clone $this; + $self['dematMutualFunds'] = $dematMutualFunds; - return $obj; + return $self; } /** - * @param list $equities + * @param list $equities */ public function withEquities(array $equities): self { - $obj = clone $this; - $obj->equities = $equities; + $self = clone $this; + $self['equities'] = $equities; - return $obj; + return $self; } /** - * @param list $governmentSecurities + * @param list $governmentSecurities */ public function withGovernmentSecurities(array $governmentSecurities): self { - $obj = clone $this; - $obj->governmentSecurities = $governmentSecurities; + $self = clone $this; + $self['governmentSecurities'] = $governmentSecurities; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif.php index 1df6013..b90689a 100644 --- a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif.php +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif.php @@ -4,52 +4,66 @@ namespace CasParser\CasParser\UnifiedResponse\DematAccount\Holdings; -use CasParser\Core\Attributes\Api; +use CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\Aif\AdditionalInfo; +use CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\Aif\Transaction; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type aif_alias = array{ - * additionalInfo?: mixed, - * isin?: string, - * name?: string, - * units?: float, - * value?: float, + * @phpstan-import-type AdditionalInfoShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\Aif\AdditionalInfo + * @phpstan-import-type TransactionShape from \CasParser\CasParser\UnifiedResponse\DematAccount\Holdings\Aif\Transaction + * + * @phpstan-type AifShape = array{ + * additionalInfo?: null|AdditionalInfo|AdditionalInfoShape, + * isin?: string|null, + * name?: string|null, + * transactions?: list|null, + * units?: float|null, + * value?: float|null, * } */ final class Aif implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the AIF. */ - #[Api('additional_info', optional: true)] - public mixed $additionalInfo; + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; /** * ISIN code of the AIF. */ - #[Api(optional: true)] + #[Optional] public ?string $isin; /** * Name of the AIF. */ - #[Api(optional: true)] + #[Optional] public ?string $name; + /** + * List of transactions for this holding (beta). + * + * @var list|null $transactions + */ + #[Optional(list: Transaction::class)] + public ?array $transactions; + /** * Number of units held. */ - #[Api(optional: true)] + #[Optional] public ?float $units; /** * Current market value of the holding. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -61,34 +75,42 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param list|null $transactions */ public static function with( - mixed $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?string $isin = null, ?string $name = null, + ?array $transactions = null, ?float $units = null, ?float $value = null, ): self { - $obj = new self; + $self = new self; - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $isin && $obj->isin = $isin; - null !== $name && $obj->name = $name; - null !== $units && $obj->units = $units; - null !== $value && $obj->value = $value; + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $isin && $self['isin'] = $isin; + null !== $name && $self['name'] = $name; + null !== $transactions && $self['transactions'] = $transactions; + null !== $units && $self['units'] = $units; + null !== $value && $self['value'] = $value; - return $obj; + return $self; } /** * Additional information specific to the AIF. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(mixed $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -96,10 +118,10 @@ public function withAdditionalInfo(mixed $additionalInfo): self */ public function withIsin(string $isin): self { - $obj = clone $this; - $obj->isin = $isin; + $self = clone $this; + $self['isin'] = $isin; - return $obj; + return $self; } /** @@ -107,10 +129,23 @@ public function withIsin(string $isin): self */ public function withName(string $name): self { - $obj = clone $this; - $obj->name = $name; + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * List of transactions for this holding (beta). + * + * @param list $transactions + */ + public function withTransactions(array $transactions): self + { + $self = clone $this; + $self['transactions'] = $transactions; - return $obj; + return $self; } /** @@ -118,10 +153,10 @@ public function withName(string $name): self */ public function withUnits(float $units): self { - $obj = clone $this; - $obj->units = $units; + $self = clone $this; + $self['units'] = $units; - return $obj; + return $self; } /** @@ -129,9 +164,9 @@ public function withUnits(float $units): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/AdditionalInfo.php new file mode 100644 index 0000000..809fdd3 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/AdditionalInfo.php @@ -0,0 +1,78 @@ + */ + use SdkModel; + + /** + * Closing balance units for the statement period (beta). + */ + #[Optional('close_units', nullable: true)] + public ?float $closeUnits; + + /** + * Opening balance units for the statement period (beta). + */ + #[Optional('open_units', nullable: true)] + public ?float $openUnits; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $closeUnits = null, + ?float $openUnits = null + ): self { + $self = new self; + + null !== $closeUnits && $self['closeUnits'] = $closeUnits; + null !== $openUnits && $self['openUnits'] = $openUnits; + + return $self; + } + + /** + * Closing balance units for the statement period (beta). + */ + public function withCloseUnits(?float $closeUnits): self + { + $self = clone $this; + $self['closeUnits'] = $closeUnits; + + return $self; + } + + /** + * Opening balance units for the statement period (beta). + */ + public function withOpenUnits(?float $openUnits): self + { + $self = clone $this; + $self['openUnits'] = $openUnits; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction.php new file mode 100644 index 0000000..2733719 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction.php @@ -0,0 +1,233 @@ +, + * units?: float|null, + * } + */ +final class Transaction implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Additional transaction-specific fields that vary by source. + */ + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + #[Optional(nullable: true)] + public ?float $amount; + + /** + * Balance units after transaction. + */ + #[Optional] + public ?float $balance; + + /** + * Transaction date (YYYY-MM-DD). + */ + #[Optional] + public ?string $date; + + /** + * Transaction description/particulars. + */ + #[Optional] + public ?string $description; + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + #[Optional('dividend_rate', nullable: true)] + public ?float $dividendRate; + + /** + * NAV/price per unit on transaction date. + */ + #[Optional(nullable: true)] + public ?float $nav; + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @var value-of|null $type + */ + #[Optional(enum: Type::class)] + public ?string $type; + + /** + * Number of units involved in transaction. + */ + #[Optional] + public ?float $units; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param Type|value-of|null $type + */ + public static function with( + AdditionalInfo|array|null $additionalInfo = null, + ?float $amount = null, + ?float $balance = null, + ?string $date = null, + ?string $description = null, + ?float $dividendRate = null, + ?float $nav = null, + Type|string|null $type = null, + ?float $units = null, + ): self { + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $amount && $self['amount'] = $amount; + null !== $balance && $self['balance'] = $balance; + null !== $date && $self['date'] = $date; + null !== $description && $self['description'] = $description; + null !== $dividendRate && $self['dividendRate'] = $dividendRate; + null !== $nav && $self['nav'] = $nav; + null !== $type && $self['type'] = $type; + null !== $units && $self['units'] = $units; + + return $self; + } + + /** + * Additional transaction-specific fields that vary by source. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo + */ + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo, + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + public function withAmount(?float $amount): self + { + $self = clone $this; + $self['amount'] = $amount; + + return $self; + } + + /** + * Balance units after transaction. + */ + public function withBalance(float $balance): self + { + $self = clone $this; + $self['balance'] = $balance; + + return $self; + } + + /** + * Transaction date (YYYY-MM-DD). + */ + public function withDate(string $date): self + { + $self = clone $this; + $self['date'] = $date; + + return $self; + } + + /** + * Transaction description/particulars. + */ + public function withDescription(string $description): self + { + $self = clone $this; + $self['description'] = $description; + + return $self; + } + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + public function withDividendRate(?float $dividendRate): self + { + $self = clone $this; + $self['dividendRate'] = $dividendRate; + + return $self; + } + + /** + * NAV/price per unit on transaction date. + */ + public function withNav(?float $nav): self + { + $self = clone $this; + $self['nav'] = $nav; + + return $self; + } + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @param Type|value-of $type + */ + public function withType(Type|string $type): self + { + $self = clone $this; + $self['type'] = $type; + + return $self; + } + + /** + * Number of units involved in transaction. + */ + public function withUnits(float $units): self + { + $self = clone $this; + $self['units'] = $units; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction/AdditionalInfo.php new file mode 100644 index 0000000..9ee6611 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction/AdditionalInfo.php @@ -0,0 +1,179 @@ + */ + use SdkModel; + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + #[Optional('capital_withdrawal')] + public ?float $capitalWithdrawal; + + /** + * Units credited (demat transactions). + */ + #[Optional] + public ?float $credit; + + /** + * Units debited (demat transactions). + */ + #[Optional] + public ?float $debit; + + /** + * Income distribution amount (CDSL MF transactions). + */ + #[Optional('income_distribution')] + public ?float $incomeDistribution; + + /** + * Order/transaction reference number (demat transactions). + */ + #[Optional('order_no')] + public ?string $orderNo; + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + #[Optional] + public ?float $price; + + /** + * Stamp duty charged. + */ + #[Optional('stamp_duty')] + public ?float $stampDuty; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $capitalWithdrawal = null, + ?float $credit = null, + ?float $debit = null, + ?float $incomeDistribution = null, + ?string $orderNo = null, + ?float $price = null, + ?float $stampDuty = null, + ): self { + $self = new self; + + null !== $capitalWithdrawal && $self['capitalWithdrawal'] = $capitalWithdrawal; + null !== $credit && $self['credit'] = $credit; + null !== $debit && $self['debit'] = $debit; + null !== $incomeDistribution && $self['incomeDistribution'] = $incomeDistribution; + null !== $orderNo && $self['orderNo'] = $orderNo; + null !== $price && $self['price'] = $price; + null !== $stampDuty && $self['stampDuty'] = $stampDuty; + + return $self; + } + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + public function withCapitalWithdrawal(float $capitalWithdrawal): self + { + $self = clone $this; + $self['capitalWithdrawal'] = $capitalWithdrawal; + + return $self; + } + + /** + * Units credited (demat transactions). + */ + public function withCredit(float $credit): self + { + $self = clone $this; + $self['credit'] = $credit; + + return $self; + } + + /** + * Units debited (demat transactions). + */ + public function withDebit(float $debit): self + { + $self = clone $this; + $self['debit'] = $debit; + + return $self; + } + + /** + * Income distribution amount (CDSL MF transactions). + */ + public function withIncomeDistribution(float $incomeDistribution): self + { + $self = clone $this; + $self['incomeDistribution'] = $incomeDistribution; + + return $self; + } + + /** + * Order/transaction reference number (demat transactions). + */ + public function withOrderNo(string $orderNo): self + { + $self = clone $this; + $self['orderNo'] = $orderNo; + + return $self; + } + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + public function withPrice(float $price): self + { + $self = clone $this; + $self['price'] = $price; + + return $self; + } + + /** + * Stamp duty charged. + */ + public function withStampDuty(float $stampDuty): self + { + $self = clone $this; + $self['stampDuty'] = $stampDuty; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction/Type.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction/Type.php new file mode 100644 index 0000000..4274cfa --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Aif/Transaction/Type.php @@ -0,0 +1,43 @@ +|null, + * units?: float|null, + * value?: float|null, * } */ final class CorporateBond implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the corporate bond. */ - #[Api('additional_info', optional: true)] - public mixed $additionalInfo; + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; /** * ISIN code of the corporate bond. */ - #[Api(optional: true)] + #[Optional] public ?string $isin; /** * Name of the corporate bond. */ - #[Api(optional: true)] + #[Optional] public ?string $name; + /** + * List of transactions for this holding (beta). + * + * @var list|null $transactions + */ + #[Optional(list: Transaction::class)] + public ?array $transactions; + /** * Number of units held. */ - #[Api(optional: true)] + #[Optional] public ?float $units; /** * Current market value of the holding. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -61,34 +75,42 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param list|null $transactions */ public static function with( - mixed $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?string $isin = null, ?string $name = null, + ?array $transactions = null, ?float $units = null, ?float $value = null, ): self { - $obj = new self; + $self = new self; - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $isin && $obj->isin = $isin; - null !== $name && $obj->name = $name; - null !== $units && $obj->units = $units; - null !== $value && $obj->value = $value; + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $isin && $self['isin'] = $isin; + null !== $name && $self['name'] = $name; + null !== $transactions && $self['transactions'] = $transactions; + null !== $units && $self['units'] = $units; + null !== $value && $self['value'] = $value; - return $obj; + return $self; } /** * Additional information specific to the corporate bond. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(mixed $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -96,10 +118,10 @@ public function withAdditionalInfo(mixed $additionalInfo): self */ public function withIsin(string $isin): self { - $obj = clone $this; - $obj->isin = $isin; + $self = clone $this; + $self['isin'] = $isin; - return $obj; + return $self; } /** @@ -107,10 +129,23 @@ public function withIsin(string $isin): self */ public function withName(string $name): self { - $obj = clone $this; - $obj->name = $name; + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * List of transactions for this holding (beta). + * + * @param list $transactions + */ + public function withTransactions(array $transactions): self + { + $self = clone $this; + $self['transactions'] = $transactions; - return $obj; + return $self; } /** @@ -118,10 +153,10 @@ public function withName(string $name): self */ public function withUnits(float $units): self { - $obj = clone $this; - $obj->units = $units; + $self = clone $this; + $self['units'] = $units; - return $obj; + return $self; } /** @@ -129,9 +164,9 @@ public function withUnits(float $units): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/AdditionalInfo.php new file mode 100644 index 0000000..c757708 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/AdditionalInfo.php @@ -0,0 +1,78 @@ + */ + use SdkModel; + + /** + * Closing balance units for the statement period (beta). + */ + #[Optional('close_units', nullable: true)] + public ?float $closeUnits; + + /** + * Opening balance units for the statement period (beta). + */ + #[Optional('open_units', nullable: true)] + public ?float $openUnits; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $closeUnits = null, + ?float $openUnits = null + ): self { + $self = new self; + + null !== $closeUnits && $self['closeUnits'] = $closeUnits; + null !== $openUnits && $self['openUnits'] = $openUnits; + + return $self; + } + + /** + * Closing balance units for the statement period (beta). + */ + public function withCloseUnits(?float $closeUnits): self + { + $self = clone $this; + $self['closeUnits'] = $closeUnits; + + return $self; + } + + /** + * Opening balance units for the statement period (beta). + */ + public function withOpenUnits(?float $openUnits): self + { + $self = clone $this; + $self['openUnits'] = $openUnits; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction.php new file mode 100644 index 0000000..816f7c6 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction.php @@ -0,0 +1,233 @@ +, + * units?: float|null, + * } + */ +final class Transaction implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Additional transaction-specific fields that vary by source. + */ + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + #[Optional(nullable: true)] + public ?float $amount; + + /** + * Balance units after transaction. + */ + #[Optional] + public ?float $balance; + + /** + * Transaction date (YYYY-MM-DD). + */ + #[Optional] + public ?string $date; + + /** + * Transaction description/particulars. + */ + #[Optional] + public ?string $description; + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + #[Optional('dividend_rate', nullable: true)] + public ?float $dividendRate; + + /** + * NAV/price per unit on transaction date. + */ + #[Optional(nullable: true)] + public ?float $nav; + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @var value-of|null $type + */ + #[Optional(enum: Type::class)] + public ?string $type; + + /** + * Number of units involved in transaction. + */ + #[Optional] + public ?float $units; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param Type|value-of|null $type + */ + public static function with( + AdditionalInfo|array|null $additionalInfo = null, + ?float $amount = null, + ?float $balance = null, + ?string $date = null, + ?string $description = null, + ?float $dividendRate = null, + ?float $nav = null, + Type|string|null $type = null, + ?float $units = null, + ): self { + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $amount && $self['amount'] = $amount; + null !== $balance && $self['balance'] = $balance; + null !== $date && $self['date'] = $date; + null !== $description && $self['description'] = $description; + null !== $dividendRate && $self['dividendRate'] = $dividendRate; + null !== $nav && $self['nav'] = $nav; + null !== $type && $self['type'] = $type; + null !== $units && $self['units'] = $units; + + return $self; + } + + /** + * Additional transaction-specific fields that vary by source. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo + */ + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo, + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + public function withAmount(?float $amount): self + { + $self = clone $this; + $self['amount'] = $amount; + + return $self; + } + + /** + * Balance units after transaction. + */ + public function withBalance(float $balance): self + { + $self = clone $this; + $self['balance'] = $balance; + + return $self; + } + + /** + * Transaction date (YYYY-MM-DD). + */ + public function withDate(string $date): self + { + $self = clone $this; + $self['date'] = $date; + + return $self; + } + + /** + * Transaction description/particulars. + */ + public function withDescription(string $description): self + { + $self = clone $this; + $self['description'] = $description; + + return $self; + } + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + public function withDividendRate(?float $dividendRate): self + { + $self = clone $this; + $self['dividendRate'] = $dividendRate; + + return $self; + } + + /** + * NAV/price per unit on transaction date. + */ + public function withNav(?float $nav): self + { + $self = clone $this; + $self['nav'] = $nav; + + return $self; + } + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @param Type|value-of $type + */ + public function withType(Type|string $type): self + { + $self = clone $this; + $self['type'] = $type; + + return $self; + } + + /** + * Number of units involved in transaction. + */ + public function withUnits(float $units): self + { + $self = clone $this; + $self['units'] = $units; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction/AdditionalInfo.php new file mode 100644 index 0000000..9c2471c --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction/AdditionalInfo.php @@ -0,0 +1,179 @@ + */ + use SdkModel; + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + #[Optional('capital_withdrawal')] + public ?float $capitalWithdrawal; + + /** + * Units credited (demat transactions). + */ + #[Optional] + public ?float $credit; + + /** + * Units debited (demat transactions). + */ + #[Optional] + public ?float $debit; + + /** + * Income distribution amount (CDSL MF transactions). + */ + #[Optional('income_distribution')] + public ?float $incomeDistribution; + + /** + * Order/transaction reference number (demat transactions). + */ + #[Optional('order_no')] + public ?string $orderNo; + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + #[Optional] + public ?float $price; + + /** + * Stamp duty charged. + */ + #[Optional('stamp_duty')] + public ?float $stampDuty; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $capitalWithdrawal = null, + ?float $credit = null, + ?float $debit = null, + ?float $incomeDistribution = null, + ?string $orderNo = null, + ?float $price = null, + ?float $stampDuty = null, + ): self { + $self = new self; + + null !== $capitalWithdrawal && $self['capitalWithdrawal'] = $capitalWithdrawal; + null !== $credit && $self['credit'] = $credit; + null !== $debit && $self['debit'] = $debit; + null !== $incomeDistribution && $self['incomeDistribution'] = $incomeDistribution; + null !== $orderNo && $self['orderNo'] = $orderNo; + null !== $price && $self['price'] = $price; + null !== $stampDuty && $self['stampDuty'] = $stampDuty; + + return $self; + } + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + public function withCapitalWithdrawal(float $capitalWithdrawal): self + { + $self = clone $this; + $self['capitalWithdrawal'] = $capitalWithdrawal; + + return $self; + } + + /** + * Units credited (demat transactions). + */ + public function withCredit(float $credit): self + { + $self = clone $this; + $self['credit'] = $credit; + + return $self; + } + + /** + * Units debited (demat transactions). + */ + public function withDebit(float $debit): self + { + $self = clone $this; + $self['debit'] = $debit; + + return $self; + } + + /** + * Income distribution amount (CDSL MF transactions). + */ + public function withIncomeDistribution(float $incomeDistribution): self + { + $self = clone $this; + $self['incomeDistribution'] = $incomeDistribution; + + return $self; + } + + /** + * Order/transaction reference number (demat transactions). + */ + public function withOrderNo(string $orderNo): self + { + $self = clone $this; + $self['orderNo'] = $orderNo; + + return $self; + } + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + public function withPrice(float $price): self + { + $self = clone $this; + $self['price'] = $price; + + return $self; + } + + /** + * Stamp duty charged. + */ + public function withStampDuty(float $stampDuty): self + { + $self = clone $this; + $self['stampDuty'] = $stampDuty; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction/Type.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction/Type.php new file mode 100644 index 0000000..9d43419 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/CorporateBond/Transaction/Type.php @@ -0,0 +1,43 @@ +|null, + * units?: float|null, + * value?: float|null, * } */ final class DematMutualFund implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the mutual fund. */ - #[Api('additional_info', optional: true)] - public mixed $additionalInfo; + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; /** * ISIN code of the mutual fund. */ - #[Api(optional: true)] + #[Optional] public ?string $isin; /** * Name of the mutual fund. */ - #[Api(optional: true)] + #[Optional] public ?string $name; + /** + * List of transactions for this holding (beta). + * + * @var list|null $transactions + */ + #[Optional(list: Transaction::class)] + public ?array $transactions; + /** * Number of units held. */ - #[Api(optional: true)] + #[Optional] public ?float $units; /** * Current market value of the holding. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -61,34 +75,42 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param list|null $transactions */ public static function with( - mixed $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?string $isin = null, ?string $name = null, + ?array $transactions = null, ?float $units = null, ?float $value = null, ): self { - $obj = new self; + $self = new self; - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $isin && $obj->isin = $isin; - null !== $name && $obj->name = $name; - null !== $units && $obj->units = $units; - null !== $value && $obj->value = $value; + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $isin && $self['isin'] = $isin; + null !== $name && $self['name'] = $name; + null !== $transactions && $self['transactions'] = $transactions; + null !== $units && $self['units'] = $units; + null !== $value && $self['value'] = $value; - return $obj; + return $self; } /** * Additional information specific to the mutual fund. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(mixed $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -96,10 +118,10 @@ public function withAdditionalInfo(mixed $additionalInfo): self */ public function withIsin(string $isin): self { - $obj = clone $this; - $obj->isin = $isin; + $self = clone $this; + $self['isin'] = $isin; - return $obj; + return $self; } /** @@ -107,10 +129,23 @@ public function withIsin(string $isin): self */ public function withName(string $name): self { - $obj = clone $this; - $obj->name = $name; + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * List of transactions for this holding (beta). + * + * @param list $transactions + */ + public function withTransactions(array $transactions): self + { + $self = clone $this; + $self['transactions'] = $transactions; - return $obj; + return $self; } /** @@ -118,10 +153,10 @@ public function withName(string $name): self */ public function withUnits(float $units): self { - $obj = clone $this; - $obj->units = $units; + $self = clone $this; + $self['units'] = $units; - return $obj; + return $self; } /** @@ -129,9 +164,9 @@ public function withUnits(float $units): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/AdditionalInfo.php new file mode 100644 index 0000000..d7e3ae7 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/AdditionalInfo.php @@ -0,0 +1,78 @@ + */ + use SdkModel; + + /** + * Closing balance units for the statement period (beta). + */ + #[Optional('close_units', nullable: true)] + public ?float $closeUnits; + + /** + * Opening balance units for the statement period (beta). + */ + #[Optional('open_units', nullable: true)] + public ?float $openUnits; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $closeUnits = null, + ?float $openUnits = null + ): self { + $self = new self; + + null !== $closeUnits && $self['closeUnits'] = $closeUnits; + null !== $openUnits && $self['openUnits'] = $openUnits; + + return $self; + } + + /** + * Closing balance units for the statement period (beta). + */ + public function withCloseUnits(?float $closeUnits): self + { + $self = clone $this; + $self['closeUnits'] = $closeUnits; + + return $self; + } + + /** + * Opening balance units for the statement period (beta). + */ + public function withOpenUnits(?float $openUnits): self + { + $self = clone $this; + $self['openUnits'] = $openUnits; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction.php new file mode 100644 index 0000000..4d35f0b --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction.php @@ -0,0 +1,233 @@ +, + * units?: float|null, + * } + */ +final class Transaction implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Additional transaction-specific fields that vary by source. + */ + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + #[Optional(nullable: true)] + public ?float $amount; + + /** + * Balance units after transaction. + */ + #[Optional] + public ?float $balance; + + /** + * Transaction date (YYYY-MM-DD). + */ + #[Optional] + public ?string $date; + + /** + * Transaction description/particulars. + */ + #[Optional] + public ?string $description; + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + #[Optional('dividend_rate', nullable: true)] + public ?float $dividendRate; + + /** + * NAV/price per unit on transaction date. + */ + #[Optional(nullable: true)] + public ?float $nav; + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @var value-of|null $type + */ + #[Optional(enum: Type::class)] + public ?string $type; + + /** + * Number of units involved in transaction. + */ + #[Optional] + public ?float $units; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param Type|value-of|null $type + */ + public static function with( + AdditionalInfo|array|null $additionalInfo = null, + ?float $amount = null, + ?float $balance = null, + ?string $date = null, + ?string $description = null, + ?float $dividendRate = null, + ?float $nav = null, + Type|string|null $type = null, + ?float $units = null, + ): self { + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $amount && $self['amount'] = $amount; + null !== $balance && $self['balance'] = $balance; + null !== $date && $self['date'] = $date; + null !== $description && $self['description'] = $description; + null !== $dividendRate && $self['dividendRate'] = $dividendRate; + null !== $nav && $self['nav'] = $nav; + null !== $type && $self['type'] = $type; + null !== $units && $self['units'] = $units; + + return $self; + } + + /** + * Additional transaction-specific fields that vary by source. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo + */ + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo, + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + public function withAmount(?float $amount): self + { + $self = clone $this; + $self['amount'] = $amount; + + return $self; + } + + /** + * Balance units after transaction. + */ + public function withBalance(float $balance): self + { + $self = clone $this; + $self['balance'] = $balance; + + return $self; + } + + /** + * Transaction date (YYYY-MM-DD). + */ + public function withDate(string $date): self + { + $self = clone $this; + $self['date'] = $date; + + return $self; + } + + /** + * Transaction description/particulars. + */ + public function withDescription(string $description): self + { + $self = clone $this; + $self['description'] = $description; + + return $self; + } + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + public function withDividendRate(?float $dividendRate): self + { + $self = clone $this; + $self['dividendRate'] = $dividendRate; + + return $self; + } + + /** + * NAV/price per unit on transaction date. + */ + public function withNav(?float $nav): self + { + $self = clone $this; + $self['nav'] = $nav; + + return $self; + } + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @param Type|value-of $type + */ + public function withType(Type|string $type): self + { + $self = clone $this; + $self['type'] = $type; + + return $self; + } + + /** + * Number of units involved in transaction. + */ + public function withUnits(float $units): self + { + $self = clone $this; + $self['units'] = $units; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction/AdditionalInfo.php new file mode 100644 index 0000000..76de736 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction/AdditionalInfo.php @@ -0,0 +1,179 @@ + */ + use SdkModel; + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + #[Optional('capital_withdrawal')] + public ?float $capitalWithdrawal; + + /** + * Units credited (demat transactions). + */ + #[Optional] + public ?float $credit; + + /** + * Units debited (demat transactions). + */ + #[Optional] + public ?float $debit; + + /** + * Income distribution amount (CDSL MF transactions). + */ + #[Optional('income_distribution')] + public ?float $incomeDistribution; + + /** + * Order/transaction reference number (demat transactions). + */ + #[Optional('order_no')] + public ?string $orderNo; + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + #[Optional] + public ?float $price; + + /** + * Stamp duty charged. + */ + #[Optional('stamp_duty')] + public ?float $stampDuty; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $capitalWithdrawal = null, + ?float $credit = null, + ?float $debit = null, + ?float $incomeDistribution = null, + ?string $orderNo = null, + ?float $price = null, + ?float $stampDuty = null, + ): self { + $self = new self; + + null !== $capitalWithdrawal && $self['capitalWithdrawal'] = $capitalWithdrawal; + null !== $credit && $self['credit'] = $credit; + null !== $debit && $self['debit'] = $debit; + null !== $incomeDistribution && $self['incomeDistribution'] = $incomeDistribution; + null !== $orderNo && $self['orderNo'] = $orderNo; + null !== $price && $self['price'] = $price; + null !== $stampDuty && $self['stampDuty'] = $stampDuty; + + return $self; + } + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + public function withCapitalWithdrawal(float $capitalWithdrawal): self + { + $self = clone $this; + $self['capitalWithdrawal'] = $capitalWithdrawal; + + return $self; + } + + /** + * Units credited (demat transactions). + */ + public function withCredit(float $credit): self + { + $self = clone $this; + $self['credit'] = $credit; + + return $self; + } + + /** + * Units debited (demat transactions). + */ + public function withDebit(float $debit): self + { + $self = clone $this; + $self['debit'] = $debit; + + return $self; + } + + /** + * Income distribution amount (CDSL MF transactions). + */ + public function withIncomeDistribution(float $incomeDistribution): self + { + $self = clone $this; + $self['incomeDistribution'] = $incomeDistribution; + + return $self; + } + + /** + * Order/transaction reference number (demat transactions). + */ + public function withOrderNo(string $orderNo): self + { + $self = clone $this; + $self['orderNo'] = $orderNo; + + return $self; + } + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + public function withPrice(float $price): self + { + $self = clone $this; + $self['price'] = $price; + + return $self; + } + + /** + * Stamp duty charged. + */ + public function withStampDuty(float $stampDuty): self + { + $self = clone $this; + $self['stampDuty'] = $stampDuty; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction/Type.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction/Type.php new file mode 100644 index 0000000..271e274 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/DematMutualFund/Transaction/Type.php @@ -0,0 +1,43 @@ +|null, + * units?: float|null, + * value?: float|null, * } */ final class Equity implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the equity. */ - #[Api('additional_info', optional: true)] - public mixed $additionalInfo; + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; /** * ISIN code of the equity. */ - #[Api(optional: true)] + #[Optional] public ?string $isin; /** * Name of the equity. */ - #[Api(optional: true)] + #[Optional] public ?string $name; + /** + * List of transactions for this holding (beta). + * + * @var list|null $transactions + */ + #[Optional(list: Transaction::class)] + public ?array $transactions; + /** * Number of units held. */ - #[Api(optional: true)] + #[Optional] public ?float $units; /** * Current market value of the holding. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -61,34 +75,42 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param list|null $transactions */ public static function with( - mixed $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?string $isin = null, ?string $name = null, + ?array $transactions = null, ?float $units = null, ?float $value = null, ): self { - $obj = new self; + $self = new self; - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $isin && $obj->isin = $isin; - null !== $name && $obj->name = $name; - null !== $units && $obj->units = $units; - null !== $value && $obj->value = $value; + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $isin && $self['isin'] = $isin; + null !== $name && $self['name'] = $name; + null !== $transactions && $self['transactions'] = $transactions; + null !== $units && $self['units'] = $units; + null !== $value && $self['value'] = $value; - return $obj; + return $self; } /** * Additional information specific to the equity. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(mixed $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -96,10 +118,10 @@ public function withAdditionalInfo(mixed $additionalInfo): self */ public function withIsin(string $isin): self { - $obj = clone $this; - $obj->isin = $isin; + $self = clone $this; + $self['isin'] = $isin; - return $obj; + return $self; } /** @@ -107,10 +129,23 @@ public function withIsin(string $isin): self */ public function withName(string $name): self { - $obj = clone $this; - $obj->name = $name; + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * List of transactions for this holding (beta). + * + * @param list $transactions + */ + public function withTransactions(array $transactions): self + { + $self = clone $this; + $self['transactions'] = $transactions; - return $obj; + return $self; } /** @@ -118,10 +153,10 @@ public function withName(string $name): self */ public function withUnits(float $units): self { - $obj = clone $this; - $obj->units = $units; + $self = clone $this; + $self['units'] = $units; - return $obj; + return $self; } /** @@ -129,9 +164,9 @@ public function withUnits(float $units): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/AdditionalInfo.php new file mode 100644 index 0000000..bdbfce2 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/AdditionalInfo.php @@ -0,0 +1,78 @@ + */ + use SdkModel; + + /** + * Closing balance units for the statement period (beta). + */ + #[Optional('close_units', nullable: true)] + public ?float $closeUnits; + + /** + * Opening balance units for the statement period (beta). + */ + #[Optional('open_units', nullable: true)] + public ?float $openUnits; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $closeUnits = null, + ?float $openUnits = null + ): self { + $self = new self; + + null !== $closeUnits && $self['closeUnits'] = $closeUnits; + null !== $openUnits && $self['openUnits'] = $openUnits; + + return $self; + } + + /** + * Closing balance units for the statement period (beta). + */ + public function withCloseUnits(?float $closeUnits): self + { + $self = clone $this; + $self['closeUnits'] = $closeUnits; + + return $self; + } + + /** + * Opening balance units for the statement period (beta). + */ + public function withOpenUnits(?float $openUnits): self + { + $self = clone $this; + $self['openUnits'] = $openUnits; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction.php new file mode 100644 index 0000000..54cbeaa --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction.php @@ -0,0 +1,233 @@ +, + * units?: float|null, + * } + */ +final class Transaction implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Additional transaction-specific fields that vary by source. + */ + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + #[Optional(nullable: true)] + public ?float $amount; + + /** + * Balance units after transaction. + */ + #[Optional] + public ?float $balance; + + /** + * Transaction date (YYYY-MM-DD). + */ + #[Optional] + public ?string $date; + + /** + * Transaction description/particulars. + */ + #[Optional] + public ?string $description; + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + #[Optional('dividend_rate', nullable: true)] + public ?float $dividendRate; + + /** + * NAV/price per unit on transaction date. + */ + #[Optional(nullable: true)] + public ?float $nav; + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @var value-of|null $type + */ + #[Optional(enum: Type::class)] + public ?string $type; + + /** + * Number of units involved in transaction. + */ + #[Optional] + public ?float $units; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param Type|value-of|null $type + */ + public static function with( + AdditionalInfo|array|null $additionalInfo = null, + ?float $amount = null, + ?float $balance = null, + ?string $date = null, + ?string $description = null, + ?float $dividendRate = null, + ?float $nav = null, + Type|string|null $type = null, + ?float $units = null, + ): self { + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $amount && $self['amount'] = $amount; + null !== $balance && $self['balance'] = $balance; + null !== $date && $self['date'] = $date; + null !== $description && $self['description'] = $description; + null !== $dividendRate && $self['dividendRate'] = $dividendRate; + null !== $nav && $self['nav'] = $nav; + null !== $type && $self['type'] = $type; + null !== $units && $self['units'] = $units; + + return $self; + } + + /** + * Additional transaction-specific fields that vary by source. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo + */ + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo, + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + public function withAmount(?float $amount): self + { + $self = clone $this; + $self['amount'] = $amount; + + return $self; + } + + /** + * Balance units after transaction. + */ + public function withBalance(float $balance): self + { + $self = clone $this; + $self['balance'] = $balance; + + return $self; + } + + /** + * Transaction date (YYYY-MM-DD). + */ + public function withDate(string $date): self + { + $self = clone $this; + $self['date'] = $date; + + return $self; + } + + /** + * Transaction description/particulars. + */ + public function withDescription(string $description): self + { + $self = clone $this; + $self['description'] = $description; + + return $self; + } + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + public function withDividendRate(?float $dividendRate): self + { + $self = clone $this; + $self['dividendRate'] = $dividendRate; + + return $self; + } + + /** + * NAV/price per unit on transaction date. + */ + public function withNav(?float $nav): self + { + $self = clone $this; + $self['nav'] = $nav; + + return $self; + } + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @param Type|value-of $type + */ + public function withType(Type|string $type): self + { + $self = clone $this; + $self['type'] = $type; + + return $self; + } + + /** + * Number of units involved in transaction. + */ + public function withUnits(float $units): self + { + $self = clone $this; + $self['units'] = $units; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction/AdditionalInfo.php new file mode 100644 index 0000000..7469063 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction/AdditionalInfo.php @@ -0,0 +1,179 @@ + */ + use SdkModel; + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + #[Optional('capital_withdrawal')] + public ?float $capitalWithdrawal; + + /** + * Units credited (demat transactions). + */ + #[Optional] + public ?float $credit; + + /** + * Units debited (demat transactions). + */ + #[Optional] + public ?float $debit; + + /** + * Income distribution amount (CDSL MF transactions). + */ + #[Optional('income_distribution')] + public ?float $incomeDistribution; + + /** + * Order/transaction reference number (demat transactions). + */ + #[Optional('order_no')] + public ?string $orderNo; + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + #[Optional] + public ?float $price; + + /** + * Stamp duty charged. + */ + #[Optional('stamp_duty')] + public ?float $stampDuty; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $capitalWithdrawal = null, + ?float $credit = null, + ?float $debit = null, + ?float $incomeDistribution = null, + ?string $orderNo = null, + ?float $price = null, + ?float $stampDuty = null, + ): self { + $self = new self; + + null !== $capitalWithdrawal && $self['capitalWithdrawal'] = $capitalWithdrawal; + null !== $credit && $self['credit'] = $credit; + null !== $debit && $self['debit'] = $debit; + null !== $incomeDistribution && $self['incomeDistribution'] = $incomeDistribution; + null !== $orderNo && $self['orderNo'] = $orderNo; + null !== $price && $self['price'] = $price; + null !== $stampDuty && $self['stampDuty'] = $stampDuty; + + return $self; + } + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + public function withCapitalWithdrawal(float $capitalWithdrawal): self + { + $self = clone $this; + $self['capitalWithdrawal'] = $capitalWithdrawal; + + return $self; + } + + /** + * Units credited (demat transactions). + */ + public function withCredit(float $credit): self + { + $self = clone $this; + $self['credit'] = $credit; + + return $self; + } + + /** + * Units debited (demat transactions). + */ + public function withDebit(float $debit): self + { + $self = clone $this; + $self['debit'] = $debit; + + return $self; + } + + /** + * Income distribution amount (CDSL MF transactions). + */ + public function withIncomeDistribution(float $incomeDistribution): self + { + $self = clone $this; + $self['incomeDistribution'] = $incomeDistribution; + + return $self; + } + + /** + * Order/transaction reference number (demat transactions). + */ + public function withOrderNo(string $orderNo): self + { + $self = clone $this; + $self['orderNo'] = $orderNo; + + return $self; + } + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + public function withPrice(float $price): self + { + $self = clone $this; + $self['price'] = $price; + + return $self; + } + + /** + * Stamp duty charged. + */ + public function withStampDuty(float $stampDuty): self + { + $self = clone $this; + $self['stampDuty'] = $stampDuty; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction/Type.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction/Type.php new file mode 100644 index 0000000..2cfd870 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/Equity/Transaction/Type.php @@ -0,0 +1,43 @@ +|null, + * units?: float|null, + * value?: float|null, * } */ final class GovernmentSecurity implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the government security. */ - #[Api('additional_info', optional: true)] - public mixed $additionalInfo; + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; /** * ISIN code of the government security. */ - #[Api(optional: true)] + #[Optional] public ?string $isin; /** * Name of the government security. */ - #[Api(optional: true)] + #[Optional] public ?string $name; + /** + * List of transactions for this holding (beta). + * + * @var list|null $transactions + */ + #[Optional(list: Transaction::class)] + public ?array $transactions; + /** * Number of units held. */ - #[Api(optional: true)] + #[Optional] public ?float $units; /** * Current market value of the holding. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -61,34 +75,42 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param list|null $transactions */ public static function with( - mixed $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?string $isin = null, ?string $name = null, + ?array $transactions = null, ?float $units = null, ?float $value = null, ): self { - $obj = new self; + $self = new self; - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $isin && $obj->isin = $isin; - null !== $name && $obj->name = $name; - null !== $units && $obj->units = $units; - null !== $value && $obj->value = $value; + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $isin && $self['isin'] = $isin; + null !== $name && $self['name'] = $name; + null !== $transactions && $self['transactions'] = $transactions; + null !== $units && $self['units'] = $units; + null !== $value && $self['value'] = $value; - return $obj; + return $self; } /** * Additional information specific to the government security. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(mixed $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -96,10 +118,10 @@ public function withAdditionalInfo(mixed $additionalInfo): self */ public function withIsin(string $isin): self { - $obj = clone $this; - $obj->isin = $isin; + $self = clone $this; + $self['isin'] = $isin; - return $obj; + return $self; } /** @@ -107,10 +129,23 @@ public function withIsin(string $isin): self */ public function withName(string $name): self { - $obj = clone $this; - $obj->name = $name; + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * List of transactions for this holding (beta). + * + * @param list $transactions + */ + public function withTransactions(array $transactions): self + { + $self = clone $this; + $self['transactions'] = $transactions; - return $obj; + return $self; } /** @@ -118,10 +153,10 @@ public function withName(string $name): self */ public function withUnits(float $units): self { - $obj = clone $this; - $obj->units = $units; + $self = clone $this; + $self['units'] = $units; - return $obj; + return $self; } /** @@ -129,9 +164,9 @@ public function withUnits(float $units): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/AdditionalInfo.php new file mode 100644 index 0000000..c47a554 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/AdditionalInfo.php @@ -0,0 +1,78 @@ + */ + use SdkModel; + + /** + * Closing balance units for the statement period (beta). + */ + #[Optional('close_units', nullable: true)] + public ?float $closeUnits; + + /** + * Opening balance units for the statement period (beta). + */ + #[Optional('open_units', nullable: true)] + public ?float $openUnits; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $closeUnits = null, + ?float $openUnits = null + ): self { + $self = new self; + + null !== $closeUnits && $self['closeUnits'] = $closeUnits; + null !== $openUnits && $self['openUnits'] = $openUnits; + + return $self; + } + + /** + * Closing balance units for the statement period (beta). + */ + public function withCloseUnits(?float $closeUnits): self + { + $self = clone $this; + $self['closeUnits'] = $closeUnits; + + return $self; + } + + /** + * Opening balance units for the statement period (beta). + */ + public function withOpenUnits(?float $openUnits): self + { + $self = clone $this; + $self['openUnits'] = $openUnits; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction.php new file mode 100644 index 0000000..919d937 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction.php @@ -0,0 +1,233 @@ +, + * units?: float|null, + * } + */ +final class Transaction implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Additional transaction-specific fields that vary by source. + */ + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + #[Optional(nullable: true)] + public ?float $amount; + + /** + * Balance units after transaction. + */ + #[Optional] + public ?float $balance; + + /** + * Transaction date (YYYY-MM-DD). + */ + #[Optional] + public ?string $date; + + /** + * Transaction description/particulars. + */ + #[Optional] + public ?string $description; + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + #[Optional('dividend_rate', nullable: true)] + public ?float $dividendRate; + + /** + * NAV/price per unit on transaction date. + */ + #[Optional(nullable: true)] + public ?float $nav; + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @var value-of|null $type + */ + #[Optional(enum: Type::class)] + public ?string $type; + + /** + * Number of units involved in transaction. + */ + #[Optional] + public ?float $units; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param Type|value-of|null $type + */ + public static function with( + AdditionalInfo|array|null $additionalInfo = null, + ?float $amount = null, + ?float $balance = null, + ?string $date = null, + ?string $description = null, + ?float $dividendRate = null, + ?float $nav = null, + Type|string|null $type = null, + ?float $units = null, + ): self { + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $amount && $self['amount'] = $amount; + null !== $balance && $self['balance'] = $balance; + null !== $date && $self['date'] = $date; + null !== $description && $self['description'] = $description; + null !== $dividendRate && $self['dividendRate'] = $dividendRate; + null !== $nav && $self['nav'] = $nav; + null !== $type && $self['type'] = $type; + null !== $units && $self['units'] = $units; + + return $self; + } + + /** + * Additional transaction-specific fields that vary by source. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo + */ + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo, + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + public function withAmount(?float $amount): self + { + $self = clone $this; + $self['amount'] = $amount; + + return $self; + } + + /** + * Balance units after transaction. + */ + public function withBalance(float $balance): self + { + $self = clone $this; + $self['balance'] = $balance; + + return $self; + } + + /** + * Transaction date (YYYY-MM-DD). + */ + public function withDate(string $date): self + { + $self = clone $this; + $self['date'] = $date; + + return $self; + } + + /** + * Transaction description/particulars. + */ + public function withDescription(string $description): self + { + $self = clone $this; + $self['description'] = $description; + + return $self; + } + + /** + * Dividend rate (for DIVIDEND_PAYOUT transactions). + */ + public function withDividendRate(?float $dividendRate): self + { + $self = clone $this; + $self['dividendRate'] = $dividendRate; + + return $self; + } + + /** + * NAV/price per unit on transaction date. + */ + public function withNav(?float $nav): self + { + $self = clone $this; + $self['nav'] = $nav; + + return $self; + } + + /** + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @param Type|value-of $type + */ + public function withType(Type|string $type): self + { + $self = clone $this; + $self['type'] = $type; + + return $self; + } + + /** + * Number of units involved in transaction. + */ + public function withUnits(float $units): self + { + $self = clone $this; + $self['units'] = $units; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction/AdditionalInfo.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction/AdditionalInfo.php new file mode 100644 index 0000000..e2bd8e6 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction/AdditionalInfo.php @@ -0,0 +1,179 @@ + */ + use SdkModel; + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + #[Optional('capital_withdrawal')] + public ?float $capitalWithdrawal; + + /** + * Units credited (demat transactions). + */ + #[Optional] + public ?float $credit; + + /** + * Units debited (demat transactions). + */ + #[Optional] + public ?float $debit; + + /** + * Income distribution amount (CDSL MF transactions). + */ + #[Optional('income_distribution')] + public ?float $incomeDistribution; + + /** + * Order/transaction reference number (demat transactions). + */ + #[Optional('order_no')] + public ?string $orderNo; + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + #[Optional] + public ?float $price; + + /** + * Stamp duty charged. + */ + #[Optional('stamp_duty')] + public ?float $stampDuty; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $capitalWithdrawal = null, + ?float $credit = null, + ?float $debit = null, + ?float $incomeDistribution = null, + ?string $orderNo = null, + ?float $price = null, + ?float $stampDuty = null, + ): self { + $self = new self; + + null !== $capitalWithdrawal && $self['capitalWithdrawal'] = $capitalWithdrawal; + null !== $credit && $self['credit'] = $credit; + null !== $debit && $self['debit'] = $debit; + null !== $incomeDistribution && $self['incomeDistribution'] = $incomeDistribution; + null !== $orderNo && $self['orderNo'] = $orderNo; + null !== $price && $self['price'] = $price; + null !== $stampDuty && $self['stampDuty'] = $stampDuty; + + return $self; + } + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + public function withCapitalWithdrawal(float $capitalWithdrawal): self + { + $self = clone $this; + $self['capitalWithdrawal'] = $capitalWithdrawal; + + return $self; + } + + /** + * Units credited (demat transactions). + */ + public function withCredit(float $credit): self + { + $self = clone $this; + $self['credit'] = $credit; + + return $self; + } + + /** + * Units debited (demat transactions). + */ + public function withDebit(float $debit): self + { + $self = clone $this; + $self['debit'] = $debit; + + return $self; + } + + /** + * Income distribution amount (CDSL MF transactions). + */ + public function withIncomeDistribution(float $incomeDistribution): self + { + $self = clone $this; + $self['incomeDistribution'] = $incomeDistribution; + + return $self; + } + + /** + * Order/transaction reference number (demat transactions). + */ + public function withOrderNo(string $orderNo): self + { + $self = clone $this; + $self['orderNo'] = $orderNo; + + return $self; + } + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + public function withPrice(float $price): self + { + $self = clone $this; + $self['price'] = $price; + + return $self; + } + + /** + * Stamp duty charged. + */ + public function withStampDuty(float $stampDuty): self + { + $self = clone $this; + $self['stampDuty'] = $stampDuty; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction/Type.php b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction/Type.php new file mode 100644 index 0000000..f1d3888 --- /dev/null +++ b/src/CasParser/UnifiedResponse/DematAccount/Holdings/GovernmentSecurity/Transaction/Type.php @@ -0,0 +1,43 @@ + */ + use SdkModel; + + /** + * Name of the account holder. + */ + #[Optional] + public ?string $name; + + /** + * PAN of the account holder. + */ + #[Optional] + public ?string $pan; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $name = null, ?string $pan = null): self + { + $self = new self; + + null !== $name && $self['name'] = $name; + null !== $pan && $self['pan'] = $pan; + + return $self; + } + + /** + * Name of the account holder. + */ + public function withName(string $name): self + { + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * PAN of the account holder. + */ + public function withPan(string $pan): self + { + $self = clone $this; + $self['pan'] = $pan; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/Insurance.php b/src/CasParser/UnifiedResponse/Insurance.php index 2a42859..db1ded5 100644 --- a/src/CasParser/UnifiedResponse/Insurance.php +++ b/src/CasParser/UnifiedResponse/Insurance.php @@ -5,26 +5,24 @@ namespace CasParser\CasParser\UnifiedResponse; use CasParser\CasParser\UnifiedResponse\Insurance\LifeInsurancePolicy; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type insurance_alias = array{ - * lifeInsurancePolicies?: list + * @phpstan-import-type LifeInsurancePolicyShape from \CasParser\CasParser\UnifiedResponse\Insurance\LifeInsurancePolicy + * + * @phpstan-type InsuranceShape = array{ + * lifeInsurancePolicies?: list|null * } */ final class Insurance implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** @var list|null $lifeInsurancePolicies */ - #[Api( - 'life_insurance_policies', - list: LifeInsurancePolicy::class, - optional: true - )] + #[Optional('life_insurance_policies', list: LifeInsurancePolicy::class)] public ?array $lifeInsurancePolicies; public function __construct() @@ -37,26 +35,26 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param list $lifeInsurancePolicies + * @param list|null $lifeInsurancePolicies */ public static function with(?array $lifeInsurancePolicies = null): self { - $obj = new self; + $self = new self; - null !== $lifeInsurancePolicies && $obj->lifeInsurancePolicies = $lifeInsurancePolicies; + null !== $lifeInsurancePolicies && $self['lifeInsurancePolicies'] = $lifeInsurancePolicies; - return $obj; + return $self; } /** - * @param list $lifeInsurancePolicies + * @param list $lifeInsurancePolicies */ public function withLifeInsurancePolicies( array $lifeInsurancePolicies ): self { - $obj = clone $this; - $obj->lifeInsurancePolicies = $lifeInsurancePolicies; + $self = clone $this; + $self['lifeInsurancePolicies'] = $lifeInsurancePolicies; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Insurance/LifeInsurancePolicy.php b/src/CasParser/UnifiedResponse/Insurance/LifeInsurancePolicy.php index c106c9c..a7a464d 100644 --- a/src/CasParser/UnifiedResponse/Insurance/LifeInsurancePolicy.php +++ b/src/CasParser/UnifiedResponse/Insurance/LifeInsurancePolicy.php @@ -4,80 +4,80 @@ namespace CasParser\CasParser\UnifiedResponse\Insurance; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type life_insurance_policy = array{ + * @phpstan-type LifeInsurancePolicyShape = array{ * additionalInfo?: mixed, - * lifeAssured?: string, - * policyName?: string, - * policyNumber?: string, - * premiumAmount?: float, - * premiumFrequency?: string, - * provider?: string, - * status?: string, - * sumAssured?: float, + * lifeAssured?: string|null, + * policyName?: string|null, + * policyNumber?: string|null, + * premiumAmount?: float|null, + * premiumFrequency?: string|null, + * provider?: string|null, + * status?: string|null, + * sumAssured?: float|null, * } */ final class LifeInsurancePolicy implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the policy. */ - #[Api('additional_info', optional: true)] + #[Optional('additional_info')] public mixed $additionalInfo; /** * Name of the life assured. */ - #[Api('life_assured', optional: true)] + #[Optional('life_assured')] public ?string $lifeAssured; /** * Name of the insurance policy. */ - #[Api('policy_name', optional: true)] + #[Optional('policy_name')] public ?string $policyName; /** * Insurance policy number. */ - #[Api('policy_number', optional: true)] + #[Optional('policy_number')] public ?string $policyNumber; /** * Premium amount. */ - #[Api('premium_amount', optional: true)] + #[Optional('premium_amount')] public ?float $premiumAmount; /** * Frequency of premium payment (e.g., Annual, Monthly). */ - #[Api('premium_frequency', optional: true)] + #[Optional('premium_frequency')] public ?string $premiumFrequency; /** * Insurance company name. */ - #[Api(optional: true)] + #[Optional] public ?string $provider; /** * Status of the policy (e.g., Active, Lapsed). */ - #[Api(optional: true)] + #[Optional] public ?string $status; /** * Sum assured amount. */ - #[Api('sum_assured', optional: true)] + #[Optional('sum_assured')] public ?float $sumAssured; public function __construct() @@ -101,19 +101,19 @@ public static function with( ?string $status = null, ?float $sumAssured = null, ): self { - $obj = new self; - - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $lifeAssured && $obj->lifeAssured = $lifeAssured; - null !== $policyName && $obj->policyName = $policyName; - null !== $policyNumber && $obj->policyNumber = $policyNumber; - null !== $premiumAmount && $obj->premiumAmount = $premiumAmount; - null !== $premiumFrequency && $obj->premiumFrequency = $premiumFrequency; - null !== $provider && $obj->provider = $provider; - null !== $status && $obj->status = $status; - null !== $sumAssured && $obj->sumAssured = $sumAssured; - - return $obj; + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $lifeAssured && $self['lifeAssured'] = $lifeAssured; + null !== $policyName && $self['policyName'] = $policyName; + null !== $policyNumber && $self['policyNumber'] = $policyNumber; + null !== $premiumAmount && $self['premiumAmount'] = $premiumAmount; + null !== $premiumFrequency && $self['premiumFrequency'] = $premiumFrequency; + null !== $provider && $self['provider'] = $provider; + null !== $status && $self['status'] = $status; + null !== $sumAssured && $self['sumAssured'] = $sumAssured; + + return $self; } /** @@ -121,10 +121,10 @@ public static function with( */ public function withAdditionalInfo(mixed $additionalInfo): self { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -132,10 +132,10 @@ public function withAdditionalInfo(mixed $additionalInfo): self */ public function withLifeAssured(string $lifeAssured): self { - $obj = clone $this; - $obj->lifeAssured = $lifeAssured; + $self = clone $this; + $self['lifeAssured'] = $lifeAssured; - return $obj; + return $self; } /** @@ -143,10 +143,10 @@ public function withLifeAssured(string $lifeAssured): self */ public function withPolicyName(string $policyName): self { - $obj = clone $this; - $obj->policyName = $policyName; + $self = clone $this; + $self['policyName'] = $policyName; - return $obj; + return $self; } /** @@ -154,10 +154,10 @@ public function withPolicyName(string $policyName): self */ public function withPolicyNumber(string $policyNumber): self { - $obj = clone $this; - $obj->policyNumber = $policyNumber; + $self = clone $this; + $self['policyNumber'] = $policyNumber; - return $obj; + return $self; } /** @@ -165,10 +165,10 @@ public function withPolicyNumber(string $policyNumber): self */ public function withPremiumAmount(float $premiumAmount): self { - $obj = clone $this; - $obj->premiumAmount = $premiumAmount; + $self = clone $this; + $self['premiumAmount'] = $premiumAmount; - return $obj; + return $self; } /** @@ -176,10 +176,10 @@ public function withPremiumAmount(float $premiumAmount): self */ public function withPremiumFrequency(string $premiumFrequency): self { - $obj = clone $this; - $obj->premiumFrequency = $premiumFrequency; + $self = clone $this; + $self['premiumFrequency'] = $premiumFrequency; - return $obj; + return $self; } /** @@ -187,10 +187,10 @@ public function withPremiumFrequency(string $premiumFrequency): self */ public function withProvider(string $provider): self { - $obj = clone $this; - $obj->provider = $provider; + $self = clone $this; + $self['provider'] = $provider; - return $obj; + return $self; } /** @@ -198,10 +198,10 @@ public function withProvider(string $provider): self */ public function withStatus(string $status): self { - $obj = clone $this; - $obj->status = $status; + $self = clone $this; + $self['status'] = $status; - return $obj; + return $self; } /** @@ -209,9 +209,9 @@ public function withStatus(string $status): self */ public function withSumAssured(float $sumAssured): self { - $obj = clone $this; - $obj->sumAssured = $sumAssured; + $self = clone $this; + $self['sumAssured'] = $sumAssured; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Investor.php b/src/CasParser/UnifiedResponse/Investor.php index dd04ddc..888699c 100644 --- a/src/CasParser/UnifiedResponse/Investor.php +++ b/src/CasParser/UnifiedResponse/Investor.php @@ -4,66 +4,66 @@ namespace CasParser\CasParser\UnifiedResponse; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type investor_alias = array{ - * address?: string, - * casID?: string, - * email?: string, - * mobile?: string, - * name?: string, - * pan?: string, - * pincode?: string, + * @phpstan-type InvestorShape = array{ + * address?: string|null, + * casID?: string|null, + * email?: string|null, + * mobile?: string|null, + * name?: string|null, + * pan?: string|null, + * pincode?: string|null, * } */ final class Investor implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Address of the investor. */ - #[Api(optional: true)] + #[Optional] public ?string $address; /** * CAS ID of the investor (only for NSDL and CDSL). */ - #[Api('cas_id', optional: true)] + #[Optional('cas_id')] public ?string $casID; /** * Email address of the investor. */ - #[Api(optional: true)] + #[Optional] public ?string $email; /** * Mobile number of the investor. */ - #[Api(optional: true)] + #[Optional] public ?string $mobile; /** * Name of the investor. */ - #[Api(optional: true)] + #[Optional] public ?string $name; /** * PAN (Permanent Account Number) of the investor. */ - #[Api(optional: true)] + #[Optional] public ?string $pan; /** * Postal code of the investor's address. */ - #[Api(optional: true)] + #[Optional] public ?string $pincode; public function __construct() @@ -85,17 +85,17 @@ public static function with( ?string $pan = null, ?string $pincode = null, ): self { - $obj = new self; + $self = new self; - null !== $address && $obj->address = $address; - null !== $casID && $obj->casID = $casID; - null !== $email && $obj->email = $email; - null !== $mobile && $obj->mobile = $mobile; - null !== $name && $obj->name = $name; - null !== $pan && $obj->pan = $pan; - null !== $pincode && $obj->pincode = $pincode; + null !== $address && $self['address'] = $address; + null !== $casID && $self['casID'] = $casID; + null !== $email && $self['email'] = $email; + null !== $mobile && $self['mobile'] = $mobile; + null !== $name && $self['name'] = $name; + null !== $pan && $self['pan'] = $pan; + null !== $pincode && $self['pincode'] = $pincode; - return $obj; + return $self; } /** @@ -103,10 +103,10 @@ public static function with( */ public function withAddress(string $address): self { - $obj = clone $this; - $obj->address = $address; + $self = clone $this; + $self['address'] = $address; - return $obj; + return $self; } /** @@ -114,10 +114,10 @@ public function withAddress(string $address): self */ public function withCasID(string $casID): self { - $obj = clone $this; - $obj->casID = $casID; + $self = clone $this; + $self['casID'] = $casID; - return $obj; + return $self; } /** @@ -125,10 +125,10 @@ public function withCasID(string $casID): self */ public function withEmail(string $email): self { - $obj = clone $this; - $obj->email = $email; + $self = clone $this; + $self['email'] = $email; - return $obj; + return $self; } /** @@ -136,10 +136,10 @@ public function withEmail(string $email): self */ public function withMobile(string $mobile): self { - $obj = clone $this; - $obj->mobile = $mobile; + $self = clone $this; + $self['mobile'] = $mobile; - return $obj; + return $self; } /** @@ -147,10 +147,10 @@ public function withMobile(string $mobile): self */ public function withName(string $name): self { - $obj = clone $this; - $obj->name = $name; + $self = clone $this; + $self['name'] = $name; - return $obj; + return $self; } /** @@ -158,10 +158,10 @@ public function withName(string $name): self */ public function withPan(string $pan): self { - $obj = clone $this; - $obj->pan = $pan; + $self = clone $this; + $self['pan'] = $pan; - return $obj; + return $self; } /** @@ -169,9 +169,9 @@ public function withPan(string $pan): self */ public function withPincode(string $pincode): self { - $obj = clone $this; - $obj->pincode = $pincode; + $self = clone $this; + $self['pincode'] = $pincode; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Meta.php b/src/CasParser/UnifiedResponse/Meta.php index 7f55cb7..8ac9067 100644 --- a/src/CasParser/UnifiedResponse/Meta.php +++ b/src/CasParser/UnifiedResponse/Meta.php @@ -6,20 +6,22 @@ use CasParser\CasParser\UnifiedResponse\Meta\CasType; use CasParser\CasParser\UnifiedResponse\Meta\StatementPeriod; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type meta_alias = array{ - * casType?: value-of, - * generatedAt?: \DateTimeInterface, - * statementPeriod?: StatementPeriod, + * @phpstan-import-type StatementPeriodShape from \CasParser\CasParser\UnifiedResponse\Meta\StatementPeriod + * + * @phpstan-type MetaShape = array{ + * casType?: null|CasType|value-of, + * generatedAt?: \DateTimeInterface|null, + * statementPeriod?: null|StatementPeriod|StatementPeriodShape, * } */ final class Meta implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** @@ -27,16 +29,16 @@ final class Meta implements BaseModel * * @var value-of|null $casType */ - #[Api('cas_type', enum: CasType::class, optional: true)] + #[Optional('cas_type', enum: CasType::class)] public ?string $casType; /** * Timestamp when the response was generated. */ - #[Api('generated_at', optional: true)] + #[Optional('generated_at')] public ?\DateTimeInterface $generatedAt; - #[Api('statement_period', optional: true)] + #[Optional('statement_period')] public ?StatementPeriod $statementPeriod; public function __construct() @@ -49,20 +51,21 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param CasType|value-of $casType + * @param CasType|value-of|null $casType + * @param StatementPeriod|StatementPeriodShape|null $statementPeriod */ public static function with( CasType|string|null $casType = null, ?\DateTimeInterface $generatedAt = null, - ?StatementPeriod $statementPeriod = null, + StatementPeriod|array|null $statementPeriod = null, ): self { - $obj = new self; + $self = new self; - null !== $casType && $obj->casType = $casType instanceof CasType ? $casType->value : $casType; - null !== $generatedAt && $obj->generatedAt = $generatedAt; - null !== $statementPeriod && $obj->statementPeriod = $statementPeriod; + null !== $casType && $self['casType'] = $casType; + null !== $generatedAt && $self['generatedAt'] = $generatedAt; + null !== $statementPeriod && $self['statementPeriod'] = $statementPeriod; - return $obj; + return $self; } /** @@ -72,10 +75,10 @@ public static function with( */ public function withCasType(CasType|string $casType): self { - $obj = clone $this; - $obj->casType = $casType instanceof CasType ? $casType->value : $casType; + $self = clone $this; + $self['casType'] = $casType; - return $obj; + return $self; } /** @@ -83,17 +86,21 @@ public function withCasType(CasType|string $casType): self */ public function withGeneratedAt(\DateTimeInterface $generatedAt): self { - $obj = clone $this; - $obj->generatedAt = $generatedAt; + $self = clone $this; + $self['generatedAt'] = $generatedAt; - return $obj; + return $self; } - public function withStatementPeriod(StatementPeriod $statementPeriod): self - { - $obj = clone $this; - $obj->statementPeriod = $statementPeriod; + /** + * @param StatementPeriod|StatementPeriodShape $statementPeriod + */ + public function withStatementPeriod( + StatementPeriod|array $statementPeriod + ): self { + $self = clone $this; + $self['statementPeriod'] = $statementPeriod; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Meta/StatementPeriod.php b/src/CasParser/UnifiedResponse/Meta/StatementPeriod.php index ebeb0f2..4d9b0e4 100644 --- a/src/CasParser/UnifiedResponse/Meta/StatementPeriod.php +++ b/src/CasParser/UnifiedResponse/Meta/StatementPeriod.php @@ -4,31 +4,29 @@ namespace CasParser\CasParser\UnifiedResponse\Meta; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type statement_period = array{ - * from?: \DateTimeInterface, to?: \DateTimeInterface - * } + * @phpstan-type StatementPeriodShape = array{from?: string|null, to?: string|null} */ final class StatementPeriod implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Start date of the statement period. */ - #[Api(optional: true)] - public ?\DateTimeInterface $from; + #[Optional] + public ?string $from; /** * End date of the statement period. */ - #[Api(optional: true)] - public ?\DateTimeInterface $to; + #[Optional] + public ?string $to; public function __construct() { @@ -40,37 +38,35 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. */ - public static function with( - ?\DateTimeInterface $from = null, - ?\DateTimeInterface $to = null - ): self { - $obj = new self; + public static function with(?string $from = null, ?string $to = null): self + { + $self = new self; - null !== $from && $obj->from = $from; - null !== $to && $obj->to = $to; + null !== $from && $self['from'] = $from; + null !== $to && $self['to'] = $to; - return $obj; + return $self; } /** * Start date of the statement period. */ - public function withFrom(\DateTimeInterface $from): self + public function withFrom(string $from): self { - $obj = clone $this; - $obj->from = $from; + $self = clone $this; + $self['from'] = $from; - return $obj; + return $self; } /** * End date of the statement period. */ - public function withTo(\DateTimeInterface $to): self + public function withTo(string $to): self { - $obj = clone $this; - $obj->to = $to; + $self = clone $this; + $self['to'] = $to; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/MutualFund.php b/src/CasParser/UnifiedResponse/MutualFund.php index 2f1da0c..393c248 100644 --- a/src/CasParser/UnifiedResponse/MutualFund.php +++ b/src/CasParser/UnifiedResponse/MutualFund.php @@ -5,58 +5,72 @@ namespace CasParser\CasParser\UnifiedResponse; use CasParser\CasParser\UnifiedResponse\MutualFund\AdditionalInfo; +use CasParser\CasParser\UnifiedResponse\MutualFund\LinkedHolder; use CasParser\CasParser\UnifiedResponse\MutualFund\Scheme; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type mutual_fund = array{ - * additionalInfo?: AdditionalInfo, - * amc?: string, - * folioNumber?: string, - * registrar?: string, - * schemes?: list, - * value?: float, + * @phpstan-import-type AdditionalInfoShape from \CasParser\CasParser\UnifiedResponse\MutualFund\AdditionalInfo + * @phpstan-import-type LinkedHolderShape from \CasParser\CasParser\UnifiedResponse\MutualFund\LinkedHolder + * @phpstan-import-type SchemeShape from \CasParser\CasParser\UnifiedResponse\MutualFund\Scheme + * + * @phpstan-type MutualFundShape = array{ + * additionalInfo?: null|AdditionalInfo|AdditionalInfoShape, + * amc?: string|null, + * folioNumber?: string|null, + * linkedHolders?: list|null, + * registrar?: string|null, + * schemes?: list|null, + * value?: float|null, * } */ final class MutualFund implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional folio information. */ - #[Api('additional_info', optional: true)] + #[Optional('additional_info')] public ?AdditionalInfo $additionalInfo; /** * Asset Management Company name. */ - #[Api(optional: true)] + #[Optional] public ?string $amc; /** * Folio number. */ - #[Api('folio_number', optional: true)] + #[Optional('folio_number')] public ?string $folioNumber; + /** + * List of account holders linked to this mutual fund folio. + * + * @var list|null $linkedHolders + */ + #[Optional('linked_holders', list: LinkedHolder::class)] + public ?array $linkedHolders; + /** * Registrar and Transfer Agent name. */ - #[Api(optional: true)] + #[Optional] public ?string $registrar; /** @var list|null $schemes */ - #[Api(list: Scheme::class, optional: true)] + #[Optional(list: Scheme::class)] public ?array $schemes; /** * Total value of the folio. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -69,37 +83,44 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param list $schemes + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param list|null $linkedHolders + * @param list|null $schemes */ public static function with( - ?AdditionalInfo $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?string $amc = null, ?string $folioNumber = null, + ?array $linkedHolders = null, ?string $registrar = null, ?array $schemes = null, ?float $value = null, ): self { - $obj = new self; + $self = new self; - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $amc && $obj->amc = $amc; - null !== $folioNumber && $obj->folioNumber = $folioNumber; - null !== $registrar && $obj->registrar = $registrar; - null !== $schemes && $obj->schemes = $schemes; - null !== $value && $obj->value = $value; + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $amc && $self['amc'] = $amc; + null !== $folioNumber && $self['folioNumber'] = $folioNumber; + null !== $linkedHolders && $self['linkedHolders'] = $linkedHolders; + null !== $registrar && $self['registrar'] = $registrar; + null !== $schemes && $self['schemes'] = $schemes; + null !== $value && $self['value'] = $value; - return $obj; + return $self; } /** * Additional folio information. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(AdditionalInfo $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -107,10 +128,10 @@ public function withAdditionalInfo(AdditionalInfo $additionalInfo): self */ public function withAmc(string $amc): self { - $obj = clone $this; - $obj->amc = $amc; + $self = clone $this; + $self['amc'] = $amc; - return $obj; + return $self; } /** @@ -118,10 +139,23 @@ public function withAmc(string $amc): self */ public function withFolioNumber(string $folioNumber): self { - $obj = clone $this; - $obj->folioNumber = $folioNumber; + $self = clone $this; + $self['folioNumber'] = $folioNumber; + + return $self; + } + + /** + * List of account holders linked to this mutual fund folio. + * + * @param list $linkedHolders + */ + public function withLinkedHolders(array $linkedHolders): self + { + $self = clone $this; + $self['linkedHolders'] = $linkedHolders; - return $obj; + return $self; } /** @@ -129,21 +163,21 @@ public function withFolioNumber(string $folioNumber): self */ public function withRegistrar(string $registrar): self { - $obj = clone $this; - $obj->registrar = $registrar; + $self = clone $this; + $self['registrar'] = $registrar; - return $obj; + return $self; } /** - * @param list $schemes + * @param list $schemes */ public function withSchemes(array $schemes): self { - $obj = clone $this; - $obj->schemes = $schemes; + $self = clone $this; + $self['schemes'] = $schemes; - return $obj; + return $self; } /** @@ -151,9 +185,9 @@ public function withSchemes(array $schemes): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/MutualFund/AdditionalInfo.php b/src/CasParser/UnifiedResponse/MutualFund/AdditionalInfo.php index b79ad23..9eea13a 100644 --- a/src/CasParser/UnifiedResponse/MutualFund/AdditionalInfo.php +++ b/src/CasParser/UnifiedResponse/MutualFund/AdditionalInfo.php @@ -4,38 +4,38 @@ namespace CasParser\CasParser\UnifiedResponse\MutualFund; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** * Additional folio information. * - * @phpstan-type additional_info = array{ - * kyc?: string, pan?: string, pankyc?: string + * @phpstan-type AdditionalInfoShape = array{ + * kyc?: string|null, pan?: string|null, pankyc?: string|null * } */ final class AdditionalInfo implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * KYC status of the folio. */ - #[Api(optional: true)] + #[Optional] public ?string $kyc; /** * PAN associated with the folio. */ - #[Api(optional: true)] + #[Optional] public ?string $pan; /** * PAN KYC status. */ - #[Api(optional: true)] + #[Optional] public ?string $pankyc; public function __construct() @@ -53,13 +53,13 @@ public static function with( ?string $pan = null, ?string $pankyc = null ): self { - $obj = new self; + $self = new self; - null !== $kyc && $obj->kyc = $kyc; - null !== $pan && $obj->pan = $pan; - null !== $pankyc && $obj->pankyc = $pankyc; + null !== $kyc && $self['kyc'] = $kyc; + null !== $pan && $self['pan'] = $pan; + null !== $pankyc && $self['pankyc'] = $pankyc; - return $obj; + return $self; } /** @@ -67,10 +67,10 @@ public static function with( */ public function withKYC(string $kyc): self { - $obj = clone $this; - $obj->kyc = $kyc; + $self = clone $this; + $self['kyc'] = $kyc; - return $obj; + return $self; } /** @@ -78,10 +78,10 @@ public function withKYC(string $kyc): self */ public function withPan(string $pan): self { - $obj = clone $this; - $obj->pan = $pan; + $self = clone $this; + $self['pan'] = $pan; - return $obj; + return $self; } /** @@ -89,9 +89,9 @@ public function withPan(string $pan): self */ public function withPankyc(string $pankyc): self { - $obj = clone $this; - $obj->pankyc = $pankyc; + $self = clone $this; + $self['pankyc'] = $pankyc; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/MutualFund/LinkedHolder.php b/src/CasParser/UnifiedResponse/MutualFund/LinkedHolder.php new file mode 100644 index 0000000..69a3f4f --- /dev/null +++ b/src/CasParser/UnifiedResponse/MutualFund/LinkedHolder.php @@ -0,0 +1,72 @@ + */ + use SdkModel; + + /** + * Name of the account holder. + */ + #[Optional] + public ?string $name; + + /** + * PAN of the account holder. + */ + #[Optional] + public ?string $pan; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $name = null, ?string $pan = null): self + { + $self = new self; + + null !== $name && $self['name'] = $name; + null !== $pan && $self['pan'] = $pan; + + return $self; + } + + /** + * Name of the account holder. + */ + public function withName(string $name): self + { + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * PAN of the account holder. + */ + public function withPan(string $pan): self + { + $self = clone $this; + $self['pan'] = $pan; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/MutualFund/Scheme.php b/src/CasParser/UnifiedResponse/MutualFund/Scheme.php index 8775dbb..76d3378 100644 --- a/src/CasParser/UnifiedResponse/MutualFund/Scheme.php +++ b/src/CasParser/UnifiedResponse/MutualFund/Scheme.php @@ -8,61 +8,65 @@ use CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Gain; use CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction; use CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Type; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type scheme_alias = array{ - * additionalInfo?: AdditionalInfo, - * cost?: float, - * gain?: Gain, - * isin?: string, - * name?: string, - * nav?: float, - * nominees?: list, - * transactions?: list, - * type?: value-of, - * units?: float, - * value?: float, + * @phpstan-import-type AdditionalInfoShape from \CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\AdditionalInfo + * @phpstan-import-type GainShape from \CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Gain + * @phpstan-import-type TransactionShape from \CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction + * + * @phpstan-type SchemeShape = array{ + * additionalInfo?: null|\CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\AdditionalInfo|AdditionalInfoShape, + * cost?: float|null, + * gain?: null|Gain|GainShape, + * isin?: string|null, + * name?: string|null, + * nav?: float|null, + * nominees?: list|null, + * transactions?: list|null, + * type?: null|Type|value-of, + * units?: float|null, + * value?: float|null, * } */ final class Scheme implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Additional information specific to the scheme. */ - #[Api('additional_info', optional: true)] + #[Optional('additional_info')] public ?AdditionalInfo $additionalInfo; /** * Cost of investment. */ - #[Api(optional: true)] + #[Optional] public ?float $cost; - #[Api(optional: true)] + #[Optional] public ?Gain $gain; /** * ISIN code of the scheme. */ - #[Api(optional: true)] + #[Optional] public ?string $isin; /** * Scheme name. */ - #[Api(optional: true)] + #[Optional] public ?string $name; /** * Net Asset Value per unit. */ - #[Api(optional: true)] + #[Optional] public ?float $nav; /** @@ -70,11 +74,11 @@ final class Scheme implements BaseModel * * @var list|null $nominees */ - #[Api(list: 'string', optional: true)] + #[Optional(list: 'string')] public ?array $nominees; /** @var list|null $transactions */ - #[Api(list: Transaction::class, optional: true)] + #[Optional(list: Transaction::class)] public ?array $transactions; /** @@ -82,19 +86,19 @@ final class Scheme implements BaseModel * * @var value-of|null $type */ - #[Api(enum: Type::class, optional: true)] + #[Optional(enum: Type::class)] public ?string $type; /** * Number of units held. */ - #[Api(optional: true)] + #[Optional] public ?float $units; /** * Current market value of the holding. */ - #[Api(optional: true)] + #[Optional] public ?float $value; public function __construct() @@ -107,14 +111,16 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param list $nominees - * @param list $transactions - * @param Type|value-of $type + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param Gain|GainShape|null $gain + * @param list|null $nominees + * @param list|null $transactions + * @param Type|value-of|null $type */ public static function with( - ?AdditionalInfo $additionalInfo = null, + AdditionalInfo|array|null $additionalInfo = null, ?float $cost = null, - ?Gain $gain = null, + Gain|array|null $gain = null, ?string $isin = null, ?string $name = null, ?float $nav = null, @@ -124,32 +130,35 @@ public static function with( ?float $units = null, ?float $value = null, ): self { - $obj = new self; - - null !== $additionalInfo && $obj->additionalInfo = $additionalInfo; - null !== $cost && $obj->cost = $cost; - null !== $gain && $obj->gain = $gain; - null !== $isin && $obj->isin = $isin; - null !== $name && $obj->name = $name; - null !== $nav && $obj->nav = $nav; - null !== $nominees && $obj->nominees = $nominees; - null !== $transactions && $obj->transactions = $transactions; - null !== $type && $obj->type = $type instanceof Type ? $type->value : $type; - null !== $units && $obj->units = $units; - null !== $value && $obj->value = $value; - - return $obj; + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $cost && $self['cost'] = $cost; + null !== $gain && $self['gain'] = $gain; + null !== $isin && $self['isin'] = $isin; + null !== $name && $self['name'] = $name; + null !== $nav && $self['nav'] = $nav; + null !== $nominees && $self['nominees'] = $nominees; + null !== $transactions && $self['transactions'] = $transactions; + null !== $type && $self['type'] = $type; + null !== $units && $self['units'] = $units; + null !== $value && $self['value'] = $value; + + return $self; } /** * Additional information specific to the scheme. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAdditionalInfo(AdditionalInfo $additionalInfo): self - { - $obj = clone $this; - $obj->additionalInfo = $additionalInfo; + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo, + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; - return $obj; + return $self; } /** @@ -157,18 +166,21 @@ public function withAdditionalInfo(AdditionalInfo $additionalInfo): self */ public function withCost(float $cost): self { - $obj = clone $this; - $obj->cost = $cost; + $self = clone $this; + $self['cost'] = $cost; - return $obj; + return $self; } - public function withGain(Gain $gain): self + /** + * @param Gain|GainShape $gain + */ + public function withGain(Gain|array $gain): self { - $obj = clone $this; - $obj->gain = $gain; + $self = clone $this; + $self['gain'] = $gain; - return $obj; + return $self; } /** @@ -176,10 +188,10 @@ public function withGain(Gain $gain): self */ public function withIsin(string $isin): self { - $obj = clone $this; - $obj->isin = $isin; + $self = clone $this; + $self['isin'] = $isin; - return $obj; + return $self; } /** @@ -187,10 +199,10 @@ public function withIsin(string $isin): self */ public function withName(string $name): self { - $obj = clone $this; - $obj->name = $name; + $self = clone $this; + $self['name'] = $name; - return $obj; + return $self; } /** @@ -198,10 +210,10 @@ public function withName(string $name): self */ public function withNav(float $nav): self { - $obj = clone $this; - $obj->nav = $nav; + $self = clone $this; + $self['nav'] = $nav; - return $obj; + return $self; } /** @@ -211,21 +223,21 @@ public function withNav(float $nav): self */ public function withNominees(array $nominees): self { - $obj = clone $this; - $obj->nominees = $nominees; + $self = clone $this; + $self['nominees'] = $nominees; - return $obj; + return $self; } /** - * @param list $transactions + * @param list $transactions */ public function withTransactions(array $transactions): self { - $obj = clone $this; - $obj->transactions = $transactions; + $self = clone $this; + $self['transactions'] = $transactions; - return $obj; + return $self; } /** @@ -235,10 +247,10 @@ public function withTransactions(array $transactions): self */ public function withType(Type|string $type): self { - $obj = clone $this; - $obj->type = $type instanceof Type ? $type->value : $type; + $self = clone $this; + $self['type'] = $type; - return $obj; + return $self; } /** @@ -246,10 +258,10 @@ public function withType(Type|string $type): self */ public function withUnits(float $units): self { - $obj = clone $this; - $obj->units = $units; + $self = clone $this; + $self['units'] = $units; - return $obj; + return $self; } /** @@ -257,9 +269,9 @@ public function withUnits(float $units): self */ public function withValue(float $value): self { - $obj = clone $this; - $obj->value = $value; + $self = clone $this; + $self['value'] = $value; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/MutualFund/Scheme/AdditionalInfo.php b/src/CasParser/UnifiedResponse/MutualFund/Scheme/AdditionalInfo.php index e5f16cd..0ec6859 100644 --- a/src/CasParser/UnifiedResponse/MutualFund/Scheme/AdditionalInfo.php +++ b/src/CasParser/UnifiedResponse/MutualFund/Scheme/AdditionalInfo.php @@ -4,54 +4,54 @@ namespace CasParser\CasParser\UnifiedResponse\MutualFund\Scheme; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** * Additional information specific to the scheme. * - * @phpstan-type additional_info = array{ - * advisor?: string, - * amfi?: string, - * closeUnits?: float, - * openUnits?: float, - * rtaCode?: string, + * @phpstan-type AdditionalInfoShape = array{ + * advisor?: string|null, + * amfi?: string|null, + * closeUnits?: float|null, + * openUnits?: float|null, + * rtaCode?: string|null, * } */ final class AdditionalInfo implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Financial advisor name (CAMS/KFintech). */ - #[Api(optional: true)] + #[Optional] public ?string $advisor; /** * AMFI code for the scheme (CAMS/KFintech). */ - #[Api(optional: true)] + #[Optional] public ?string $amfi; /** - * Closing balance units (CAMS/KFintech). + * Closing balance units for the statement period. */ - #[Api('close_units', optional: true)] + #[Optional('close_units', nullable: true)] public ?float $closeUnits; /** - * Opening balance units (CAMS/KFintech). + * Opening balance units for the statement period. */ - #[Api('open_units', optional: true)] + #[Optional('open_units', nullable: true)] public ?float $openUnits; /** * RTA code for the scheme (CAMS/KFintech). */ - #[Api('rta_code', optional: true)] + #[Optional('rta_code')] public ?string $rtaCode; public function __construct() @@ -71,15 +71,15 @@ public static function with( ?float $openUnits = null, ?string $rtaCode = null, ): self { - $obj = new self; + $self = new self; - null !== $advisor && $obj->advisor = $advisor; - null !== $amfi && $obj->amfi = $amfi; - null !== $closeUnits && $obj->closeUnits = $closeUnits; - null !== $openUnits && $obj->openUnits = $openUnits; - null !== $rtaCode && $obj->rtaCode = $rtaCode; + null !== $advisor && $self['advisor'] = $advisor; + null !== $amfi && $self['amfi'] = $amfi; + null !== $closeUnits && $self['closeUnits'] = $closeUnits; + null !== $openUnits && $self['openUnits'] = $openUnits; + null !== $rtaCode && $self['rtaCode'] = $rtaCode; - return $obj; + return $self; } /** @@ -87,10 +87,10 @@ public static function with( */ public function withAdvisor(string $advisor): self { - $obj = clone $this; - $obj->advisor = $advisor; + $self = clone $this; + $self['advisor'] = $advisor; - return $obj; + return $self; } /** @@ -98,32 +98,32 @@ public function withAdvisor(string $advisor): self */ public function withAmfi(string $amfi): self { - $obj = clone $this; - $obj->amfi = $amfi; + $self = clone $this; + $self['amfi'] = $amfi; - return $obj; + return $self; } /** - * Closing balance units (CAMS/KFintech). + * Closing balance units for the statement period. */ - public function withCloseUnits(float $closeUnits): self + public function withCloseUnits(?float $closeUnits): self { - $obj = clone $this; - $obj->closeUnits = $closeUnits; + $self = clone $this; + $self['closeUnits'] = $closeUnits; - return $obj; + return $self; } /** - * Opening balance units (CAMS/KFintech). + * Opening balance units for the statement period. */ - public function withOpenUnits(float $openUnits): self + public function withOpenUnits(?float $openUnits): self { - $obj = clone $this; - $obj->openUnits = $openUnits; + $self = clone $this; + $self['openUnits'] = $openUnits; - return $obj; + return $self; } /** @@ -131,9 +131,9 @@ public function withOpenUnits(float $openUnits): self */ public function withRtaCode(string $rtaCode): self { - $obj = clone $this; - $obj->rtaCode = $rtaCode; + $self = clone $this; + $self['rtaCode'] = $rtaCode; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/MutualFund/Scheme/Gain.php b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Gain.php index 8006cfa..c01c4a0 100644 --- a/src/CasParser/UnifiedResponse/MutualFund/Scheme/Gain.php +++ b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Gain.php @@ -4,28 +4,28 @@ namespace CasParser\CasParser\UnifiedResponse\MutualFund\Scheme; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type gain_alias = array{absolute?: float, percentage?: float} + * @phpstan-type GainShape = array{absolute?: float|null, percentage?: float|null} */ final class Gain implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Absolute gain or loss. */ - #[Api(optional: true)] + #[Optional] public ?float $absolute; /** * Percentage gain or loss. */ - #[Api(optional: true)] + #[Optional] public ?float $percentage; public function __construct() @@ -42,12 +42,12 @@ public static function with( ?float $absolute = null, ?float $percentage = null ): self { - $obj = new self; + $self = new self; - null !== $absolute && $obj->absolute = $absolute; - null !== $percentage && $obj->percentage = $percentage; + null !== $absolute && $self['absolute'] = $absolute; + null !== $percentage && $self['percentage'] = $percentage; - return $obj; + return $self; } /** @@ -55,10 +55,10 @@ public static function with( */ public function withAbsolute(float $absolute): self { - $obj = clone $this; - $obj->absolute = $absolute; + $self = clone $this; + $self['absolute'] = $absolute; - return $obj; + return $self; } /** @@ -66,9 +66,9 @@ public function withAbsolute(float $absolute): self */ public function withPercentage(float $percentage): self { - $obj = clone $this; - $obj->percentage = $percentage; + $self = clone $this; + $self['percentage'] = $percentage; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction.php b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction.php index 0ea64d4..26ee653 100644 --- a/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction.php +++ b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction.php @@ -4,73 +4,90 @@ namespace CasParser\CasParser\UnifiedResponse\MutualFund\Scheme; -use CasParser\Core\Attributes\Api; +use CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction\AdditionalInfo; +use CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction\Type; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type transaction_alias = array{ - * amount?: float, - * balance?: float, - * date?: \DateTimeInterface, - * description?: string, - * dividendRate?: float, - * nav?: float, - * type?: string, - * units?: float, + * Unified transaction schema for all holding types (MF folios, equities, bonds, etc.). + * + * @phpstan-import-type AdditionalInfoShape from \CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction\AdditionalInfo + * + * @phpstan-type TransactionShape = array{ + * additionalInfo?: null|\CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction\AdditionalInfo|AdditionalInfoShape, + * amount?: float|null, + * balance?: float|null, + * date?: string|null, + * description?: string|null, + * dividendRate?: float|null, + * nav?: float|null, + * type?: null|\CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction\Type|value-of<\CasParser\CasParser\UnifiedResponse\MutualFund\Scheme\Transaction\Type>, + * units?: float|null, * } */ final class Transaction implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** - * Transaction amount. + * Additional transaction-specific fields that vary by source. */ - #[Api(optional: true)] + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + #[Optional(nullable: true)] public ?float $amount; /** * Balance units after transaction. */ - #[Api(optional: true)] + #[Optional] public ?float $balance; /** - * Transaction date. + * Transaction date (YYYY-MM-DD). */ - #[Api(optional: true)] - public ?\DateTimeInterface $date; + #[Optional] + public ?string $date; /** - * Transaction description. + * Transaction description/particulars. */ - #[Api(optional: true)] + #[Optional] public ?string $description; /** - * Dividend rate (for dividend transactions). + * Dividend rate (for DIVIDEND_PAYOUT transactions). */ - #[Api('dividend_rate', optional: true)] + #[Optional('dividend_rate', nullable: true)] public ?float $dividendRate; /** - * NAV on transaction date. + * NAV/price per unit on transaction date. */ - #[Api(optional: true)] + #[Optional(nullable: true)] public ?float $nav; /** - * Transaction type detected based on description. Possible values are PURCHASE,PURCHASE_SIP,REDEMPTION,SWITCH_IN,SWITCH_IN_MERGER,SWITCH_OUT,SWITCH_OUT_MERGER,DIVIDEND_PAYOUT,DIVIDEND_REINVESTMENT,SEGREGATION,STAMP_DUTY_TAX,TDS_TAX,STT_TAX,MISC. If dividend_rate is present, then possible values are dividend_rate is applicable only for DIVIDEND_PAYOUT and DIVIDEND_REINVESTMENT. + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @var value-of|null $type */ - #[Api(optional: true)] + #[Optional( + enum: Type::class, + )] public ?string $type; /** - * Number of units involved. + * Number of units involved in transaction. */ - #[Api(optional: true)] + #[Optional] public ?float $units; public function __construct() @@ -82,40 +99,59 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + * @param Type|value-of|null $type */ public static function with( + AdditionalInfo|array|null $additionalInfo = null, ?float $amount = null, ?float $balance = null, - ?\DateTimeInterface $date = null, + ?string $date = null, ?string $description = null, ?float $dividendRate = null, ?float $nav = null, - ?string $type = null, + Type|string|null $type = null, ?float $units = null, ): self { - $obj = new self; - - null !== $amount && $obj->amount = $amount; - null !== $balance && $obj->balance = $balance; - null !== $date && $obj->date = $date; - null !== $description && $obj->description = $description; - null !== $dividendRate && $obj->dividendRate = $dividendRate; - null !== $nav && $obj->nav = $nav; - null !== $type && $obj->type = $type; - null !== $units && $obj->units = $units; - - return $obj; + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $amount && $self['amount'] = $amount; + null !== $balance && $self['balance'] = $balance; + null !== $date && $self['date'] = $date; + null !== $description && $self['description'] = $description; + null !== $dividendRate && $self['dividendRate'] = $dividendRate; + null !== $nav && $self['nav'] = $nav; + null !== $type && $self['type'] = $type; + null !== $units && $self['units'] = $units; + + return $self; } /** - * Transaction amount. + * Additional transaction-specific fields that vary by source. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo */ - public function withAmount(float $amount): self + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo, + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Transaction amount in currency (computed from units × price/NAV). + */ + public function withAmount(?float $amount): self { - $obj = clone $this; - $obj->amount = $amount; + $self = clone $this; + $self['amount'] = $amount; - return $obj; + return $self; } /** @@ -123,75 +159,78 @@ public function withAmount(float $amount): self */ public function withBalance(float $balance): self { - $obj = clone $this; - $obj->balance = $balance; + $self = clone $this; + $self['balance'] = $balance; - return $obj; + return $self; } /** - * Transaction date. + * Transaction date (YYYY-MM-DD). */ - public function withDate(\DateTimeInterface $date): self + public function withDate(string $date): self { - $obj = clone $this; - $obj->date = $date; + $self = clone $this; + $self['date'] = $date; - return $obj; + return $self; } /** - * Transaction description. + * Transaction description/particulars. */ public function withDescription(string $description): self { - $obj = clone $this; - $obj->description = $description; + $self = clone $this; + $self['description'] = $description; - return $obj; + return $self; } /** - * Dividend rate (for dividend transactions). + * Dividend rate (for DIVIDEND_PAYOUT transactions). */ - public function withDividendRate(float $dividendRate): self + public function withDividendRate(?float $dividendRate): self { - $obj = clone $this; - $obj->dividendRate = $dividendRate; + $self = clone $this; + $self['dividendRate'] = $dividendRate; - return $obj; + return $self; } /** - * NAV on transaction date. + * NAV/price per unit on transaction date. */ - public function withNav(float $nav): self + public function withNav(?float $nav): self { - $obj = clone $this; - $obj->nav = $nav; + $self = clone $this; + $self['nav'] = $nav; - return $obj; + return $self; } /** - * Transaction type detected based on description. Possible values are PURCHASE,PURCHASE_SIP,REDEMPTION,SWITCH_IN,SWITCH_IN_MERGER,SWITCH_OUT,SWITCH_OUT_MERGER,DIVIDEND_PAYOUT,DIVIDEND_REINVESTMENT,SEGREGATION,STAMP_DUTY_TAX,TDS_TAX,STT_TAX,MISC. If dividend_rate is present, then possible values are dividend_rate is applicable only for DIVIDEND_PAYOUT and DIVIDEND_REINVESTMENT. + * Transaction type. Possible values are PURCHASE, PURCHASE_SIP, REDEMPTION, SWITCH_IN, SWITCH_IN_MERGER, SWITCH_OUT, SWITCH_OUT_MERGER, DIVIDEND_PAYOUT, DIVIDEND_REINVEST, SEGREGATION, STAMP_DUTY_TAX, TDS_TAX, STT_TAX, MISC, REVERSAL, UNKNOWN. + * + * @param Type|value-of $type */ - public function withType(string $type): self - { - $obj = clone $this; - $obj->type = $type; + public function withType( + Type|string $type, + ): self { + $self = clone $this; + $self['type'] = $type; - return $obj; + return $self; } /** - * Number of units involved. + * Number of units involved in transaction. */ public function withUnits(float $units): self { - $obj = clone $this; - $obj->units = $units; + $self = clone $this; + $self['units'] = $units; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction/AdditionalInfo.php b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction/AdditionalInfo.php new file mode 100644 index 0000000..950c7b6 --- /dev/null +++ b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction/AdditionalInfo.php @@ -0,0 +1,179 @@ + */ + use SdkModel; + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + #[Optional('capital_withdrawal')] + public ?float $capitalWithdrawal; + + /** + * Units credited (demat transactions). + */ + #[Optional] + public ?float $credit; + + /** + * Units debited (demat transactions). + */ + #[Optional] + public ?float $debit; + + /** + * Income distribution amount (CDSL MF transactions). + */ + #[Optional('income_distribution')] + public ?float $incomeDistribution; + + /** + * Order/transaction reference number (demat transactions). + */ + #[Optional('order_no')] + public ?string $orderNo; + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + #[Optional] + public ?float $price; + + /** + * Stamp duty charged. + */ + #[Optional('stamp_duty')] + public ?float $stampDuty; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $capitalWithdrawal = null, + ?float $credit = null, + ?float $debit = null, + ?float $incomeDistribution = null, + ?string $orderNo = null, + ?float $price = null, + ?float $stampDuty = null, + ): self { + $self = new self; + + null !== $capitalWithdrawal && $self['capitalWithdrawal'] = $capitalWithdrawal; + null !== $credit && $self['credit'] = $credit; + null !== $debit && $self['debit'] = $debit; + null !== $incomeDistribution && $self['incomeDistribution'] = $incomeDistribution; + null !== $orderNo && $self['orderNo'] = $orderNo; + null !== $price && $self['price'] = $price; + null !== $stampDuty && $self['stampDuty'] = $stampDuty; + + return $self; + } + + /** + * Capital withdrawal amount (CDSL MF transactions). + */ + public function withCapitalWithdrawal(float $capitalWithdrawal): self + { + $self = clone $this; + $self['capitalWithdrawal'] = $capitalWithdrawal; + + return $self; + } + + /** + * Units credited (demat transactions). + */ + public function withCredit(float $credit): self + { + $self = clone $this; + $self['credit'] = $credit; + + return $self; + } + + /** + * Units debited (demat transactions). + */ + public function withDebit(float $debit): self + { + $self = clone $this; + $self['debit'] = $debit; + + return $self; + } + + /** + * Income distribution amount (CDSL MF transactions). + */ + public function withIncomeDistribution(float $incomeDistribution): self + { + $self = clone $this; + $self['incomeDistribution'] = $incomeDistribution; + + return $self; + } + + /** + * Order/transaction reference number (demat transactions). + */ + public function withOrderNo(string $orderNo): self + { + $self = clone $this; + $self['orderNo'] = $orderNo; + + return $self; + } + + /** + * Price per unit (NSDL/CDSL MF transactions). + */ + public function withPrice(float $price): self + { + $self = clone $this; + $self['price'] = $price; + + return $self; + } + + /** + * Stamp duty charged. + */ + public function withStampDuty(float $stampDuty): self + { + $self = clone $this; + $self['stampDuty'] = $stampDuty; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction/Type.php b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction/Type.php new file mode 100644 index 0000000..d251575 --- /dev/null +++ b/src/CasParser/UnifiedResponse/MutualFund/Scheme/Transaction/Type.php @@ -0,0 +1,43 @@ +|null, + * linkedHolders?: list|null, + * pran?: string|null, + * value?: float|null, + * } + */ +final class Np implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Additional information specific to the NPS account. + */ + #[Optional('additional_info')] + public mixed $additionalInfo; + + /** + * Central Record Keeping Agency name. + */ + #[Optional] + public ?string $cra; + + /** @var list|null $funds */ + #[Optional(list: Fund::class)] + public ?array $funds; + + /** + * List of account holders linked to this NPS account. + * + * @var list|null $linkedHolders + */ + #[Optional('linked_holders', list: LinkedHolder::class)] + public ?array $linkedHolders; + + /** + * Permanent Retirement Account Number (PRAN). + */ + #[Optional] + public ?string $pran; + + /** + * Total value of the NPS account. + */ + #[Optional] + public ?float $value; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list|null $funds + * @param list|null $linkedHolders + */ + public static function with( + mixed $additionalInfo = null, + ?string $cra = null, + ?array $funds = null, + ?array $linkedHolders = null, + ?string $pran = null, + ?float $value = null, + ): self { + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $cra && $self['cra'] = $cra; + null !== $funds && $self['funds'] = $funds; + null !== $linkedHolders && $self['linkedHolders'] = $linkedHolders; + null !== $pran && $self['pran'] = $pran; + null !== $value && $self['value'] = $value; + + return $self; + } + + /** + * Additional information specific to the NPS account. + */ + public function withAdditionalInfo(mixed $additionalInfo): self + { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Central Record Keeping Agency name. + */ + public function withCra(string $cra): self + { + $self = clone $this; + $self['cra'] = $cra; + + return $self; + } + + /** + * @param list $funds + */ + public function withFunds(array $funds): self + { + $self = clone $this; + $self['funds'] = $funds; + + return $self; + } + + /** + * List of account holders linked to this NPS account. + * + * @param list $linkedHolders + */ + public function withLinkedHolders(array $linkedHolders): self + { + $self = clone $this; + $self['linkedHolders'] = $linkedHolders; + + return $self; + } + + /** + * Permanent Retirement Account Number (PRAN). + */ + public function withPran(string $pran): self + { + $self = clone $this; + $self['pran'] = $pran; + + return $self; + } + + /** + * Total value of the NPS account. + */ + public function withValue(float $value): self + { + $self = clone $this; + $self['value'] = $value; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/Np/Fund.php b/src/CasParser/UnifiedResponse/Np/Fund.php new file mode 100644 index 0000000..3dd4122 --- /dev/null +++ b/src/CasParser/UnifiedResponse/Np/Fund.php @@ -0,0 +1,165 @@ + */ + use SdkModel; + + /** + * Additional information specific to the NPS fund. + */ + #[Optional('additional_info')] + public ?AdditionalInfo $additionalInfo; + + /** + * Cost of investment. + */ + #[Optional] + public ?float $cost; + + /** + * Name of the NPS fund. + */ + #[Optional] + public ?string $name; + + /** + * Net Asset Value per unit. + */ + #[Optional] + public ?float $nav; + + /** + * Number of units held. + */ + #[Optional] + public ?float $units; + + /** + * Current market value of the holding. + */ + #[Optional] + public ?float $value; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AdditionalInfo|AdditionalInfoShape|null $additionalInfo + */ + public static function with( + AdditionalInfo|array|null $additionalInfo = null, + ?float $cost = null, + ?string $name = null, + ?float $nav = null, + ?float $units = null, + ?float $value = null, + ): self { + $self = new self; + + null !== $additionalInfo && $self['additionalInfo'] = $additionalInfo; + null !== $cost && $self['cost'] = $cost; + null !== $name && $self['name'] = $name; + null !== $nav && $self['nav'] = $nav; + null !== $units && $self['units'] = $units; + null !== $value && $self['value'] = $value; + + return $self; + } + + /** + * Additional information specific to the NPS fund. + * + * @param AdditionalInfo|AdditionalInfoShape $additionalInfo + */ + public function withAdditionalInfo( + AdditionalInfo|array $additionalInfo + ): self { + $self = clone $this; + $self['additionalInfo'] = $additionalInfo; + + return $self; + } + + /** + * Cost of investment. + */ + public function withCost(float $cost): self + { + $self = clone $this; + $self['cost'] = $cost; + + return $self; + } + + /** + * Name of the NPS fund. + */ + public function withName(string $name): self + { + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * Net Asset Value per unit. + */ + public function withNav(float $nav): self + { + $self = clone $this; + $self['nav'] = $nav; + + return $self; + } + + /** + * Number of units held. + */ + public function withUnits(float $units): self + { + $self = clone $this; + $self['units'] = $units; + + return $self; + } + + /** + * Current market value of the holding. + */ + public function withValue(float $value): self + { + $self = clone $this; + $self['value'] = $value; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/Np/Fund/AdditionalInfo.php b/src/CasParser/UnifiedResponse/Np/Fund/AdditionalInfo.php new file mode 100644 index 0000000..f7d3ce5 --- /dev/null +++ b/src/CasParser/UnifiedResponse/Np/Fund/AdditionalInfo.php @@ -0,0 +1,78 @@ + */ + use SdkModel; + + /** + * Fund manager name. + */ + #[Optional] + public ?string $manager; + + /** + * NPS tier (Tier I or Tier II). + */ + #[Optional(nullable: true)] + public ?float $tier; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?string $manager = null, + ?float $tier = null + ): self { + $self = new self; + + null !== $manager && $self['manager'] = $manager; + null !== $tier && $self['tier'] = $tier; + + return $self; + } + + /** + * Fund manager name. + */ + public function withManager(string $manager): self + { + $self = clone $this; + $self['manager'] = $manager; + + return $self; + } + + /** + * NPS tier (Tier I or Tier II). + */ + public function withTier(?float $tier): self + { + $self = clone $this; + $self['tier'] = $tier; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/Np/LinkedHolder.php b/src/CasParser/UnifiedResponse/Np/LinkedHolder.php new file mode 100644 index 0000000..65f3765 --- /dev/null +++ b/src/CasParser/UnifiedResponse/Np/LinkedHolder.php @@ -0,0 +1,72 @@ + */ + use SdkModel; + + /** + * Name of the account holder. + */ + #[Optional] + public ?string $name; + + /** + * PAN of the account holder. + */ + #[Optional] + public ?string $pan; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $name = null, ?string $pan = null): self + { + $self = new self; + + null !== $name && $self['name'] = $name; + null !== $pan && $self['pan'] = $pan; + + return $self; + } + + /** + * Name of the account holder. + */ + public function withName(string $name): self + { + $self = clone $this; + $self['name'] = $name; + + return $self; + } + + /** + * PAN of the account holder. + */ + public function withPan(string $pan): self + { + $self = clone $this; + $self['pan'] = $pan; + + return $self; + } +} diff --git a/src/CasParser/UnifiedResponse/Summary.php b/src/CasParser/UnifiedResponse/Summary.php index 6b32295..9865595 100644 --- a/src/CasParser/UnifiedResponse/Summary.php +++ b/src/CasParser/UnifiedResponse/Summary.php @@ -5,25 +5,29 @@ namespace CasParser\CasParser\UnifiedResponse; use CasParser\CasParser\UnifiedResponse\Summary\Accounts; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type summary_alias = array{accounts?: Accounts, totalValue?: float} + * @phpstan-import-type AccountsShape from \CasParser\CasParser\UnifiedResponse\Summary\Accounts + * + * @phpstan-type SummaryShape = array{ + * accounts?: null|Accounts|AccountsShape, totalValue?: float|null + * } */ final class Summary implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; - #[Api(optional: true)] + #[Optional] public ?Accounts $accounts; /** * Total portfolio value across all accounts. */ - #[Api('total_value', optional: true)] + #[Optional('total_value')] public ?float $totalValue; public function __construct() @@ -35,25 +39,30 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param Accounts|AccountsShape|null $accounts */ public static function with( - ?Accounts $accounts = null, + Accounts|array|null $accounts = null, ?float $totalValue = null ): self { - $obj = new self; + $self = new self; - null !== $accounts && $obj->accounts = $accounts; - null !== $totalValue && $obj->totalValue = $totalValue; + null !== $accounts && $self['accounts'] = $accounts; + null !== $totalValue && $self['totalValue'] = $totalValue; - return $obj; + return $self; } - public function withAccounts(Accounts $accounts): self + /** + * @param Accounts|AccountsShape $accounts + */ + public function withAccounts(Accounts|array $accounts): self { - $obj = clone $this; - $obj->accounts = $accounts; + $self = clone $this; + $self['accounts'] = $accounts; - return $obj; + return $self; } /** @@ -61,9 +70,9 @@ public function withAccounts(Accounts $accounts): self */ public function withTotalValue(float $totalValue): self { - $obj = clone $this; - $obj->totalValue = $totalValue; + $self = clone $this; + $self['totalValue'] = $totalValue; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Summary/Accounts.php b/src/CasParser/UnifiedResponse/Summary/Accounts.php index 82b1f21..9e4db59 100644 --- a/src/CasParser/UnifiedResponse/Summary/Accounts.php +++ b/src/CasParser/UnifiedResponse/Summary/Accounts.php @@ -7,29 +7,41 @@ use CasParser\CasParser\UnifiedResponse\Summary\Accounts\Demat; use CasParser\CasParser\UnifiedResponse\Summary\Accounts\Insurance; use CasParser\CasParser\UnifiedResponse\Summary\Accounts\MutualFunds; -use CasParser\Core\Attributes\Api; +use CasParser\CasParser\UnifiedResponse\Summary\Accounts\Nps; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type accounts_alias = array{ - * demat?: Demat, insurance?: Insurance, mutualFunds?: MutualFunds + * @phpstan-import-type DematShape from \CasParser\CasParser\UnifiedResponse\Summary\Accounts\Demat + * @phpstan-import-type InsuranceShape from \CasParser\CasParser\UnifiedResponse\Summary\Accounts\Insurance + * @phpstan-import-type MutualFundsShape from \CasParser\CasParser\UnifiedResponse\Summary\Accounts\MutualFunds + * @phpstan-import-type NpsShape from \CasParser\CasParser\UnifiedResponse\Summary\Accounts\Nps + * + * @phpstan-type AccountsShape = array{ + * demat?: null|Demat|DematShape, + * insurance?: null|Insurance|InsuranceShape, + * mutualFunds?: null|MutualFunds|MutualFundsShape, + * nps?: null|Nps|NpsShape, * } */ final class Accounts implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; - #[Api(optional: true)] + #[Optional] public ?Demat $demat; - #[Api(optional: true)] + #[Optional] public ?Insurance $insurance; - #[Api('mutual_funds', optional: true)] + #[Optional('mutual_funds')] public ?MutualFunds $mutualFunds; + #[Optional] + public ?Nps $nps; + public function __construct() { $this->initialize(); @@ -39,42 +51,69 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param Demat|DematShape|null $demat + * @param Insurance|InsuranceShape|null $insurance + * @param MutualFunds|MutualFundsShape|null $mutualFunds + * @param Nps|NpsShape|null $nps */ public static function with( - ?Demat $demat = null, - ?Insurance $insurance = null, - ?MutualFunds $mutualFunds = null, + Demat|array|null $demat = null, + Insurance|array|null $insurance = null, + MutualFunds|array|null $mutualFunds = null, + Nps|array|null $nps = null, ): self { - $obj = new self; + $self = new self; - null !== $demat && $obj->demat = $demat; - null !== $insurance && $obj->insurance = $insurance; - null !== $mutualFunds && $obj->mutualFunds = $mutualFunds; + null !== $demat && $self['demat'] = $demat; + null !== $insurance && $self['insurance'] = $insurance; + null !== $mutualFunds && $self['mutualFunds'] = $mutualFunds; + null !== $nps && $self['nps'] = $nps; + + return $self; + } + + /** + * @param Demat|DematShape $demat + */ + public function withDemat(Demat|array $demat): self + { + $self = clone $this; + $self['demat'] = $demat; - return $obj; + return $self; } - public function withDemat(Demat $demat): self + /** + * @param Insurance|InsuranceShape $insurance + */ + public function withInsurance(Insurance|array $insurance): self { - $obj = clone $this; - $obj->demat = $demat; + $self = clone $this; + $self['insurance'] = $insurance; - return $obj; + return $self; } - public function withInsurance(Insurance $insurance): self + /** + * @param MutualFunds|MutualFundsShape $mutualFunds + */ + public function withMutualFunds(MutualFunds|array $mutualFunds): self { - $obj = clone $this; - $obj->insurance = $insurance; + $self = clone $this; + $self['mutualFunds'] = $mutualFunds; - return $obj; + return $self; } - public function withMutualFunds(MutualFunds $mutualFunds): self + /** + * @param Nps|NpsShape $nps + */ + public function withNps(Nps|array $nps): self { - $obj = clone $this; - $obj->mutualFunds = $mutualFunds; + $self = clone $this; + $self['nps'] = $nps; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Summary/Accounts/Demat.php b/src/CasParser/UnifiedResponse/Summary/Accounts/Demat.php index 50165c2..45bee75 100644 --- a/src/CasParser/UnifiedResponse/Summary/Accounts/Demat.php +++ b/src/CasParser/UnifiedResponse/Summary/Accounts/Demat.php @@ -4,28 +4,28 @@ namespace CasParser\CasParser\UnifiedResponse\Summary\Accounts; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type demat_alias = array{count?: int, totalValue?: float} + * @phpstan-type DematShape = array{count?: int|null, totalValue?: float|null} */ final class Demat implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Number of demat accounts. */ - #[Api(optional: true)] + #[Optional] public ?int $count; /** * Total value of demat accounts. */ - #[Api('total_value', optional: true)] + #[Optional('total_value')] public ?float $totalValue; public function __construct() @@ -42,12 +42,12 @@ public static function with( ?int $count = null, ?float $totalValue = null ): self { - $obj = new self; + $self = new self; - null !== $count && $obj->count = $count; - null !== $totalValue && $obj->totalValue = $totalValue; + null !== $count && $self['count'] = $count; + null !== $totalValue && $self['totalValue'] = $totalValue; - return $obj; + return $self; } /** @@ -55,10 +55,10 @@ public static function with( */ public function withCount(int $count): self { - $obj = clone $this; - $obj->count = $count; + $self = clone $this; + $self['count'] = $count; - return $obj; + return $self; } /** @@ -66,9 +66,9 @@ public function withCount(int $count): self */ public function withTotalValue(float $totalValue): self { - $obj = clone $this; - $obj->totalValue = $totalValue; + $self = clone $this; + $self['totalValue'] = $totalValue; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Summary/Accounts/Insurance.php b/src/CasParser/UnifiedResponse/Summary/Accounts/Insurance.php index a14d733..26fece6 100644 --- a/src/CasParser/UnifiedResponse/Summary/Accounts/Insurance.php +++ b/src/CasParser/UnifiedResponse/Summary/Accounts/Insurance.php @@ -4,28 +4,28 @@ namespace CasParser\CasParser\UnifiedResponse\Summary\Accounts; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type insurance_alias = array{count?: int, totalValue?: float} + * @phpstan-type InsuranceShape = array{count?: int|null, totalValue?: float|null} */ final class Insurance implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Number of insurance policies. */ - #[Api(optional: true)] + #[Optional] public ?int $count; /** * Total value of insurance policies. */ - #[Api('total_value', optional: true)] + #[Optional('total_value')] public ?float $totalValue; public function __construct() @@ -42,12 +42,12 @@ public static function with( ?int $count = null, ?float $totalValue = null ): self { - $obj = new self; + $self = new self; - null !== $count && $obj->count = $count; - null !== $totalValue && $obj->totalValue = $totalValue; + null !== $count && $self['count'] = $count; + null !== $totalValue && $self['totalValue'] = $totalValue; - return $obj; + return $self; } /** @@ -55,10 +55,10 @@ public static function with( */ public function withCount(int $count): self { - $obj = clone $this; - $obj->count = $count; + $self = clone $this; + $self['count'] = $count; - return $obj; + return $self; } /** @@ -66,9 +66,9 @@ public function withCount(int $count): self */ public function withTotalValue(float $totalValue): self { - $obj = clone $this; - $obj->totalValue = $totalValue; + $self = clone $this; + $self['totalValue'] = $totalValue; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Summary/Accounts/MutualFunds.php b/src/CasParser/UnifiedResponse/Summary/Accounts/MutualFunds.php index dc2f0c0..3b91f0d 100644 --- a/src/CasParser/UnifiedResponse/Summary/Accounts/MutualFunds.php +++ b/src/CasParser/UnifiedResponse/Summary/Accounts/MutualFunds.php @@ -4,28 +4,30 @@ namespace CasParser\CasParser\UnifiedResponse\Summary\Accounts; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; /** - * @phpstan-type mutual_funds = array{count?: int, totalValue?: float} + * @phpstan-type MutualFundsShape = array{ + * count?: int|null, totalValue?: float|null + * } */ final class MutualFunds implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; /** * Number of mutual fund folios. */ - #[Api(optional: true)] + #[Optional] public ?int $count; /** * Total value of mutual funds. */ - #[Api('total_value', optional: true)] + #[Optional('total_value')] public ?float $totalValue; public function __construct() @@ -42,12 +44,12 @@ public static function with( ?int $count = null, ?float $totalValue = null ): self { - $obj = new self; + $self = new self; - null !== $count && $obj->count = $count; - null !== $totalValue && $obj->totalValue = $totalValue; + null !== $count && $self['count'] = $count; + null !== $totalValue && $self['totalValue'] = $totalValue; - return $obj; + return $self; } /** @@ -55,10 +57,10 @@ public static function with( */ public function withCount(int $count): self { - $obj = clone $this; - $obj->count = $count; + $self = clone $this; + $self['count'] = $count; - return $obj; + return $self; } /** @@ -66,9 +68,9 @@ public function withCount(int $count): self */ public function withTotalValue(float $totalValue): self { - $obj = clone $this; - $obj->totalValue = $totalValue; + $self = clone $this; + $self['totalValue'] = $totalValue; - return $obj; + return $self; } } diff --git a/src/CasParser/UnifiedResponse/Summary/Accounts/Nps.php b/src/CasParser/UnifiedResponse/Summary/Accounts/Nps.php new file mode 100644 index 0000000..d407a09 --- /dev/null +++ b/src/CasParser/UnifiedResponse/Summary/Accounts/Nps.php @@ -0,0 +1,74 @@ + */ + use SdkModel; + + /** + * Number of NPS accounts. + */ + #[Optional] + public ?int $count; + + /** + * Total value of NPS accounts. + */ + #[Optional('total_value')] + public ?float $totalValue; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?int $count = null, + ?float $totalValue = null + ): self { + $self = new self; + + null !== $count && $self['count'] = $count; + null !== $totalValue && $self['totalValue'] = $totalValue; + + return $self; + } + + /** + * Number of NPS accounts. + */ + public function withCount(int $count): self + { + $self = clone $this; + $self['count'] = $count; + + return $self; + } + + /** + * Total value of NPS accounts. + */ + public function withTotalValue(float $totalValue): self + { + $self = clone $this; + $self['totalValue'] = $totalValue; + + return $self; + } +} diff --git a/src/Client.php b/src/Client.php index 947f3cc..765ca70 100644 --- a/src/Client.php +++ b/src/Client.php @@ -5,6 +5,7 @@ namespace CasParser; use CasParser\Core\BaseClient; +use CasParser\Core\Util; use CasParser\Services\CasGeneratorService; use CasParser\Services\CasParserService; use Http\Discovery\Psr17FactoryDiscovery; @@ -28,7 +29,7 @@ public function __construct(?string $apiKey = null, ?string $baseUrl = null) { $this->apiKey = (string) ($apiKey ?? getenv('CAS_PARSER_API_KEY')); - $base = $baseUrl ?? getenv( + $baseUrl ??= getenv( 'CAS_PARSER_BASE_URL' ) ?: 'https://portfolio-parser.api.casparser.in'; @@ -41,19 +42,27 @@ public function __construct(?string $apiKey = null, ?string $baseUrl = null) parent::__construct( headers: [ - 'Content-Type' => 'application/json', 'Accept' => 'application/json', + 'Content-Type' => 'application/json', + 'Accept' => 'application/json', + 'User-Agent' => sprintf('CAS Parser/PHP %s', VERSION), + 'X-Stainless-Lang' => 'php', + 'X-Stainless-Package-Version' => '0.0.1', + 'X-Stainless-Arch' => Util::machtype(), + 'X-Stainless-OS' => Util::ostype(), + 'X-Stainless-Runtime' => php_sapi_name(), + 'X-Stainless-Runtime-Version' => phpversion(), ], - baseUrl: $base, - options: $options, + baseUrl: $baseUrl, + options: $options ); $this->casParser = new CasParserService($this); $this->casGenerator = new CasGeneratorService($this); } - /** @return array */ + /** @return array */ protected function authHeaders(): array { - return ['x-api-key' => $this->apiKey]; + return $this->apiKey ? ['x-api-key' => $this->apiKey] : []; } } diff --git a/src/Core/Attributes/Optional.php b/src/Core/Attributes/Optional.php new file mode 100644 index 0000000..50d1e83 --- /dev/null +++ b/src/Core/Attributes/Optional.php @@ -0,0 +1,35 @@ +|Converter|string|null $type + * @param class-string<\BackedEnum>|Converter|null $enum + * @param class-string|Converter|null $union + * @param class-string|Converter|string|null $list + * @param class-string|Converter|string|null $map + */ + public function __construct( + ?string $apiName = null, + Converter|string|null $type = null, + Converter|string|null $enum = null, + Converter|string|null $union = null, + Converter|string|null $list = null, + Converter|string|null $map = null, + bool $nullable = false, + ) { + parent::__construct(apiName: $apiName, type: $type, enum: $enum, union: $union, list: $list, map: $map, nullable: $nullable); + $this->optional = true; + } +} diff --git a/src/Core/Attributes/Api.php b/src/Core/Attributes/Required.php similarity index 77% rename from src/Core/Attributes/Api.php rename to src/Core/Attributes/Required.php index c3f6875..589a017 100644 --- a/src/Core/Attributes/Api.php +++ b/src/Core/Attributes/Required.php @@ -14,11 +14,17 @@ * @internal */ #[\Attribute(\Attribute::TARGET_PROPERTY)] -final class Api +class Required { /** @var class-string|Converter|string|null */ public readonly Converter|string|null $type; + public readonly ?string $apiName; + + public bool $optional; + + public readonly bool $nullable; + /** @var array */ private static array $enumConverters = []; @@ -30,14 +36,13 @@ final class Api * @param class-string|Converter|string|null $map */ public function __construct( - public readonly ?string $apiName = null, + ?string $apiName = null, Converter|string|null $type = null, Converter|string|null $enum = null, Converter|string|null $union = null, Converter|string|null $list = null, Converter|string|null $map = null, - public readonly bool $nullable = false, - public readonly bool $optional = false, + bool $nullable = false, ) { $type ??= $union; if (null !== $list) { @@ -47,17 +52,21 @@ public function __construct( $type ??= new MapOf($map); } if (null !== $enum) { - $type ??= $enum instanceof Converter ? $enum : $this->getEnumConverter($enum); + $type ??= $enum instanceof Converter ? $enum : self::enumConverter($enum); } + $this->apiName = $apiName; $this->type = $type; + $this->optional = false; + $this->nullable = $nullable; } /** @property class-string<\BackedEnum> $enum */ - private function getEnumConverter(string $enum): Converter + private static function enumConverter(string $enum): Converter { if (!isset(self::$enumConverters[$enum])) { - $converter = new EnumOf(array_column($enum::cases(), 'value')); // @phpstan-ignore-line + // @phpstan-ignore-next-line argument.type + $converter = new EnumOf(array_column($enum::cases(), column_key: 'value')); self::$enumConverters[$enum] = $converter; } diff --git a/src/Core/BaseClient.php b/src/Core/BaseClient.php index cae68a4..ab0aefa 100644 --- a/src/Core/BaseClient.php +++ b/src/Core/BaseClient.php @@ -5,11 +5,13 @@ namespace CasParser\Core; use CasParser\Core\Contracts\BasePage; +use CasParser\Core\Contracts\BaseResponse; use CasParser\Core\Contracts\BaseStream; use CasParser\Core\Conversion\Contracts\Converter; use CasParser\Core\Conversion\Contracts\ConverterSource; use CasParser\Core\Exceptions\APIConnectionException; use CasParser\Core\Exceptions\APIStatusException; +use CasParser\Core\Implementation\RawResponse; use CasParser\RequestOptions; use Psr\Http\Client\ClientExceptionInterface; use Psr\Http\Client\ClientInterface; @@ -24,23 +26,24 @@ * @phpstan-type normalized_request = array{ * method: string, * path: string, - * query: array, - * headers: array>, + * query: array, + * headers: array>, * body: mixed, * } */ -class BaseClient +abstract class BaseClient { protected UriInterface $baseUrl; /** * @internal * - * @param array|null> $headers + * @param array|null> $headers */ public function __construct( protected array $headers, string $baseUrl, + protected ?string $idempotencyHeader = null, protected RequestOptions $options = new RequestOptions, ) { assert(!is_null($this->options->uriFactory)); @@ -49,11 +52,14 @@ public function __construct( /** * @param string|list $path - * @param array $query - * @param array $headers - * @param class-string> $page - * @param class-string> $stream - * @param RequestOptions|array|null $options + * @param array $query + * @param array $headers + * @param string|int|list|null $unwrap + * @param class-string>|null $page + * @param class-string>|null $stream + * @param RequestOptions|array|null $options + * + * @return BaseResponse */ public function request( string $method, @@ -61,69 +67,53 @@ public function request( array $query = [], array $headers = [], mixed $body = null, + string|int|array|null $unwrap = null, string|Converter|ConverterSource|null $convert = null, ?string $page = null, ?string $stream = null, RequestOptions|array|null $options = [], - ): mixed { + ): BaseResponse { // @phpstan-ignore-next-line [$req, $opts] = $this->buildRequest(method: $method, path: $path, query: $query, headers: $headers, body: $body, opts: $options); - ['method' => $method, 'path' => $uri, 'headers' => $headers] = $req; + ['method' => $method, 'path' => $uri, 'headers' => $headers, 'body' => $data] = $req; assert(!is_null($opts->requestFactory)); $request = $opts->requestFactory->createRequest($method, uri: $uri); $request = Util::withSetHeaders($request, headers: $headers); - // @phpstan-ignore-next-line - $rsp = $this->sendRequest($opts, req: $request, data: $body, redirectCount: 0, retryCount: 0); - - $decoded = Util::decodeContent($rsp); - - if (!is_null($stream)) { - return new $stream( - convert: $convert, - request: $request, - response: $rsp, - stream: $decoded - ); - } - - if (!is_null($page)) { - return new $page( - convert: $convert, - client: $this, - request: $req, - options: $opts, - data: $decoded, - ); - } - - if (!is_null($convert)) { - return Conversion::coerce($convert, value: $decoded); - } + // @phpstan-ignore-next-line argument.type + $rsp = $this->sendRequest($opts, req: $request, data: $data, redirectCount: 0, retryCount: 0); - return $decoded; + // @phpstan-ignore-next-line argument.type + return new RawResponse(client: $this, request: $request, response: $rsp, options: $opts, requestInfo: $req, unwrap: $unwrap, stream: $stream, page: $page, convert: $convert ?? 'null'); } - /** @return array */ - protected function authHeaders(): array + /** @return array */ + abstract protected function authHeaders(): array; + + /** + * @internal + */ + protected function generateIdempotencyKey(): string { - return []; + $hex = bin2hex(random_bytes(32)); + + return "stainless-php-retry-{$hex}"; } /** * @internal * * @param string|list $path - * @param array $query - * @param array|null> $headers + * @param array $query + * @param array|null> $headers * @param array{ * timeout?: float|null, * maxRetries?: int|null, * initialRetryDelay?: float|null, * maxRetryDelay?: float|null, - * extraHeaders?: array|null>|null, - * extraQueryParams?: array|null, + * extraHeaders?: array|null>|null, + * extraQueryParams?: array|null, * extraBodyParams?: mixed, * transporter?: ClientInterface|null, * uriFactory?: UriFactoryInterface|null, @@ -145,18 +135,24 @@ protected function buildRequest( $parsedPath = Util::parsePath($path); - /** @var array $mergedQuery */ + /** @var array $mergedQuery */ $mergedQuery = array_merge_recursive( $query, - $options->extraQueryParams ?? [], + $options->extraQueryParams ?? [] ); $uri = Util::joinUri($this->baseUrl, path: $parsedPath, query: $mergedQuery)->__toString(); + $idempotencyHeaders = $this->idempotencyHeader && !array_key_exists($this->idempotencyHeader, array: $headers) + ? [$this->idempotencyHeader => $this->generateIdempotencyKey()] + : []; - /** @var array|null> $mergedHeaders */ - $mergedHeaders = [...$this->headers, + /** @var array|null> $mergedHeaders */ + $mergedHeaders = [ + ...$this->headers, ...$this->authHeaders(), ...$headers, - ...($options->extraHeaders ?? []), ]; + ...($options->extraHeaders ?? []), + ...$idempotencyHeaders, + ]; $req = ['method' => strtoupper($method), 'path' => $uri, 'query' => $mergedQuery, 'headers' => $mergedHeaders, 'body' => $body]; @@ -232,8 +228,7 @@ protected function retryDelay( /** * @internal * - * @param bool|int|float|string|resource|\Traversable|array|null $data + * @param bool|int|float|string|resource|\Traversable|array|null $data */ protected function sendRequest( RequestOptions $opts, @@ -244,6 +239,8 @@ protected function sendRequest( ): ResponseInterface { assert(null !== $opts->streamFactory && null !== $opts->transporter); + /** @var RequestInterface */ + $req = $req->withHeader('X-Stainless-Retry-Count', strval($retryCount)); $req = Util::withSetBody($opts->streamFactory, req: $req, body: $data); $rsp = null; @@ -270,7 +267,7 @@ protected function sendRequest( } if ($code >= 400 || is_null($rsp)) { - if ($this->shouldRetry($opts, retryCount: $retryCount, rsp: $rsp)) { + if (!$this->shouldRetry($opts, retryCount: $retryCount, rsp: $rsp)) { $exn = is_null($rsp) ? new APIConnectionException($req, previous: $err) : APIStatusException::from(request: $req, response: $rsp); throw $exn; diff --git a/src/Core/Concerns/ResponseProxy.php b/src/Core/Concerns/ResponseProxy.php new file mode 100644 index 0000000..b0ca8af --- /dev/null +++ b/src/Core/Concerns/ResponseProxy.php @@ -0,0 +1,101 @@ +response->getProtocolVersion(); + } + + public function withProtocolVersion(string $version): static + { + $self = clone $this; + $self->response = $this->response->withProtocolVersion($version); + + return $self; + } + + public function getHeaders(): array + { + return $this->response->getHeaders(); + } + + public function hasHeader(string $name): bool + { + return $this->response->hasHeader($name); + } + + public function getHeader(string $name): array + { + return $this->response->getHeader($name); + } + + public function getHeaderLine(string $name): string + { + return $this->response->getHeaderLine($name); + } + + public function withHeader(string $name, $value): static + { + $self = clone $this; + $self->response = $this->response->withHeader($name, value: $value); + + return $self; + } + + public function withAddedHeader(string $name, $value): static + { + $self = clone $this; + $self->response = $this->response->withAddedHeader($name, value: $value); + + return $self; + } + + public function withoutHeader(string $name): static + { + $self = clone $this; + $self->response = $this->response->withoutHeader($name); + + return $self; + } + + public function getBody(): StreamInterface + { + return $this->response->getBody(); + } + + public function withBody(StreamInterface $body): static + { + $self = clone $this; + $self->response = $this->response->withBody($body); + + return $self; + } + + public function getStatusCode(): int + { + return $this->response->getStatusCode(); + } + + public function withStatus(int $code, string $reasonPhrase = ''): static + { + $self = clone $this; + $self->response = $this->response->withstatus($code, reasonPhrase: $reasonPhrase); + + return $self; + } + + public function getReasonPhrase(): string + { + return $this->response->getReasonPhrase(); + } +} diff --git a/src/Core/Concerns/SdkEnum.php b/src/Core/Concerns/SdkEnum.php index 9941eaf..467116e 100644 --- a/src/Core/Concerns/SdkEnum.php +++ b/src/Core/Concerns/SdkEnum.php @@ -28,6 +28,7 @@ public static function converter(): Converter } } - return static::$converter = new EnumOf($acc); // @phpstan-ignore-line + // @phpstan-ignore-next-line return.type + return static::$converter = new EnumOf($acc); } } diff --git a/src/Core/Concerns/SdkModel.php b/src/Core/Concerns/SdkModel.php index 27f095b..a8548e1 100644 --- a/src/Core/Concerns/SdkModel.php +++ b/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(); - return array_map(static fn ($v) => self::serialize($v), array: $rows); + return array_map(static fn ($v) => self::serialize($v), array: $properties); } /** @@ -45,7 +45,8 @@ public function __serialize(): array public function __unserialize(array $data): void { foreach ($data as $key => $value) { - $this->offsetSet($key, value: $value); // @phpstan-ignore-line + // @phpstan-ignore-next-line argument.type + $this->offsetSet($key, value: $value); } } @@ -74,8 +75,6 @@ public function __toString(): string * a native class property, indicating an omitted value, * or a property overridden with an incongruent type * - * @return value-of - * * @throws \Exception */ public function __get(string $key): mixed @@ -94,15 +93,19 @@ public function __get(string $key): mixed // An optional property which was unset to be omitted from serialized is being accessed. // Return null to match user's expectations. - return null; // @phpstan-ignore-line + // @phpstan-ignore-next-line return.type + return null; } /** + * @internal + * * @return Shape */ - public function toArray(): array + public function toProperties(): array { - return $this->__serialize(); // @phpstan-ignore-line + // @phpstan-ignore-next-line return.type + return [...Util::get_object_vars($this), ...$this->_data]; } /** @@ -112,7 +115,8 @@ public function toArray(): array */ public function offsetExists(mixed $offset): bool { - if (!is_string($offset)) { // @phpstan-ignore-line + // @phpstan-ignore-next-line function.alreadyNarrowedType + if (!is_string($offset)) { throw new \InvalidArgumentException; } @@ -140,19 +144,24 @@ public function offsetExists(mixed $offset): bool */ public function &offsetGet(mixed $offset): mixed { - if (!is_string($offset)) { // @phpstan-ignore-line + // @phpstan-ignore-next-line function.alreadyNarrowedType + if (!is_string($offset)) { throw new \InvalidArgumentException; } - if (!$this->offsetExists($offset)) { // @phpstan-ignore-line - return null; // @phpstan-ignore-line + // @phpstan-ignore-next-line function.alreadyNarrowedType + if (!$this->offsetExists($offset)) { + // @phpstan-ignore-next-line return.type + return null; } if (array_key_exists($offset, array: $this->_data)) { - return $this->_data[$offset]; // @phpstan-ignore-line + // @phpstan-ignore-next-line return.type + return $this->_data[$offset]; } - return $this->{$offset}; // @phpstan-ignore-line + // @phpstan-ignore-next-line return.type + return $this->{$offset}; } /** @@ -162,7 +171,8 @@ public function &offsetGet(mixed $offset): mixed */ public function offsetSet(mixed $offset, mixed $value): void { - if (!is_string($offset)) { // @phpstan-ignore-line + // @phpstan-ignore-next-line function.alreadyNarrowedType + if (!is_string($offset)) { throw new \InvalidArgumentException; } @@ -172,13 +182,16 @@ public function offsetSet(mixed $offset, mixed $value): void $coerced = Conversion::coerce($type, value: $value, state: new CoerceState(translateNames: false)); - if (property_exists($this, property: $offset)) { // @phpstan-ignore-line + // @phpstan-ignore-next-line function.alreadyNarrowedType + if (property_exists($this, property: $offset)) { try { - $this->{$offset} = $coerced; // @phpstan-ignore-line + // @phpstan-ignore-next-line assign.propertyType + $this->{$offset} = $coerced; unset($this->_data[$offset]); return; - } catch (\TypeError) { // @phpstan-ignore-line + // @phpstan-ignore-next-line catch.neverThrown + } catch (\TypeError) { unset($this->{$offset}); } } @@ -193,11 +206,13 @@ public function offsetSet(mixed $offset, mixed $value): void */ public function offsetUnset(mixed $offset): void { - if (!is_string($offset)) { // @phpstan-ignore-line + // @phpstan-ignore-next-line function.alreadyNarrowedType + if (!is_string($offset)) { throw new \InvalidArgumentException; } - if (property_exists($this, property: $offset)) { // @phpstan-ignore-line + // @phpstan-ignore-next-line function.alreadyNarrowedType + if (property_exists($this, property: $offset)) { unset($this->{$offset}); } @@ -211,7 +226,7 @@ public function offsetUnset(mixed $offset): void */ public function jsonSerialize(): array { - // @phpstan-ignore-next-line + // @phpstan-ignore-next-line argument.type return Conversion::dump(self::converter(), value: $this->__serialize()); } @@ -220,7 +235,8 @@ public function jsonSerialize(): array */ public static function fromArray(array $data): static { - return self::converter()->from($data); // @phpstan-ignore-line + // @phpstan-ignore-next-line argument.type + return self::converter()->from($data); } /** @@ -257,7 +273,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)) { diff --git a/src/Core/Concerns/SdkPage.php b/src/Core/Concerns/SdkPage.php index 20e1c71..b46c41c 100644 --- a/src/Core/Concerns/SdkPage.php +++ b/src/Core/Concerns/SdkPage.php @@ -5,6 +5,7 @@ namespace CasParser\Core\Concerns; use CasParser\Client; +use CasParser\Core\Contracts\BaseResponse; use CasParser\Core\Conversion\Contracts\Converter; use CasParser\Core\Conversion\Contracts\ConverterSource; use CasParser\Core\Exceptions\APIStatusException; @@ -14,8 +15,6 @@ * @internal * * @template Item - * - * @phpstan-import-type normalized_request from \CasParser\Core\BaseClient */ trait SdkPage { @@ -23,13 +22,6 @@ trait SdkPage private Client $client; - /** - * normalized_request $request. - */ - private array $request; - - private RequestOptions $options; - /** * @return list */ @@ -37,12 +29,7 @@ abstract public function getItems(): array; public function hasNextPage(): bool { - $items = $this->getItems(); - if (empty($items)) { - return false; - } - - return null != $this->nextRequest(); + return !is_null($this->nextRequest()); } /** @@ -65,8 +52,12 @@ public function getNextPage(): static [$req, $opts] = $next; - // @phpstan-ignore-next-line - return $this->client->request(...$req, convert: $this->convert, page: $this::class, options: $opts); + // @phpstan-ignore-next-line argument.type + /** @var BaseResponse */ + $response = $this->client->request(...$req, convert: $this->convert, page: $this::class, options: $opts); + + // @phpstan-ignore-next-line return.type + return $response->parse(); } /** @@ -100,15 +91,6 @@ public function pagingEachItem(): \Generator } } - /** - * @internal - * - * @param array $data - * - * @return static - */ - abstract public static function fromArray(array $data): static; - /** * @internal * diff --git a/src/Core/Concerns/SdkParams.php b/src/Core/Concerns/SdkParams.php index 1010389..c93a9b2 100644 --- a/src/Core/Concerns/SdkParams.php +++ b/src/Core/Concerns/SdkParams.php @@ -15,23 +15,24 @@ trait SdkParams { /** - * @param array|self|null $params * @param array|RequestOptions|null $options * * @return array{array, RequestOptions} */ - public static function parseRequest(array|self|null $params, array|RequestOptions|null $options): array + public static function parseRequest(mixed $params, array|RequestOptions|null $options): array { $value = is_array($params) ? Util::array_filter_omit($params) : $params; $converter = self::converter(); $state = new DumpState; $dumped = (array) Conversion::dump($converter, value: $value, state: $state); - $opts = RequestOptions::parse($options); // @phpstan-ignore-line + // @phpstan-ignore-next-line argument.type + $opts = RequestOptions::parse($options); if (!$state->canRetry) { $opts->maxRetries = 0; } - return [$dumped, $opts]; // @phpstan-ignore-line + // @phpstan-ignore-next-line return.type + return [$dumped, $opts]; } } diff --git a/src/Core/Concerns/SdkUnion.php b/src/Core/Concerns/SdkUnion.php index 6a073f8..b94173f 100644 --- a/src/Core/Concerns/SdkUnion.php +++ b/src/Core/Concerns/SdkUnion.php @@ -15,7 +15,7 @@ trait SdkUnion { private static Converter $converter; - public static function discriminator(): ?string // @phpstan-ignore-line + public static function discriminator(): ?string { return null; } @@ -34,7 +34,6 @@ public static function converter(): Converter return static::$converter; } - // @phpstan-ignore-next-line return static::$converter = new UnionOf(discriminator: static::discriminator(), variants: static::variants()); } } diff --git a/src/Core/Contracts/BaseModel.php b/src/Core/Contracts/BaseModel.php index a6b38d2..1938411 100644 --- a/src/Core/Contracts/BaseModel.php +++ b/src/Core/Contracts/BaseModel.php @@ -14,5 +14,5 @@ interface BaseModel extends \ArrayAccess, \JsonSerializable, \Stringable, ConverterSource { /** @return array */ - public function toArray(): array; + public function toProperties(): array; } diff --git a/src/Core/Contracts/BasePage.php b/src/Core/Contracts/BasePage.php index 40eecd6..532e867 100644 --- a/src/Core/Contracts/BasePage.php +++ b/src/Core/Contracts/BasePage.php @@ -4,11 +4,6 @@ namespace CasParser\Core\Contracts; -use CasParser\Client; -use CasParser\Core\Conversion\Contracts\Converter; -use CasParser\Core\Conversion\Contracts\ConverterSource; -use CasParser\RequestOptions; - /** * @internal * @@ -20,19 +15,6 @@ */ interface BasePage extends \IteratorAggregate { - /** - * @internal - * - * @param normalized_request $request - */ - public function __construct( - Converter|ConverterSource|string $convert, - Client $client, - array $request, - RequestOptions $options, - mixed $data, - ); - public function hasNextPage(): bool; /** diff --git a/src/Core/Contracts/BaseResponse.php b/src/Core/Contracts/BaseResponse.php new file mode 100644 index 0000000..bd3f07b --- /dev/null +++ b/src/Core/Contracts/BaseResponse.php @@ -0,0 +1,21 @@ + $stream - */ public function __construct( Converter|ConverterSource|string $convert, RequestInterface $request, ResponseInterface $response, - \Generator $stream, + mixed $parsedBody, ); /** diff --git a/src/Core/Conversion.php b/src/Core/Conversion.php index e8c605e..bf56efa 100644 --- a/src/Core/Conversion.php +++ b/src/Core/Conversion.php @@ -9,6 +9,9 @@ use CasParser\Core\Conversion\Contracts\ConverterSource; use CasParser\Core\Conversion\DumpState; +/** + * @internal + */ final class Conversion { public static function dump_unknown(mixed $value, DumpState $state): mixed @@ -22,8 +25,12 @@ public static function dump_unknown(mixed $value, DumpState $state): mixed return $value::converter()->dump($value, state: $state); } + if (is_a($value, class: \BackedEnum::class)) { + return $value->value; + } + if (is_a($value, class: \DateTimeInterface::class)) { - return $value->format(format: \DateTimeInterface::RFC3339); + return date_format($value, format: \DateTimeInterface::RFC3339); } if (is_a($value, class: \JsonSerializable::class)) { @@ -54,6 +61,26 @@ public static function coerce(Converter|ConverterSource|string $target, mixed $v return $target->coerce($value, state: $state); } + return self::tryConvert($target, value: $value, state: $state); + } + + public static function dump(Converter|ConverterSource|string $target, mixed $value, DumpState $state = new DumpState): mixed + { + if ($target instanceof Converter) { + return $target->dump($value, state: $state); + } + + if (is_a($target, class: ConverterSource::class, allow_string: true)) { + return $target::converter()->dump($value, state: $state); + } + + self::tryConvert($target, value: $value, state: $state); + + return self::dump_unknown($value, state: $state); + } + + private static function tryConvert(Converter|ConverterSource|string $target, mixed $value, CoerceState|DumpState $state): mixed + { switch ($target) { case 'mixed': ++$state->yes; @@ -149,17 +176,4 @@ public static function coerce(Converter|ConverterSource|string $target, mixed $v return $value; } } - - public static function dump(Converter|ConverterSource|string $target, mixed $value, DumpState $state = new DumpState): mixed - { - if ($target instanceof Converter) { - return $target->dump($value, state: $state); - } - - if (is_a($target, class: ConverterSource::class, allow_string: true)) { - return $target::converter()->dump($value, state: $state); - } - - return self::dump_unknown($value, state: $state); - } } diff --git a/src/Core/Conversion/Concerns/ArrayOf.php b/src/Core/Conversion/Concerns/ArrayOf.php index e711b11..9321b52 100644 --- a/src/Core/Conversion/Concerns/ArrayOf.php +++ b/src/Core/Conversion/Concerns/ArrayOf.php @@ -32,10 +32,11 @@ public function coerce(mixed $value, CoerceState $state): mixed if (!is_array($value)) { return $value; } + ++$state->yes; $acc = []; foreach ($value as $k => $v) { - if ($this->nullable && null === $v) { + if ($this->nullable && is_null($v)) { ++$state->yes; $acc[$k] = null; } else { @@ -51,15 +52,27 @@ public function dump(mixed $value, DumpState $state): mixed if (!is_array($value)) { return Conversion::dump_unknown($value, state: $state); } + ++$state->yes; if (empty($value)) { return $this->empty(); } - return array_map(fn ($v) => Conversion::dump($this->type, value: $v, state: $state), array: $value); + $acc = []; + foreach ($value as $k => $v) { + if ($this->nullable && is_null($v)) { + ++$state->yes; + $acc[$k] = null; + } else { + $acc[$k] = Conversion::dump($this->type, value: $v, state: $state); + } + } + + return $acc; } - private function empty(): array|object // @phpstan-ignore-line + // @phpstan-ignore-next-line missingType.iterableValue + private function empty(): array|object { return (object) []; } diff --git a/src/Core/Conversion/DumpState.php b/src/Core/Conversion/DumpState.php index fbc8c1d..86435ab 100644 --- a/src/Core/Conversion/DumpState.php +++ b/src/Core/Conversion/DumpState.php @@ -10,6 +10,11 @@ final class DumpState { public function __construct( + public bool $translateNames = true, + public int $yes = 0, + public int $no = 0, + public int $maybe = 0, + public int $branched = 0, public bool $canRetry = true ) {} } diff --git a/src/Core/Conversion/EnumOf.php b/src/Core/Conversion/EnumOf.php index aaed8da..c1ae0aa 100644 --- a/src/Core/Conversion/EnumOf.php +++ b/src/Core/Conversion/EnumOf.php @@ -28,19 +28,26 @@ public function __construct(private readonly array $members) public function coerce(mixed $value, CoerceState $state): mixed { - if (in_array($value, haystack: $this->members, strict: true)) { - ++$state->yes; - } elseif ($this->type === gettype($value)) { - ++$state->maybe; - } else { - ++$state->no; - } + $this->tally($value, state: $state); return $value; } public function dump(mixed $value, DumpState $state): mixed { + $this->tally($value, state: $state); + return Conversion::dump_unknown($value, state: $state); } + + private function tally(mixed $value, CoerceState|DumpState $state): void + { + if (in_array($value, haystack: $this->members, strict: true)) { + ++$state->yes; + } elseif ($this->type === gettype($value)) { + ++$state->maybe; + } else { + ++$state->no; + } + } } diff --git a/src/Core/Conversion/ListOf.php b/src/Core/Conversion/ListOf.php index 8af6837..229d124 100644 --- a/src/Core/Conversion/ListOf.php +++ b/src/Core/Conversion/ListOf.php @@ -14,7 +14,8 @@ final class ListOf implements Converter { use ArrayOf; - private function empty(): array|object // @phpstan-ignore-line + // @phpstan-ignore-next-line missingType.iterableValue + private function empty(): array|object { return []; } diff --git a/src/Core/Conversion/ModelOf.php b/src/Core/Conversion/ModelOf.php index 0dbf406..36669be 100644 --- a/src/Core/Conversion/ModelOf.php +++ b/src/Core/Conversion/ModelOf.php @@ -4,7 +4,8 @@ namespace CasParser\Core\Conversion; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; +use CasParser\Core\Attributes\Required; use CasParser\Core\Contracts\BaseModel; use CasParser\Core\Conversion; use CasParser\Core\Conversion\Contracts\Converter; @@ -27,7 +28,9 @@ public function __construct(public readonly \ReflectionClass $class) $properties = []; foreach ($this->class->getProperties() as $property) { - if (!empty($property->getAttributes(Api::class))) { + $attributes = [...$property->getAttributes(Required::class), ...$property->getAttributes(Optional::class)]; + + if (!empty($attributes)) { $name = $property->getName(); $properties[$name] = new PropertyInfo($property); } @@ -88,31 +91,23 @@ public function coerce(mixed $value, CoerceState $state): mixed $acc[$name] = $item; } - return $this->from($acc); // @phpstan-ignore-line - } - - /** - * @param array $data - */ - public function from(array $data): BaseModel - { - $instance = $this->class->newInstanceWithoutConstructor(); - $instance->__unserialize($data); // @phpstan-ignore-line - - return $instance; + // @phpstan-ignore-next-line return.type + return $this->from($acc); } public function dump(mixed $value, DumpState $state): mixed { if ($value instanceof BaseModel) { - $value = $value->toArray(); + $value = $value->toProperties(); } if (is_array($value)) { + ++$state->yes; $acc = []; foreach ($value as $name => $item) { if (array_key_exists($name, array: $this->properties)) { + ++$state->yes; $info = $this->properties[$name]; $acc[$info->apiName] = Conversion::dump($info->type, value: $item, state: $state); } else { @@ -120,9 +115,23 @@ public function dump(mixed $value, DumpState $state): mixed } } - return empty($acc) ? ((object) []) : $acc; + return empty($acc) ? ((object) $acc) : $acc; } + ++$state->no; + return Conversion::dump_unknown($value, state: $state); } + + /** + * @param array $data + */ + public function from(array $data): BaseModel + { + $instance = $this->class->newInstanceWithoutConstructor(); + // @phpstan-ignore-next-line + $instance->__unserialize($data); + + return $instance; + } } diff --git a/src/Core/Conversion/PropertyInfo.php b/src/Core/Conversion/PropertyInfo.php index 385627b..aea255b 100644 --- a/src/Core/Conversion/PropertyInfo.php +++ b/src/Core/Conversion/PropertyInfo.php @@ -4,7 +4,8 @@ namespace CasParser\Core\Conversion; -use CasParser\Core\Attributes\Api; +use CasParser\Core\Attributes\Optional; +use CasParser\Core\Attributes\Required; use CasParser\Core\Conversion\Contracts\Converter; use CasParser\Core\Conversion\Contracts\ConverterSource; @@ -28,9 +29,10 @@ public function __construct(public readonly \ReflectionProperty $property) $apiName = $property->getName(); $type = $property->getType(); $optional = false; + $attributes = [...$property->getAttributes(Required::class), ...$property->getAttributes(Optional::class)]; - foreach ($property->getAttributes(Api::class) as $attr) { - /** @var Api $attribute */ + foreach ($attributes as $attr) { + /** @var Required $attribute */ $attribute = $attr->newInstance(); $apiName = $attribute->apiName ?? $apiName; @@ -55,11 +57,12 @@ private static function parse(array|Converter|ConverterSource|\ReflectionType|st } if (is_array($type)) { - return new UnionOf($type); // @phpstan-ignore-line + // @phpstan-ignore-next-line return.type + return new UnionOf($type); } if ($type instanceof \ReflectionUnionType) { - // @phpstan-ignore-next-line + // @phpstan-ignore-next-line argument.type return new UnionOf(array_map(static fn ($t) => self::parse($t), array: $type->getTypes())); } diff --git a/src/Core/Conversion/UnionOf.php b/src/Core/Conversion/UnionOf.php index 0145ca1..d8852d4 100644 --- a/src/Core/Conversion/UnionOf.php +++ b/src/Core/Conversion/UnionOf.php @@ -65,17 +65,46 @@ public function coerce(mixed $value, CoerceState $state): mixed public function dump(mixed $value, DumpState $state): mixed { - if (null !== ($target = $this->resolveVariant(value: $value))) { + if (!is_null($target = $this->resolveVariant(value: $value))) { return Conversion::dump($target, value: $value, state: $state); } - foreach ($this->variants as $variant) { + $alternatives = []; + foreach ($this->variants as $_ => $variant) { + ++$state->branched; if ($value instanceof $variant) { return Conversion::dump($variant, value: $value, state: $state); } + + $newState = new DumpState; + $dumped = Conversion::dump($variant, value: $value, state: $newState); + if (($newState->no + $newState->maybe) === 0) { + $state->yes += $newState->yes; + + return $dumped; + } + if ($newState->maybe > 0) { + $alternatives[] = [[-$newState->yes, -$newState->maybe, $newState->no], $newState, $dumped]; + } } - return Conversion::dump_unknown($value, state: $state); + usort( + $alternatives, + static fn (array $a, array $b): int => $a[0][0] <=> $b[0][0] ?: $a[0][1] <=> $b[0][1] ?: $a[0][2] <=> $b[0][2] + ); + + if (empty($alternatives)) { + ++$state->no; + + return Conversion::dump_unknown($value, state: $state); + } + + [[,$newState, $best]] = $alternatives; + $state->yes += $newState->yes; + $state->maybe += $newState->maybe; + $state->no += $newState->no; + + return $best; } private function resolveVariant( diff --git a/src/Core/Exceptions/APITimeoutException.php b/src/Core/Exceptions/APITimeoutException.php index 5e9e4d3..999d529 100644 --- a/src/Core/Exceptions/APITimeoutException.php +++ b/src/Core/Exceptions/APITimeoutException.php @@ -10,7 +10,7 @@ class APITimeoutException extends APIConnectionException protected const DESC = 'CasParser API Timeout Exception'; public function __construct( - public RequestInterface $request, + RequestInterface $request, ?\Throwable $previous = null, string $message = 'Request timed out.', ) { diff --git a/src/Core/Implementation/HasRawResponse.php b/src/Core/Implementation/HasRawResponse.php deleted file mode 100644 index d3ffd67..0000000 --- a/src/Core/Implementation/HasRawResponse.php +++ /dev/null @@ -1,10 +0,0 @@ - + * + * @phpstan-import-type normalized_request from \CasParser\Core\BaseClient + */ +class RawResponse implements BaseResponse +{ + use ResponseProxy; + + private mixed $decodedBody; + + /** @var R */ + private mixed $coercedResponse; + + private bool $decoded = false; + private bool $coerced = false; + + /** + * @param normalized_request $requestInfo + * @param list|string|int|null $unwrap + */ + public function __construct( + private BaseClient $client, + private RequestOptions $options, + private RequestInterface $request, + private ResponseInterface $response, + private array $requestInfo, + private array|string|int|null $unwrap, + private Converter|ConverterSource|string $convert, + private ?string $page, + private ?string $stream, + ) {} + + public function getRequest(): RequestInterface + { + return $this->request; + } + + public function parse(): mixed + { + if (!$this->coerced) { + if (!is_null($this->stream)) { + // @phpstan-ignore-next-line assign.propertyType + $this->coercedResponse = new $this->stream( + convert: $this->convert, + request: $this->request, + response: $this->response, + parsedBody: $this->getDecoded(), + ); + } elseif (!is_null($this->page)) { + // @phpstan-ignore-next-line assign.propertyType + $this->coercedResponse = new $this->page( + convert: $this->convert, + client: $this->client, + requestInfo: $this->requestInfo, + options: $this->options, + response: $this->response, + parsedBody: $this->getDecoded(), + ); + } else { + // @phpstan-ignore-next-line assign.propertyType + $this->coercedResponse = Conversion::coerce( + $this->convert, + value: $this->getDecoded(), + ); + } + + $this->coerced = true; + } + + return $this->coercedResponse; + } + + private function getDecoded(): mixed + { + if (!$this->decoded) { + $decoded = Util::decodeContent($this->response); + if (!is_null($this->unwrap)) { + $decoded = Util::dig($decoded, key: $this->unwrap); + } + $this->decodedBody = $decoded; + $this->decoded = true; + } + + return $this->decodedBody; + } +} diff --git a/src/Core/Util.php b/src/Core/Util.php index 8ff5dd1..6a98bfa 100644 --- a/src/Core/Util.php +++ b/src/Core/Util.php @@ -26,20 +26,46 @@ final class Util public const JSONL_CONTENT_TYPE = '/^application\/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)/'; /** - * @return array + * @return array */ - public static function get_object_vars(object $object1): array + public static function get_object_vars(object $object): array { - return get_object_vars($object1); + return get_object_vars($object); + } + + public static function machtype(): string + { + $arch = php_uname('m'); + + return match (true) { + str_contains($arch, 'aarch64'), str_contains($arch, 'arm64') => 'arm64', + str_contains($arch, 'x86_64'), str_contains($arch, 'amd64') => 'x64', + str_contains($arch, 'i386'), str_contains($arch, 'i686') => 'x32', + str_contains($arch, 'arm') => 'arm', + default => 'unknown', + }; + } + + public static function ostype(): string + { + return match ($os = strtolower(PHP_OS_FAMILY)) { + 'linux' => 'Linux', + 'darwin' => 'MacOS', + 'windows' => 'Windows', + 'solaris' => 'Solaris', + // @phpstan-ignore-next-line match.alwaysFalse + 'bsd', 'freebsd', 'openbsd' => 'BSD', + default => "Other:{$os}", + }; } /** * @template T * - * @param array $array - * @param array $map + * @param array $array + * @param array $map * - * @return array + * @return array */ public static function array_transform_keys(array $array, array $map): array { @@ -52,15 +78,52 @@ public static function array_transform_keys(array $array, array $map): array } /** - * @param array $arr + * @param array $arr * - * @return array + * @return array */ public static function array_filter_omit(array $arr): array { return array_filter($arr, fn ($v, $_) => OMIT !== $v, mode: ARRAY_FILTER_USE_BOTH); } + public static function strVal(mixed $value): string + { + if (is_bool($value)) { + return $value ? 'true' : 'false'; + } + + if (is_object($value) && is_a($value, class: \DateTimeInterface::class)) { + return date_format($value, format: \DateTimeInterface::RFC3339); + } + + // @phpstan-ignore-next-line argument.type + return strval($value); + } + + /** + * @param callable $callback + */ + public static function mapRecursive(mixed $callback, mixed $value): mixed + { + $mapped = match (true) { + is_array($value) => array_map(static fn ($v) => self::mapRecursive($callback, value: $v), $value), + default => $value, + }; + + return $callback($mapped); + } + + public static function removeNulls(mixed $value): mixed + { + $mapped = self::mapRecursive( + static fn ($vs) => is_array($vs) && !array_is_list($vs) ? array_filter($vs, callback: static fn ($v) => !is_null($v)) : $vs, + value: $value + ); + + return $mapped; + } + /** * @param string|int|list|callable $key */ @@ -101,12 +164,13 @@ public static function parsePath(string|array $path): string } [$template] = $path; + $mapped = array_map(static fn ($s) => rawurlencode(self::strVal($s)), array: array_slice($path, 1)); - return sprintf($template, ...array_map('rawurlencode', array: array_slice($path, 1))); + return sprintf($template, ...$mapped); } /** - * @param array $query + * @param array $query */ public static function joinUri( UriInterface $base, @@ -134,14 +198,20 @@ public static function joinUri( parse_str($base->getQuery(), $q1); parse_str($parsed['query'] ?? '', $q2); - $merged_query = array_merge_recursive($q1, $q2, $query); - $qs = http_build_query($merged_query, encoding_type: PHP_QUERY_RFC3986); + $mergedQuery = array_merge_recursive($q1, $q2, $query); + + /** @var array */ + $normalizedQuery = self::mapRecursive( + static fn ($v) => is_bool($v) || is_numeric($v) ? self::strVal($v) : $v, + value: $mergedQuery + ); + $qs = http_build_query($normalizedQuery, encoding_type: PHP_QUERY_RFC3986); return $base->withQuery($qs); } /** - * @param array|null> $headers + * @param array|null> $headers */ public static function withSetHeaders( RequestInterface $req, @@ -149,13 +219,12 @@ public static function withSetHeaders( ): RequestInterface { foreach ($headers as $name => $value) { if (is_null($value)) { + /** @var RequestInterface */ $req = $req->withoutHeader($name); } else { - $value = is_int($value) - ? (string) $value - : (is_array($value) - ? array_map(static fn ($v) => (string) $v, array: $value) - : $value); + $value = is_array($value) ? array_map(static fn ($v) => self::strVal($v), array: $value) : self::strVal($value); + + /** @var RequestInterface */ $req = $req->withHeader($name, $value); } } @@ -182,8 +251,7 @@ public static function streamIterator(StreamInterface $stream): \Iterator } /** - * @param bool|int|float|string|resource|\Traversable|array|null $body + * @param bool|int|float|string|resource|\Traversable|array|null $body */ public static function withSetBody( StreamFactoryInterface $factory, @@ -191,6 +259,7 @@ public static function withSetBody( mixed $body ): RequestInterface { if ($body instanceof StreamInterface) { + /** @var RequestInterface */ return $req->withBody($body); } @@ -200,6 +269,7 @@ public static function withSetBody( $encoded = json_encode($body, flags: self::JSON_ENCODE_FLAGS); $stream = $factory->createStream($encoded); + /** @var RequestInterface */ return $req->withBody($stream); } } @@ -209,12 +279,21 @@ public static function withSetBody( $encoded = implode('', iterator_to_array($gen)); $stream = $factory->createStream($encoded); + /** @var RequestInterface */ return $req->withHeader('Content-Type', "{$contentType}; boundary={$boundary}")->withBody($stream); } if (is_resource($body)) { $stream = $factory->createStreamFromResource($body); + /** @var RequestInterface */ + return $req->withBody($stream); + } + + if (is_string($body)) { + $stream = $factory->createStream($body); + + // @var RequestInterface return $req->withBody($stream); } @@ -371,7 +450,7 @@ private static function writeMultipartContent( } elseif (is_string($val) || is_numeric($val) || is_bool($val)) { yield sprintf($contentLine, $contentType ?? 'text/plain'); - yield (string) $val; + yield self::strVal($val); } else { yield sprintf($contentLine, $contentType ?? 'application/json'); @@ -397,7 +476,7 @@ private static function writeMultipartChunk( yield 'Content-Disposition: form-data'; if (!is_null($key)) { - $name = rawurlencode($key); + $name = rawurlencode(self::strVal($key)); yield "; name=\"{$name}\""; } @@ -409,8 +488,7 @@ private static function writeMultipartChunk( } /** - * @param bool|int|float|string|resource|\Traversable|array|null $body + * @param bool|int|float|string|resource|\Traversable|array|null $body * * @return array{string, \Generator} */ diff --git a/src/RequestOptions.php b/src/RequestOptions.php index 03ece1a..77d79bf 100644 --- a/src/RequestOptions.php +++ b/src/RequestOptions.php @@ -4,7 +4,8 @@ namespace CasParser; -use CasParser\Core\Attributes\Api as Property; +use CasParser\Core\Attributes\Optional; +use CasParser\Core\Attributes\Required as Property; use CasParser\Core\Concerns\SdkModel; use CasParser\Core\Contracts\BaseModel; use CasParser\Core\Implementation\Omit; @@ -21,8 +22,8 @@ * maxRetries?: int|null, * initialRetryDelay?: float|null, * maxRetryDelay?: float|null, - * extraHeaders?: array>|null, - * extraQueryParams?: array|null, + * extraHeaders?: array>|null, + * extraQueryParams?: array|null, * extraBodyParams?: mixed, * transporter?: ClientInterface|null, * uriFactory?: UriFactoryInterface|null, @@ -48,27 +49,27 @@ final class RequestOptions implements BaseModel #[Property] public float $maxRetryDelay = 8.0; - /** @var array|null>|null $extraHeaders */ - #[Property(optional: true)] + /** @var array|null>|null $extraHeaders */ + #[Optional] public ?array $extraHeaders; - /** @var array|null $extraQueryParams */ - #[Property(optional: true)] + /** @var array|null $extraQueryParams */ + #[Optional] public ?array $extraQueryParams; - #[Property(optional: true)] + #[Optional] public mixed $extraBodyParams; - #[Property(optional: true)] + #[Optional] public ?ClientInterface $transporter; - #[Property(optional: true)] + #[Optional] public ?UriFactoryInterface $uriFactory; - #[Property(optional: true)] + #[Optional] public ?StreamFactoryInterface $streamFactory; - #[Property(optional: true)] + #[Optional] public ?RequestFactoryInterface $requestFactory; public function __construct() @@ -81,14 +82,15 @@ 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 + // @phpstan-ignore-next-line argument.type + return self::with(...array_merge(...$parsed)); } /** - * @param array|null>|null $extraHeaders - * @param array|null $extraQueryParams + * @param array|null>|null $extraHeaders + * @param array|null $extraQueryParams * @param mixed|Omit $extraBodyParams */ public static function with( @@ -104,116 +106,118 @@ public static function with( ?StreamFactoryInterface $streamFactory = null, ?RequestFactoryInterface $requestFactory = null, ): self { - $obj = new self; - - null !== $timeout && $obj->timeout = $timeout; - null !== $maxRetries && $obj->maxRetries = $maxRetries; - null !== $initialRetryDelay && $obj->initialRetryDelay = $initialRetryDelay; - null !== $maxRetryDelay && $obj->maxRetryDelay = $maxRetryDelay; - null !== $extraHeaders && $obj->extraHeaders = $extraHeaders; - null !== $extraQueryParams && $obj->extraQueryParams = $extraQueryParams; - omit !== $extraBodyParams && $obj->extraBodyParams = $extraBodyParams; - null !== $transporter && $obj->transporter = $transporter; - null !== $uriFactory && $obj->uriFactory = $uriFactory; - null !== $streamFactory && $obj->streamFactory = $streamFactory; - null !== $requestFactory && $obj->requestFactory = $requestFactory; - - return $obj; + $self = new self; + + null !== $timeout && $self->timeout = $timeout; + null !== $maxRetries && $self->maxRetries = $maxRetries; + null !== $initialRetryDelay && $self + ->initialRetryDelay = $initialRetryDelay + ; + null !== $maxRetryDelay && $self->maxRetryDelay = $maxRetryDelay; + null !== $extraHeaders && $self->extraHeaders = $extraHeaders; + null !== $extraQueryParams && $self->extraQueryParams = $extraQueryParams; + omit !== $extraBodyParams && $self->extraBodyParams = $extraBodyParams; + null !== $transporter && $self->transporter = $transporter; + null !== $uriFactory && $self->uriFactory = $uriFactory; + null !== $streamFactory && $self->streamFactory = $streamFactory; + null !== $requestFactory && $self->requestFactory = $requestFactory; + + return $self; } public function withTimeout(float $timeout): self { - $obj = clone $this; - $obj->timeout = $timeout; + $self = clone $this; + $self->timeout = $timeout; - return $obj; + return $self; } public function withMaxRetries(int $maxRetries): self { - $obj = clone $this; - $obj->maxRetries = $maxRetries; + $self = clone $this; + $self->maxRetries = $maxRetries; - return $obj; + return $self; } public function withInitialRetryDelay(float $initialRetryDelay): self { - $obj = clone $this; - $obj->initialRetryDelay = $initialRetryDelay; + $self = clone $this; + $self->initialRetryDelay = $initialRetryDelay; - return $obj; + return $self; } public function withMaxRetryDelay(float $maxRetryDelay): self { - $obj = clone $this; - $obj->maxRetryDelay = $maxRetryDelay; + $self = clone $this; + $self->maxRetryDelay = $maxRetryDelay; - return $obj; + return $self; } /** - * @param array|null> $extraHeaders + * @param array|null> $extraHeaders */ public function withExtraHeaders(array $extraHeaders): self { - $obj = clone $this; - $obj->extraHeaders = $extraHeaders; + $self = clone $this; + $self->extraHeaders = $extraHeaders; - return $obj; + return $self; } /** - * @param array $extraQueryParams + * @param array $extraQueryParams */ public function withExtraQueryParams(array $extraQueryParams): self { - $obj = clone $this; - $obj->extraQueryParams = $extraQueryParams; + $self = clone $this; + $self->extraQueryParams = $extraQueryParams; - return $obj; + return $self; } public function withExtraBodyParams(mixed $extraBodyParams): self { - $obj = clone $this; - $obj->extraBodyParams = $extraBodyParams; + $self = clone $this; + $self->extraBodyParams = $extraBodyParams; - return $obj; + return $self; } public function withTransporter(ClientInterface $transporter): self { - $obj = clone $this; - $obj->transporter = $transporter; + $self = clone $this; + $self->transporter = $transporter; - return $obj; + return $self; } public function withUriFactory(UriFactoryInterface $uriFactory): self { - $obj = clone $this; - $obj->uriFactory = $uriFactory; + $self = clone $this; + $self->uriFactory = $uriFactory; - return $obj; + return $self; } public function withStreamFactory( StreamFactoryInterface $streamFactory ): self { - $obj = clone $this; - $obj->streamFactory = $streamFactory; + $self = clone $this; + $self->streamFactory = $streamFactory; - return $obj; + return $self; } public function withRequestFactory( RequestFactoryInterface $requestFactory ): self { - $obj = clone $this; - $obj->requestFactory = $requestFactory; + $self = clone $this; + $self->requestFactory = $requestFactory; - return $obj; + return $self; } } diff --git a/src/ServiceContracts/CasGeneratorContract.php b/src/ServiceContracts/CasGeneratorContract.php index 240aad8..6202572 100644 --- a/src/ServiceContracts/CasGeneratorContract.php +++ b/src/ServiceContracts/CasGeneratorContract.php @@ -7,11 +7,8 @@ use CasParser\CasGenerator\CasGeneratorGenerateCasParams\CasAuthority; use CasParser\CasGenerator\CasGeneratorGenerateCasResponse; use CasParser\Core\Exceptions\APIException; -use CasParser\Core\Implementation\HasRawResponse; use CasParser\RequestOptions; -use const CasParser\Core\OMIT as omit; - interface CasGeneratorContract { /** @@ -21,34 +18,18 @@ interface CasGeneratorContract * @param string $fromDate Start date for the CAS period (format YYYY-MM-DD) * @param string $password Password to protect the generated CAS PDF * @param string $toDate End date for the CAS period (format YYYY-MM-DD) - * @param CasAuthority|value-of $casAuthority CAS authority to generate the document from (currently only kfintech is supported) + * @param 'kfintech'|'cams'|'cdsl'|'nsdl'|CasAuthority $casAuthority CAS authority to generate the document from (currently only kfintech is supported) * @param string $panNo PAN number (optional for some CAS authorities) * - * @return CasGeneratorGenerateCasResponse - * * @throws APIException */ public function generateCas( - $email, - $fromDate, - $password, - $toDate, - $casAuthority = omit, - $panNo = omit, + string $email, + string $fromDate, + string $password, + string $toDate, + string|CasAuthority $casAuthority = 'kfintech', + ?string $panNo = null, ?RequestOptions $requestOptions = null, ): CasGeneratorGenerateCasResponse; - - /** - * @api - * - * @param array $params - * - * @return CasGeneratorGenerateCasResponse - * - * @throws APIException - */ - public function generateCasRaw( - array $params, - ?RequestOptions $requestOptions = null - ): CasGeneratorGenerateCasResponse; } diff --git a/src/ServiceContracts/CasGeneratorRawContract.php b/src/ServiceContracts/CasGeneratorRawContract.php new file mode 100644 index 0000000..af9fcd2 --- /dev/null +++ b/src/ServiceContracts/CasGeneratorRawContract.php @@ -0,0 +1,28 @@ +|CasGeneratorGenerateCasParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function generateCas( + array|CasGeneratorGenerateCasParams $params, + ?RequestOptions $requestOptions = null, + ): BaseResponse; +} diff --git a/src/ServiceContracts/CasParserContract.php b/src/ServiceContracts/CasParserContract.php index c21836f..5179c9c 100644 --- a/src/ServiceContracts/CasParserContract.php +++ b/src/ServiceContracts/CasParserContract.php @@ -6,11 +6,8 @@ use CasParser\CasParser\UnifiedResponse; use CasParser\Core\Exceptions\APIException; -use CasParser\Core\Implementation\HasRawResponse; use CasParser\RequestOptions; -use const CasParser\Core\OMIT as omit; - interface CasParserContract { /** @@ -20,31 +17,15 @@ interface CasParserContract * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function camsKfintech( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse; - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function camsKfintechRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse; - /** * @api * @@ -52,31 +33,15 @@ public function camsKfintechRaw( * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function cdsl( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse; - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function cdslRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse; - /** * @api * @@ -84,31 +49,15 @@ public function cdslRaw( * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function nsdl( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse; - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function nsdlRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse; - /** * @api * @@ -116,28 +65,12 @@ public function nsdlRaw( * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function smartParse( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse; - - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function smartParseRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse; } diff --git a/src/ServiceContracts/CasParserRawContract.php b/src/ServiceContracts/CasParserRawContract.php new file mode 100644 index 0000000..dfd941e --- /dev/null +++ b/src/ServiceContracts/CasParserRawContract.php @@ -0,0 +1,73 @@ +|CasParserCamsKfintechParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function camsKfintech( + array|CasParserCamsKfintechParams $params, + ?RequestOptions $requestOptions = null, + ): BaseResponse; + + /** + * @api + * + * @param array|CasParserCdslParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function cdsl( + array|CasParserCdslParams $params, + ?RequestOptions $requestOptions = null + ): BaseResponse; + + /** + * @api + * + * @param array|CasParserNsdlParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function nsdl( + array|CasParserNsdlParams $params, + ?RequestOptions $requestOptions = null + ): BaseResponse; + + /** + * @api + * + * @param array|CasParserSmartParseParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function smartParse( + array|CasParserSmartParseParams $params, + ?RequestOptions $requestOptions = null, + ): BaseResponse; +} diff --git a/src/Services/CasGeneratorRawService.php b/src/Services/CasGeneratorRawService.php new file mode 100644 index 0000000..1e59fed --- /dev/null +++ b/src/Services/CasGeneratorRawService.php @@ -0,0 +1,61 @@ + + * + * @throws APIException + */ + public function generateCas( + array|CasGeneratorGenerateCasParams $params, + ?RequestOptions $requestOptions = null, + ): BaseResponse { + [$parsed, $options] = CasGeneratorGenerateCasParams::parseRequest( + $params, + $requestOptions, + ); + + // @phpstan-ignore-next-line return.type + return $this->client->request( + method: 'post', + path: 'v4/generate', + body: (object) $parsed, + options: $options, + convert: CasGeneratorGenerateCasResponse::class, + ); + } +} diff --git a/src/Services/CasGeneratorService.php b/src/Services/CasGeneratorService.php index c7d2e8e..5d505eb 100644 --- a/src/Services/CasGeneratorService.php +++ b/src/Services/CasGeneratorService.php @@ -4,23 +4,28 @@ namespace CasParser\Services; -use CasParser\CasGenerator\CasGeneratorGenerateCasParams; use CasParser\CasGenerator\CasGeneratorGenerateCasParams\CasAuthority; use CasParser\CasGenerator\CasGeneratorGenerateCasResponse; use CasParser\Client; use CasParser\Core\Exceptions\APIException; -use CasParser\Core\Implementation\HasRawResponse; +use CasParser\Core\Util; use CasParser\RequestOptions; use CasParser\ServiceContracts\CasGeneratorContract; -use const CasParser\Core\OMIT as omit; - final class CasGeneratorService implements CasGeneratorContract { + /** + * @api + */ + public CasGeneratorRawService $raw; + /** * @internal */ - public function __construct(private Client $client) {} + public function __construct(private Client $client) + { + $this->raw = new CasGeneratorRawService($client); + } /** * @api @@ -32,59 +37,34 @@ public function __construct(private Client $client) {} * @param string $fromDate Start date for the CAS period (format YYYY-MM-DD) * @param string $password Password to protect the generated CAS PDF * @param string $toDate End date for the CAS period (format YYYY-MM-DD) - * @param CasAuthority|value-of $casAuthority CAS authority to generate the document from (currently only kfintech is supported) + * @param 'kfintech'|'cams'|'cdsl'|'nsdl'|CasAuthority $casAuthority CAS authority to generate the document from (currently only kfintech is supported) * @param string $panNo PAN number (optional for some CAS authorities) * - * @return CasGeneratorGenerateCasResponse - * * @throws APIException */ public function generateCas( - $email, - $fromDate, - $password, - $toDate, - $casAuthority = omit, - $panNo = omit, + string $email, + string $fromDate, + string $password, + string $toDate, + string|CasAuthority $casAuthority = 'kfintech', + ?string $panNo = null, ?RequestOptions $requestOptions = null, ): CasGeneratorGenerateCasResponse { - $params = [ - 'email' => $email, - 'fromDate' => $fromDate, - 'password' => $password, - 'toDate' => $toDate, - 'casAuthority' => $casAuthority, - 'panNo' => $panNo, - ]; - - return $this->generateCasRaw($params, $requestOptions); - } - - /** - * @api - * - * @param array $params - * - * @return CasGeneratorGenerateCasResponse - * - * @throws APIException - */ - public function generateCasRaw( - array $params, - ?RequestOptions $requestOptions = null - ): CasGeneratorGenerateCasResponse { - [$parsed, $options] = CasGeneratorGenerateCasParams::parseRequest( - $params, - $requestOptions + $params = Util::removeNulls( + [ + 'email' => $email, + 'fromDate' => $fromDate, + 'password' => $password, + 'toDate' => $toDate, + 'casAuthority' => $casAuthority, + 'panNo' => $panNo, + ], ); - // @phpstan-ignore-next-line; - return $this->client->request( - method: 'post', - path: 'v4/generate', - body: (object) $parsed, - options: $options, - convert: CasGeneratorGenerateCasResponse::class, - ); + // @phpstan-ignore-next-line argument.type + $response = $this->raw->generateCas(params: $params, requestOptions: $requestOptions); + + return $response->parse(); } } diff --git a/src/Services/CasParserRawService.php b/src/Services/CasParserRawService.php new file mode 100644 index 0000000..7f05f33 --- /dev/null +++ b/src/Services/CasParserRawService.php @@ -0,0 +1,157 @@ + + * + * @throws APIException + */ + public function camsKfintech( + array|CasParserCamsKfintechParams $params, + ?RequestOptions $requestOptions = null, + ): BaseResponse { + [$parsed, $options] = CasParserCamsKfintechParams::parseRequest( + $params, + $requestOptions, + ); + + // @phpstan-ignore-next-line return.type + return $this->client->request( + method: 'post', + path: 'v4/cams_kfintech/parse', + body: (object) $parsed, + options: $options, + convert: UnifiedResponse::class, + ); + } + + /** + * @api + * + * 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. + * + * @param array{ + * password?: string, pdfFile?: string, pdfURL?: string + * }|CasParserCdslParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function cdsl( + array|CasParserCdslParams $params, + ?RequestOptions $requestOptions = null + ): BaseResponse { + [$parsed, $options] = CasParserCdslParams::parseRequest( + $params, + $requestOptions, + ); + + // @phpstan-ignore-next-line return.type + return $this->client->request( + method: 'post', + path: 'v4/cdsl/parse', + body: (object) $parsed, + options: $options, + convert: UnifiedResponse::class, + ); + } + + /** + * @api + * + * 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. + * + * @param array{ + * password?: string, pdfFile?: string, pdfURL?: string + * }|CasParserNsdlParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function nsdl( + array|CasParserNsdlParams $params, + ?RequestOptions $requestOptions = null + ): BaseResponse { + [$parsed, $options] = CasParserNsdlParams::parseRequest( + $params, + $requestOptions, + ); + + // @phpstan-ignore-next-line return.type + return $this->client->request( + method: 'post', + path: 'v4/nsdl/parse', + body: (object) $parsed, + options: $options, + convert: UnifiedResponse::class, + ); + } + + /** + * @api + * + * 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. + * + * @param array{ + * password?: string, pdfFile?: string, pdfURL?: string + * }|CasParserSmartParseParams $params + * + * @return BaseResponse + * + * @throws APIException + */ + public function smartParse( + array|CasParserSmartParseParams $params, + ?RequestOptions $requestOptions = null, + ): BaseResponse { + [$parsed, $options] = CasParserSmartParseParams::parseRequest( + $params, + $requestOptions, + ); + + // @phpstan-ignore-next-line return.type + return $this->client->request( + method: 'post', + path: 'v4/smart/parse', + body: (object) $parsed, + options: $options, + convert: UnifiedResponse::class, + ); + } +} diff --git a/src/Services/CasParserService.php b/src/Services/CasParserService.php index 8c2adff..13ce1f7 100644 --- a/src/Services/CasParserService.php +++ b/src/Services/CasParserService.php @@ -4,25 +4,27 @@ namespace CasParser\Services; -use CasParser\CasParser\CasParserCamsKfintechParams; -use CasParser\CasParser\CasParserCdslParams; -use CasParser\CasParser\CasParserNsdlParams; -use CasParser\CasParser\CasParserSmartParseParams; use CasParser\CasParser\UnifiedResponse; use CasParser\Client; use CasParser\Core\Exceptions\APIException; -use CasParser\Core\Implementation\HasRawResponse; +use CasParser\Core\Util; use CasParser\RequestOptions; use CasParser\ServiceContracts\CasParserContract; -use const CasParser\Core\OMIT as omit; - final class CasParserService implements CasParserContract { + /** + * @api + */ + public CasParserRawService $raw; + /** * @internal */ - public function __construct(private Client $client) {} + public function __construct(private Client $client) + { + $this->raw = new CasParserRawService($client); + } /** * @api @@ -34,49 +36,22 @@ public function __construct(private Client $client) {} * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function camsKfintech( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse { - $params = [ - 'password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL, - ]; - - return $this->camsKfintechRaw($params, $requestOptions); - } - - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function camsKfintechRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse { - [$parsed, $options] = CasParserCamsKfintechParams::parseRequest( - $params, - $requestOptions + $params = Util::removeNulls( + ['password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL] ); - // @phpstan-ignore-next-line; - return $this->client->request( - method: 'post', - path: 'v4/cams_kfintech/parse', - body: (object) $parsed, - options: $options, - convert: UnifiedResponse::class, - ); + // @phpstan-ignore-next-line argument.type + $response = $this->raw->camsKfintech(params: $params, requestOptions: $requestOptions); + + return $response->parse(); } /** @@ -89,49 +64,22 @@ public function camsKfintechRaw( * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function cdsl( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse { - $params = [ - 'password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL, - ]; - - return $this->cdslRaw($params, $requestOptions); - } - - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function cdslRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse { - [$parsed, $options] = CasParserCdslParams::parseRequest( - $params, - $requestOptions + $params = Util::removeNulls( + ['password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL] ); - // @phpstan-ignore-next-line; - return $this->client->request( - method: 'post', - path: 'v4/cdsl/parse', - body: (object) $parsed, - options: $options, - convert: UnifiedResponse::class, - ); + // @phpstan-ignore-next-line argument.type + $response = $this->raw->cdsl(params: $params, requestOptions: $requestOptions); + + return $response->parse(); } /** @@ -144,49 +92,22 @@ public function cdslRaw( * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function nsdl( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse { - $params = [ - 'password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL, - ]; - - return $this->nsdlRaw($params, $requestOptions); - } - - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function nsdlRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse { - [$parsed, $options] = CasParserNsdlParams::parseRequest( - $params, - $requestOptions + $params = Util::removeNulls( + ['password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL] ); - // @phpstan-ignore-next-line; - return $this->client->request( - method: 'post', - path: 'v4/nsdl/parse', - body: (object) $parsed, - options: $options, - convert: UnifiedResponse::class, - ); + // @phpstan-ignore-next-line argument.type + $response = $this->raw->nsdl(params: $params, requestOptions: $requestOptions); + + return $response->parse(); } /** @@ -199,48 +120,21 @@ public function nsdlRaw( * @param string $pdfFile Base64 encoded CAS PDF file * @param string $pdfURL URL to the CAS PDF file * - * @return UnifiedResponse - * * @throws APIException */ public function smartParse( - $password = omit, - $pdfFile = omit, - $pdfURL = omit, + ?string $password = null, + ?string $pdfFile = null, + ?string $pdfURL = null, ?RequestOptions $requestOptions = null, ): UnifiedResponse { - $params = [ - 'password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL, - ]; - - return $this->smartParseRaw($params, $requestOptions); - } - - /** - * @api - * - * @param array $params - * - * @return UnifiedResponse - * - * @throws APIException - */ - public function smartParseRaw( - array $params, - ?RequestOptions $requestOptions = null - ): UnifiedResponse { - [$parsed, $options] = CasParserSmartParseParams::parseRequest( - $params, - $requestOptions + $params = Util::removeNulls( + ['password' => $password, 'pdfFile' => $pdfFile, 'pdfURL' => $pdfURL] ); - // @phpstan-ignore-next-line; - return $this->client->request( - method: 'post', - path: 'v4/smart/parse', - body: (object) $parsed, - options: $options, - convert: UnifiedResponse::class, - ); + // @phpstan-ignore-next-line argument.type + $response = $this->raw->smartParse(params: $params, requestOptions: $requestOptions); + + return $response->parse(); } } diff --git a/src/Version.php b/src/Version.php new file mode 100644 index 0000000..e05c34e --- /dev/null +++ b/src/Version.php @@ -0,0 +1,9 @@ +> */ use SdkModel; - #[Api] + #[Required] public string $name; - #[Api('age_years')] + #[Required('age_years')] public int $ageYears; /** @var list|null */ - #[Api(optional: true)] + #[Optional] public ?array $friends; - #[Api] + #[Required] public ?string $owner; /** @@ -42,7 +43,7 @@ public function __construct( $this->ageYears = $ageYears; $this->owner = $owner; - null != $friends && $this->friends = $friends; + null !== $friends && $this['friends'] = $friends; } } @@ -52,16 +53,12 @@ public function __construct( * @coversNothing */ #[CoversNothing] -class TestModelTest extends TestCase +class ModelTest extends TestCase { #[Test] public function testBasicGetAndSet(): void { - $model = new TestModel( - name: 'Bob', - ageYears: 12, - owner: null, - ); + $model = new Dog(name: 'Bob', ageYears: 12, owner: null); $this->assertEquals(12, $model->ageYears); ++$model->ageYears; @@ -71,11 +68,7 @@ public function testBasicGetAndSet(): void #[Test] public function testNullAccess(): void { - $model = new TestModel( - name: 'Bob', - ageYears: 12, - owner: null, - ); + $model = new Dog(name: 'Bob', ageYears: 12, owner: null); $this->assertNull($model->owner); $this->assertNull($model->friends); } @@ -83,11 +76,7 @@ public function testNullAccess(): void #[Test] public function testArrayGetAndSet(): void { - $model = new TestModel( - name: 'Bob', - ageYears: 12, - owner: null, - ); + $model = new Dog(name: 'Bob', ageYears: 12, owner: null); $model->friends ??= []; $this->assertEquals([], $model->friends); $model->friends[] = 'Alice'; @@ -97,16 +86,8 @@ public function testArrayGetAndSet(): void #[Test] public function testDiscernsBetweenNullAndUnset(): void { - $modelUnsetFriends = new TestModel( - name: 'Bob', - ageYears: 12, - owner: null, - ); - $modelNullFriends = new TestModel( - name: 'bob', - ageYears: 12, - owner: null, - ); + $modelUnsetFriends = new Dog(name: 'Bob', ageYears: 12, owner: null); + $modelNullFriends = new Dog(name: 'bob', ageYears: 12, owner: null); $modelNullFriends->friends = null; $this->assertEquals(12, $modelUnsetFriends->ageYears); @@ -125,11 +106,7 @@ public function testDiscernsBetweenNullAndUnset(): void #[Test] public function testIssetOnOmittedProperties(): void { - $model = new TestModel( - name: 'Bob', - ageYears: 12, - owner: null, - ); + $model = new Dog(name: 'Bob', ageYears: 12, owner: null); $this->assertFalse(isset($model->owner)); $this->assertFalse(isset($model->friends)); } @@ -137,12 +114,7 @@ public function testIssetOnOmittedProperties(): void #[Test] public function testSerializeBasicModel(): void { - $model = new TestModel( - name: 'Bob', - ageYears: 12, - owner: 'Eve', - friends: ['Alice', 'Charlie'], - ); + $model = new Dog(name: 'Bob', ageYears: 12, owner: 'Eve', friends: ['Alice', 'Charlie']); $this->assertEquals( '{"name":"Bob","age_years":12,"friends":["Alice","Charlie"],"owner":"Eve"}', json_encode($model) @@ -152,11 +124,7 @@ public function testSerializeBasicModel(): void #[Test] public function testSerializeModelWithOmittedProperties(): void { - $model = new TestModel( - name: 'Bob', - ageYears: 12, - owner: null, - ); + $model = new Dog(name: 'Bob', ageYears: 12, owner: null); $this->assertEquals( '{"name":"Bob","age_years":12,"owner":null}', json_encode($model) @@ -166,11 +134,7 @@ public function testSerializeModelWithOmittedProperties(): void #[Test] public function testSerializeModelWithExplicitNull(): void { - $model = new TestModel( - name: 'Bob', - ageYears: 12, - owner: null, - ); + $model = new Dog(name: 'Bob', ageYears: 12, owner: null); $model->friends = null; $this->assertEquals( '{"name":"Bob","age_years":12,"friends":null,"owner":null}', diff --git a/tests/Core/UtilTest.php b/tests/Core/UtilTest.php new file mode 100644 index 0000000..2134876 --- /dev/null +++ b/tests/Core/UtilTest.php @@ -0,0 +1,90 @@ + $v, + ], + [ + ['a' => null, 'b' => [null, null], 'c' => ['d' => null, 'e' => 0], 'f' => ['g' => null]], + ['b' => [null, null], 'c' => ['e' => 0], 'f' => []], + static fn ($vs) => is_array($vs) && !array_is_list($vs) ? array_filter($vs, callback: static fn ($v) => !is_null($v)) : $vs, + ], + [ + ['a' => null, 'b' => 2, 'c' => true, 'd' => [1, 2]], + ['a' => null, 'b' => '2', 'c' => true, 'd' => ['1', '2']], + static fn ($v) => is_bool($v) || is_numeric($v) ? Util::strVal($v) : $v, + ], + ]; + + foreach ($cases as [$input, $expected, $xform]) { + $actual = Util::mapRecursive($xform, value: $input); + $this->assertEquals($expected, $actual); + } + } + + #[Test] + public function testJoinUri(): void + { + $factory = Psr17FactoryDiscovery::findUriFactory(); + $base = $factory->createUri('http://localhost'); + $cases = [ + [ + '', + [], + 'http://localhost', + ], + [ + 'dog', + [], + 'http://localhost/dog', + ], + [ + '', + ['dog' => 'dog'], + 'http://localhost?dog=dog', + ], + [ + '', + ['dog' => ['dog']], + 'http://localhost?dog[0]=dog', + ], + [ + '', + ['dog' => [true, false]], + 'http://localhost?dog[0]=true&dog[1]=false', + ], + [ + '', + ['dog' => ['dog' => ['dog']]], + 'http://localhost?dog[dog][0]=dog', + ], + ]; + + foreach ($cases as [$path, $query, $output]) { + $expected = $factory->createUri($output); + $actual = Util::joinUri($base, path: $path, query: $query); + $this->assertEquals($expected, $actual); + } + } +} diff --git a/tests/Services/CasGeneratorTest.php b/tests/Services/CasGeneratorTest.php index ac566d8..9b82933 100644 --- a/tests/Services/CasGeneratorTest.php +++ b/tests/Services/CasGeneratorTest.php @@ -2,6 +2,7 @@ namespace Tests\Services; +use CasParser\CasGenerator\CasGeneratorGenerateCasResponse; use CasParser\Client; use PHPUnit\Framework\Attributes\CoversNothing; use PHPUnit\Framework\Attributes\Test; @@ -40,7 +41,8 @@ public function testGenerateCas(): void toDate: '2023-12-31', ); - $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType + // @phpstan-ignore-next-line method.alreadyNarrowedType + $this->assertInstanceOf(CasGeneratorGenerateCasResponse::class, $result); } #[Test] @@ -55,8 +57,11 @@ public function testGenerateCasWithOptionalParams(): void fromDate: '2023-01-01', password: 'Abcdefghi12$', toDate: '2023-12-31', + casAuthority: 'kfintech', + panNo: 'ABCDE1234F', ); - $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType + // @phpstan-ignore-next-line method.alreadyNarrowedType + $this->assertInstanceOf(CasGeneratorGenerateCasResponse::class, $result); } } diff --git a/tests/Services/CasParserTest.php b/tests/Services/CasParserTest.php index 17f3bb6..b16e886 100644 --- a/tests/Services/CasParserTest.php +++ b/tests/Services/CasParserTest.php @@ -2,6 +2,7 @@ namespace Tests\Services; +use CasParser\CasParser\UnifiedResponse; use CasParser\Client; use PHPUnit\Framework\Attributes\CoversNothing; use PHPUnit\Framework\Attributes\Test; @@ -35,7 +36,8 @@ public function testCamsKfintech(): void $result = $this->client->casParser->camsKfintech(); - $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType + // @phpstan-ignore-next-line method.alreadyNarrowedType + $this->assertInstanceOf(UnifiedResponse::class, $result); } #[Test] @@ -47,7 +49,8 @@ public function testCdsl(): void $result = $this->client->casParser->cdsl(); - $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType + // @phpstan-ignore-next-line method.alreadyNarrowedType + $this->assertInstanceOf(UnifiedResponse::class, $result); } #[Test] @@ -59,7 +62,8 @@ public function testNsdl(): void $result = $this->client->casParser->nsdl(); - $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType + // @phpstan-ignore-next-line method.alreadyNarrowedType + $this->assertInstanceOf(UnifiedResponse::class, $result); } #[Test] @@ -71,6 +75,7 @@ public function testSmartParse(): void $result = $this->client->casParser->smartParse(); - $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType + // @phpstan-ignore-next-line method.alreadyNarrowedType + $this->assertInstanceOf(UnifiedResponse::class, $result); } }