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,11 +1,25 @@
<?php
/*
// MODULE_CONTRACT: Defines the data structure for the response of a step action request within a deal.
// RESPONSIBILITY: To hold and type-safely represent the outcome and status of an action performed on a deal step.
// INPUTS: Raw JSON object from the API response.
// OUTPUTS: A structured object containing step action status information.
// LINKS: Requests/NominalAccounts/Deals/Steps/ManageStepRequest.php
*/
namespace Apoloz\AlfaBank\Data\NominalAccounts\Deals\Steps;
// <SECTION name="module_imports" intent="Import the base Spatie Laravel Data class.">
// <BELIEF_STATE "Extending `Spatie\LaravelData\Data` enables automatic casting from JSON and provides other DTO benefits.">
use Spatie\LaravelData\Data;
// </SECTION>
// <SECTION name="class_definition" intent="Define a DTO for the response of a step action request.">
// <BELIEF_STATE "This DTO provides a clear, type-safe contract for tracking the status of actions performed on deal steps, which can be asynchronous operations.">
class StepActionResponseData extends Data
{
// <SECTION name="constructor_properties" intent="Define the properties of a step action response.">
// <BELIEF_STATE "The constructor includes key identifiers such as `dealId`, `stepId`, `stepNumber`, and `requestId`. The `status` and `description` provide details about the action's outcome. All fields are optional to accommodate various response scenarios.">
public function __construct(
public ?string $dealId = null,
public ?string $stepId = null,
@@ -14,4 +28,5 @@ class StepActionResponseData extends Data
public ?string $status = null,
public ?string $requestId = null,
) {}
// </SECTION>
}