Module: Peddler::Types::ApplicationIntegrations20240401

Defined in:

lib/peddler/types/application_integrations_2024_04_01/error.rb,
lib/peddler/types/application_integrations_2024_04_01/error_list.rb,
lib/peddler/types/application_integrations_2024_04_01/notification_parameters.rb,
lib/peddler/types/application_integrations_2024_04_01/create_notification_request.rb,
lib/peddler/types/application_integrations_2024_04_01/create_notification_response.rb,
lib/peddler/types/application_integrations_2024_04_01/delete_notifications_request.rb,
lib/peddler/types/application_integrations_2024_04_01/record_action_feedback_request.rb

Constant Summary

Error =

Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

ErrorList =

A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>] Error response returned when the request is unsuccessful.
  attribute(:errors, [Error])
end

NotificationParameters =

The dynamic parameters required by the notification templated specified by templateId.

Structure.new do
end

CreateNotificationRequest =

The request for the createNotification operation.

Structure.new do
  # @return [String] The unique identifier of the notification template you used to onboard your application.
  attribute(:template_id, String, from: "templateId")

  # @return [NotificationParameters] The parameters specified in the template you used to onboard your
  # application.
  attribute(:notification_parameters, NotificationParameters, from: "notificationParameters")

  # @return [String] An encrypted marketplace identifier for the posted notification.
  attribute(:marketplace_id, String, from: "marketplaceId")
end

CreateNotificationResponse =

The response for the createNotification operation.

Structure.new do
  # @return [String] The unique identifier assigned to each notification.
  attribute(:notification_id, String, from: "notificationId")
end

DeleteNotificationsRequest =

The request for the deleteNotifications operation.

Structure.new do
  # @return [String] The unique identifier of the notification template you used to onboard your application.
  attribute(:template_id, String, from: "templateId")

  # @return [String] The unique identifier that maps each notification status to a reason code.
  attribute(:deletion_reason, String, from: "deletionReason")
end

RecordActionFeedbackRequest =

The request for the recordActionFeedback operation.

Structure.new do
  # @return [String] The unique identifier for each notification status.
  attribute(:feedback_action_code, String, from: "feedbackActionCode")
end