Class: Peddler::APIs::ApplicationIntegrations20240401

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/application_integrations_2024_04_01.rb,
lib/peddler/apis/application_integrations_2024_04_01/error.rb,
lib/peddler/apis/application_integrations_2024_04_01/error_list.rb,
lib/peddler/apis/application_integrations_2024_04_01/create_notification_request.rb,
lib/peddler/apis/application_integrations_2024_04_01/create_notification_response.rb,
lib/peddler/apis/application_integrations_2024_04_01/delete_notifications_request.rb,
lib/peddler/apis/application_integrations_2024_04_01/record_action_feedback_request.rb,
sig/peddler/apis/application_integrations_2024_04_01.rbs

Overview

The Selling Partner API for third party application integrations.

With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.

See Also:

Defined Under Namespace

Classes: CreateNotificationRequest, CreateNotificationResponse, DeleteNotificationsRequest, Error, ErrorList, RecordActionFeedbackRequest

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#create_notification(body, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Create a notification for sellers in Seller Central.

Parameters:

  • body (Hash) —

    The request body for the createNotification operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 1.0)

Returns:



20
21
22
23
24
 
# File 'lib/peddler/apis/application_integrations_2024_04_01.rb', line 20

def create_notification(body, rate_limit: 1.0)
  path = "/appIntegrations/2024-04-01/notifications"
  parser = -> { CreateNotificationResponse }
  post(path, body:, rate_limit:, parser:)
end

#delete_notifications(body, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Remove your application's notifications from the Appstore notifications dashboard.

Parameters:

  • body (Hash) —

    The request body for the deleteNotifications operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 1.0)

Returns:



32
33
34
35
 
# File 'lib/peddler/apis/application_integrations_2024_04_01.rb', line 32

def delete_notifications(body, rate_limit: 1.0)
  path = "/appIntegrations/2024-04-01/notifications/deletion"
  post(path, body:, rate_limit:)
end

#record_action_feedback(notification_id, body, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Records the seller's response to a notification.

Parameters:

  • notification_id (String) —

    A notificationId uniquely identifies a notification.

  • body (Hash) —

    The request body for the recordActionFeedback operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

  • (String)
  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 1.0)

Returns:



44
45
46
47
 
# File 'lib/peddler/apis/application_integrations_2024_04_01.rb', line 44

def record_action_feedback(notification_id, body, rate_limit: 1.0)
  path = "/appIntegrations/2024-04-01/notifications/#{percent_encode(notification_id)}/feedback"
  post(path, body:, rate_limit:)
end