Module: Peddler::Notifications::ReportProcessingFinished

Defined in:

lib/peddler/notifications/report_processing_finished.rb,
lib/peddler/notifications/report_processing_finished/payload.rb,
lib/peddler/notifications/report_processing_finished/notification.rb,
lib/peddler/notifications/report_processing_finished/report_processing_finished_notification.rb

Overview

The root schema comprises the entire JSON document.

Constant Summary

Payload =

Notification payload that wraps nested notification data

Structure.new do
  # @return [ReportProcessingFinishedNotification]
  attribute(:report_processing_finished_notification, ReportProcessingFinishedNotification, from: "reportProcessingFinishedNotification")
end

Notification =

The root schema comprises the entire JSON document.

Structure.new do
  # @return [String] The timestamp of the event, formatted as ISO 8601 date-time.
  attribute(:event_time, String, from: "eventTime")

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

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

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

  # @return [Payload] The details of this notification.
  attribute(:payload, Payload)

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

ReportProcessingFinishedNotification =

Nested notification data

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

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

  # @return [String] The report identifier.
  attribute(:report_id, String, from: "reportId")

  # @return [String] The report type.
  attribute(:report_type, String, from: "reportType")

  # @return [String] The report document identifier. This identifier is unique only in combination with a seller
  # ID.
  attribute?(:report_document_id, String, from: "reportDocumentId")

  # @return [String] The merchant customer identifier of the selling partner account on whose behalf the report
  # was submitted. This field will be null when the report was submitted on behalf of a vendor group identifier.
  attribute?(:seller_id, String, from: "sellerId")
end

Class Method Summary

• .parse(hash) ⇒ Object

Class Method Details

.parse(hash) ⇒ Object

# File 'lib/peddler/notifications/report_processing_finished.rb', line 12

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