peddler 5.1.0 → 5.3.0

data/lib/peddler/data_kiosk/sales_and_traffic20240424.json

@@ -390,6 +390,90 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "ordersShipped",
+              "description": "The number of orders shipped for the selected time period.",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Long",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "ordersShippedB2B",
+              "description": "The number of orders shipped to Amazon Business customers for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "refundRate",
+              "description": "The percentage conversion metric indicating how many orders were refunded,\ncalculated by dividing unitsRefunded by unitsOrdered for the selected time period.",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Float",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "refundRateB2B",
+              "description": "The percentage conversion metric indicating how many orders were refunded by\nAmazon Business customers, calculated by dividing unitsRefundedB2B by\nunitsOrderedB2B for the selected time period. Note: This field is only\npopulated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Float",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "shippedProductSales",
+              "description": "The amount of ordered product sales shipped for the selected time period.",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "OBJECT",
+                  "name": "Amount",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "shippedProductSalesB2B",
+              "description": "The amount of ordered product sales shipped to Amazon Business customers for\nthe selected time period. Note: This field is only populated when the seller\nis a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "OBJECT",
+                "name": "Amount",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "totalOrderItems",
               "description": "The number of items that were ordered for the selected time period.",
@@ -445,6 +529,62 @@
               },
               "isDeprecated": false,
               "deprecationReason": null
+            },
+            {
+              "name": "unitsRefunded",
+              "description": "The number of units refunded for the selected time period.",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Long",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "unitsRefundedB2B",
+              "description": "The number of units refunded by Amazon Business customers for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "unitsShipped",
+              "description": "The number of units shipped for the selected time period.",
+              "args": [],
+              "type": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "SCALAR",
+                  "name": "Long",
+                  "ofType": null
+                }
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "unitsShippedB2B",
+              "description": "The number of units shipped to Amazon Business customers for the selected time\nperiod. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
             }
           ],
           "inputFields": null,
@@ -890,7 +1030,7 @@
             },
             {
               "name": "averageSellingPrice",
-              "description": "The average price of the units sold in the selected time period, calculated by\ndividing the orderedProductSales by unitsOrdered for the selected time period.",
+              "description": "The average price of the units sold for the selected time period, calculated\nby dividing the orderedProductSales by unitsOrdered for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -960,6 +1100,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "claimsAmountB2B",
+              "description": "Monetary amount of filed A-to-z guarantee claims for Amazon Business\ncustomers. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "OBJECT",
+                "name": "Amount",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "claimsGranted",
               "description": "The number of A-to-z guarantee claims granted.",
@@ -976,6 +1128,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "claimsGrantedB2B",
+              "description": "The number of A-to-z guarantee claims granted for Amazon Business customers.\nNote: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "orderedProductSales",
               "description": "The amount of ordered product sales, calculated by multiplying the price of\nproducts and the number of units sold for the selected time period.",
@@ -994,7 +1158,7 @@
             },
             {
               "name": "orderedProductSalesB2B",
-              "description": "The amount of ordered product sales to Amazon Business customers, calculated\nby multiplying the price of products and the number of units sold for the\nselected time period.",
+              "description": "The amount of ordered product sales to Amazon Business customers, calculated\nby multiplying the price of products and the number of units sold for the\nselected time period. Note: This field is only populated when the seller is a B2B seller.",
               "args": [],
               "type": {
                 "kind": "OBJECT",
@@ -1006,7 +1170,7 @@
             },
             {
               "name": "ordersShipped",
-              "description": "The number of orders shipped in the selected time period.",
+              "description": "The number of orders shipped for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1020,9 +1184,21 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "ordersShippedB2B",
+              "description": "The number of orders shipped to Amazon Business customers for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "refundRate",
-              "description": "The percentage conversion metric indicating how many orders were refunded by\nthe seller, calculated by dividing unitsOrdered by unitsRefunded in the\nselected time period.",
+              "description": "The percentage conversion metric indicating how many orders were refunded by\nthe seller, calculated by dividing unitsRefunded by unitsOrdered for the\nselected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1036,6 +1212,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "refundRateB2B",
+              "description": "The percentage conversion metric indicating how many orders were refunded by\nAmazon Business customers, calculated by dividing unitsRefundedB2B by\nunitsOrderedB2B for the selected time period. Note: This field is only\npopulated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Float",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "shippedProductSales",
               "description": "The amount of ordered product sales shipped for the selected time period.",
@@ -1052,6 +1240,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "shippedProductSalesB2B",
+              "description": "The amount of ordered product sales shipped to Amazon Business customers for\nthe selected time period. Note: This field is only populated when the seller\nis a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "OBJECT",
+                "name": "Amount",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "totalOrderItems",
               "description": "The number of items that were ordered for the selected time period. Example:\nFor an order containing 2 copies of book A and 3 copies of book B, the number\nof orders is 1, the number of order items is 2 (book A and book B), and the\nnumber of units is 5 (2 + 3).",
@@ -1070,7 +1270,7 @@
             },
             {
               "name": "totalOrderItemsB2B",
-              "description": "The number of items that were ordered by Amazon Business customers for the\nselected time period. Example: For an order containing 2 copies of book A and\n3 copies of book B, the number of orders is 1, the number of order items is 2\n(book A and book B), and the number of units is 5 (2 + 3).",
+              "description": "The number of items that were ordered by Amazon Business customers for the\nselected time period. Example: For an order containing 2 copies of book A and\n3 copies of book B, the number of orders is 1, the number of order items is 2\n(book A and book B), and the number of units is 5 (2 + 3). Note: This field is\nonly populated when the seller is a B2B seller.",
               "args": [],
               "type": {
                 "kind": "SCALAR",
@@ -1098,7 +1298,7 @@
             },
             {
               "name": "unitsOrderedB2B",
-              "description": "The number of units ordered by Amazon Business customers for the selected time\nperiod. Example: For an order containing 2 copies of book A and 3 copies of\nbook B, the number of orders is 1, the number of order items is 2 (book A and\nbook B), and the number of units is 5 (2 + 3).",
+              "description": "The number of units ordered by Amazon Business customers for the selected time\nperiod. Example: For an order containing 2 copies of book A and 3 copies of\nbook B, the number of orders is 1, the number of order items is 2 (book A and\nbook B), and the number of units is 5 (2 + 3). Note: This field is only\npopulated when the seller is a B2B seller.",
               "args": [],
               "type": {
                 "kind": "SCALAR",
@@ -1110,7 +1310,7 @@
             },
             {
               "name": "unitsRefunded",
-              "description": "The number of units refunded in the selected time period.",
+              "description": "The number of units refunded for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1124,9 +1324,21 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "unitsRefundedB2B",
+              "description": "The number of units refunded by Amazon Business customers for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "unitsShipped",
-              "description": "The number of units shipped in the selected time period.",
+              "description": "The number of units shipped for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1139,6 +1351,18 @@
               },
               "isDeprecated": false,
               "deprecationReason": null
+            },
+            {
+              "name": "unitsShippedB2B",
+              "description": "The number of units shipped to Amazon Business customers for the selected time\nperiod. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
             }
           ],
           "inputFields": null,
@@ -1153,7 +1377,7 @@
           "fields": [
             {
               "name": "averageOfferCount",
-              "description": "The average number of offers listed for sale in the selected time period. It\nis calculated from the total number of offers and the total number of days in\nthe selected time period.",
+              "description": "The average number of offers listed for sale for the selected time period. It\nis calculated from the total number of offers and the total number of days for\nthe selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1169,7 +1393,7 @@
             },
             {
               "name": "averageParentItems",
-              "description": "The average number of parent items listed for sale in the selected time period.",
+              "description": "The average number of parent items listed for sale for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1269,7 +1493,7 @@
             },
             {
               "name": "feedbackReceived",
-              "description": "The number of times customers left feedback in the selected time period.",
+              "description": "The number of times customers left feedback for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1283,6 +1507,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "feedbackReceivedB2B",
+              "description": "The number of times Amazon Business customers left feedback for the selected\ntime period. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "mobileAppPageViews",
               "description": "Mobile app page views are the number of times a user visited your Amazon.com\nmobile app pages for the selected time period.",
@@ -1341,7 +1577,7 @@
             },
             {
               "name": "negativeFeedbackReceived",
-              "description": "The number of times customers left negative feedback in the selected time period.",
+              "description": "The number of times customers left negative feedback for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1355,6 +1591,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "negativeFeedbackReceivedB2B",
+              "description": "The number of times Amazon Business customers left negative feedback for the\nselected time period. Note: This field is only populated when the seller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Long",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "orderItemSessionPercentage",
               "description": "The percentage conversion metric indicating how many order items were\ngenerated relative to the number of people who viewed the products.",
@@ -1413,7 +1661,7 @@
             },
             {
               "name": "receivedNegativeFeedbackRate",
-              "description": "The negative feedback rate is the number of orders that have received negative\nfeedback divided by the number of orders in the selected time period.",
+              "description": "The negative feedback rate is the number of orders that have received negative\nfeedback divided by the number of orders for the selected time period.",
               "args": [],
               "type": {
                 "kind": "NON_NULL",
@@ -1427,6 +1675,18 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "receivedNegativeFeedbackRateB2B",
+              "description": "The negative feedback rate for Amazon Business customers is the number of\norders that have received negative feedback divided by the number of orders\nfor the selected time period. Note: This field is only populated when the\nseller is a B2B seller.",
+              "args": [],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Float",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "sessions",
               "description": "Sessions are visits to your Amazon.com browser or mobile app pages by a user.\nAll browser and mobile app activity within a 24-hour period is considered a\nsession. It is calculated as the sum of browserSessions and mobileAppSessions.",

data/lib/peddler/notifications/any_offer_changed/notification.rb

@@ -18,14 +18,14 @@ module Peddler
         # @return [String]
         attribute(:notification_type, String, from: "NotificationType")
 
+        # @return [String]
+        attribute(:notification_version, String, from: "NotificationVersion")
+
         # @return [Payload]
         attribute(:payload, Payload, from: "Payload")
 
         # @return [String]
         attribute(:payload_version, String, from: "PayloadVersion")
-
-        # @return [String]
-        attribute?(:notification_version, String, from: "NotificationVersion")
       end
     end
   end

data/lib/peddler/notifications/b2b_any_offer_changed/b2b_any_offer_changed_notification.rb

@@ -9,17 +9,17 @@ module Peddler
     module B2BAnyOfferChanged
       B2BAnyOfferChangedNotification = Structure.new do
         # @return [OfferChangeTrigger]
-        attribute(:offer_change_trigger, OfferChangeTrigger, from: "offerChangeTrigger")
+        attribute(:offer_change_trigger, OfferChangeTrigger, from: "OfferChangeTrigger")
 
         # @return [Array<Offer>] The top 20 competitive B2B offers for the item and condition that triggered the
-        #   notification.
-        attribute(:offers, [Offer])
+        #   notification
+        attribute(:offers, [Offer], from: "Offers")
 
-        # @return [String] The seller identifier for the offer.
-        attribute(:seller_id, String, from: "sellerId")
+        # @return [String] The seller identifier for the offer
+        attribute(:seller_id, String, from: "SellerId")
 
         # @return [Summary]
-        attribute(:summary, Summary)
+        attribute(:summary, Summary, from: "Summary")
       end
     end
   end

data/lib/peddler/notifications/b2b_any_offer_changed/buy_box_price.rb

@@ -9,28 +9,31 @@ module Peddler
     module B2BAnyOfferChanged
       BuyBoxPrice = Structure.new do
         # @return [String]
-        attribute(:condition, String)
+        attribute(:condition, String, from: "Condition")
 
         # @return [Money]
-        attribute(:listing_price, Money, from: "listingPrice")
+        attribute(:listing_price, Money, from: "ListingPrice")
 
         # @return [String]
-        attribute(:offer_type, String, from: "offerType")
+        attribute(:offer_type, String, from: "OfferType")
 
         # @return [String]
-        attribute(:quantity_tier, String, from: "quantityTier")
+        attribute(:quantity_tier, String, from: "QuantityTier")
 
         # @return [String]
-        attribute?(:discount_type, String, from: "discountType")
+        attribute?(:discount_type, String, from: "DiscountType")
 
         # @return [Money]
-        attribute?(:landed_price, Money, from: "landedPrice")
+        attribute?(:landed_price, Money, from: "LandedPrice")
 
-        # @return [String] The seller identifier for the offer.
-        attribute?(:seller_id, String, from: "sellerId")
+        # @return [Points]
+        attribute?(:points, Points, from: "Points")
+
+        # @return [String] The seller identifier for the offer
+        attribute?(:seller_id, String, from: "SellerId")
 
         # @return [Money]
-        attribute?(:shipping, Money)
+        attribute?(:shipping, Money, from: "Shipping")
       end
     end
   end

data/lib/peddler/notifications/b2b_any_offer_changed/lowest_price.rb

@@ -9,28 +9,31 @@ module Peddler
     module B2BAnyOfferChanged
       LowestPrice = Structure.new do
         # @return [String]
-        attribute(:condition, String)
+        attribute(:condition, String, from: "Condition")
 
         # @return [String]
-        attribute(:fulfillment_channel, String, from: "fulfillmentChannel")
+        attribute(:fulfillment_channel, String, from: "FulfillmentChannel")
 
         # @return [Money]
-        attribute(:listing_price, Money, from: "listingPrice")
+        attribute(:listing_price, Money, from: "ListingPrice")
 
         # @return [String]
-        attribute(:offer_type, String, from: "offerType")
+        attribute(:offer_type, String, from: "OfferType")
 
         # @return [String]
-        attribute(:quantity_tier, String, from: "quantityTier")
+        attribute(:quantity_tier, String, from: "QuantityTier")
 
         # @return [String]
-        attribute?(:discount_type, String, from: "discountType")
+        attribute?(:discount_type, String, from: "DiscountType")
 
         # @return [Money]
-        attribute?(:landed_price, Money, from: "landedPrice")
+        attribute?(:landed_price, Money, from: "LandedPrice")
+
+        # @return [Points]
+        attribute?(:points, Points, from: "Points")
 
         # @return [Money]
-        attribute?(:shipping, Money)
+        attribute?(:shipping, Money, from: "Shipping")
       end
     end
   end

data/lib/peddler/notifications/b2b_any_offer_changed/notification.rb

@@ -9,26 +9,23 @@ module Peddler
     module B2BAnyOfferChanged
       # Notification envelope with metadata
       Notification = Structure.new do
-        # @return [String] The date and time in ISO 8601 format in UTC time that the event which triggered the
-        #   notification occurred.
-        attribute(:event_time, String, from: "eventTime")
+        # @return [String] The date and time (in UTC) that the event which triggered the notification occurred
+        attribute(:event_time, String, from: "EventTime")
 
         # @return [String]
-        attribute(:notification_metadata, String, from: "notificationMetadata")
+        attribute(:notification_metadata, String, from: "NotificationMetadata")
 
-        # @return [String] The notification type. Combined with the payload version this controls the structure of the
-        #   payload object.
-        attribute(:notification_type, String, from: "notificationType")
+        # @return [String] The notification type. Combined with payload version controls the structure of payload object
+        attribute(:notification_type, String, from: "NotificationType")
 
-        # @return [String] The notification version. This controls the structure of the notification.
-        attribute(:notification_version, String, from: "notificationVersion")
+        # @return [String] The notification version. This controls the structure of the notification
+        attribute(:notification_version, String, from: "NotificationVersion")
 
         # @return [Payload]
-        attribute(:payload, Payload)
+        attribute(:payload, Payload, from: "Payload")
 
-        # @return [String] The payload version. Combined with the notification type this controls the structure of the
-        #   payload object.
-        attribute(:payload_version, String, from: "payloadVersion")
+        # @return [String] The payload version. Combined with notification type controls the structure of payload
+        attribute(:payload_version, String, from: "PayloadVersion")
       end
     end
   end

data/lib/peddler/notifications/b2b_any_offer_changed/notification_metadata.rb

@@ -8,17 +8,17 @@ module Peddler
   module Notifications
     module B2BAnyOfferChanged
       NotificationMetadata = Structure.new do
-        # @return [String] The identifier for the application that uses the notifications.
-        attribute(:application_id, String, from: "applicationId")
+        # @return [String] The identifier for the application that uses the notifications
+        attribute(:application_id, String, from: "ApplicationId")
 
-        # @return [String] A unique identifier for this notification instance.
-        attribute(:notification_id, String, from: "notificationId")
+        # @return [String] A unique identifier for this notification instance
+        attribute(:notification_id, String, from: "NotificationId")
 
-        # @return [String] The date and time in ISO 8601 format in UTC time that the notification was sent.
-        attribute(:publish_time, String, from: "publishTime")
+        # @return [String] The date and time (in UTC) that the notification was sent
+        attribute(:publish_time, String, from: "PublishTime")
 
-        # @return [String] A unique identifier for the subscription which resulted in this notification.
-        attribute(:subscription_id, String, from: "subscriptionId")
+        # @return [String] A unique identifier for the subscription which resulted in this notification
+        attribute(:subscription_id, String, from: "SubscriptionId")
       end
     end
   end