refactor(core): enhance SDK structure and documentation

Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
2026-01-18 21:48:25 +03:00
parent 3da69c03e1
commit d214eecebe
378 changed files with 10514 additions and 496 deletions

View File

@@ -1,19 +1,33 @@
<?php
/*
// MODULE_CONTRACT: Defines the data structure for the request payload when updating an existing requisite.
// RESPONSIBILITY: To hold and validate necessary information for modifying a payment requisite.
// INPUTS: Digest signatures, and various optional requisite details (PAN, account number, phone, etc.).
// OUTPUTS: A structured, type-safe object for the `UpdateRequisiteRequest` payload.
// LINKS: Requests/NominalAccounts/Beneficiaries/Requisites/UpdateRequisiteRequest.php
*/
namespace Apoloz\AlfaBank\Data\NominalAccounts\Beneficiaries\Requisites;
// <SECTION name="module_imports" intent="Import necessary DTOs and Spatie Laravel Data components.">
// <BELIEF_STATE "This DTO requires `DigestSignatureData` as a collection for security, utilizing `DataCollectionOf` for type safety.">
use Apoloz\AlfaBank\Data\NominalAccounts\Payouts\DigestSignatureData;
use Spatie\LaravelData\Attributes\DataCollectionOf;
use Spatie\LaravelData\Data;
use Spatie\LaravelData\DataCollection;
// </SECTION>
// <SECTION name="class_definition" intent="Define a DTO for updating an existing requisite.">
// <BELIEF_STATE "This DTO ensures the request payload for updating a requisite is strictly typed and complete, supporting partial updates through nullable fields.">
class UpdateRequisiteRequestData extends Data
{
// <SECTION name="constructor_properties" intent="Define all properties for the requisite update request.">
// <BELIEF_STATE "The constructor includes mandatory `digestSignatures` for security. Optional fields allow for specific updates to `pan`, `keyId`, `phoneNumber`, `bankId`, `accountNumber`, `bik`, `isMain` status, and `isActive` status. The flexibility with nullable fields allows partial updates.">
public function __construct(
#[DataCollectionOf(DigestSignatureData::class)]
public DataCollection $digestSignatures,
public ?string $pan = null,
public ?string $keyId = null,
public ?string $keyId = null, // Specific identifier for some requisite types
public ?string $phoneNumber = null,
public ?string $bankId = null,
public ?string $accountNumber = null,
@@ -21,4 +35,5 @@ class UpdateRequisiteRequestData extends Data
public ?bool $isMain = null,
public ?bool $isActive = null,
) {}
// </SECTION>
}