Module: Peddler::Notifications::DataKioskQueryProcessingFinished

Defined in:
lib/peddler/notifications/data_kiosk_query_processing_finished.rb,
lib/peddler/notifications/data_kiosk_query_processing_finished/payload.rb,
lib/peddler/notifications/data_kiosk_query_processing_finished/notification.rb

Overview

Data Kiosk Query Processing Finished Notification.

This notification is delivered when a Data Kiosk query finishes processing.

Constant Summary collapse

Payload =

Notification payload data

Structure.new do
  # @return [String] The merchant customer identifier or vendor group identifier of the selling partner account on
  # whose behalf the query was submitted.
  attribute(:account_id, String, from: "accountId")

  # @return [String] The processing status of the query.
  attribute(:processing_status, String, from: "processingStatus")

  # @return [String] The submitted query.
  attribute(:query, String)

  # @return [String] The query identifier. This identifier is unique only in combination with the `accountId`.
  attribute(:query_id, String, from: "queryId")

  # @return [String] The data document identifier. This document identifier is only present when there is data
  # available as a result of the query. This identifier is unique only in combination with the `accountId`. Pass
  # this identifier into the `getDocument` operation to get the information required to retrieve the data
  # document's contents.
  attribute?(:data_document_id, String, from: "dataDocumentId")

  # @return [String] The error document identifier. This document identifier is only present when an error occurs
  # during query processing. This identifier is unique only in combination with the `accountId`. Pass this
  # identifier into the `getDocument` operation to get the information required to retrieve the error document's
  # contents.
  attribute?(:error_document_id, String, from: "errorDocumentId")

  # @return [Hash] When a query produces results that are not included in the data document, pagination occurs.
  # This means that results are divided into pages. To retrieve the next page, you must pass a
  # `CreateQuerySpecification` object with `paginationToken` set to this object's `nextToken` and with `query` set
  # to this object's `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the
  # `nextToken` field will be absent.
  attribute?(:pagination, Hash)
end
Notification =

This notification is delivered when a Data Kiosk query finishes processing.

Structure.new do
  # @return [String] The time the notification was sent in ISO 8601 format.
  attribute(:event_time, String, from: "eventTime")

  # @return [Hash] The notification's metadata.
  attribute(:notification_metadata, Hash, from: "notificationMetadata")

  # @return [String] The notification type.
  attribute(:notification_type, String, from: "notificationType")

  # @return [String] The notification version.
  attribute(:notification_version, String, from: "notificationVersion")

  # @return [Payload] The Data Kiosk query processing notification payload.
  attribute(:payload, Payload)

  # @return [String] The payload version of the notification.
  attribute(:payload_version, String, from: "payloadVersion")
end

Class Method Summary collapse

Class Method Details

.parse(hash) ⇒ Object 



12
13
14
 
# File 'lib/peddler/notifications/data_kiosk_query_processing_finished.rb', line 12

def parse(hash)
  Notification.parse(hash)
end