Class: Peddler::APIs::Feeds20210630

Inherits:
Peddler::API show all
Includes:
Helpers::Feeds20210630
Defined in:
lib/peddler/apis/feeds_2021_06_30.rb,
lib/peddler/apis/feeds_2021_06_30/feed.rb,
lib/peddler/apis/feeds_2021_06_30/error.rb,
lib/peddler/apis/feeds_2021_06_30/feed_list.rb,
lib/peddler/apis/feeds_2021_06_30/error_list.rb,
lib/peddler/apis/feeds_2021_06_30/feed_document.rb,
lib/peddler/apis/feeds_2021_06_30/get_feeds_response.rb,
lib/peddler/apis/feeds_2021_06_30/create_feed_response.rb,
lib/peddler/apis/feeds_2021_06_30/create_feed_specification.rb,
lib/peddler/apis/feeds_2021_06_30/create_feed_document_response.rb,
lib/peddler/apis/feeds_2021_06_30/create_feed_document_specification.rb,
sig/peddler/apis/feeds_2021_06_30.rbs

Overview

Selling Partner API for Feeds

The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.

See Also:

Defined Under Namespace

Classes: CreateFeedDocumentResponse, CreateFeedDocumentSpecification, CreateFeedResponse, CreateFeedSpecification, Error, ErrorList, Feed, FeedDocument, FeedList, GetFeedsResponse

Constant Summary

Constants inherited from Peddler::API

Peddler::API::TRANSIENT_STATUSES

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #base_url, #endpoint, #retries

Instance Method Summary collapse

Methods included from Helpers::Feeds20210630

#download_result_feed_document, #upload_feed_document

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #host_header, #http, #initialize, #must_sandbox!, #parse_base_url, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#cancel_feed(feed_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations.

Parameters:

  • feed_id (String) —

    The identifier for the feed. This identifier is unique only in combination with a seller ID.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



73
74
75
76
 
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 73

def cancel_feed(feed_id, rate_limit: 2.0)
  path = "/feeds/2021-06-30/feeds/#{percent_encode(feed_id)}"
  delete(path, rate_limit:)
end

#create_feed(body, rate_limit: 0.0083) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Creates a feed. Upload the contents of the feed document before calling this operation.

Parameters:

  • body (Hash) —

    Information required to create the feed.

  • rate_limit (Float) (defaults to: 0.0083) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 0.0083)

Returns:



58
59
60
61
62
 
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 58

def create_feed(body, rate_limit: 0.0083)
  path = "/feeds/2021-06-30/feeds"
  parser = -> { CreateFeedResponse }
  post(path, body:, rate_limit:, parser:)
end

#create_feed_document(body, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation.

Parameters:

  • body (Hash) —

    Specifies the content type for the createFeedDocument operation.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 0.5)

Returns:



99
100
101
102
103
 
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 99

def create_feed_document(body, rate_limit: 0.5)
  path = "/feeds/2021-06-30/documents"
  parser = -> { CreateFeedDocumentResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_feed(feed_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns feed details (including the feedDocumentId, if available) for the feed that you specify.

Parameters:

  • feed_id (String) —

    The identifier for the feed. This identifier is unique only in combination with a seller ID.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



85
86
87
88
89
 
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 85

def get_feed(feed_id, rate_limit: 2.0)
  path = "/feeds/2021-06-30/feeds/#{percent_encode(feed_id)}"
  parser = -> { Feed }
  get(path, rate_limit:, parser:)
end

#get_feed_document(feed_document_id, enable_content_encoding_url_header: nil, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the information required for retrieving a feed document's contents.

Parameters:

  • feed_document_id (String) —

    The identifier of the feed document.

  • enable_content_encoding_url_header (Boolean) (defaults to: nil) —

    When true, the Content-Encoding header on the returned URL is set to gzip instead of the default identity when compressionAlgorithm is GZIP. This allows automatic decompression by HTTP clients.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • (String)
  • enable_content_encoding_url_header: (Boolean, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



114
115
116
117
118
119
120
121
 
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 114

def get_feed_document(feed_document_id, enable_content_encoding_url_header: nil, rate_limit: 0.0222)
  path = "/feeds/2021-06-30/documents/#{percent_encode(feed_document_id)}"
  params = {
    "enableContentEncodingUrlHeader" => enable_content_encoding_url_header,
  }.compact
  parser = -> { FeedDocument }
  get(path, params:, rate_limit:, parser:)
end

#get_feeds(feed_types: nil, marketplace_ids: nil, page_size: 10, processing_statuses: nil, created_since: nil, created_until: nil, next_token: nil, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns feed details for the feeds that match the filters that you specify.

Parameters:

  • feed_types (Array<String>) (defaults to: nil) —

    A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.

  • marketplace_ids (Array<String>) (defaults to: nil) —

    A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.

  • page_size (Integer) (defaults to: 10) —

    The maximum number of feeds to return in a single call.

  • processing_statuses (Array<String>) (defaults to: nil) —

    A list of processing statuses used to filter feeds. Known values: CANCELLED, DONE, FATAL, IN_PROGRESS, IN_QUEUE.

  • created_since (String) (defaults to: nil) —

    The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.

  • created_until (String) (defaults to: nil) —

    The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.

  • next_token (String) (defaults to: nil) —

    A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.

  • rate_limit (Float) (defaults to: 0.0222) —

    Requests per second

  • feed_types: (Array[String], nil) (defaults to: nil)
  • marketplace_ids: (Array[String], nil) (defaults to: nil)
  • page_size: (Integer, nil) (defaults to: 10)
  • processing_statuses: (Array[String], nil) (defaults to: nil)
  • created_since: (String, nil) (defaults to: nil)
  • created_until: (String, nil) (defaults to: nil)
  • next_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 36

def get_feeds(feed_types: nil, marketplace_ids: nil, page_size: 10, processing_statuses: nil, created_since: nil,
  created_until: nil, next_token: nil, rate_limit: 0.0222)
  path = "/feeds/2021-06-30/feeds"
  params = {
    "feedTypes" => stringify_array(feed_types),
    "marketplaceIds" => stringify_array(marketplace_ids),
    "pageSize" => page_size,
    "processingStatuses" => stringify_array(processing_statuses),
    "createdSince" => created_since,
    "createdUntil" => created_until,
    "nextToken" => next_token,
  }.compact
  parser = -> { GetFeedsResponse }
  get(path, params:, rate_limit:, parser:)
end