subscriptions.rb in peddler-0.7.1

- old
+ new

@@ -11,15 +11,13 @@
     path 'Subscriptions/2013-07-01'
 
     # Registers a new destination to receive notifications
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_RegisterDestination.html
-    # @method register_destination
-    # @overload register_destination(sqs_queue_url, marketplace_id = marketplace_id)
-    #   @param sqs_queue_url [String]
-    #   @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @param sqs_queue_url [String]
+    # @param marketplace_id [String]
+    # @return [Peddler::XMLParser]
     def register_destination(sqs_queue_url, marketplace_id = marketplace_id)
       operation('RegisterDestination')
         .add('MarketplaceId' => marketplace_id)
         .add(build_destination(sqs_queue_url))
 
@@ -27,15 +25,13 @@
     end
 
     # Removes an existing destination from the list of registered destinations
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeregisterDestination.html
-    # @method deregister_destination
-    # @overload deregister_destination(sqs_queue_url, marketplace_id = marketplace_id)
-    #   @param sqs_queue_url [String]
-    #   @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @param sqs_queue_url [String]
+    # @param marketplace_id [String]
+    # @return [Peddler::XMLParser]
     def deregister_destination(sqs_queue_url, marketplace_id = marketplace_id)
       operation('DeregisterDestination')
         .add('MarketplaceId' => marketplace_id)
         .add(build_destination(sqs_queue_url))
 
@@ -44,26 +40,24 @@
 
     # Lists all registered destinations
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListRegisteredDestinations.html
     # @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @return [Peddler::XMLParser]
     def list_registered_destinations( marketplace_id = marketplace_id)
       operation('ListRegisteredDestinations')
         .add('MarketplaceId' => marketplace_id)
 
       run
     end
 
     # Sends a test notification to an existing destination
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_SendTestNotificationToDestination.html
-    # @method send_test_notification_to_destination
-    # @overload send_test_notification_to_destination(sqs_queue_url, marketplace_id = marketplace_id)
-    #   @param sqs_queue_url [String]
-    #   @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @param sqs_queue_url [String]
+    # @param marketplace_id [String]
+    # @return [Peddler::XMLParser]
     def send_test_notification_to_destination(sqs_queue_url, marketplace_id = marketplace_id)
       operation('SendTestNotificationToDestination')
         .add('MarketplaceId' => marketplace_id)
         .add(build_destination(sqs_queue_url))
 
@@ -74,11 +68,11 @@
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_CreateSubscription.html
     # @param notification_type [String]
     # @param sqs_queue_url [String]
     # @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @return [Peddler::XMLParser]
     def create_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id)
       operation('CreateSubscription')
         .add('MarketplaceId' => marketplace_id)
         .add(build_subscription(notification_type, sqs_queue_url))
 
@@ -89,11 +83,11 @@
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_GetSubscription.html
     # @param notification_type [String]
     # @param sqs_queue_url [String]
     # @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @return [Peddler::XMLParser]
     def get_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id)
       operation('GetSubscription')
         .add('MarketplaceId' => marketplace_id, 'NotificationType' => notification_type)
         .add(build_destination(sqs_queue_url))
 
@@ -104,11 +98,11 @@
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeleteSubscription.html
     # @param notification_type [String]
     # @param sqs_queue_url [String]
     # @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @return [Peddler::XMLParser]
     def delete_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id)
       operation('DeleteSubscription')
         .add('MarketplaceId' => marketplace_id, 'NotificationType' => notification_type)
         .add(build_destination(sqs_queue_url))
 
@@ -117,11 +111,11 @@
 
     # Lists current subscriptions
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListSubscriptions.html
     # @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @return [Peddler::XMLParser]
     def list_subscriptions(marketplace_id = marketplace_id)
       operation('ListSubscriptions')
         .add('MarketplaceId' => marketplace_id)
 
       run
@@ -132,11 +126,11 @@
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_UpdateSubscription.html
     # @param notification_type [String]
     # @param sqs_queue_url [String]
     # @param enabled [Boolean]
     # @param marketplace_id [String]
-    # @return [Peddler::Parser]
+    # @return [Peddler::XMLParser]
     def update_subscription(notification_type, sqs_queue_url, enabled, marketplace_id = marketplace_id)
       operation('CreateSubscription')
         .add('MarketplaceId' => marketplace_id)
         .add(build_subscription(notification_type, sqs_queue_url, enabled))
 
@@ -144,10 +138,10 @@
     end
 
     # Gets the service status of the API
     #
     # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_GetServiceStatus.html
-    # @return [Peddler::Parser]
+    # @return [Peddler::XMLParser]
     def get_service_status
       operation('GetServiceStatus')
       run
     end
 