refactor(core): enhance SDK structure and documentation
Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
@@ -1,13 +1,28 @@
|
||||
<?php
|
||||
/*
|
||||
// MODULE_CONTRACT: Defines the data structure for the response of a refund request for an unidentified transaction.
|
||||
// RESPONSIBILITY: To hold and type-safely represent the outcome and status of an initiated refund operation.
|
||||
// INPUTS: Raw JSON object from the API response.
|
||||
// OUTPUTS: A structured object containing refund request status information.
|
||||
// LINKS: Requests/NominalAccounts/Identification/RefundUnidentifiedTransactionRequest.php
|
||||
*/
|
||||
|
||||
namespace Apoloz\AlfaBank\Data\NominalAccounts\Identification;
|
||||
|
||||
// <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 refund request.">
|
||||
// <BELIEF_STATE "This DTO provides a clear, type-safe contract for tracking the status of a refund request, which is a critical financial operation.">
|
||||
class RefundUnidentifiedTransactionResponseData extends Data
|
||||
{
|
||||
// <SECTION name="constructor_properties" intent="Define the properties of a refund request response.">
|
||||
// <BELIEF_STATE "The `refundId` serves as a unique identifier for the specific refund operation, and `status` indicates its current state.">
|
||||
public function __construct(
|
||||
public string $refundId,
|
||||
public string $status,
|
||||
) {}
|
||||
// </SECTION>
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user