From a014c5a59f125ea9ccc91e8bd6e73e63751ece91 Mon Sep 17 00:00:00 2001 From: Jesse Evers Date: Wed, 7 Aug 2024 12:56:49 -0400 Subject: [PATCH] Regenerate from latest upstream models --- .../v2024-05-09.json | 6 +- .../seller/merchant-fulfillment/v0.json | 146 +++++++++--------- .../MerchantFulfillmentV0/Dto/Address.php | 2 +- .../MerchantFulfillmentV0/Dto/Benefits.php | 2 +- .../Dto/DangerousGoodsDetails.php | 2 +- .../MerchantFulfillmentV0/Dto/Error.php | 2 +- .../Dto/ExcludedBenefit.php | 4 +- .../Dto/GetEligibleShipmentServicesResult.php | 2 +- src/Seller/MerchantFulfillmentV0/Dto/Item.php | 4 +- .../MerchantFulfillmentV0/Dto/Label.php | 4 +- .../Dto/LabelCustomization.php | 4 +- .../Dto/PackageDimensions.php | 10 +- .../Dto/RejectedShippingService.php | 6 +- .../MerchantFulfillmentV0/Dto/Shipment.php | 2 +- .../Dto/ShipmentRequestDetails.php | 2 +- .../Dto/ShippingService.php | 4 +- .../Dto/ShippingServiceOptions.php | 4 +- .../Responses/CancelShipmentResponse.php | 2 +- .../Responses/CreateShipmentResponse.php | 2 +- .../GetAdditionalSellerInputsResponse.php | 2 +- .../GetEligibleShipmentServicesResponse.php | 2 +- .../Responses/GetShipmentResponse.php | 2 +- 22 files changed, 112 insertions(+), 104 deletions(-) diff --git a/resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json b/resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json index 1aea124ce..0289518de 100644 --- a/resources/models/seller/amazon-warehousing-distribution/v2024-05-09.json +++ b/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": [ { diff --git a/resources/models/seller/merchant-fulfillment/v0.json b/resources/models/seller/merchant-fulfillment/v0.json index 77d99002a..4cded23c2 100644 --- a/resources/models/seller/merchant-fulfillment/v0.json +++ b/resources/models/seller/merchant-fulfillment/v0.json @@ -2,7 +2,7 @@ "openapi": "3.0.1", "info": { "title": "Selling Partner API for Merchant Fulfillment", - "description": "With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon's Buy Shipping Services.", + "description": "The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon\u2019s Buy Shipping Services.", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" @@ -24,7 +24,7 @@ "tags": [ "MerchantFulfillmentV0" ], - "description": "Returns a list of shipping service offers that satisfy the specified shipment request details.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation when available. The preceding table 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 SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns a list of shipping service offers that satisfy the specified shipment request details.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\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, see [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": "getEligibleShipmentServices", "requestBody": { "description": "Request schema for GetEligibleShipmentServices operation.", @@ -39,7 +39,7 @@ }, "responses": { "200": { - "description": "Success.", + "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -110,8 +110,8 @@ "payload": { "ShippingServiceList": [ { - "ShippingServiceName": "UPS 2nd Day Air\\u00AE", - "CarrierName": "UPS\\u00AE", + "ShippingServiceName": "UPS 2nd Day Air\u00ae", + "CarrierName": "UPS\u00ae", "ShippingServiceId": "UPS_PTP_2ND_DAY_AIR", "ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKoZAReW8oJ1SMumuBS8lA/Hjuglhyiu0+KRLvyJxFV0PB9YFMDhygs3VyTL0WGYkGxiuRkmuEvpqldUn9rrkWVodqnR4vx2VtXvtER/Ju6RqYoddJZGy6RS2KLzzhQ2NclN0NYXMZVqpOe5RsRBddXaGuJr7oza3M52+JzChocAHzcurIhCRynpbxfmNLzZMQEbgnpGLzuaoSMzfxg90/NaXFR/Ou01du/uKd5AbfMW/AxAKP9ht6Oi9lDHq6WkGqvjkVLW0/jj/fBgblIwcs+t", "ShipDate": "2019-10-28T16:36:36Z", @@ -154,8 +154,8 @@ } }, { - "ShippingServiceName": "UPS Next Day Air Saver\\u00AE", - "CarrierName": "UPS\\u00AE", + "ShippingServiceName": "UPS Next Day Air Saver\u00ae", + "CarrierName": "UPS\u00ae", "ShippingServiceId": "UPS_PTP_NEXT_DAY_AIR_SAVER", "ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKqqhKGQ2YZmuxsXKVXmdgdWNvfxb1qfm5bGm8NuqlqnNT3eTiJ4viTctepggbeUKUSykClJ+Qmw43zdA8wsgREhQCmb4Bbo/skapLQS1F9uwH2FgY5SfMsj/egudyocpVRT45KSQAT0H5YiXW3OyyRAae9fZ0RzDJAABHiisOyYyXnB1mtWOZqc7rlGR4yyqN7jmiT4t8dmuGPX7ptY4qskrN+6VHZO9bM9tdDS0ysHhAVv4jO3Q5sWFg4nEPaARWSsrpa6zSGMLxAOj56O3tcP", "ShipDate": "2019-10-28T16:36:36Z", @@ -205,7 +205,7 @@ ], "TemporarilyUnavailableCarrierList": [ { - "CarrierName": "UPS\\u00AE" + "CarrierName": "UPS\u00ae" }, { "CarrierName": "DHLECOMMERCE" @@ -307,7 +307,7 @@ } }, "401": { - "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -429,7 +429,7 @@ "tags": [ "MerchantFulfillmentV0" ], - "description": "Returns the shipment information for an existing shipment.\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 are applied to the requested operation when available. The preceding table 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 SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the shipment information for an existing shipment.\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, see [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": "getShipment", "parameters": [ { @@ -445,7 +445,7 @@ ], "responses": { "200": { - "description": "Success.", + "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -524,8 +524,8 @@ "Unit": "oz" }, "ShippingService": { - "ShippingServiceName": "UPS 2nd Day Air\\u00AE", - "CarrierName": "UPS\\u00AE", + "ShippingServiceName": "UPS 2nd Day Air\u00ae", + "CarrierName": "UPS\u00ae", "ShippingServiceId": "UPS_PTP_2ND_DAY_AIR", "ShippingServiceOfferId": "", "ShipDate": "2019-10-28T18:00:00Z", @@ -622,7 +622,7 @@ } }, "401": { - "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -741,7 +741,7 @@ "tags": [ "MerchantFulfillmentV0" ], - "description": "Cancel the shipment indicated by the specified shipment identifier.\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 are applied to the requested operation when available. The preceding table 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 SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Cancel the shipment indicated by the specified shipment identifier.\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, see [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": "cancelShipment", "parameters": [ { @@ -757,7 +757,7 @@ ], "responses": { "200": { - "description": "Success.", + "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -836,8 +836,8 @@ "Unit": "oz" }, "ShippingService": { - "ShippingServiceName": "UPS 2nd Day Air\\u00AE", - "CarrierName": "UPS\\u00AE", + "ShippingServiceName": "UPS 2nd Day Air\u00ae", + "CarrierName": "UPS\u00ae", "ShippingServiceId": "UPS_PTP_2ND_DAY_AIR", "ShippingServiceOfferId": "", "ShipDate": "2019-10-28T18:00:00Z", @@ -919,7 +919,7 @@ } }, "401": { - "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -1040,10 +1040,10 @@ "tags": [ "MerchantFulfillmentV0" ], - "description": "Create a shipment with the information provided.\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 are applied to the requested operation when available. The preceding table 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 SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Create a shipment with the information provided.\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, see [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": "createShipment", "requestBody": { - "description": "Request schema for `CreateShipment` operation.", + "description": "Request schema for CreateShipment operation.", "content": { "application/json": { "schema": { @@ -1055,7 +1055,7 @@ }, "responses": { "200": { - "description": "Success.", + "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -1170,8 +1170,8 @@ "Unit": "oz" }, "ShippingService": { - "ShippingServiceName": "UPS 2nd Day Air\\u00AE", - "CarrierName": "UPS\\u00AE", + "ShippingServiceName": "UPS 2nd Day Air\u00ae", + "CarrierName": "UPS\u00ae", "ShippingServiceId": "UPS_PTP_2ND_DAY_AIR", "ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKoZAReW8oJ1SMumuBS8lA/Hjuglhyiu0+KRLvyJxFV0PB9YFMDhygs3VyTL0WGYkGxiuRkmuEvpqldUn9rrkWVodqnR4vx2VtXvtER/Ju6RqYoddJZGy6RS2KLzzhQ2NclN0NYXMZVqpOe5RsRBddXaGuJr7oza3M52+JzChocAHzcurIhCRynpbxfmNLzZMQEbgnpGLzuaoSMzfxg90/NaXFR/Ou01du/uKd5AbfMW/AxAKP9ht6Oi9lDHq6WkGqvjkVLW0/jj/fBgblIwcs+t", "ShipDate": "2019-10-28T16:37:37Z", @@ -1302,7 +1302,7 @@ } }, "401": { - "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -1424,10 +1424,10 @@ "tags": [ "MerchantFulfillmentV0" ], - "description": "Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.\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 are applied to the requested operation when available. The preceding table 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 SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.\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, see [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": "getAdditionalSellerInputs", "requestBody": { - "description": "Request schema for the `GetAdditionalSellerInputs` operation.", + "description": "Request schema for GetAdditionalSellerInputs operation.", "content": { "application/json": { "schema": { @@ -1439,7 +1439,7 @@ }, "responses": { "200": { - "description": "Success.", + "description": "Success", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -1563,7 +1563,7 @@ } }, "401": { - "description": "The request's authorization header is not formatted correctly or does not contain a valid token.", + "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", @@ -1692,7 +1692,7 @@ "properties": { "code": { "type": "string", - "description": "An error code that identifies the type of error that occurred." + "description": "An error code that identifies the type of error that occured." }, "message": { "type": "string", @@ -2062,7 +2062,7 @@ "$ref": "#/components/schemas/ExcludedBenefits" } }, - "description": "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." + "description": "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" }, "IncludedBenefits": { "type": "array", @@ -2073,7 +2073,7 @@ }, "ExcludedBenefits": { "type": "array", - "description": "A list of excluded benefits. Refer to the `ExcludeBenefit` object for further documentation.", + "description": "A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation.", "items": { "$ref": "#/components/schemas/ExcludedBenefit" } @@ -2083,17 +2083,17 @@ "properties": { "Benefit": { "type": "string", - "description": "A benefit that is being excluded from a shipment." + "description": "Benefit that is being excluded from a shipment." }, "ReasonCodes": { "$ref": "#/components/schemas/ExcludedBenefitReasonCodes" } }, - "description": "An object representing an excluded benefit that is excluded for a shipping offer or rate." + "description": "Object representing an excluded benefit that is excluded for a shipping offer or rate." }, "ExcludedBenefitReasonCodes": { "type": "array", - "description": "List of reasons (for example, `LATE_DELIVERY_RISK`) why a benefit is excluded for a shipping offer.", + "description": "List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.", "items": { "type": "string" } @@ -2214,7 +2214,7 @@ "$ref": "#/components/schemas/ItemLevelFieldsList" } }, - "description": "The payload for the `getAdditionalSellerInputs` operation." + "description": "The payload for the getAdditionalSellerInputs operation." }, "GetAdditionalSellerInputsResponse": { "type": "object", @@ -2251,7 +2251,7 @@ "CustomTextForLabel": { "maxLength": 14, "type": "string", - "description": "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`." + "description": "Custom text to print on the label.\n\nNote: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel." }, "DeliveryExperienceType": { "type": "string", @@ -2265,15 +2265,15 @@ "x-docgen-enum-table-extension": [ { "value": "DeliveryConfirmationWithAdultSignature", - "description": "Delivery confirmation with an adult signature." + "description": "Delivery confirmation with adult signature." }, { "value": "DeliveryConfirmationWithSignature", - "description": "Delivery confirmation with a signature. Required for DPD (UK)." + "description": "Delivery confirmation with signature. Required for DPD (UK)." }, { "value": "DeliveryConfirmationWithoutSignature", - "description": "Delivery confirmation without a signature." + "description": "Delivery confirmation without signature." }, { "value": "NoTracking", @@ -2380,7 +2380,7 @@ "$ref": "#/components/schemas/TermsAndConditionsNotAcceptedCarrierList" } }, - "description": "The payload for the `getEligibleShipmentServices` operation." + "description": "The payload for the getEligibleShipmentServices operation." }, "GetShipmentResponse": { "type": "object", @@ -2452,7 +2452,7 @@ }, "ItemList": { "type": "array", - "description": "The list of items you want to include in a shipment.", + "description": "The list of items to be included in a shipment.", "items": { "$ref": "#/components/schemas/Item" } @@ -2586,7 +2586,7 @@ }, "PackageDimension": { "type": "number", - "description": "Number that represents the given package dimension.", + "description": "Number representing the given package dimension.", "format": "double" }, "PackageDimensions": { @@ -2622,7 +2622,7 @@ }, "PredefinedPackageDimensions": { "type": "string", - "description": "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.", + "description": "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.\n\nNote: 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.", "enum": [ "FedEx_Box_10kg", "FedEx_Box_25kg", @@ -2954,7 +2954,7 @@ "$ref": "#/components/schemas/Timestamp" } }, - "description": "The details of a shipment. Includes the shipment status." + "description": "The details of a shipment, including the shipment status." }, "ShipmentId": { "type": "string", @@ -3016,15 +3016,15 @@ "x-docgen-enum-table-extension": [ { "value": "Purchased", - "description": "The seller purchased a label by calling the `createShipment` operation." + "description": "The seller purchased a label by calling the createShipment operation." }, { "value": "RefundPending", - "description": "The seller requested a label refund by calling the `cancelShipment` operation, and the refund request is being processed by the carrier. Note: A seller can create a new shipment for an order while `Status=RefundPending` for a canceled shipment. After you request a label refund (by calling `cancelShipment`), the status of the order remains `Shipped`." + "description": "The seller requested a label refund by calling the cancelShipment operation, and the refund request is being processed by the carrier.\n\nNote:\n\n* A seller can create a new shipment for an order while Status=RefundPending for a canceled shipment.\n* After a label refund is requested by calling the cancelShipment operation, the order status of the order remains \"Shipped\"." }, { "value": "RefundRejected", - "description": "The label refund request is rejected by the carrier. A refund request is rejected because the cancellation window has expired, or the carrier has already accepted the shipment for delivery. Cancellation policies vary by carrier. For more information about carrier cancellation policies, refer to the Seller Central Help for your marketplace." + "description": "The label refund request was rejected by the carrier. A refund request is rejected for either of the following reasons:\n\n* The cancellation window has expired. Cancellation policies vary by carrier. For more information about carrier cancellation policies, see the Seller Central Help.\n* The carrier has already accepted the shipment for delivery." }, { "value": "RefundApplied", @@ -3099,7 +3099,7 @@ "properties": { "ShippingServiceName": { "type": "string", - "description": "A plain text representation of a carrier's shipping service. For example, UPS Ground or FedEx Standard Overnight. " + "description": "A plain text representation of a carrier's shipping service. For example, \"UPS Ground\" or \"FedEx Standard Overnight\". " }, "CarrierName": { "type": "string", @@ -3172,7 +3172,7 @@ }, "CarrierWillPickUp": { "type": "boolean", - "description": "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)." + "description": "When true, the carrier will pick up the package.\n\nNote: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK)." }, "CarrierWillPickUpOption": { "$ref": "#/components/schemas/CarrierWillPickUpOption" @@ -3222,7 +3222,7 @@ "StateOrProvinceCode": { "maxLength": 30, "type": "string", - "description": "The state or province code. Note: Required in Canada, US, and UK marketplaces. Also required for shipments originating in China." + "description": "The state or province code. **Note.** Required in the Canada, US, and UK marketplaces. Also required for shipments originating from China." }, "RejectedShippingService": { "required": [ @@ -3235,18 +3235,18 @@ "properties": { "CarrierName": { "type": "string", - "description": "The rejected shipping carrier name. For example, USPS." + "description": "The rejected shipping carrier name. e.g. USPS" }, "ShippingServiceName": { "type": "string", - "description": "The rejected shipping service localized name. For example, FedEx Standard Overnight." + "description": "The rejected shipping service localized name. e.g. FedEx Standard Overnight" }, "ShippingServiceId": { "$ref": "#/components/schemas/ShippingServiceIdentifier" }, "RejectionReasonCode": { "type": "string", - "description": "A reason code meant to be consumed programatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`." + "description": "A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX" }, "RejectionReasonMessage": { "type": "string", @@ -3257,7 +3257,7 @@ }, "RejectedShippingServiceList": { "type": "array", - "description": "List of services that are for some reason unavailable for this request", + "description": "List of services that were for some reason unavailable for this request", "items": { "$ref": "#/components/schemas/RejectedShippingService" } @@ -3313,7 +3313,7 @@ }, "TransparencyCode": { "type": "string", - "description": "The transparency code associated with the item. Determine the transparency serial number with:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, that likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." + "description": "The Transparency code associated with the item. The Transparency serial number that needs to be submitted can be determined by the following:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates." }, "TransparencyCodeList": { "type": "array", @@ -3409,7 +3409,7 @@ }, { "value": "FL_OZ", - "description": "Fluid ounce - Imperial unit of volume." + "description": "Fluid Ounce - Imperial unit of volume." }, { "value": "GAL", @@ -3434,7 +3434,7 @@ "description": "The measurement value." } }, - "description": "Liquid volume." + "description": "Liquid Volume." }, "DangerousGoodsDetails": { "type": "object", @@ -3447,7 +3447,7 @@ "TransportationRegulatoryClass": { "pattern": "^[1-9](\\.[1-9])?$", "type": "string", - "description": "The specific regulatory class of the shipped item." + "description": "The specific regulatory class of the item being shipped." }, "PackingGroup": { "type": "string", @@ -3493,60 +3493,60 @@ "x-docgen-enum-table-extension": [ { "value": "PI965_SECTION_IA", - "description": "Ion PI965 Section IA (LiBa)." + "description": "Ion PI965 Section IA (LiBa)" }, { "value": "PI965_SECTION_IB", - "description": "Ion PI965 Section IB (LiBa)." + "description": "Ion PI965 Section IB (LiBa)" }, { "value": "PI965_SECTION_II", - "description": "Ion PI965 Section II (LiBa)." + "description": "Ion PI965 Section II (LiBa)" }, { "value": "PI966_SECTION_I", - "description": "Ion PI966 Section I (LiBa with equipment)." + "description": "Ion PI966 Section I (LiBa with equipment)" }, { "value": "PI966_SECTION_II", - "description": "Ion PI966 Section II (LiBa with equipment)." + "description": "Ion PI966 Section II (LiBa with equipment)" }, { "value": "PI967_SECTION_I", - "description": "Ion PI967 Section I (LiBa in equipment)." + "description": "Ion PI967 Section I (LiBa in equipment)" }, { "value": "PI967_SECTION_II", - "description": "Ion PI967 Section II (LiBa in equipment)." + "description": "Ion PI967 Section II (LiBa in equipment)" }, { "value": "PI968_SECTION_IA", - "description": "Metal PI968 Section IA (LiBa)." + "description": "Metal PI968 Section IA (LiBa)" }, { "value": "PI968_SECTION_IB", - "description": "Metal PI968 Section IB (LiBa)." + "description": "Metal PI968 Section IB (LiBa)" }, { "value": "PI969_SECTION_I", - "description": "Metal PI969 Section I (LiBa with equipment)." + "description": "Metal PI969 Section I (LiBa with equipment)" }, { "value": "PI969_SECTION_II", - "description": "Metal PI969 Section II (LiBa with equipment)." + "description": "Metal PI969 Section II (LiBa with equipment)" }, { "value": "PI970_SECTION_I", - "description": "Metal PI970 Section I (LiBa in equipment)." + "description": "Metal PI970 Section I (LiBa in equipment)" }, { "value": "PI970_SECTION_II", - "description": "Metal PI970 Section II (LiBa in equipment)." + "description": "Metal PI970 Section II (LiBa in equipment)" } ] } }, - "description": "Details related to any dangerous goods or items that are shipped." + "description": "Details related to any dangerous goods/items that are being shipped." } } }, diff --git a/src/Seller/MerchantFulfillmentV0/Dto/Address.php b/src/Seller/MerchantFulfillmentV0/Dto/Address.php index 94d222a5b..9b21b4cb5 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/Address.php +++ b/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, diff --git a/src/Seller/MerchantFulfillmentV0/Dto/Benefits.php b/src/Seller/MerchantFulfillmentV0/Dto/Benefits.php index 97aa2f84d..4ce511eb3 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/Benefits.php +++ b/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, diff --git a/src/Seller/MerchantFulfillmentV0/Dto/DangerousGoodsDetails.php b/src/Seller/MerchantFulfillmentV0/Dto/DangerousGoodsDetails.php index 20cbe0414..d17844621 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/DangerousGoodsDetails.php +++ b/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. */ diff --git a/src/Seller/MerchantFulfillmentV0/Dto/Error.php b/src/Seller/MerchantFulfillmentV0/Dto/Error.php index 601be1a7e..ce792a683 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/Error.php +++ b/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. */ diff --git a/src/Seller/MerchantFulfillmentV0/Dto/ExcludedBenefit.php b/src/Seller/MerchantFulfillmentV0/Dto/ExcludedBenefit.php index d9ecef786..60ceaf6b2 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/ExcludedBenefit.php +++ b/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, diff --git a/src/Seller/MerchantFulfillmentV0/Dto/GetEligibleShipmentServicesResult.php b/src/Seller/MerchantFulfillmentV0/Dto/GetEligibleShipmentServicesResult.php index ceabd511f..9e731a91b 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/GetEligibleShipmentServicesResult.php +++ b/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. */ diff --git a/src/Seller/MerchantFulfillmentV0/Dto/Item.php b/src/Seller/MerchantFulfillmentV0/Dto/Item.php index 633bb42bb..03ef89698 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/Item.php +++ b/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, diff --git a/src/Seller/MerchantFulfillmentV0/Dto/Label.php b/src/Seller/MerchantFulfillmentV0/Dto/Label.php index 8af1eec34..30a948650 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/Label.php +++ b/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. */ diff --git a/src/Seller/MerchantFulfillmentV0/Dto/LabelCustomization.php b/src/Seller/MerchantFulfillmentV0/Dto/LabelCustomization.php index 1511eaaaf..e9390f6af 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/LabelCustomization.php +++ b/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( diff --git a/src/Seller/MerchantFulfillmentV0/Dto/PackageDimensions.php b/src/Seller/MerchantFulfillmentV0/Dto/PackageDimensions.php index afa7b9a93..48c665bc6 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/PackageDimensions.php +++ b/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, diff --git a/src/Seller/MerchantFulfillmentV0/Dto/RejectedShippingService.php b/src/Seller/MerchantFulfillmentV0/Dto/RejectedShippingService.php index 5f0394d9b..ea4c702a9 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/RejectedShippingService.php +++ b/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( diff --git a/src/Seller/MerchantFulfillmentV0/Dto/Shipment.php b/src/Seller/MerchantFulfillmentV0/Dto/Shipment.php index 21595a8fb..7e36674c3 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/Shipment.php +++ b/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. diff --git a/src/Seller/MerchantFulfillmentV0/Dto/ShipmentRequestDetails.php b/src/Seller/MerchantFulfillmentV0/Dto/ShipmentRequestDetails.php index f2964fd1c..9bac8373a 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/ShipmentRequestDetails.php +++ b/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. diff --git a/src/Seller/MerchantFulfillmentV0/Dto/ShippingService.php b/src/Seller/MerchantFulfillmentV0/Dto/ShippingService.php index ce77d1103..1a769a6a7 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/ShippingService.php +++ b/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, diff --git a/src/Seller/MerchantFulfillmentV0/Dto/ShippingServiceOptions.php b/src/Seller/MerchantFulfillmentV0/Dto/ShippingServiceOptions.php index 680a57ec5..7caf5bd5b 100644 --- a/src/Seller/MerchantFulfillmentV0/Dto/ShippingServiceOptions.php +++ b/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. diff --git a/src/Seller/MerchantFulfillmentV0/Responses/CancelShipmentResponse.php b/src/Seller/MerchantFulfillmentV0/Responses/CancelShipmentResponse.php index 10c368054..82f09329b 100644 --- a/src/Seller/MerchantFulfillmentV0/Responses/CancelShipmentResponse.php +++ b/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( diff --git a/src/Seller/MerchantFulfillmentV0/Responses/CreateShipmentResponse.php b/src/Seller/MerchantFulfillmentV0/Responses/CreateShipmentResponse.php index d38592a13..b41f868d4 100644 --- a/src/Seller/MerchantFulfillmentV0/Responses/CreateShipmentResponse.php +++ b/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( diff --git a/src/Seller/MerchantFulfillmentV0/Responses/GetAdditionalSellerInputsResponse.php b/src/Seller/MerchantFulfillmentV0/Responses/GetAdditionalSellerInputsResponse.php index 9efe6fcd4..8505207c8 100644 --- a/src/Seller/MerchantFulfillmentV0/Responses/GetAdditionalSellerInputsResponse.php +++ b/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( diff --git a/src/Seller/MerchantFulfillmentV0/Responses/GetEligibleShipmentServicesResponse.php b/src/Seller/MerchantFulfillmentV0/Responses/GetEligibleShipmentServicesResponse.php index 56e915a3f..230179e95 100644 --- a/src/Seller/MerchantFulfillmentV0/Responses/GetEligibleShipmentServicesResponse.php +++ b/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( diff --git a/src/Seller/MerchantFulfillmentV0/Responses/GetShipmentResponse.php b/src/Seller/MerchantFulfillmentV0/Responses/GetShipmentResponse.php index ee6451e5c..38b7a893f 100644 --- a/src/Seller/MerchantFulfillmentV0/Responses/GetShipmentResponse.php +++ b/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(