Regenerate from latest upstream models

resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json

@@ -24,7 +24,7 @@
                 "tags": [
                     "AmazonWarehousingAndDistributionV20240509"
                 ],
-                "description": "Retrieves an AWD inbound shipment.",
+                "description": "Retrieves an AWD inbound shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api)",
                 "operationId": "getInboundShipment",
                 "parameters": [
                     {
@@ -326,7 +326,7 @@
                 "tags": [
                     "AmazonWarehousingAndDistributionV20240509"
                 ],
-                "description": "Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.",
+                "description": "Retrieves a summary for all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
                 "operationId": "listInboundShipments",
                 "parameters": [
                     {
@@ -746,7 +746,7 @@
                 "tags": [
                     "AmazonWarehousingAndDistributionV20240509"
                 ],
-                "description": "Lists AWD inventory associated with a merchant with the ability to apply optional filters.",
+                "description": "Lists AWD inventory associated with a merchant with the ability to apply optional filters.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
                 "operationId": "listInventory",
                 "parameters": [
                     {

src/Seller/MerchantFulfillmentV0/Dto/Address.php

@@ -39,7 +39,7 @@ final class Address extends Dto
      * @param  ?string  $addressLine2  Additional street address information.
      * @param  ?string  $addressLine3  Additional street address information.
      * @param  ?string  $districtOrCounty  The district or county.
-     * @param  ?string  $stateOrProvinceCode  The state or province code. Note: Required in Canada, US, and UK marketplaces. Also required for shipments originating in China.
+     * @param  ?string  $stateOrProvinceCode  The state or province code. **Note.** Required in the Canada, US, and UK marketplaces. Also required for shipments originating from China.
      */
     public function __construct(
         public readonly string $name,

src/Seller/MerchantFulfillmentV0/Dto/Benefits.php

@@ -23,7 +23,7 @@ final class Benefits extends Dto
 
     /**
      * @param  ?string[]  $includedBenefits  A list of included benefits.
-     * @param  ExcludedBenefit[]|null  $excludedBenefits  A list of excluded benefits. Refer to the `ExcludeBenefit` object for further documentation.
+     * @param  ExcludedBenefit[]|null  $excludedBenefits  A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation.
      */
     public function __construct(
         public readonly ?array $includedBenefits = null,

src/Seller/MerchantFulfillmentV0/Dto/DangerousGoodsDetails.php

@@ -23,7 +23,7 @@ final class DangerousGoodsDetails extends Dto
 
     /**
      * @param  ?string  $unitedNationsRegulatoryId  The specific UNID of the item being shipped.
-     * @param  ?string  $transportationRegulatoryClass  The specific regulatory class of the shipped item.
+     * @param  ?string  $transportationRegulatoryClass  The specific regulatory class  of the item being shipped.
      * @param  ?string  $packingGroup  The specific packaging group of the item being shipped.
      * @param  ?string  $packingInstruction  The specific packing instruction of the item being shipped.
      */

src/Seller/MerchantFulfillmentV0/Dto/Error.php

@@ -15,7 +15,7 @@
 final class Error extends Dto
 {
     /**
-     * @param  string  $code  An error code that identifies the type of error that occurred.
+     * @param  string  $code  An error code that identifies the type of error that occured.
      * @param  string  $message  A message that describes the error condition in a human-readable form.
      * @param  ?string  $details  Additional details that can help the caller understand or fix the issue.
      */

src/Seller/MerchantFulfillmentV0/Dto/ExcludedBenefit.php

@@ -17,8 +17,8 @@ final class ExcludedBenefit extends Dto
     protected static array $attributeMap = ['benefit' => 'Benefit', 'reasonCodes' => 'ReasonCodes'];
 
     /**
-     * @param  ?string  $benefit  A benefit that is being excluded from a shipment.
-     * @param  ?string[]  $reasonCodes  List of reasons (for example, `LATE_DELIVERY_RISK`) why a benefit is excluded for a shipping offer.
+     * @param  ?string  $benefit  Benefit that is being excluded from a shipment.
+     * @param  ?string[]  $reasonCodes  List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.
      */
     public function __construct(
         public readonly ?string $benefit = null,

src/Seller/MerchantFulfillmentV0/Dto/GetEligibleShipmentServicesResult.php

@@ -30,7 +30,7 @@ final class GetEligibleShipmentServicesResult extends Dto
 
     /**
      * @param  ShippingService[]  $shippingServiceList  A list of shipping services offers.
-     * @param  RejectedShippingService[]|null  $rejectedShippingServiceList  List of services that are for some reason unavailable for this request
+     * @param  RejectedShippingService[]|null  $rejectedShippingServiceList  List of services that were for some reason unavailable for this request
      * @param  TemporarilyUnavailableCarrier[]|null  $temporarilyUnavailableCarrierList  A list of temporarily unavailable carriers.
      * @param  TermsAndConditionsNotAcceptedCarrier[]|null  $termsAndConditionsNotAcceptedCarrierList  List of carriers whose terms and conditions were not accepted by the seller.
      */

src/Seller/MerchantFulfillmentV0/Dto/Item.php

@@ -35,9 +35,9 @@ final class Item extends Dto
      * @param  ?string  $itemDescription  The description of the item.
      * @param  ?string[]  $transparencyCodeList  A list of transparency codes.
      * @param  AdditionalSellerInputs[]|null  $itemLevelSellerInputsList  A list of additional seller input pairs required to purchase shipping.
-     * @param  ?LiquidVolume  $liquidVolume  Liquid volume.
+     * @param  ?LiquidVolume  $liquidVolume  Liquid Volume.
      * @param  ?bool  $isHazmat  When true, the item qualifies as hazardous materials (hazmat). Defaults to false.
-     * @param  ?DangerousGoodsDetails  $dangerousGoodsDetails  Details related to any dangerous goods or items that are shipped.
+     * @param  ?DangerousGoodsDetails  $dangerousGoodsDetails  Details related to any dangerous goods/items that are being shipped.
      */
     public function __construct(
         public readonly string $orderItemId,

src/Seller/MerchantFulfillmentV0/Dto/Label.php

@@ -25,7 +25,9 @@ final class Label extends Dto
     /**
      * @param  LabelDimensions  $dimensions  Dimensions for printing a shipping label.
      * @param  FileContents  $fileContents  The document data and checksum.
-     * @param  ?string  $customTextForLabel  Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`.
+     * @param  ?string  $customTextForLabel  Custom text to print on the label.
+     *
+     * Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.
      * @param  ?string  $labelFormat  The label format.
      * @param  ?string  $standardIdForLabel  The type of standard identifier to print on the label.
      */

src/Seller/MerchantFulfillmentV0/Dto/LabelCustomization.php

@@ -20,7 +20,9 @@ final class LabelCustomization extends Dto
     ];
 
     /**
-     * @param  ?string  $customTextForLabel  Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`.
+     * @param  ?string  $customTextForLabel  Custom text to print on the label.
+     *
+     * Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.
      * @param  ?string  $standardIdForLabel  The type of standard identifier to print on the label.
      */
     public function __construct(

src/Seller/MerchantFulfillmentV0/Dto/PackageDimensions.php

@@ -23,11 +23,13 @@ final class PackageDimensions extends Dto
     ];
 
     /**
-     * @param  ?float  $length  Number that represents the given package dimension.
-     * @param  ?float  $width  Number that represents the given package dimension.
-     * @param  ?float  $height  Number that represents the given package dimension.
+     * @param  ?float  $length  Number representing the given package dimension.
+     * @param  ?float  $width  Number representing the given package dimension.
+     * @param  ?float  $height  Number representing the given package dimension.
      * @param  ?string  $unit  The unit of length.
-     * @param  ?string  $predefinedPackageDimensions  An enumeration of predefined parcel tokens. If you specify a `PredefinedPackageDimensions` token, you are not obligated to use a branded package from a carrier. For example, if you specify the `FedEx_Box_10kg` token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate envelope or box.
+     * @param  ?string  $predefinedPackageDimensions  An enumeration of predefined parcel tokens. If you specify a PredefinedPackageDimensions token, you are not obligated to use a branded package from a carrier. For example, if you specify the FedEx_Box_10kg token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token.
+     *
+     * Note: Please note that carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for all details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate Envelope or Box.
      */
     public function __construct(
         public readonly ?float $length = null,

src/Seller/MerchantFulfillmentV0/Dto/RejectedShippingService.php

@@ -23,10 +23,10 @@ final class RejectedShippingService extends Dto
     ];
 
     /**
-     * @param  string  $carrierName  The rejected shipping carrier name. For example, USPS.
-     * @param  string  $shippingServiceName  The rejected shipping service localized name. For example, FedEx Standard Overnight.
+     * @param  string  $carrierName  The rejected shipping carrier name. e.g. USPS
+     * @param  string  $shippingServiceName  The rejected shipping service localized name. e.g. FedEx Standard Overnight
      * @param  string  $shippingServiceId  An Amazon-defined shipping service identifier.
-     * @param  string  $rejectionReasonCode  A reason code meant to be consumed programatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`.
+     * @param  string  $rejectionReasonCode  A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX
      * @param  ?string  $rejectionReasonMessage  A localized human readable description of the rejected reason.
      */
     public function __construct(

src/Seller/MerchantFulfillmentV0/Dto/Shipment.php

@@ -37,7 +37,7 @@ final class Shipment extends Dto
     /**
      * @param  string  $shipmentId  An Amazon-defined shipment identifier.
      * @param  string  $amazonOrderId  An Amazon-defined order identifier, in 3-7-7 format.
-     * @param  Item[]  $itemList  The list of items you want to include in a shipment.
+     * @param  Item[]  $itemList  The list of items to be included in a shipment.
      * @param  Address  $shipFromAddress  The postal address information.
      * @param  Address  $shipToAddress  The postal address information.
      * @param  PackageDimensions  $packageDimensions  The dimensions of a package contained in a shipment.

src/Seller/MerchantFulfillmentV0/Dto/ShipmentRequestDetails.php

@@ -31,7 +31,7 @@ final class ShipmentRequestDetails extends Dto
 
     /**
      * @param  string  $amazonOrderId  An Amazon-defined order identifier, in 3-7-7 format.
-     * @param  Item[]  $itemList  The list of items you want to include in a shipment.
+     * @param  Item[]  $itemList  The list of items to be included in a shipment.
      * @param  Address  $shipFromAddress  The postal address information.
      * @param  PackageDimensions  $packageDimensions  The dimensions of a package contained in a shipment.
      * @param  Weight  $weight  The weight.

src/Seller/MerchantFulfillmentV0/Dto/ShippingService.php

@@ -34,7 +34,7 @@ final class ShippingService extends Dto
     protected static array $complexArrayTypes = ['availableFormatOptionsForLabel' => LabelFormatOption::class];
 
     /**
-     * @param  string  $shippingServiceName  A plain text representation of a carrier's shipping service. For example, UPS Ground or FedEx Standard Overnight.
+     * @param  string  $shippingServiceName  A plain text representation of a carrier's shipping service. For example, "UPS Ground" or "FedEx Standard Overnight".
      * @param  string  $carrierName  The name of the carrier.
      * @param  string  $shippingServiceId  An Amazon-defined shipping service identifier.
      * @param  string  $shippingServiceOfferId  An Amazon-defined shipping service offer identifier.
@@ -47,7 +47,7 @@ final class ShippingService extends Dto
      * @param  ?string[]  $availableLabelFormats  List of label formats.
      * @param  LabelFormatOption[]|null  $availableFormatOptionsForLabel  The available label formats.
      * @param  ?bool  $requiresAdditionalSellerInputs  When true, additional seller inputs are required.
-     * @param  ?Benefits  $benefits  Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (for example, `CLAIMS_PROTECTED`) when sellers purchase shipping through Amazon. Benefit details are made available for any shipment placed on or after January 1st 2024 00:00 UTC.
+     * @param  ?Benefits  $benefits  Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC
      */
     public function __construct(
         public readonly string $shippingServiceName,

src/Seller/MerchantFulfillmentV0/Dto/ShippingServiceOptions.php

@@ -24,7 +24,9 @@ final class ShippingServiceOptions extends Dto
 
     /**
      * @param  string  $deliveryExperience  The delivery confirmation level.
-     * @param  bool  $carrierWillPickUp  When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK).
+     * @param  bool  $carrierWillPickUp  When true, the carrier will pick up the package.
+     *
+     * Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK).
      * @param  ?CurrencyAmount  $declaredValue  Currency type and amount.
      * @param  ?string  $carrierWillPickUpOption  Carrier will pick up option.
      * @param  ?string  $labelFormat  The label format.

src/Seller/MerchantFulfillmentV0/Responses/CancelShipmentResponse.php

@@ -17,7 +17,7 @@
 final class CancelShipmentResponse extends Response
 {
     /**
-     * @param  ?Shipment  $payload  The details of a shipment. Includes the shipment status.
+     * @param  ?Shipment  $payload  The details of a shipment, including the shipment status.
      * @param  ?ErrorList  $errors  A list of error responses returned when a request is unsuccessful.
      */
     public function __construct(

src/Seller/MerchantFulfillmentV0/Responses/CreateShipmentResponse.php

@@ -17,7 +17,7 @@
 final class CreateShipmentResponse extends Response
 {
     /**
-     * @param  ?Shipment  $payload  The details of a shipment. Includes the shipment status.
+     * @param  ?Shipment  $payload  The details of a shipment, including the shipment status.
      * @param  ?ErrorList  $errors  A list of error responses returned when a request is unsuccessful.
      */
     public function __construct(

src/Seller/MerchantFulfillmentV0/Responses/GetAdditionalSellerInputsResponse.php

@@ -17,7 +17,7 @@
 final class GetAdditionalSellerInputsResponse extends Response
 {
     /**
-     * @param  ?GetAdditionalSellerInputsResult  $payload  The payload for the `getAdditionalSellerInputs` operation.
+     * @param  ?GetAdditionalSellerInputsResult  $payload  The payload for the getAdditionalSellerInputs operation.
      * @param  ?ErrorList  $errors  A list of error responses returned when a request is unsuccessful.
      */
     public function __construct(

src/Seller/MerchantFulfillmentV0/Responses/GetEligibleShipmentServicesResponse.php

@@ -17,7 +17,7 @@
 final class GetEligibleShipmentServicesResponse extends Response
 {
     /**
-     * @param  ?GetEligibleShipmentServicesResult  $payload  The payload for the `getEligibleShipmentServices` operation.
+     * @param  ?GetEligibleShipmentServicesResult  $payload  The payload for the getEligibleShipmentServices operation.
      * @param  ?ErrorList  $errors  A list of error responses returned when a request is unsuccessful.
      */
     public function __construct(

src/Seller/MerchantFulfillmentV0/Responses/GetShipmentResponse.php

@@ -17,7 +17,7 @@
 final class GetShipmentResponse extends Response
 {
     /**
-     * @param  ?Shipment  $payload  The details of a shipment. Includes the shipment status.
+     * @param  ?Shipment  $payload  The details of a shipment, including the shipment status.
      * @param  ?ErrorList  $errors  A list of error responses returned when a request is unsuccessful.
      */
     public function __construct(