peddler 2.4.5 → 3.0.0

data/lib/peddler/api/messaging_v1.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def messaging_v1(...)
+      API::MessagingV1.new(...)
+    end
+  end
+
+  class API
+    # Selling Partner API for Messaging
+    #
+    # With the Messaging API you can build applications that send messages to buyers. You can get a list of message
+    # types that are available for an order that you specify, then call an operation that sends a message to the buyer
+    # for that order. The Messaging API returns responses that are formed according to the <a
+    # href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language</a> (HAL) standard.
+    class MessagingV1 < API
+      # Returns a list of message types that are available for an order that you specify. A message type is represented
+      # by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to
+      # call an operation that sends a message.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which you want a list
+      #   of available message types.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def get_messaging_actions_for_order(amazon_order_id, marketplace_ids, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Sends a message asking a buyer to provide or verify customization details such as name spelling, images,
+      # initials, etc.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def confirm_customization_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmCustomizationDetails"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_confirm_delivery_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmDeliveryDetails"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer.
+      # This message should only be used to deliver documents that are required by law.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_legal_disclosure(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/legalDisclosure"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be
+      # sent after the seller has resolved the buyer's problem.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_negative_feedback_removal(amazon_order_id, marketplace_ids, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/negativeFeedbackRemoval"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, params:)
+      end
+
+      # Sends a message to ask a buyer an order-related question prior to shipping their order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_confirm_order_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmOrderDetails"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a
+      # service call.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_confirm_service_details(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/confirmServiceDetails"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by
+      # Amazon Motors sellers.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_amazon_motors(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/amazonMotors"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a message to a buyer to provide details about warranty information on a purchase in their order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_warranty(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/warranty"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Returns a response containing attributes related to an order. This includes buyer preferences.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def get_attributes(amazon_order_id, marketplace_ids, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/attributes"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Sends a message to a buyer to share a digital access key needed to utilize digital content in their order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_digital_access_key(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/digitalAccessKey"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the
+      # order.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_unexpected_problem(amazon_order_id, marketplace_ids, body, rate_limit: 1.0)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/unexpectedProblem"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        meter(rate_limit).post(path, body:, params:)
+      end
+
+      # Sends a message providing the buyer an invoice
+      #
+      # @note This operation can make a static sandbox call.
+      # @param amazon_order_id [String] An Amazon order identifier. This specifies the order for which a message is
+      #   sent.
+      # @param marketplace_ids [Array<String>] A marketplace identifier. This specifies the marketplace in which the
+      #   order was placed. Only one marketplace can be specified.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def send_invoice(amazon_order_id, marketplace_ids, body, rate_limit: nil)
+        path = "/messaging/v1/orders/#{amazon_order_id}/messages/invoice"
+        params = {
+          "marketplaceIds" => marketplace_ids,
+        }.compact
+
+        post(path, body:, params:)
+      end
+    end
+  end
+end

data/lib/peddler/api/notifications_v1.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "peddler/api"
+
+module Peddler
+  class << self
+    def notifications_v1(...)
+      API::NotificationsV1.new(...)
+    end
+  end
+
+  class API
+    # Selling Partner API for Notifications
+    #
+    # The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling
+    # partner's business. Using this API you can create a destination to receive notifications, subscribe to
+    # notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use
+    # Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
+    class NotificationsV1 < API
+      # Returns information about subscription of the specified notification type and payload version. `payloadVersion`
+      # is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version
+      # subscription's information. You can use this API to get subscription information when you do not have a
+      # subscription identifier.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param payload_version [String] The version of the payload object to be used in the notification.
+      # @param rate_limit [Float] Requests per second
+      # @param notification_type [String] The type of notification. For more information about notification types, refer
+      #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
+      # @return [Hash] The API response
+      def get_subscription(notification_type, payload_version: nil, rate_limit: 1.0)
+        path = "/notifications/v1/subscriptions/#{notification_type}"
+        params = {
+          "payloadVersion" => payload_version,
+        }.compact
+
+        meter(rate_limit).get(path, params:)
+      end
+
+      # Creates a subscription for the specified notification type to be delivered to the specified destination. Before
+      # you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases
+      # where the specified notification type supports multiple payload versions, you can utilize this API to subscribe
+      # to a different payload version if you already have an existing subscription for a different payload version.
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @param notification_type [String] The type of notification. For more information about notification types, refer
+      #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
+      # @return [Hash] The API response
+      def create_subscription(body, notification_type, rate_limit: 1.0)
+        path = "/notifications/v1/subscriptions/#{notification_type}"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Returns information about a subscription for the specified notification type. The `getSubscriptionById`
+      # operation is grantless. For more information, refer to [Grantless
+      # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+      #
+      # @note This operation can make a static sandbox call.
+      # @param subscription_id [String] The identifier for the subscription that you want to get.
+      # @param rate_limit [Float] Requests per second
+      # @param notification_type [String] The type of notification. For more information about notification types, refer
+      #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
+      # @return [Hash] The API response
+      def get_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0)
+        path = "/notifications/v1/subscriptions/#{notification_type}/#{subscription_id}"
+
+        meter(rate_limit).get(path)
+      end
+
+      # Deletes the subscription indicated by the subscription identifier and notification type that you specify. The
+      # subscription identifier can be for any subscription associated with your application. After you successfully
+      # call this operation, notifications will stop being sent for the associated subscription. The
+      # `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless
+      # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+      #
+      # @note This operation can make a static sandbox call.
+      # @param subscription_id [String] The identifier for the subscription that you want to delete.
+      # @param rate_limit [Float] Requests per second
+      # @param notification_type [String] The type of notification. For more information about notification types, refer
+      #   to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
+      # @return [Hash] The API response
+      def delete_subscription_by_id(subscription_id, notification_type, rate_limit: 1.0)
+        path = "/notifications/v1/subscriptions/#{notification_type}/#{subscription_id}"
+
+        meter(rate_limit).delete(path)
+      end
+
+      # Returns information about all destinations. The `getDestinations` operation is grantless. For more information,
+      # refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+      #
+      # @note This operation can make a static sandbox call.
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def get_destinations(rate_limit: 1.0)
+        path = "/notifications/v1/destinations"
+
+        meter(rate_limit).get(path)
+      end
+
+      # Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For
+      # more information, refer to [Grantless
+      # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+      #
+      # @note This operation can make a static sandbox call.
+      # @param body [Hash]
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def create_destination(body, rate_limit: 1.0)
+        path = "/notifications/v1/destinations"
+
+        meter(rate_limit).post(path, body:)
+      end
+
+      # Returns information about the destination that you specify. The `getDestination` operation is grantless. For
+      # more information, refer to [Grantless
+      # operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+      #
+      # @note This operation can make a static sandbox call.
+      # @param destination_id [String] The identifier generated when you created the destination.
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def get_destination(destination_id, rate_limit: 1.0)
+        path = "/notifications/v1/destinations/#{destination_id}"
+
+        meter(rate_limit).get(path)
+      end
+
+      # Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information,
+      # refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations).
+      #
+      # @note This operation can make a static sandbox call.
+      # @param destination_id [String] The identifier for the destination that you want to delete.
+      # @param rate_limit [Float] Requests per second
+      # @return [Hash] The API response
+      def delete_destination(destination_id, rate_limit: 1.0)
+        path = "/notifications/v1/destinations/#{destination_id}"
+
+        meter(rate_limit).delete(path)
+      end
+    end
+  end
+end