client.rb in peddler-1.3.0

- old
+ new

@@ -7,18 +7,18 @@
     # the operations in the Subscriptions API section, you can register to
     # receive important information from Amazon without having to poll the
     # Amazon MWS service. Instead, the information is sent directly to you when
     # an event occurs to which you are subscribed.
     class Client < ::Peddler::Client
-      version "2013-07-01"
+      version '2013-07-01'
       path "/Subscriptions/#{version}"
 
       # Registers a new destination to receive notifications
       #
       # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_RegisterDestination.html
-      # @param sqs_queue_url [String]
-      # @param marketplace_id [String]
+      # @param [String] sqs_queue_url
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def register_destination(sqs_queue_url, marketplace_id = primary_marketplace_id)
         operation('RegisterDestination')
           .add('MarketplaceId' => marketplace_id)
           .add(build_destination(sqs_queue_url))
@@ -27,12 +27,12 @@
       end
 
       # Removes an existing destination from the list of registered destinations
       #
       # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeregisterDestination.html
-      # @param sqs_queue_url [String]
-      # @param marketplace_id [String]
+      # @param [String] sqs_queue_url
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def deregister_destination(sqs_queue_url, marketplace_id = primary_marketplace_id)
         operation('DeregisterDestination')
           .add('MarketplaceId' => marketplace_id)
           .add(build_destination(sqs_queue_url))
@@ -41,11 +41,11 @@
       end
 
       # Lists all registered destinations
       #
       # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListRegisteredDestinations.html
-      # @param marketplace_id [String]
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def list_registered_destinations(marketplace_id = primary_marketplace_id)
         operation('ListRegisteredDestinations')
           .add('MarketplaceId' => marketplace_id)
 
@@ -53,12 +53,12 @@
       end
 
       # Sends a test notification to an existing destination
       #
       # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_SendTestNotificationToDestination.html
-      # @param sqs_queue_url [String]
-      # @param marketplace_id [String]
+      # @param [String] sqs_queue_url
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def send_test_notification_to_destination(sqs_queue_url, marketplace_id = primary_marketplace_id)
         operation('SendTestNotificationToDestination')
           .add('MarketplaceId' => marketplace_id)
           .add(build_destination(sqs_queue_url))
@@ -67,13 +67,13 @@
       end
 
       # Creates a new subscription
       #
       # @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]
+      # @param [String] notification_type
+      # @param [String] sqs_queue_url
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def create_subscription(notification_type, sqs_queue_url, marketplace_id = primary_marketplace_id)
         operation('CreateSubscription')
           .add('MarketplaceId' => marketplace_id)
           .add(build_subscription(notification_type, sqs_queue_url))
@@ -82,13 +82,13 @@
       end
 
       # Gets a subscription
       #
       # @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]
+      # @param [String] notification_type
+      # @param [String] sqs_queue_url
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def get_subscription(notification_type, sqs_queue_url, marketplace_id = primary_marketplace_id)
         operation('GetSubscription')
           .add(
             'MarketplaceId' => marketplace_id,
@@ -100,13 +100,13 @@
       end
 
       # Deletes a subscription
       #
       # @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]
+      # @param [String] notification_type
+      # @param [String] sqs_queue_url
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def delete_subscription(notification_type, sqs_queue_url, marketplace_id = primary_marketplace_id)
         operation('DeleteSubscription')
           .add(
             'MarketplaceId' => marketplace_id,
@@ -118,11 +118,11 @@
       end
 
       # Lists current subscriptions
       #
       # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListSubscriptions.html
-      # @param marketplace_id [String]
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def list_subscriptions(marketplace_id = primary_marketplace_id)
         operation('ListSubscriptions')
           .add('MarketplaceId' => marketplace_id)
 
@@ -130,13 +130,13 @@
       end
 
       # Updates a subscription
       #
       # @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]
+      # @param [String] notification_type
+      # @param [String] sqs_queue_url
+      # @param [Boolean] enabled
+      # @param [String] marketplace_id
       # @return [Peddler::XMLParser]
       def update_subscription(notification_type, sqs_queue_url, enabled, marketplace_id = primary_marketplace_id)
         operation('UpdateSubscription')
           .add('MarketplaceId' => marketplace_id)
           .add(build_subscription(notification_type, sqs_queue_url, enabled))