Module: Peddler::Types::SolicitationsV1

Defined in:

lib/peddler/types/solicitations_v1/error.rb,
lib/peddler/types/solicitations_v1/schema.rb,
lib/peddler/types/solicitations_v1/link_object.rb,
lib/peddler/types/solicitations_v1/get_schema_response.rb,
lib/peddler/types/solicitations_v1/solicitations_action.rb,
lib/peddler/types/solicitations_v1/get_solicitation_action_response.rb,
lib/peddler/types/solicitations_v1/get_solicitation_actions_for_order_response.rb,
lib/peddler/types/solicitations_v1/create_product_review_and_seller_feedback_solicitation_response.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

Schema =

A JSON schema document describing the expected payload of the action. This object can be validated against http://json-schema.org/draft-04/schema.

Structure.new do
end

LinkObject =

A Link object.

Structure.new do
  # @return [String] A URI for this object.
  attribute(:href, String)

  # @return [String] An identifier for this object.
  attribute(:name, String)
end

GetSchemaResponse =

Structure.new do
  # @return [Hash]
  attribute(:_links, Hash)

  # @return [Schema]
  attribute(:payload, Schema)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

SolicitationsAction =

A simple object containing the name of the template.

Structure.new do
  # @return [String]
  attribute(:name, String)
end

GetSolicitationActionResponse =

Describes a solicitation action that can be taken for an order. Provides a JSON Hypertext Application Language (HAL) link to the JSON schema document that describes the expected input.

Structure.new do
  # @return [Hash]
  attribute(:_links, Hash)

  # @return [Hash]
  attribute(:_embedded, Hash)

  # @return [SolicitationsAction]
  attribute(:payload, SolicitationsAction)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

GetSolicitationActionsForOrderResponse =

The response schema for the getSolicitationActionsForOrder operation.

Structure.new do
  # @return [Hash]
  attribute(:_links, Hash)

  # @return [Hash]
  attribute(:_embedded, Hash)

  # @return [Array<Error>]
  attribute(:errors, [Error])
end

CreateProductReviewAndSellerFeedbackSolicitationResponse =

The response schema for the createProductReviewAndSellerFeedbackSolicitation operation.

Structure.new do
  # @return [Array<Error>]
  attribute(:errors, [Error])
end