Class: Peddler::APIs::Feeds20210630
- Inherits:
-
Peddler::API
- Object
- Peddler::API
- Peddler::APIs::Feeds20210630
- Includes:
- Helpers::Feeds20210630
- Defined in:
- lib/peddler/apis/feeds_2021_06_30.rb
Overview
Selling Partner API for Feeds
The Selling Partner API for Feeds lets you upload data to Amazon on behalf of a selling partner.
Instance Attribute Summary
Attributes inherited from Peddler::API
#access_token, #endpoint, #retries
Instance Method Summary collapse
-
#cancel_feed(feed_id, rate_limit: 2.0) ⇒ Peddler::Response
Cancels the feed that you specify.
-
#create_feed(body, rate_limit: 0.0083) ⇒ Peddler::Response
Creates a feed.
-
#create_feed_document(body, rate_limit: 0.5) ⇒ Peddler::Response
Creates a feed document for the feed type that you specify.
-
#get_feed(feed_id, rate_limit: 2.0) ⇒ Peddler::Response
Returns feed details (including the
resultDocumentId
, if available) for the feed that you specify. -
#get_feed_document(feed_document_id, rate_limit: 0.0222) ⇒ Peddler::Response
Returns the information required for retrieving a feed document's contents.
-
#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
Returns feed details for the feeds that match the filters that you specify.
Methods included from Helpers::Feeds20210630
#download_result_feed_document, #upload_feed_document
Methods inherited from Peddler::API
#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #typed, #typed?, #use, #via
Constructor Details
This class inherits a constructor from Peddler::API
Instance Method Details
#cancel_feed(feed_id, rate_limit: 2.0) ⇒ Peddler::Response
79 80 81 82 |
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 79 def cancel_feed(feed_id, rate_limit: 2.0) path = "/feeds/2021-06-30/feeds/#{percent_encode(feed_id)}" meter(rate_limit).delete(path) end |
#create_feed(body, rate_limit: 0.0083) ⇒ Peddler::Response
This operation can make a static sandbox call.
Creates a feed. Upload the contents of the feed document before calling this operation.
64 65 66 67 68 |
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 64 def create_feed(body, rate_limit: 0.0083) path = "/feeds/2021-06-30/feeds" parser = Peddler::Types::Feeds20210630::CreateFeedResponse if typed? meter(rate_limit).post(path, body:, parser:) end |
#create_feed_document(body, rate_limit: 0.5) ⇒ Peddler::Response
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.
105 106 107 108 109 |
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 105 def create_feed_document(body, rate_limit: 0.5) path = "/feeds/2021-06-30/documents" parser = Peddler::Types::Feeds20210630::CreateFeedDocumentResponse if typed? meter(rate_limit).post(path, body:, parser:) end |
#get_feed(feed_id, rate_limit: 2.0) ⇒ Peddler::Response
This operation can make a static sandbox call.
Returns feed details (including the resultDocumentId
, if available) for the feed that you specify.
91 92 93 94 95 |
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 91 def get_feed(feed_id, rate_limit: 2.0) path = "/feeds/2021-06-30/feeds/#{percent_encode(feed_id)}" parser = Peddler::Types::Feeds20210630::Feed if typed? meter(rate_limit).get(path, parser:) end |
#get_feed_document(feed_document_id, rate_limit: 0.0222) ⇒ Peddler::Response
This operation can make a static sandbox call.
Returns the information required for retrieving a feed document's contents.
117 118 119 120 121 |
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 117 def get_feed_document(feed_document_id, rate_limit: 0.0222) path = "/feeds/2021-06-30/documents/#{percent_encode(feed_document_id)}" parser = Peddler::Types::Feeds20210630::FeedDocument if typed? meter(rate_limit).get(path, 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
This operation can make a static sandbox call.
Returns feed details for the feeds that match the filters that you specify.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/peddler/apis/feeds_2021_06_30.rb', line 42 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 = Peddler::Types::Feeds20210630::GetFeedsResponse if typed? meter(rate_limit).get(path, params:, parser:) end |