Module: Peddler::Types::Feeds20210630

Defined in:

lib/peddler/types/feeds_2021_06_30/feed.rb,
lib/peddler/types/feeds_2021_06_30/error.rb,
lib/peddler/types/feeds_2021_06_30/error_list.rb,
lib/peddler/types/feeds_2021_06_30/feed_options.rb,
lib/peddler/types/feeds_2021_06_30/feed_document.rb,
lib/peddler/types/feeds_2021_06_30/get_feeds_response.rb,
lib/peddler/types/feeds_2021_06_30/create_feed_response.rb,
lib/peddler/types/feeds_2021_06_30/create_feed_specification.rb,
lib/peddler/types/feeds_2021_06_30/create_feed_document_response.rb,
lib/peddler/types/feeds_2021_06_30/create_feed_document_specification.rb

Constant Summary

Feed =

Detailed information about the feed.

Structure.new do
  # @return [String] The identifier for the feed. This identifier is unique only in combination with a seller ID.
  attribute(:feed_id, String, from: "feedId")

  # @return [String] The feed type.
  attribute(:feed_type, String, from: "feedType")

  # @return [Array<String>] A list of identifiers for the marketplaces that the feed is applied to.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [String] The date and time when the feed was created, in ISO 8601 date time format.
  attribute(:created_time, String, from: "createdTime")

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

  # @return [String] The date and time when feed processing started, in ISO 8601 date time format.
  attribute(:processing_start_time, String, from: "processingStartTime")

  # @return [String] The date and time when feed processing completed, in ISO 8601 date time format.
  attribute(:processing_end_time, String, from: "processingEndTime")

  # @return [String] The identifier for the feed document. This identifier is unique only in combination with a
  # seller ID.
  attribute(:result_feed_document_id, String, from: "resultFeedDocumentId")
end

Error =

An 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>] An error response returned when the request is unsuccessful.
  attribute(:errors, [Error])
end

FeedOptions =

Additional options to control the feed. These vary by feed type.

Structure.new do
end

FeedDocument =

Information required for the feed document.

Structure.new do
  # @return [String] The identifier for the feed document. This identifier is unique only in combination with a
  # seller ID.
  attribute(:feed_document_id, String, from: "feedDocumentId")

  # @return [String] A presigned URL for the feed document. If `compressionAlgorithm` is not returned, you can
  # download the feed directly from this URL. This URL expires after 5 minutes.
  attribute(:url, String)

  # @return [String] If the feed document contents have been compressed, the compression algorithm used is
  # returned in this property and you must decompress the feed when you download. Otherwise, you can download the
  # feed directly. Refer to [Step 7. Download the feed processing
  # report](doc:feeds-api-v2021-06-30-use-case-guide#step-7-download-the-feed-processing-report) in the use case
  # guide, where sample code is provided.
  attribute(:compression_algorithm, String, from: "compressionAlgorithm")
end

GetFeedsResponse =

Response schema.

Structure.new do
  # @return [Array<Feed>] The feeds.
  attribute(:feeds, [Feed])

  # @return [String] Returned when the number of results exceeds pageSize. To get the next page of results, call
  # the getFeeds operation with this token as the only parameter.
  attribute(:next_token, String, from: "nextToken")
end

CreateFeedResponse =

Response schema.

Structure.new do
  # @return [String] The identifier for the feed. This identifier is unique only in combination with a seller ID.
  attribute(:feed_id, String, from: "feedId")
end

CreateFeedSpecification =

Information required to create the feed.

Structure.new do
  # @return [String] The feed type.
  attribute(:feed_type, String, from: "feedType")

  # @return [Array<String>] A list of identifiers for marketplaces that you want the feed to be applied to.
  attribute(:marketplace_ids, [String], from: "marketplaceIds")

  # @return [String] The document identifier returned by the createFeedDocument operation. Upload the feed
  # document contents before calling the createFeed operation.
  attribute(:input_feed_document_id, String, from: "inputFeedDocumentId")

  # @return [FeedOptions]
  attribute(:feed_options, FeedOptions, from: "feedOptions")
end

CreateFeedDocumentResponse =

Information required to upload a feed document's contents.

Structure.new do
  # @return [String] The identifier of the feed document.
  attribute(:feed_document_id, String, from: "feedDocumentId")

  # @return [String] The presigned URL for uploading the feed contents. This URL expires after 5 minutes.
  attribute(:url, String)
end

CreateFeedDocumentSpecification =

Specifies the content type for the createFeedDocument operation.

Structure.new do
  # @return [String] The content type of the feed.
  attribute(:content_type, String, from: "contentType")
end