Class: MWS::Subscriptions::Client
- Inherits:
-
Peddler::Client
- Object
- Peddler::Client
- MWS::Subscriptions::Client
- Defined in:
- lib/mws/subscriptions/client.rb
Overview
The Amazon MWS Subscriptions API section enables you to subscribe to receive notifications that are relevant to your business with Amazon. With 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.
Constant Summary
Constants inherited from Peddler::Client
Peddler::Client::BadMarketplaceId, Peddler::Client::HOSTS
Instance Attribute Summary
Attributes inherited from Peddler::Client
#body, #marketplace_id, #merchant_id, #path
Instance Method Summary collapse
-
#create_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Creates a new subscription.
-
#delete_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Deletes a subscription.
-
#deregister_destination(sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Removes an existing destination from the list of registered destinations.
-
#get_service_status ⇒ Peddler::XMLParser
Gets the service status of the API.
-
#get_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Gets a subscription.
-
#list_registered_destinations(marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Lists all registered destinations.
-
#list_subscriptions(marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Lists current subscriptions.
-
#register_destination(sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Registers a new destination to receive notifications.
-
#send_test_notification_to_destination(sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Sends a test notification to an existing destination.
-
#update_subscription(notification_type, sqs_queue_url, enabled, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Updates a subscription.
Methods inherited from Peddler::Client
#aws_endpoint, #defaults, #headers, inherited, #initialize, #operation, parser, parser=, path, #run
Constructor Details
This class inherits a constructor from Peddler::Client
Instance Method Details
#create_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Creates a new subscription
75 76 77 78 79 80 81 |
# File 'lib/mws/subscriptions/client.rb', line 75 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)) run end |
#delete_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Deletes a subscription
108 109 110 111 112 113 114 115 116 117 |
# File 'lib/mws/subscriptions/client.rb', line 108 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)) run end |
#deregister_destination(sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Removes an existing destination from the list of registered destinations
34 35 36 37 38 39 40 |
# File 'lib/mws/subscriptions/client.rb', line 34 def deregister_destination(sqs_queue_url, marketplace_id = marketplace_id) operation('DeregisterDestination') .add('MarketplaceId' => marketplace_id) .add(build_destination(sqs_queue_url)) run end |
#get_service_status ⇒ Peddler::XMLParser
Gets the service status of the API
151 152 153 154 |
# File 'lib/mws/subscriptions/client.rb', line 151 def get_service_status operation('GetServiceStatus') run end |
#get_subscription(notification_type, sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Gets a subscription
90 91 92 93 94 95 96 97 98 99 |
# File 'lib/mws/subscriptions/client.rb', line 90 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)) run end |
#list_registered_destinations(marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Lists all registered destinations
47 48 49 50 51 52 |
# File 'lib/mws/subscriptions/client.rb', line 47 def list_registered_destinations(marketplace_id = marketplace_id) operation('ListRegisteredDestinations') .add('MarketplaceId' => marketplace_id) run end |
#list_subscriptions(marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Lists current subscriptions
124 125 126 127 128 129 |
# File 'lib/mws/subscriptions/client.rb', line 124 def list_subscriptions(marketplace_id = marketplace_id) operation('ListSubscriptions') .add('MarketplaceId' => marketplace_id) run end |
#register_destination(sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Registers a new destination to receive notifications
20 21 22 23 24 25 26 |
# File 'lib/mws/subscriptions/client.rb', line 20 def register_destination(sqs_queue_url, marketplace_id = marketplace_id) operation('RegisterDestination') .add('MarketplaceId' => marketplace_id) .add(build_destination(sqs_queue_url)) run end |
#send_test_notification_to_destination(sqs_queue_url, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Sends a test notification to an existing destination
60 61 62 63 64 65 66 |
# File 'lib/mws/subscriptions/client.rb', line 60 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)) run end |
#update_subscription(notification_type, sqs_queue_url, enabled, marketplace_id = marketplace_id) ⇒ Peddler::XMLParser
Updates a subscription
139 140 141 142 143 144 145 |
# File 'lib/mws/subscriptions/client.rb', line 139 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)) run end |