Fix address schemas

jasara · Aug 9, 2024 · 22789b8 · 22789b8
1 parent 2977586
commit 22789b8
Show file tree

Hide file tree

Showing 14 changed files with 106 additions and 25 deletions.
diff --git a/src/Data/Requests/FulfillmentOutbound/CreateFulfillmentOrderRequest.php b/src/Data/Requests/FulfillmentOutbound/CreateFulfillmentOrderRequest.php
@@ -6,11 +6,11 @@
 use Jasara\AmznSPA\Data\Base\Casts\CarbonFromStringCaster;
 use Jasara\AmznSPA\Data\Base\Validators\StringEnumValidator;
 use Jasara\AmznSPA\Data\Requests\BaseRequest;
-use Jasara\AmznSPA\Data\Schemas\AddressSchema;
 use Jasara\AmznSPA\Data\Schemas\FulfillmentOutbound\CODSettingsSchema;
 use Jasara\AmznSPA\Data\Schemas\FulfillmentOutbound\CreateFulfillmentOrderItemListSchema;
 use Jasara\AmznSPA\Data\Schemas\FulfillmentOutbound\DeliveryWindowSchema;
 use Jasara\AmznSPA\Data\Schemas\FulfillmentOutbound\FeatureSettingListSchema;
+use Jasara\AmznSPA\Data\Schemas\FulfillmentOutbound\FulfillmentOutboundAddressSchema;
 
 class CreateFulfillmentOrderRequest extends BaseRequest
 {
@@ -22,7 +22,7 @@ public function __construct(
         public string $displayable_order_comment,
         #[StringEnumValidator(['Standard', 'Expedited', 'Priority', 'ScheduledDelivery'])]
         public string $shipping_speed_category,
-        public AddressSchema $destination_address,
+        public FulfillmentOutboundAddressSchema $destination_address,
         public CreateFulfillmentOrderItemListSchema $items,
         public ?DeliveryWindowSchema $delivery_window = null,
         #[StringEnumValidator(['Ship', 'Hold'])]

diff --git a/src/Data/Requests/MerchantFulfillment/GetAdditionalSellerInputsRequest.php b/src/Data/Requests/MerchantFulfillment/GetAdditionalSellerInputsRequest.php
@@ -3,13 +3,13 @@
 namespace Jasara\AmznSPA\Data\Requests\MerchantFulfillment;
 
 use Jasara\AmznSPA\Data\Requests\BaseRequest;
-use Jasara\AmznSPA\Data\Schemas\AddressSchema;
+use Jasara\AmznSPA\Data\Schemas\MerchantFulfillment\MerchantFulfillmentAddressSchema;
 
 class GetAdditionalSellerInputsRequest extends BaseRequest
 {
     public function __construct(
         public string $shipping_service_id,
-        public AddressSchema $ship_from_address,
+        public MerchantFulfillmentAddressSchema $ship_from_address,
         public string $order_id,
     ) {
     }

diff --git a/src/Data/Schemas/AddressSchema.php b/src/Data/Schemas/AddressSchema.php
@@ -27,7 +27,7 @@ public function __construct(
         public string $postal_code,
         public ?string $email,
         #[MaxLengthValidator(30)]
-        public ?string $phone,
+        public ?string $phone_number,
     ) {
     }
 }
diff --git a/src/Data/Schemas/FulfillmentInbound/v20240320/BoxContentSchema.php b/src/Data/Schemas/FulfillmentInbound/v20240320/BoxContentSchema.php
@@ -2,14 +2,16 @@
 
 namespace Jasara\AmznSPA\Data\Schemas\FulfillmentInbound\v20240320;
 
+use Carbon\CarbonImmutable;
+use Jasara\AmznSPA\Data\Base\Casts\CarbonFromStringCaster;
 use Jasara\AmznSPA\Data\Base\Validators\RuleValidator;
 use Jasara\AmznSPA\Data\Schemas\BaseSchema;
 
 class BoxContentSchema extends BaseSchema
 {
     public function __construct(
-        #[RuleValidator(['date_format:Y-m-d'])]
-        public ?string $expiration,
+        #[CarbonFromStringCaster]
+        public ?CarbonImmutable $expiration,
         public LabelOwner $label_owner,
         #[RuleValidator(['min:1', 'max:256'])]
         public ?string $manufacturing_lot_code,

diff --git a/src/Data/Schemas/FulfillmentInbound/v20240320/ItemInputSchema.php b/src/Data/Schemas/FulfillmentInbound/v20240320/ItemInputSchema.php
@@ -2,14 +2,16 @@
 
 namespace Jasara\AmznSPA\Data\Schemas\FulfillmentInbound\v20240320;
 
+use Carbon\CarbonImmutable;
+use Jasara\AmznSPA\Data\Base\Casts\CarbonFromStringCaster;
 use Jasara\AmznSPA\Data\Base\Validators\RuleValidator;
 use Jasara\AmznSPA\Data\Schemas\BaseSchema;
 
 class ItemInputSchema extends BaseSchema
 {
     public function __construct(
-        #[RuleValidator(['date_format:Y-m-d'])]
-        public ?string $expiration,
+        #[CarbonFromStringCaster]
+        public ?CarbonImmutable $expiration,
         public LabelOwner $label_owner,
         #[RuleValidator(['min:1', 'max:256'])]
         public ?string $manufacturing_lot_code,

diff --git a/src/Data/Schemas/FulfillmentInbound/v20240320/ItemSchema.php b/src/Data/Schemas/FulfillmentInbound/v20240320/ItemSchema.php
@@ -2,6 +2,8 @@
 
 namespace Jasara\AmznSPA\Data\Schemas\FulfillmentInbound\v20240320;
 
+use Carbon\CarbonImmutable;
+use Jasara\AmznSPA\Data\Base\Casts\CarbonFromStringCaster;
 use Jasara\AmznSPA\Data\Base\Validators\RuleValidator;
 use Jasara\AmznSPA\Data\Schemas\BaseSchema;
 
@@ -10,8 +12,8 @@ class ItemSchema extends BaseSchema
     public function __construct(
         #[RuleValidator(['min:1', 'max:10'])]
         public string $asin,
-        #[RuleValidator(['date_format:Y-m-d'])]
-        public ?string $expiration,
+        #[CarbonFromStringCaster]
+        public ?CarbonImmutable $expiration,
         #[RuleValidator(['min:1', 'max:10'])]
         public string $fnsku,
         public LabelOwner $label_owner,

diff --git a/src/Data/Schemas/FulfillmentOutbound/FulfillmentOutboundAddressSchema.php b/src/Data/Schemas/FulfillmentOutbound/FulfillmentOutboundAddressSchema.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Jasara\AmznSPA\Data\Schemas\FulfillmentOutbound;
+
+use Jasara\AmznSPA\Data\Base\Validators\MaxLengthValidator;
+use Jasara\AmznSPA\Data\Base\Validators\RuleValidator;
+use Jasara\AmznSPA\Data\Schemas\BaseSchema;
+
+class FulfillmentOutboundAddressSchema extends BaseSchema
+{
+    public function __construct(
+        #[RuleValidator(['max:30'])]
+        public string $name,
+        #[MaxLengthValidator(180)]
+        public string $address_line_1,
+        #[MaxLengthValidator(60)]
+        public ?string $address_line_2,
+        #[MaxLengthValidator(60)]
+        public ?string $address_line_3,
+        public ?string $district_or_county,
+        #[MaxLengthValidator(30)]
+        public ?string $city,
+        #[MaxLengthValidator(30)]
+        public ?string $state_or_region,
+        #[MaxLengthValidator(2)]
+        public string $country_code,
+        #[MaxLengthValidator(30)]
+        public string $postal_code,
+        #[MaxLengthValidator(30)]
+        public ?string $phone,
+    ) {
+    }
+}
diff --git a/src/Data/Schemas/MerchantFulfillment/AdditionalSellerInputSchema.php b/src/Data/Schemas/MerchantFulfillment/AdditionalSellerInputSchema.php
@@ -4,7 +4,6 @@
 
 use Carbon\CarbonImmutable;
 use Jasara\AmznSPA\Data\Base\Casts\CarbonFromStringCaster;
-use Jasara\AmznSPA\Data\Schemas\AddressSchema;
 use Jasara\AmznSPA\Data\Schemas\BaseSchema;
 use Jasara\AmznSPA\Data\Schemas\MoneySchema;
 use Jasara\AmznSPA\Data\Schemas\WeightSchema;
@@ -18,7 +17,7 @@ public function __construct(
         public ?int $value_as_integer,
         #[CarbonFromStringCaster]
         public ?CarbonImmutable $value_as_timestamp,
-        public ?AddressSchema $value_as_address,
+        public ?MerchantFulfillmentAddressSchema $value_as_address,
         public ?WeightSchema $value_as_weight,
         public ?PackageDimensionsSchema $value_as_dimension,
         public ?MoneySchema $value_as_currency,

diff --git a/src/Data/Schemas/MerchantFulfillment/MerchantFulfillmentAddressSchema.php b/src/Data/Schemas/MerchantFulfillment/MerchantFulfillmentAddressSchema.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Jasara\AmznSPA\Data\Schemas\MerchantFulfillment;
+
+use Jasara\AmznSPA\Data\Base\Validators\MaxLengthValidator;
+use Jasara\AmznSPA\Data\Base\Validators\RuleValidator;
+use Jasara\AmznSPA\Data\Schemas\BaseSchema;
+
+class MerchantFulfillmentAddressSchema extends BaseSchema
+{
+    public function __construct(
+        #[RuleValidator(['max:30'])]
+        public string $name,
+        #[MaxLengthValidator(180)]
+        public string $address_line_1,
+        #[MaxLengthValidator(60)]
+        public ?string $address_line_2,
+        #[MaxLengthValidator(60)]
+        public ?string $address_line_3,
+        public ?string $district_or_county,
+        #[MaxLengthValidator(30)]
+        public ?string $city,
+        #[MaxLengthValidator(30)]
+        public ?string $state_or_province_code,
+        #[MaxLengthValidator(2)]
+        public string $country_code,
+        #[MaxLengthValidator(30)]
+        public string $postal_code,
+        public ?string $email,
+        #[MaxLengthValidator(30)]
+        public ?string $phone,
+    ) {
+    }
+}
diff --git a/src/Data/Schemas/MerchantFulfillment/ShipmentRequestDetailsSchema.php b/src/Data/Schemas/MerchantFulfillment/ShipmentRequestDetailsSchema.php
@@ -4,7 +4,6 @@
 
 use Carbon\CarbonImmutable;
 use Jasara\AmznSPA\Data\Base\Casts\CarbonFromStringCaster;
-use Jasara\AmznSPA\Data\Schemas\AddressSchema;
 use Jasara\AmznSPA\Data\Schemas\BaseSchema;
 use Jasara\AmznSPA\Data\Schemas\CatalogItems\v20201201\ItemListSchema;
 use Jasara\AmznSPA\Data\Schemas\WeightSchema;
@@ -15,7 +14,7 @@ public function __construct(
         public string $amazon_order_id,
         public ?string $seller_order_id,
         public ItemListSchema $item_list,
-        public AddressSchema $ship_from_address,
+        public MerchantFulfillmentAddressSchema $ship_from_address,
         public PackageDimensionsSchema $package_dimensions,
         public WeightSchema $weight,
         #[CarbonFromStringCaster]

diff --git a/src/Data/Schemas/MerchantFulfillment/ShipmentSchema.php b/src/Data/Schemas/MerchantFulfillment/ShipmentSchema.php
@@ -5,7 +5,6 @@
 use Carbon\CarbonImmutable;
 use Jasara\AmznSPA\Data\Base\Casts\CarbonFromStringCaster;
 use Jasara\AmznSPA\Data\Base\Validators\StringEnumValidator;
-use Jasara\AmznSPA\Data\Schemas\AddressSchema;
 use Jasara\AmznSPA\Data\Schemas\BaseSchema;
 use Jasara\AmznSPA\Data\Schemas\MoneySchema;
 use Jasara\AmznSPA\Data\Schemas\WeightSchema;
@@ -17,8 +16,8 @@ public function __construct(
         public string $amazon_order_id,
         public ?string $seller_order_id,
         public ItemListSchema $item_list,
-        public AddressSchema $ship_from_address,
-        public AddressSchema $ship_to_address,
+        public MerchantFulfillmentAddressSchema $ship_from_address,
+        public MerchantFulfillmentAddressSchema $ship_to_address,
         public PackageDimensionsSchema $package_dimensions,
         public WeightSchema $weight,
         public MoneySchema $insurance,

diff --git a/tests/Setup/SetupMerchantFulfillmentRequest.php b/tests/Setup/SetupMerchantFulfillmentRequest.php
@@ -3,12 +3,16 @@
 namespace Jasara\AmznSPA\Tests\Setup;
 
 use Illuminate\Support\Str;
+use Jasara\AmznSPA\Data\Schemas\MerchantFulfillment\MerchantFulfillmentAddressSchema;
 use Jasara\AmznSPA\Data\Schemas\MerchantFulfillment\ShipmentRequestDetailsSchema;
 
 trait SetupMerchantFulfillmentRequest
 {
     public function shipmentRequestDetails(): ShipmentRequestDetailsSchema
     {
+        $setup_address = $this->setupAddress();
+        $address = MerchantFulfillmentAddressSchema::from($setup_address->toArray());
+
         return ShipmentRequestDetailsSchema::from(
             amazon_order_id: '52986411826454',
             item_list: [
@@ -18,7 +22,7 @@ public function shipmentRequestDetails(): ShipmentRequestDetailsSchema
                     'quantity' => rand(1, 10),
                 ],
             ],
-            ship_from_address: $this->setupAddress(),
+            ship_from_address: $address,
             package_dimensions: [
                 'length' => 88,
             ],

diff --git a/tests/Unit/Resources/FulfillmentOutboundResourceTest.php b/tests/Unit/Resources/FulfillmentOutboundResourceTest.php
@@ -22,6 +22,7 @@
 use Jasara\AmznSPA\Data\Responses\FulfillmentOutbound\ListAllFulfillmentOrdersResponse;
 use Jasara\AmznSPA\Data\Responses\FulfillmentOutbound\ListReturnReasonCodesResponse;
 use Jasara\AmznSPA\Data\Responses\FulfillmentOutbound\UpdateFulfillmentOrderResponse;
+use Jasara\AmznSPA\Data\Schemas\FulfillmentOutbound\FulfillmentOutboundAddressSchema;
 use Jasara\AmznSPA\Tests\Unit\UnitTestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
 
@@ -89,14 +90,19 @@ public function testCreateFulfillmentOrder()
     {
         list($config, $http) = $this->setupConfigWithFakeHttp('empty');
 
+        $setup_address = $this->setupAddress();
+        $address = FulfillmentOutboundAddressSchema::from(array_merge($setup_address->toArray(), [
+            'state_or_region' => $setup_address->state_or_province_code,
+        ]));
+
         $request = CreateFulfillmentOrderRequest::from(
             marketplace_id: 'ATVPDKIKX0DER',
             seller_fulfillment_order_id: Str::random(),
             displayable_order_id: Str::random(),
             displayable_order_date: CarbonImmutable::now(),
             displayable_order_comment: Str::random(),
             shipping_speed_category: 'Expedited',
-            destination_address: $this->setupAddress(),
+            destination_address: $address,
             fulfillment_action: 'Hold',
             fulfillment_policy: 'fulfillment_policy',
             cod_settings: [

diff --git a/tests/Unit/Resources/MerchantFulfillmentResourceTest.php b/tests/Unit/Resources/MerchantFulfillmentResourceTest.php
@@ -13,6 +13,7 @@
 use Jasara\AmznSPA\Data\Responses\MerchantFulfillment\GetAdditionalSellerInputsResponse;
 use Jasara\AmznSPA\Data\Responses\MerchantFulfillment\GetEligibleShipmentServicesResponse;
 use Jasara\AmznSPA\Data\Responses\MerchantFulfillment\GetShipmentResponse;
+use Jasara\AmznSPA\Data\Schemas\MerchantFulfillment\MerchantFulfillmentAddressSchema;
 use Jasara\AmznSPA\Tests\Setup\SetupMerchantFulfillmentRequest;
 use Jasara\AmznSPA\Tests\Unit\UnitTestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -90,7 +91,7 @@ function (Request $request) {
             },
             function (Request $request) use ($shipment_id) {
                 $this->assertEquals('GET', $request->method());
-                $this->assertEquals('https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/'.$shipment_id, $request->url());
+                $this->assertEquals('https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/' . $shipment_id, $request->url());
 
                 return true;
             },
@@ -114,7 +115,7 @@ public function testCancelShipment()
 
         $http->assertSent(function (Request $request) use ($shipment_id) {
             $this->assertEquals('DELETE', $request->method());
-            $this->assertEquals('https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/'.$shipment_id, $request->url());
+            $this->assertEquals('https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/' . $shipment_id, $request->url());
 
             return true;
         });
@@ -135,7 +136,7 @@ public function testCancelShipmentOld()
 
         $http->assertSent(function (Request $request) use ($shipment_id) {
             $this->assertEquals('PUT', $request->method());
-            $this->assertEquals('https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/'.$shipment_id.'/cancel', $request->url());
+            $this->assertEquals('https://sellingpartnerapi-na.amazon.com/mfn/v0/shipments/' . $shipment_id . '/cancel', $request->url());
 
             return true;
         });
@@ -169,7 +170,7 @@ public function testGetAdditionalSellerInputsOld()
         list($config, $http) = $this->setupConfigWithFakeHttp('merchant-fulfillment/get-additional-seller-inputs-old');
         $request = new GetAdditionalSellerInputsRequest(
             shipping_service_id: Str::random(),
-            ship_from_address: $this->setupAddress(),
+            ship_from_address: MerchantFulfillmentAddressSchema::from($this->setupAddress()->toArray()),
             order_id: Str::random()
         );
 
@@ -193,7 +194,7 @@ public function testGetAdditionalSellerInputs()
         list($config, $http) = $this->setupConfigWithFakeHttp('merchant-fulfillment/get-additional-seller-inputs-old');
         $request = new GetAdditionalSellerInputsRequest(
             shipping_service_id: Str::random(),
-            ship_from_address: $this->setupAddress(),
+            ship_from_address: MerchantFulfillmentAddressSchema::from($this->setupAddress()->toArray()),
             order_id: Str::random()
         );