Refactor README examples: adopt readonly DTOs, enhance syntax simplicity, and update namespaces

Author: lloricode

README.md

@@ -48,100 +48,97 @@ use Lloricode\Paymaya\DataTransferObjects\Checkout\MetaDataDto;
 use Lloricode\Paymaya\DataTransferObjects\Checkout\RedirectUrlDto;
 use Lloricode\Paymaya\DataTransferObjects\Checkout\TotalAmountDto;
 use Lloricode\Paymaya\Enums\Environment;
-use Lloricode\Paymaya\Requests\RetrieveCheckoutRequest;
-use Lloricode\Paymaya\Requests\SubmitCheckoutRequest;
+use Lloricode\Paymaya\Requests\Checkout\RetrieveCheckoutRequest;
+use Lloricode\Paymaya\Requests\Checkout\SubmitCheckoutRequest;
 
 Constant::$environment = Environment::sandbox;
 Constant::$secretKey = 'sk-X8qolYjy62kIzEbr0QRK1h4b4KDVHaNcwMYk39jInSl';
 Constant::$publicKey = 'pk-Z0OSzLvIcOI2UIvDhdTGVVfRSSeiGStnceqwUE7n0Ah';
 
-$checkout = (new CheckoutDto)
-    ->setTotalAmount(
-        (new TotalAmountDto)
-            ->setValue(100)
-            ->setDetails((new AmountDetailDto)->setSubtotal(100))
-    )
-    ->setBuyer(
-        (new BuyerDto)
-            ->setFirstName('John')
-            ->setMiddleName('Paul')
-            ->setLastName('Doe')
-            ->setBirthday('1995-10-24')
-            ->setCustomerSince('1995-10-24')
-            ->setGender('M')
-            ->setContact(
-                (new ContactDto)
-                    ->setPhone('+639181008888')
-                    ->setEmail('merchant@merchantsite.com')
-            )
-            ->setShippingAddress(
-                (new ShippingAddressDto)
-                    ->setFirstName('John')
-                    ->setMiddleName('Paul')
-                    ->setLastName('Doe')
-                    ->setPhone('+639181008888')
-                    ->setEmail('merchant@merchantsite.com')
-                    ->setLine1('6F Launchpad')
-                    ->setLine2('Reliance Street')
-                    ->setCity('Mandaluyong City')
-                    ->setState('Metro Manila')
-                    ->setZipCode('1552')
-                    ->setCountryCode('PH')
-                    ->setShippingType('ST')
-            )
-            ->setBillingAddress(
-                (new BillingAddressDto)
-                    ->setLine1('6F Launchpad')
-                    ->setLine2('Reliance Street')
-                    ->setCity('Mandaluyong City')
-                    ->setState('Metro Manila')
-                    ->setZipCode('1552')
-                    ->setCountryCode('PH')
-            )
-    )
-    ->addItem(
-        (new ItemDto)
-            ->setName('Canvas Slip Ons')
-            ->setQuantity(1)
-            ->setCode('CVG-096732')
-            ->setDescription('Shoes')
-            ->setAmount(
-                (new AmountDto)->setValue(100)->setDetails(
-                    (new AmountDetailDto)
-                        ->setDiscount(0)
-                        ->setServiceCharge(0)
-                        ->setShippingFee(0)
-                        ->setTax(0)
-                        ->setSubtotal(100)
+$checkout = new CheckoutDto(
+    totalAmount: new TotalAmountDto(
+        value: 100,
+        details: new AmountDetailDto(
+            subtotal: 100
+        )
+    ),
+    buyer: new BuyerDto(
+        firstName: 'John',
+        middleName: 'Paul',
+        lastName: 'Doe',
+        birthday: '1995-10-24',
+        customerSince: '1995-10-24',
+        gender: 'M',
+        contact: new ContactDto(
+            phone: '+639181008888',
+            email: 'merchant@merchantsite.com'
+        ),
+        shippingAddress: new ShippingAddressDto(
+            firstName: 'John',
+            middleName: 'Paul',
+            lastName: 'Doe',
+            phone: '+639181008888',
+            email: 'merchant@merchantsite.com',
+            line1: '6F Launchpad',
+            line2: 'Reliance Street',
+            city: 'Mandaluyong City',
+            state: 'Metro Manila',
+            zipCode: '1552',
+            countryCode: 'PH',
+            shippingType: 'ST'
+        ),
+        billingAddress: new BillingAddressDto(
+            line1: '6F Launchpad',
+            line2: 'Reliance Street',
+            city: 'Mandaluyong City',
+            state: 'Metro Manila',
+            zipCode: '1552',
+            countryCode: 'PH'
+        )
+    ),
+    items: [
+        new ItemDto(
+            name: 'Canvas Slip Ons',
+            quantity: 1,
+            code: 'CVG-096732',
+            description: 'Shoes',
+            amount: new AmountDto(
+                value: 100,
+                details: new AmountDetailDto(
+                    discount: 0,
+                    serviceCharge: 0,
+                    shippingFee: 0,
+                    tax: 0,
+                    subtotal: 100
                 )
-            )
-            ->setTotalAmount(
-                (new AmountDto)->setValue(100)->setDetails(
-                    (new AmountDetailDto)
-                        ->setDiscount(0)
-                        ->setServiceCharge(0)
-                        ->setShippingFee(0)
-                        ->setTax(0)
-                        ->setSubtotal(100)
+            ),
+            totalAmount: new AmountDto(
+                value: 100,
+                details: new AmountDetailDto(
+                    discount: 0,
+                    serviceCharge: 0,
+                    shippingFee: 0,
+                    tax: 0,
+                    subtotal: 100
                 )
             )
+        ),
+    ],
+    redirectUrl: new RedirectUrlDto(
+        success: 'https://www.merchantsite.com/success',
+        failure: 'https://www.merchantsite.com/failure',
+        cancel: 'https://www.merchantsite.com/cancel'
+    ),
+    requestReferenceNumber: '1551191039',
+    metadata: new MetaDataDto(
+        smi: 'smi',
+        smn: 'smn',
+        mci: 'mci',
+        mpc: 'mpc',
+        mco: 'mco',
+        mst: 'mst'
     )
-    ->setRedirectUrl(
-        (new RedirectUrlDto)
-            ->setSuccess('https://www.merchantsite.com/success')
-            ->setFailure('https://www.merchantsite.com/failure')
-            ->setCancel('https://www.merchantsite.com/cancel')
-    )
-    ->setRequestReferenceNumber('1551191039')
-    ->setMetadata(
-        (new MetaDataDto)
-            ->setSMI('smi')
-            ->setSMN('smn')
-            ->setMCI('mci')
-            ->setMPC('mpc')
-            ->setMCO('mco')
-            ->setMST('mst')
-    );
+);
 
 // submit
 $checkoutResponse = (new SubmitCheckoutRequest($checkout))->send()->dto();
@@ -169,14 +166,15 @@ Constant::$environment = Environment::sandbox;
 Constant::$secretKey = 'sk-X8qolYjy62kIzEbr0QRK1h4b4KDVHaNcwMYk39jInSl';
 Constant::$publicKey = 'pk-Z0OSzLvIcOI2UIvDhdTGVVfRSSeiGStnceqwUE7n0Ah';
 
-// register
+// register (readonly DTO via constructor)
 (new RegisterCustomizationRequest(
-    (new CustomizationDto)
-        ->setLogoUrl('https://image-logo.png')
-        ->setIconUrl('https://image-icon.png')
-        ->setAppleTouchIconUrl('https://image-apple.png')
-        ->setCustomTitle('Test Title Mock')
-        ->setColorScheme('#e01c44')
+    new CustomizationDto(
+        logoUrl: 'https://image-logo.png',
+        iconUrl: 'https://image-icon.png',
+        appleTouchIconUrl: 'https://image-apple.png',
+        customTitle: 'Test Title Mock',
+        colorScheme: '#e01c44',
+    )
 ))
     ->send()
     ->dto();
@@ -215,31 +213,37 @@ foreach ($webhooks as $webhook) {
     (new DeleteWebhookRequest($webhook->id))->send();
 }
 
-// register
+// register (readonly DTOs via constructors)
 (new RegisterWebhookRequest(
-    (new WebhookDto)
-        ->setName(Webhook::CHECKOUT_SUCCESS)
-        ->setCallbackUrl('https://web.test/test/success')
+    new WebhookDto(
+        name: Webhook::CHECKOUT_SUCCESS,
+        callbackUrl: 'https://web.test/test/success'
+    )
 ))->send();
 
 (new RegisterWebhookRequest(
-    (new WebhookDto)
-        ->setName(Webhook::CHECKOUT_FAILURE)
-        ->setCallbackUrl('https://web.test/test/failure')
+    new WebhookDto(
+        name: Webhook::CHECKOUT_FAILURE,
+        callbackUrl: 'https://web.test/test/failure'
+    )
 ))->send();
 
 (new RegisterWebhookRequest(
-    (new WebhookDto)
-        ->setName(Webhook::CHECKOUT_DROPOUT)
-        ->setCallbackUrl('https://web.test/test/drop')
+    new WebhookDto(
+        name: Webhook::CHECKOUT_DROPOUT,
+        callbackUrl: 'https://web.test/test/drop'
+    )
 ))->send();
 
-// update
-$webhooks = (new UpdateWebhookRequest(
-    $webhooks[Webhook::CHECKOUT_SUCCESS]->setCallbackUrl(
-        'https://web.test/test/update-success'
-    )
-))
+// update (create a new readonly DTO with the existing id and new callback URL)
+$existing = $webhooks[Webhook::CHECKOUT_SUCCESS];
+$updatedDto = new WebhookDto(
+    id: $existing->id,
+    name: $existing->name,
+    callbackUrl: 'https://web.test/test/update-success'
+);
+
+$webhooks = (new UpdateWebhookRequest($updatedDto))
     ->send()
     ->dto();