forked from apoloz/alfa-bank-sdk
46 lines
2.3 KiB
PHP
46 lines
2.3 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/*
|
|
// 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 Apoloz\AlfaBank\Traits\SignableData;
|
|
use Spatie\LaravelData\Attributes\DataCollectionOf;
|
|
use Spatie\LaravelData\Attributes\Validation\Numeric;
|
|
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 provides a structured format for updating requisite details. It supports partial updates by making all fields except signatures optional.">
|
|
class UpdateRequisiteRequestData extends Data
|
|
{
|
|
use SignableData;
|
|
|
|
// <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 = null,
|
|
public ?string $pan = null,
|
|
public ?string $keyId = null,
|
|
public ?string $phoneNumber = null,
|
|
public ?string $bankId = null,
|
|
public ?string $accountNumber = null,
|
|
public ?string $bik = null,
|
|
public ?bool $isMain = null,
|
|
public ?bool $isActive = null,
|
|
) {}
|
|
// </SECTION>
|
|
}
|